org.tikv.common

Class TiSession

java.lang.Object

org.tikv.common.TiSession

All Implemented Interfaces:

AutoCloseable

public class TiSession
extends Object
implements AutoCloseable

TiSession is the holder for PD Client, Store pdClient and PD Cache All sessions share common region store connection pool but separated PD conn and cache for better concurrency

TiSession is thread-safe but it's also recommended to have multiple session avoiding lock contention

Constructor Summary

Constructors

Constructor and Description
TiSession(TiConfiguration conf)

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeAwaitTermination(long timeoutMS)
static TiSession	create(TiConfiguration conf)
KVClient	createKVClient()
RawKVClient	createRawClient()
SmartRawKVClient	createSmartRawClient()
Snapshot	createSnapshot()
Snapshot	createSnapshot(TiTimestamp ts)
TxnKVClient	createTxnClient()
Catalog	getCatalog()
ChannelFactory	getChannelFactory()
TiConfiguration	getConf()
ImporterStoreClient.ImporterStoreClientBuilder	getImporterRegionStoreClientBuilder()
static TiSession	getInstance(TiConfiguration conf) Deprecated.
PDClient	getPDClient()
RegionManager	getRegionManager()
RegionStoreClient.RegionStoreClientBuilder	getRegionStoreClientBuilder()
SwitchTiKVModeClient	getSwitchTiKVModeClient() SwitchTiKVModeClient is used for SST Ingest.
ExecutorService	getThreadPoolForBatchDelete()
ExecutorService	getThreadPoolForBatchGet()
ExecutorService	getThreadPoolForBatchPut()
ExecutorService	getThreadPoolForBatchScan()
ExecutorService	getThreadPoolForDeleteRange()
ExecutorService	getThreadPoolForIndexScan()
ExecutorService	getThreadPoolForTableScan()
TiTimestamp	getTimestamp()
void	splitRegionAndScatter(List<byte[]> splitKeys) split region and scatter
void	splitRegionAndScatter(List<byte[]> splitKeys, int splitRegionBackoffMS, int scatterRegionBackoffMS, int scatterWaitMS) split region and scatter
void	warmUp()

Methods inherited from class java.lang.Object

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

Constructor Detail

TiSession

public TiSession(TiConfiguration conf)

Method Detail

warmUp

public void warmUp()

create

public static TiSession create(TiConfiguration conf)

getInstance

@Deprecated
public static TiSession getInstance(TiConfiguration conf)

Deprecated.

createRawClient

public RawKVClient createRawClient()

createSmartRawClient

public SmartRawKVClient createSmartRawClient()

createKVClient

public KVClient createKVClient()

createTxnClient

public TxnKVClient createTxnClient()

getRegionStoreClientBuilder

public RegionStoreClient.RegionStoreClientBuilder getRegionStoreClientBuilder()

getImporterRegionStoreClientBuilder

public ImporterStoreClient.ImporterStoreClientBuilder getImporterRegionStoreClientBuilder()

getConf

public TiConfiguration getConf()

getTimestamp

public TiTimestamp getTimestamp()

createSnapshot

public Snapshot createSnapshot()

createSnapshot

public Snapshot createSnapshot(TiTimestamp ts)

getPDClient

public PDClient getPDClient()

getCatalog

public Catalog getCatalog()

getRegionManager

public RegionManager getRegionManager()

getThreadPoolForIndexScan

public ExecutorService getThreadPoolForIndexScan()

getThreadPoolForTableScan

public ExecutorService getThreadPoolForTableScan()

getThreadPoolForBatchPut

public ExecutorService getThreadPoolForBatchPut()

getThreadPoolForBatchGet

public ExecutorService getThreadPoolForBatchGet()

getThreadPoolForBatchDelete

public ExecutorService getThreadPoolForBatchDelete()

getThreadPoolForBatchScan

public ExecutorService getThreadPoolForBatchScan()

getThreadPoolForDeleteRange

public ExecutorService getThreadPoolForDeleteRange()

getChannelFactory

public ChannelFactory getChannelFactory()

getSwitchTiKVModeClient

public SwitchTiKVModeClient getSwitchTiKVModeClient()

SwitchTiKVModeClient is used for SST Ingest.

Returns:

a SwitchTiKVModeClient

splitRegionAndScatter

public void splitRegionAndScatter(List<byte[]> splitKeys,
                                  int splitRegionBackoffMS,
                                  int scatterRegionBackoffMS,
                                  int scatterWaitMS)

split region and scatter

Parameters:

splitKeys -

splitRegionBackoffMS -

scatterRegionBackoffMS -

scatterWaitMS -

splitRegionAndScatter

public void splitRegionAndScatter(List<byte[]> splitKeys)

split region and scatter

Parameters:

splitKeys -

closeAwaitTermination

public void closeAwaitTermination(long timeoutMS)
                           throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception