Background

ShardingSphere-JDBC provides a JDBC Driver, which can be used only through configuration changes without rewriting the code.

Parameters

Driver Class Name

org.apache.shardingsphere.driver.ShardingSphereDriver

URL Configuration

  • Use jdbc:shardingsphere: as prefix
  • Configuration file: xxx.yaml, keep consist format with YAML Configuration
  • Configuration file loading rule:
    • absolutepath: prefix means to load the configuration file from the absolute path
    • classpath: prefix indicates that the configuration file is loaded from the classpath

Procedure

  1. Import Maven Dependency
  1. <dependency>
  2. <groupId>org.apache.shardingsphere</groupId>
  3. <artifactId>shardingsphere-jdbc-core</artifactId>
  4. <version>${shardingsphere.version}</version>
  5. </dependency>
  1. Use drive
  • Use native drivers:
  1. Class.forName("org.apache.shardingsphere.driver.ShardingSphereDriver");
  2. String jdbcUrl = "jdbc:shardingsphere:classpath:config.yaml";
  3. String sql = "SELECT i.* FROM t_order o JOIN t_order_item i ON o.order_id=i.order_id WHERE o.user_id=? AND o.order_id=?";
  4. try (
  5. Connection conn = DriverManager.getConnection(jdbcUrl);
  6. PreparedStatement ps = conn.prepareStatement(sql)) {
  7. ps.setInt(1, 10);
  8. ps.setInt(2, 1000);
  9. try (ResultSet rs = preparedStatement.executeQuery()) {
  10. while(rs.next()) {
  11. // ...
  12. }
  13. }
  14. }
  • Use database connection pool:
  1. String driverClassName = "org.apache.shardingsphere.driver.ShardingSphereDriver";
  2. String jdbcUrl = "jdbc:shardingsphere:classpath:config.yaml";
  3. // Take HikariCP as an example
  4. HikariDataSource dataSource = new HikariDataSource();
  5. dataSource.setDriverClassName(driverClassName);
  6. dataSource.setJdbcUrl(jdbcUrl);
  7. String sql = "SELECT i.* FROM t_order o JOIN t_order_item i ON o.order_id=i.order_id WHERE o.user_id=? AND o.order_id=?";
  8. try (
  9. Connection conn = dataSource.getConnection();
  10. PreparedStatement ps = conn.prepareStatement(sql)) {
  11. ps.setInt(1, 10);
  12. ps.setInt(2, 1000);
  13. try (ResultSet rs = preparedStatement.executeQuery()) {
  14. while(rs.next()) {
  15. // ...
  16. }
  17. }
  18. }

Sample

Load JDBC URL of config.yaml profile in classpath:

  1. jdbc:shardingsphere:classpath:config.yaml

Load JDBC URL of config.yaml profile in absolute path

  1. jdbc:shardingsphere:absolutepath:/path/to/config.yaml