Proxy Startup

Startup Steps

  1. Download the latest version of ShardingSphere-Proxy.
  2. If users use docker, they can execute docker pull shardingsphere/shardingsphere-proxy to get the image. Please refer to Docker Image for more details.
  3. After the decompression, revise conf/server.yaml and documents begin with config- prefix, conf/config-xxx.yaml for example, to configure sharding rules and readwrite-splitting rules. Please refer to Configuration Manual for the configuration method.
  4. Please run bin/ for Linux operating system; run bin/start.bat for Windows operating system to start ShardingSphere-Proxy. To configure start port and document location, please refer to Quick Start.

Using PostgreSQL

  1. Use any PostgreSQL client end to connect, such as psql -U root -h -p 3307.

Using MySQL/openGauss

  1. Copy MySQL/openGauss’s JDBC driver to folder ext-lib/.
  2. Use any MySQL/openGauss client end to connect, such as mysql -u root -h -P 3307 or gsql.

Using user-defined sharding algorithm

When developer need to use user-defined sharding algorithm, it can not configure via inline expression in YAML file simply, should use the way below to configure sharding algorithm.

  1. Implement ShardingAlgorithm interface.
  2. Package Java file to jar.
  3. Copy jar to ShardingSphere-Proxy’s ext-lib/ folder.
  4. Configure user-defined Java class into YAML file. Please refer to Configuration Manual for more details.


  1. ShardingSphere-Proxy uses 3307 port in default. Users can start the script parameter as the start port number, like bin/ 3308.
  2. ShardingSphere-Proxy uses conf/server.yaml to configure the registry center, authentication information and public properties.
  3. ShardingSphere-Proxy supports multi-logic data source, with each yaml configuration document named by config- prefix as a logic data source.