APIdia Launch Partner
Top Description Methods
java.sql

public Interface ShardingKeyBuilder

A builder created from a DataSource or XADataSource object, used to create a ShardingKey with sub-keys of supported data types. Implementations must support JDBCType.VARCHAR and may also support additional data types.

The following example illustrates the use of ShardingKeyBuilder to create a ShardingKey: 

DataSource ds = new MyDataSource();
    ShardingKey shardingKey = ds.createShardingKeyBuilder()
                          .subkey("abc", JDBCType.VARCHAR)
                          .subkey(94002, JDBCType.INTEGER)
                          .build();
Since
9

Method Summary

Modifier and TypeMethod and Description
public ShardingKey

Returns:

The built object
build()

Returns an instance of the object defined by this builder.

public ShardingKeyBuilder

Returns:

this builder object
subkey(Object
contains the object that needs to be part of shard sub key
subkey, SQLType
sub-key data type of type java.sql.SQLType
subkeyType)

This method will be called to add a subkey into a Sharding Key object being built.

Method Detail

buildback to summary
public ShardingKey build() throws SQLException

Returns an instance of the object defined by this builder.

Returns:ShardingKey

The built object

Exceptions
SQLException:
If an error occurs building the object
subkeyback to summary
public ShardingKeyBuilder subkey(Object subkey, SQLType subkeyType)

This method will be called to add a subkey into a Sharding Key object being built. The order in which subkey method is called is important as it indicates the order of placement of the subkey within the Sharding Key.

Parameters
subkey:Object

contains the object that needs to be part of shard sub key

subkeyType:SQLType

sub-key data type of type java.sql.SQLType

Returns:ShardingKeyBuilder

this builder object