com.singlestore.jdbc.client.impl

Class FailoverClient

java.lang.Object

com.singlestore.jdbc.client.impl.FailoverClient

All Implemented Interfaces:

com.singlestore.jdbc.client.Client, AutoCloseable

public class FailoverClient
extends Object
implements com.singlestore.jdbc.client.Client

Handling connection failing automatic reconnection transparently when possible for multi-host Topology.

remark: would have been better using proxy, but for AOT compilation, avoiding to using not supported proxy class.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed is connections explicitly closed
protected Configuration	conf configuration
protected com.singlestore.jdbc.client.Client	currentClient current client
protected long	deniedListTimeout denied timeout
protected static ConcurrentMap<HostAddress,Long>	denyList temporary blacklisted hosts
protected ClosableLock	lock thread locker

Constructor Summary

Constructors

Constructor and Description
FailoverClient(Configuration conf, ClosableLock lock) Constructor

Method Summary

Modifier and Type	Method and Description
void	abort(Executor executor) Abort current connection
void	close() Close client
void	closePrepare(Prepare prepare) Close prepare command
protected com.singlestore.jdbc.client.Client	connectHost() Trying connecting server.
List<com.singlestore.jdbc.client.Completion>	execute(com.singlestore.jdbc.message.ClientMessage message, boolean canRedo) Send client message and read result
List<com.singlestore.jdbc.client.Completion>	execute(com.singlestore.jdbc.message.ClientMessage message, Statement stmt, boolean canRedo) Send client message and read result
List<com.singlestore.jdbc.client.Completion>	execute(com.singlestore.jdbc.message.ClientMessage message, Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, boolean canRedo) Send client message and read result
List<com.singlestore.jdbc.client.Completion>	executePipeline(com.singlestore.jdbc.message.ClientMessage[] messages, Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, boolean canRedo) Send client messages pipelining and read result
protected void	executeTransactionReplay(com.singlestore.jdbc.client.Client oldCli) Execute transaction replay
BigInteger	getAggregatorId() Get aggregator id
com.singlestore.jdbc.client.Context	getContext() Get connection context
ExceptionFactory	getExceptionFactory() Get connection exception factory
HostAddress	getHostAddress() Get connection host
BigInteger	getInitialSqlSelectLimit() Get the maximum number of rows returned by a SELECT query.
com.singlestore.jdbc.util.Version	getSingleStoreVersion() Get SingleStore version.
String	getSocketIp() Get current socket IP or null (for Pipe / unix socket)
int	getSocketTimeout() get socket timeout
boolean	isClosed() Is client closed
boolean	isPrimary()
void	readStreamingResults(List<com.singlestore.jdbc.client.Completion> completions, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion) Read results
protected com.singlestore.jdbc.client.Client	reConnect() Connection loop
protected void	replayIfPossible(com.singlestore.jdbc.client.Client oldClient, boolean canRedo, SQLException cause) Execute transaction replay if in transaction and configured for it, throw an exception if not
void	reset() Reset connection
void	setReadOnly(boolean readOnly) Switch to a writer/read-only connection, no effet on mono-connection
void	setSocketTimeout(int milliseconds) Set socket timeout
void	syncNewState(com.singlestore.jdbc.client.Client oldCli) Synchronized previous and new client states.

Methods inherited from class java.lang.Object

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

Field Detail

denyList

protected static final ConcurrentMap<HostAddress,Long> denyList

temporary blacklisted hosts

deniedListTimeout

protected final long deniedListTimeout

denied timeout

conf

protected final Configuration conf

configuration

closed

protected boolean closed

is connections explicitly closed

lock

protected final ClosableLock lock

thread locker

currentClient

protected com.singlestore.jdbc.client.Client currentClient

current client

Constructor Detail

FailoverClient

public FailoverClient(Configuration conf,
                      ClosableLock lock)
               throws SQLException

Constructor

Parameters:

conf - configuration

lock - thread locker

Throws:

SQLException - if fail to connect

Method Detail

connectHost

protected com.singlestore.jdbc.client.Client connectHost()
                                                  throws SQLException

Trying connecting server.

