io.shardingsphere.core.api

Class HintManager

java.lang.Object

io.shardingsphere.core.api.HintManager

All Implemented Interfaces:

AutoCloseable

public final class HintManager
extends Object
implements AutoCloseable

The manager that use hint to inject sharding key directly through ThreadLocal.

Author:

gaohongtao, zhangliang

Constructor Summary

Constructors

Constructor and Description
HintManager()

Method Summary

Modifier and Type	Method and Description
void	addDatabaseShardingValue(String logicTable, String shardingColumn, Comparable<?> value) Add sharding value for database.
void	addDatabaseShardingValue(String logicTable, String shardingColumn, ShardingOperator operator, Comparable<?>... values) Add sharding value for database.
void	addTableShardingValue(String logicTable, String shardingColumn, Comparable<?> value) Add sharding value for table.
void	addTableShardingValue(String logicTable, String shardingColumn, ShardingOperator operator, Comparable<?>... values) Add sharding value for table.
void	close()
ShardingValue	getDatabaseShardingValue(ShardingKey shardingKey) Get sharding value for database.
static HintManager	getInstance() Get a new instance for HintManager.
ShardingValue	getTableShardingValue(ShardingKey shardingKey) Get sharding value for table.
void	setDatabaseShardingValue(Comparable<?> value) Set sharding value for database sharding only.
void	setMasterRouteOnly() Set CRUD operation force route to master database only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HintManager

public HintManager()

Method Detail

getInstance

public static HintManager getInstance()

Get a new instance for HintManager.

Returns:

HintManager instance

setDatabaseShardingValue

public void setDatabaseShardingValue(Comparable<?> value)

Set sharding value for database sharding only.

The sharding operator is =

Parameters:

value - sharding value

addDatabaseShardingValue

public void addDatabaseShardingValue(String logicTable,
                                     String shardingColumn,
                                     Comparable<?> value)

Add sharding value for database.

The sharding operator is =

Parameters:

logicTable - logic table name

shardingColumn - sharding column name

value - sharding value

addDatabaseShardingValue

public void addDatabaseShardingValue(String logicTable,
                                     String shardingColumn,
                                     ShardingOperator operator,
                                     Comparable<?>... values)

Add sharding value for database.

Parameters:

logicTable - logic table name

shardingColumn - sharding column name

operator - sharding operator

values - sharding value

addTableShardingValue

public void addTableShardingValue(String logicTable,
                                  String shardingColumn,
                                  Comparable<?> value)

Add sharding value for table.

The sharding operator is =

Parameters:

logicTable - logic table name

shardingColumn - sharding column name

value - sharding value

addTableShardingValue

public void addTableShardingValue(String logicTable,
                                  String shardingColumn,
                                  ShardingOperator operator,
                                  Comparable<?>... values)

Add sharding value for table.

Parameters:

logicTable - logic table name

shardingColumn - sharding column name

operator - sharding operator

values - sharding value

getDatabaseShardingValue

public ShardingValue getDatabaseShardingValue(ShardingKey shardingKey)

Get sharding value for database.

Parameters:

shardingKey - sharding key

Returns:

sharding value for database

getTableShardingValue

public ShardingValue getTableShardingValue(ShardingKey shardingKey)

Get sharding value for table.

Parameters:

shardingKey - sharding key

Returns:

sharding value for table

setMasterRouteOnly

public void setMasterRouteOnly()

Set CRUD operation force route to master database only.

close

public void close()

Specified by:

close in interface AutoCloseable