APIdia Launch Partner
Top Description Methods
java.sql

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 TypeMethod and Description
public Connection

Returns:

The built object
build()

Returns an instance of the object defined by this builder.

public ConnectionBuilder

Returns:

the same ConnectionBuilder instance
password(String
the password to use for this connection. May be null
password)

Specifies the password to be used when creating a connection

public ConnectionBuilder

Returns:

the same ConnectionBuilder instance
shardingKey(ShardingKey
the ShardingKey. May be null
shardingKey)

Specifies a shardingKey to be used when creating a connection

public ConnectionBuilder

Returns:

the same ConnectionBuilder instance
superShardingKey(ShardingKey
the SuperShardingKey. May be null
superShardingKey)

Specifies a superShardingKey to be used when creating a connection

public ConnectionBuilder

Returns:

the same ConnectionBuilder instance
user(String
the database user on whose behalf the connection is being made
username)

Specifies the username to be used when creating a connection

Method Detail

buildback to summary
public Connection build() throws SQLException

Returns an instance of the object defined by this builder.

Returns:Connection

The built object

Exceptions
SQLException:
If an error occurs building the object
passwordback to summary
public ConnectionBuilder password(String password)

Specifies the password to be used when creating a connection

Parameters
password:String

the password to use for this connection. May be null

Returns:ConnectionBuilder

the same ConnectionBuilder instance

shardingKeyback to summary
public ConnectionBuilder shardingKey(ShardingKey shardingKey)

Specifies a shardingKey to be used when creating a connection

Parameters
shardingKey:ShardingKey

the ShardingKey. May be null

Returns:ConnectionBuilder

the same ConnectionBuilder instance

See Also
ShardingKey, ShardingKeyBuilder
superShardingKeyback to summary
public ConnectionBuilder superShardingKey(ShardingKey superShardingKey)

Specifies a superShardingKey to be used when creating a connection

Parameters
superShardingKey:ShardingKey

the SuperShardingKey. May be null

Returns:ConnectionBuilder

the same ConnectionBuilder instance

See Also
ShardingKey, ShardingKeyBuilder
userback to summary
public ConnectionBuilder user(String username)

Specifies the username to be used when creating a connection

Parameters
username:String

the database user on whose behalf the connection is being made

Returns:ConnectionBuilder

the same ConnectionBuilder instance