Package com.clickhouse.client

Class ClickHouseRequestManager

java.lang.Object

com.clickhouse.client.ClickHouseRequestManager

public class ClickHouseRequestManager
extends Object

Request manager is responsible for generating query and session ID, as well as transaction creation. ServiceLoader will search and instantiate customized request manager first, and then fall back to default implementation if no luck.

Constructor Summary

Constructors

Constructor	Description
ClickHouseRequestManager()

Method Summary

Modifier and Type	Method	Description
ClickHouseTransaction	createImplicitTransaction(ClickHouseRequest<?> request)	Creates an implicit transaction.
String	createQueryId()	Creates a new query ID.
String	createSessionId()	Creates a new session ID.
ClickHouseTransaction	createTransaction(ClickHouseNode server, int timeout)	Creates a new transaction.
ClickHouseTransaction	createTransaction(ClickHouseRequest<?> request)	Creates a new transaction.
ClickHouseTransaction	createTransaction(ClickHouseRequest<?> request, int timeout)	Creates a new transaction.
String	createUniqueId()	Creates a global, URL-safe unique ID.
static ClickHouseRequestManager	getInstance()	Gets instance of request manager.
ClickHouseTransaction	getOrStartTransaction(ClickHouseRequest<?> request)	Gets or starts a new transaction.
ClickHouseTransaction	getOrStartTransaction(ClickHouseRequest<?> request, int timeout)	Gets or starts a new transaction.

Methods inherited from class java.lang.Object

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

Constructor Details

ClickHouseRequestManager

public ClickHouseRequestManager()

Method Details

getInstance

public static ClickHouseRequestManager getInstance()

Gets instance of request manager.

Returns:

non-null request manager

createQueryId

public String createQueryId()

Creates a new query ID. By default, it simply forwards the call to createUniqueId().

Returns:

non-null unique query ID

createSessionId

public String createSessionId()

Creates a new session ID. By default, it simply forwards the call to createUniqueId().

Returns:

non-null unique session ID

createUniqueId

public String createUniqueId()

Creates a global, URL-safe unique ID. By default it uses UUID.randomUUID() for least dependency, but you can override this method to use any other alternatives like TimeUUID, snowflake and maybe NanoID.

Returns:

non-empty global unique ID

createImplicitTransaction

public ClickHouseTransaction createImplicitTransaction(ClickHouseRequest<?> request)
                                                throws ClickHouseException

Creates an implicit transaction.

Parameters:

request - non-null request

Returns:

non-null new transaction

Throws:

ClickHouseException - when failed to create implicit transaction

createTransaction

public ClickHouseTransaction createTransaction(ClickHouseRequest<?> request)
                                        throws ClickHouseException

Creates a new transaction. Same as createTransaction(request, 0).

Parameters:

request - non-null request

Returns:

non-null new transaction

Throws:

ClickHouseException - when failed to create transaction

createTransaction

public ClickHouseTransaction createTransaction(ClickHouseRequest<?> request,
 int timeout)
                                        throws ClickHouseException

Creates a new transaction. Unlike getOrStartTransaction(ClickHouseRequest, int), the transaction's state is ClickHouseTransaction.NEW and it's not bounded with the request.

Parameters:

request - non-null request

timeout - transaction timeout in seconds, zero or negative number means request.getConfig().getTransactionTimeout()

Returns:

non-null new transaction

Throws:

ClickHouseException - when failed to create transaction

createTransaction

public ClickHouseTransaction createTransaction(ClickHouseNode server,
 int timeout)
                                        throws ClickHouseException

Creates a new transaction. createSessionId() will be called to start a new session just for the transaction.

Parameters:

server - non-null server

timeout - transaction timeout in seconds

Returns:

non-null new transaction

Throws:

ClickHouseException - when failed to create transaction

getOrStartTransaction

public ClickHouseTransaction getOrStartTransaction(ClickHouseRequest<?> request)
                                            throws ClickHouseException

Gets or starts a new transaction. Same as getOrStartTransaction(request, 0).

Parameters:

request - non-null request

Returns:

non-null transaction

Throws:

ClickHouseException - when failed to get or start transaction

getOrStartTransaction

public ClickHouseTransaction getOrStartTransaction(ClickHouseRequest<?> request,
 int timeout)
                                            throws ClickHouseException

Gets or starts a new transaction. createSessionId() will be called to when a new transaction is created.

Parameters:

request - non-null request

timeout - transaction timeout in seconds, zero or negative number means request.getConfig().getTransactionTimeout()

Returns:

non-null transaction in ClickHouseTransaction.ACTIVE state

Throws:

ClickHouseException - when failed to get or start transaction