Spring Framework 6.1.4 · org.springframework.jdbc.datasource.ShardingKeyDataSourceAdapter

An adapter for a target DataSource, designed to apply sharding keys, if specified, to every standard #getConnection call, returning a direct connection to the shard corresponding to the specified sharding key value. All other methods simply delegate to the corresponding methods of the target DataSource.

The target DataSource must implement the createConnectionBuilder method; otherwise, a java.sql.SQLFeatureNotSupportedException will be thrown when attempting to acquire shard connections.

This adapter needs to be configured with a ShardingKeyProvider callback which is used to get the current sharding keys for every #getConnection call, for example:

ShardingKeyDataSourceAdapter dataSourceAdapter = new ShardingKeyDataSourceAdapter(dataSource);
dataSourceAdapter.setShardingKeyProvider(() -> dataSource.createShardingKeyBuilder()
    .subkey(SecurityContextHolder.getContext().getAuthentication().getName(), JDBCType.VARCHAR).build());

Modifier and Type	Field and Description
private ShardingKeyProvider	shardingkeyProvider

Constructor Summary

Access	Constructor and Description
public	ShardingKeyDataSourceAdapter(DataSource the target `DataSource` to be wrapped dataSource) Create a new instance of `ShardingKeyDataSourceAdapter`, wrapping the given `DataSource`.
public	ShardingKeyDataSourceAdapter(DataSource the target `DataSource` to be wrapped dataSource, ShardingKeyProvider the `ShardingKeyProvider` used to get the sharding keys shardingKeyProvider) Create a new instance of `ShardingKeyDataSourceAdapter`, wrapping the given `DataSource`.

Method Summary

