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")
.shardingKey(shardingKey)
.superShardingKey(superShardingKey)
.build();
- Since:
- 9
-
Method Summary
Modifier and TypeMethodDescriptionbuild()Returns an instance of the object defined by this builder.Specifies the password to be used when creating a connectionshardingKey(ShardingKey shardingKey) Specifies ashardingKeyto be used when creating a connectionsuperShardingKey(ShardingKey superShardingKey) Specifies asuperShardingKeyto be used when creating a connectionSpecifies the username to be used when creating a connection
-
Method Details
-
user
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
ConnectionBuilderinstance
-
password
Specifies the password to be used when creating a connection- Parameters:
password- the password to use for this connection. May benull- Returns:
- the same
ConnectionBuilderinstance
-
shardingKey
Specifies ashardingKeyto be used when creating a connection- Parameters:
shardingKey- the ShardingKey. May benull- Returns:
- the same
ConnectionBuilderinstance - See Also:
-
superShardingKey
Specifies asuperShardingKeyto be used when creating a connection- Parameters:
superShardingKey- the SuperShardingKey. May benull- Returns:
- the same
ConnectionBuilderinstance - See Also:
-
build
Returns an instance of the object defined by this builder.- Returns:
- The built object
- Throws:
SQLException- If an error occurs building the object
-