org.apache.shardingsphere.infra.hint

Class HintManager

java.lang.Object

org.apache.shardingsphere.infra.hint.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.

Constructor Summary

Constructors

Constructor and Description
HintManager()

Method Summary

Modifier and Type	Method and Description
void	addDatabaseShardingValue(String logicTable, Comparable<?> value) Add sharding value for database.
void	addTableShardingValue(String logicTable, Comparable<?> value) Add sharding value for table.
static void	clear() Clear thread local for hint manager.
void	close()
static Collection<Comparable<?>>	getDatabaseShardingValues() Get database sharding values.
static Collection<Comparable<?>>	getDatabaseShardingValues(String logicTable) Get database sharding values.
static HintManager	getInstance() Get a new instance for HintManager.
static Collection<Comparable<?>>	getTableShardingValues(String logicTable) Get table sharding values.
static boolean	isDatabaseShardingOnly() Judge whether database sharding only.
static boolean	isWriteRouteOnly() Judge whether route to write database only or not.
void	setDatabaseShardingValue(Comparable<?> value) Set sharding value for database sharding only.
void	setWriteRouteOnly() Set database operation force route to write 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,
                                     Comparable<?> value)

Add sharding value for database.

The sharding operator is =

Parameters:

logicTable - logic table name

value - sharding value

addTableShardingValue

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

Add sharding value for table.

The sharding operator is =

Parameters:

logicTable - logic table name

value - sharding value

getDatabaseShardingValues

public static Collection<Comparable<?>> getDatabaseShardingValues()

Get database sharding values.

Returns:

database sharding values

getDatabaseShardingValues

public static Collection<Comparable<?>> getDatabaseShardingValues(String logicTable)

Get database sharding values.

Parameters:

logicTable - logic table

Returns:

database sharding values

getTableShardingValues

public static Collection<Comparable<?>> getTableShardingValues(String logicTable)

Get table sharding values.

Parameters:

logicTable - logic table name

Returns:

table sharding values

isDatabaseShardingOnly

public static boolean isDatabaseShardingOnly()

Judge whether database sharding only.

Returns:

database sharding or not

setWriteRouteOnly

public void setWriteRouteOnly()

Set database operation force route to write database only.

isWriteRouteOnly

public static boolean isWriteRouteOnly()

Judge whether route to write database only or not.

Returns:

route to write database only or not

clear

public static void clear()

Clear thread local for hint manager.

close

public void close()

Specified by:

close in interface AutoCloseable