Module java.sql
Package java.sql

Interface ConnectionBuilder

  • public interface ConnectionBuilder
    A builder created from a DataSource object, used to establish a connection to the database that the data source object represents. The connection properties that were specified for the data source are used as the default values by the ConnectionBuilder.

    The following example illustrates the use of ConnectionBuilder to create a Connection: 

    
     DataSource ds = new MyDataSource();
     ShardingKey superShardingKey = ds.createShardingKeyBuilder()
                           .subkey("EASTERN_REGION", JDBCType.VARCHAR)
                           .build();
     ShardingKey shardingKey = ds.createShardingKeyBuilder()
                           .subkey("PITTSBURGH_BRANCH", JDBCType.VARCHAR)
                           .build();
     Connection con = ds.createConnectionBuilder()
                       .user("rafa")
                       .password("tennis")
                       .setShardingKey(shardingKey)
                       .setSuperShardingKey(superShardingKey)
                       .build();

    Since:
    9

    • Method Detail

      • user

        ConnectionBuilder user​(String username)
        Specifies the username to be used when creating a connection
        Parameters:
        username - the database user on whose behalf the connection is being made
        Returns:
        the same ConnectionBuilder instance

      • password

        ConnectionBuilder password​(String password)
        Specifies the password to be used when creating a connection
        Parameters:
        password - the password to use for this connection. May be null
        Returns:
        the same ConnectionBuilder instance

      • superShardingKey

        ConnectionBuilder superShardingKey​(ShardingKey superShardingKey)
        Specifies a superShardingKey to be used when creating a connection
        Parameters:
        superShardingKey - the SuperShardingKey. May be null
        Returns:
        the same ConnectionBuilder instance
        See Also:
        ShardingKey, ShardingKeyBuilder

      • build

        Connection build()
          throws SQLException
        Returns an instance of the object defined by this builder.
        Returns:
        The built object
        Throws:
        SQLException - If an error occurs building the object