Interface ConnectionBuilder

public interfaceConnectionBuilder
A builder created from aDataSource object, used to establish a connection to the database that thedata source object represents. The connection properties that were specified for thedata source are used as the default values by theConnectionBuilder.

The following example illustrates the use ofConnectionBuilder to create aConnection:

     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")                       .shardingKey(shardingKey)                       .superShardingKey(superShardingKey)                       .build();

Since:
9

  • Method Details

    • 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 sameConnectionBuilder 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 benull
      Returns:
      the sameConnectionBuilder instance

    • shardingKey

      ConnectionBuilder shardingKey(ShardingKey shardingKey)
      Specifies ashardingKey to be used when creating a connection
      Parameters:
      shardingKey - the ShardingKey. May benull
      Returns:
      the sameConnectionBuilder instance
      See Also:

    • superShardingKey

      ConnectionBuilder superShardingKey(ShardingKey superShardingKey)
      Specifies asuperShardingKey to be used when creating a connection
      Parameters:
      superShardingKey - the SuperShardingKey. May benull
      Returns:
      the sameConnectionBuilder instance
      See Also:

    • build

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