searching each connecting primary / replica connection not temporary denied until found one. searching in temporary denied host if not succeed, until reaching `retriesAllDown` attempts.

Returns:

a valid connection client

Throws:

SQLException - if not succeed to create a connection.

reConnect

protected com.singlestore.jdbc.client.Client reConnect()
                                                throws SQLException

Connection loop

Returns:

client connection

Throws:

SQLException - if fail to connect

replayIfPossible

protected void replayIfPossible(com.singlestore.jdbc.client.Client oldClient,
                                boolean canRedo,
                                SQLException cause)
                         throws SQLException

Execute transaction replay if in transaction and configured for it, throw an exception if not

Parameters:

oldClient - previous client

canRedo - if command can be redo even if not in transaction

Throws:

SQLException - if not able to replay

executeTransactionReplay

protected void executeTransactionReplay(com.singlestore.jdbc.client.Client oldCli)
                                 throws SQLException

Execute transaction replay

Parameters:

oldCli - previous client

Throws:

SQLException - if not able to replay

syncNewState

public void syncNewState(com.singlestore.jdbc.client.Client oldCli)
                  throws SQLException

Synchronized previous and new client states.

Parameters:

oldCli - previous client

Throws:

SQLException - if error occurs

execute

public List<com.singlestore.jdbc.client.Completion> execute(com.singlestore.jdbc.message.ClientMessage message,
                                                            boolean canRedo)
                                                     throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Send client message and read result

Specified by:

execute in interface com.singlestore.jdbc.client.Client

Parameters:

message - client message

canRedo - can client message be redone in case of failover

Returns:

results

Throws:

SQLException - if execution fails

execute

public List<com.singlestore.jdbc.client.Completion> execute(com.singlestore.jdbc.message.ClientMessage message,
                                                            Statement stmt,
                                                            boolean canRedo)
                                                     throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Send client message and read result

Specified by:

execute in interface com.singlestore.jdbc.client.Client

Parameters:

message - client message

stmt - statement

canRedo - can client message be redone in case of failover

Returns:

results

Throws:

SQLException - if execution fails

execute

public List<com.singlestore.jdbc.client.Completion> execute(com.singlestore.jdbc.message.ClientMessage message,
                                                            Statement stmt,
                                                            int fetchSize,
                                                            long maxRows,
                                                            int resultSetConcurrency,
                                                            int resultSetType,
                                                            boolean closeOnCompletion,
                                                            boolean canRedo)
                                                     throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Send client message and read result

Specified by:

execute in interface com.singlestore.jdbc.client.Client

Parameters:

message - client message

stmt - statement

fetchSize - fetch size

maxRows - maximum number of rows. 0 = all

resultSetConcurrency - concurrency

resultSetType - result-set type

closeOnCompletion - close statement on completion

canRedo - can client message be redone in case of failover

Returns:

results

Throws:

SQLException - if any error occurs

executePipeline

public List<com.singlestore.jdbc.client.Completion> executePipeline(com.singlestore.jdbc.message.ClientMessage[] messages,
                                                                    Statement stmt,
                                                                    int fetchSize,
                                                                    long maxRows,
                                                                    int resultSetConcurrency,
                                                                    int resultSetType,
                                                                    boolean closeOnCompletion,
                                                                    boolean canRedo)
                                                             throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Send client messages pipelining and read result

Specified by:

executePipeline in interface com.singlestore.jdbc.client.Client

Parameters:

messages - client message

stmt - statement

fetchSize - fetch size

maxRows - maximum number of rows. 0 = all

resultSetConcurrency - concurrency

resultSetType - result-set type

closeOnCompletion - close statement on completion

canRedo - can client message be redone in case of failover

Returns:

results

Throws:

SQLException - if any error occurs

readStreamingResults

public void readStreamingResults(List<com.singlestore.jdbc.client.Completion> completions,
                                 int fetchSize,
                                 long maxRows,
                                 int resultSetConcurrency,
                                 int resultSetType,
                                 boolean closeOnCompletion)
                          throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Read results

Specified by:

readStreamingResults in interface com.singlestore.jdbc.client.Client

Parameters:

completions - List that will have the new results

fetchSize - fetch size

maxRows - maximum number of rows. 0 = all

resultSetConcurrency - concurrency

resultSetType - result-set type

closeOnCompletion - close statement on completion

Throws:

SQLException - if any error occurs

closePrepare

public void closePrepare(Prepare prepare)
                  throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Close prepare command

Specified by:

closePrepare in interface com.singlestore.jdbc.client.Client

Parameters:

prepare - prepare command

Throws:

SQLException - if any error occurs

abort

public void abort(Executor executor)
           throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Abort current connection

Specified by:

abort in interface com.singlestore.jdbc.client.Client

Parameters:

executor - executor

Throws:

SQLException - if any error occurs

close

public void close()
           throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Close client

Specified by:

close in interface com.singlestore.jdbc.client.Client

Specified by:

close in interface AutoCloseable

Throws:

SQLException - if any error occurs

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Switch to a writer/read-only connection, no effet on mono-connection

Specified by:

setReadOnly in interface com.singlestore.jdbc.client.Client

Parameters:

readOnly - must use read-only connection

Throws:

SQLException - if any error occurs

getSocketTimeout

public int getSocketTimeout()

Description copied from interface: com.singlestore.jdbc.client.Client

get socket timeout

Specified by:

getSocketTimeout in interface com.singlestore.jdbc.client.Client

Returns:

socket timeout

setSocketTimeout

public void setSocketTimeout(int milliseconds)
                      throws SQLException

Description copied from interface: com.singlestore.jdbc.client.Client

Set socket timeout

Specified by:

setSocketTimeout in interface com.singlestore.jdbc.client.Client

Parameters:

milliseconds - timeout

Throws:

SQLException - if any error occurs

isClosed

public boolean isClosed()

Description copied from interface: com.singlestore.jdbc.client.Client

Is client closed

Specified by:

isClosed in interface com.singlestore.jdbc.client.Client

Returns:

close flag

getContext

public com.singlestore.jdbc.client.Context getContext()

Description copied from interface: com.singlestore.jdbc.client.Client

Get connection context

Specified by:

getContext in interface com.singlestore.jdbc.client.Client

Returns:

connection context

getExceptionFactory

public ExceptionFactory getExceptionFactory()

Description copied from interface: com.singlestore.jdbc.client.Client

Get connection exception factory

Specified by:

getExceptionFactory in interface com.singlestore.jdbc.client.Client

Returns:

connection exception factory

getHostAddress

public HostAddress getHostAddress()

Description copied from interface: com.singlestore.jdbc.client.Client

Get connection host

Specified by:

getHostAddress in interface com.singlestore.jdbc.client.Client

Returns:

connection host

getSocketIp

public String getSocketIp()

Description copied from interface: com.singlestore.jdbc.client.Client

Get current socket IP or null (for Pipe / unix socket)

Specified by:

getSocketIp in interface com.singlestore.jdbc.client.Client

Returns:

Socket current IP

getAggregatorId

public BigInteger getAggregatorId()

Description copied from interface: com.singlestore.jdbc.client.Client

Get aggregator id

Specified by:

getAggregatorId in interface com.singlestore.jdbc.client.Client

Returns:

aggregator id

getInitialSqlSelectLimit

public BigInteger getInitialSqlSelectLimit()

Description copied from interface: com.singlestore.jdbc.client.Client

Get the maximum number of rows returned by a SELECT query. If the LIMIT clause is specified in a SELECT query, the value in the LIMIT clause overrides sql_select_limit

Specified by:

getInitialSqlSelectLimit in interface com.singlestore.jdbc.client.Client

Returns:

sql select limit

getSingleStoreVersion

public com.singlestore.jdbc.util.Version getSingleStoreVersion()

Description copied from interface: com.singlestore.jdbc.client.Client

Get SingleStore version.

Specified by:

getSingleStoreVersion in interface com.singlestore.jdbc.client.Client

Returns:

S2 version

isPrimary

public boolean isPrimary()

reset

public void reset()

Description copied from interface: com.singlestore.jdbc.client.Client

Reset connection

Specified by:

reset in interface com.singlestore.jdbc.client.Client