Modifier and Type	Method and Description
public ConnectionBuilder	Returns: a ConnectionBuilder object representing a builder for direct shard connections createConnectionBuilder() Overrides org.springframework.jdbc.datasource.DelegatingDataSource.createConnectionBuilder. Overrides default javax.sql.DataSource.createConnectionBuilder. Create a new instance of `ConnectionBuilder` using the target `DataSource`'s `createConnectionBuilder()` method and set the appropriate sharding keys from the configured `ShardingKeyProvider`.
public Connection	Returns: a `Connection` object representing a direct shard connection getConnection() Overrides org.springframework.jdbc.datasource.DelegatingDataSource.getConnection. Implements javax.sql.DataSource.getConnection. Obtain a connection to the database shard using the provided sharding key and super sharding key (if available).
public Connection	Returns: a `Connection` object representing a direct shard connection getConnection(String the database user on whose behalf the connection is being made username, String the user's password password) Overrides org.springframework.jdbc.datasource.DelegatingDataSource.getConnection. Implements javax.sql.DataSource.getConnection. Obtain a connection to the database shard using the provided username and password, considering the sharding keys (if available) and the given credentials.
public void	setShardingKeyProvider(ShardingKeyProvider shardingKeyProvider) Set the `ShardingKeyProvider` for this adapter.

Inherited from org.springframework.jdbc.datasource.DelegatingDataSource:: afterPropertiesSet createShardingKeyBuilder getLoginTimeout getLogWriter getParentLogger getTargetDataSource isWrapperFor obtainTargetDataSource setLoginTimeout setLogWriter setTargetDataSource unwrap

Field Detail

shardingkeyProvider	back to summary
private ShardingKeyProvider shardingkeyProvider Annotations @Nullable

Constructor Detail

ShardingKeyDataSourceAdapter back to summary

ShardingKeyDataSourceAdapter	back to summary
public ShardingKeyDataSourceAdapter(DataSource dataSource) Create a new instance of `ShardingKeyDataSourceAdapter`, wrapping the given `DataSource`. Parameters dataSource:DataSource the target `DataSource` to be wrapped

public ShardingKeyDataSourceAdapter(DataSource dataSource)

Create a new instance of ShardingKeyDataSourceAdapter, wrapping the given DataSource.

Parameters

dataSource:DataSource: the target DataSource to be wrapped

ShardingKeyDataSourceAdapter back to summary

ShardingKeyDataSourceAdapter	back to summary
public ShardingKeyDataSourceAdapter(DataSource dataSource, ShardingKeyProvider shardingKeyProvider) Create a new instance of `ShardingKeyDataSourceAdapter`, wrapping the given `DataSource`. Parameters dataSource:DataSource the target `DataSource` to be wrapped shardingKeyProvider:ShardingKeyProvider the `ShardingKeyProvider` used to get the sharding keys

public ShardingKeyDataSourceAdapter(DataSource dataSource, ShardingKeyProvider shardingKeyProvider)

Create a new instance of ShardingKeyDataSourceAdapter, wrapping the given DataSource.

Parameters

dataSource:DataSource: the target DataSource to be wrapped
shardingKeyProvider:ShardingKeyProvider: the ShardingKeyProvider used to get the sharding keys

Method Detail

createConnectionBuilder back to summary

createConnectionBuilder	back to summary
public ConnectionBuilder createConnectionBuilder() throws SQLException Overrides org.springframework.jdbc.datasource.DelegatingDataSource.createConnectionBuilder. Overrides default javax.sql.DataSource.createConnectionBuilder. Create a new instance of `ConnectionBuilder` using the target `DataSource`'s `createConnectionBuilder()` method and set the appropriate sharding keys from the configured `ShardingKeyProvider`. Returns:ConnectionBuilder a ConnectionBuilder object representing a builder for direct shard connections Annotations @Override Exceptions SQLException: if an error occurs while creating the ConnectionBuilder

public ConnectionBuilder createConnectionBuilder() throws SQLException

Overrides org.springframework.jdbc.datasource.DelegatingDataSource.createConnectionBuilder.

Overrides default javax.sql.DataSource.createConnectionBuilder.

Create a new instance of ConnectionBuilder using the target DataSource's createConnectionBuilder() method and set the appropriate sharding keys from the configured ShardingKeyProvider.

Returns:ConnectionBuilder

a ConnectionBuilder object representing a builder for direct shard connections

Annotations

@Override

Exceptions

SQLException:: if an error occurs while creating the ConnectionBuilder

getConnection back to summary

getConnection	back to summary
public Connection getConnection() throws SQLException Overrides org.springframework.jdbc.datasource.DelegatingDataSource.getConnection. Implements javax.sql.DataSource.getConnection. Obtain a connection to the database shard using the provided sharding key and super sharding key (if available). The sharding key is obtained from the configured `ShardingKeyProvider`. Returns:Connection a `Connection` object representing a direct shard connection Annotations @Override Exceptions SQLException: if an error occurs while creating the connection See Also `createConnectionBuilder()`

public Connection getConnection() throws SQLException

Overrides org.springframework.jdbc.datasource.DelegatingDataSource.getConnection.

Implements javax.sql.DataSource.getConnection.

Obtain a connection to the database shard using the provided sharding key and super sharding key (if available).

The sharding key is obtained from the configured ShardingKeyProvider.

Returns:Connection

a Connection object representing a direct shard connection

Annotations

@Override

Exceptions

SQLException:: if an error occurs while creating the connection

See Also

createConnectionBuilder()

getConnection back to summary

getConnection	back to summary
public Connection getConnection(String username, String password) throws SQLException Overrides org.springframework.jdbc.datasource.DelegatingDataSource.getConnection. Implements javax.sql.DataSource.getConnection. Obtain a connection to the database shard using the provided username and password, considering the sharding keys (if available) and the given credentials. The sharding key is obtained from the configured `ShardingKeyProvider`. Parameters username:String the database user on whose behalf the connection is being made password:String the user's password Returns:Connection a `Connection` object representing a direct shard connection Annotations @Override Exceptions SQLException: if an error occurs while creating the connection

public Connection getConnection(String username, String password) throws SQLException

Overrides org.springframework.jdbc.datasource.DelegatingDataSource.getConnection.

Implements javax.sql.DataSource.getConnection.

Obtain a connection to the database shard using the provided username and password, considering the sharding keys (if available) and the given credentials.

The sharding key is obtained from the configured ShardingKeyProvider.

Parameters

username:String: the database user on whose behalf the connection is being made
password:String: the user's password

Returns:Connection

a Connection object representing a direct shard connection

Annotations

@Override

Exceptions

SQLException:: if an error occurs while creating the connection

setShardingKeyProvider	back to summary
public void setShardingKeyProvider(ShardingKeyProvider shardingKeyProvider) Set the `ShardingKeyProvider` for this adapter.

public Class ShardingKeyDataSourceAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail