apache/sharding-proxy repository overview

⁠Deprecated

Please go to: https://hub.docker.com/r/apache/shardingsphere-proxy⁠

Sharding-Sphere is an open-sourced distributed database middleware solution suite, which is composite by Sharding-JDBC, Sharding-Proxy and Sharding-Sidecar. Those 3 projects provide consistent features which include data sharding, read-write splitting, orchestration and B.A.S.E transaction. They can suitable for various scenario.

Sharding-Proxy is a database proxy. Deploy as a stateless server, support MySQL protocol for now.

Use standard MySQL protocol, application do not care about whether proxy or real MySQL.

Any MySQL command line and UI workbench supported in theoretically. MySQL Workbench are fully compatible right now.

⁠Pull official docker image

docker pull apache/sharding-proxy

⁠Configure Sharing-Proxy

Create /${your_work_dir}/conf/config.yaml file to configure sharding rule. More details please reference Configuration Manual⁠.

⁠Run docker

docker run -d -v /${your_work_dir}/conf:/opt/sharding-proxy/conf --env PORT=3308 -p13308:3308 apache/sharding-proxy:latest

The port 3308 and 13308 could be customized, 3308 represents port of docker container, 13308 represents port of host machine.

docker run -d -v /${your_work_dir}/conf:/opt/sharding-proxy/conf --env JVM_OPTS="-Djava.awt.headless=true" --env PORT=3308 -p13308:3308 apache/sharding-proxy:latest

Set JVM relative parameters into JVM_OPTS.

⁠Access Sharing-Proxy

Same as access MySQL.

mysql -u${your_user_name} -p${your_password} -h${your_host} -P13308

⁠FAQ

Q1: I/O exception (java.io.IOException) caught when processing request to {}->unix://localhost:80: Connection refused?

A: Please make sure docker is running before you build or run.

Q2：Can't connect to database when starting the container？

A：Please make sure /${your_work_dir}/conf/sharding-config.yaml's mysql database ip can be accessed by docker container.