com.singlestore.jdbc.client.impl

Class StandardClient

java.lang.Object

com.singlestore.jdbc.client.impl.StandardClient

All Implemented Interfaces:

com.singlestore.jdbc.client.Client, AutoCloseable

Direct Known Subclasses:

ReplayClient

public class StandardClient
extends Object
implements com.singlestore.jdbc.client.Client, AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
protected com.singlestore.jdbc.client.Context	context
protected ExceptionFactory	exceptionFactory
protected Writer	writer

Constructor Summary

Constructors

Constructor and Description
StandardClient(Configuration conf, HostAddress hostAddress, ClosableLock lock, boolean skipPostCommands) Constructor

Method Summary

Modifier and Type	Method and Description
void	abort(Executor executor) Abort current connection
protected void	checkNotClosed() Throw an exception if client is closed
void	close() Close client
void	closePrepare(Prepare prepare) Close prepare command
protected void	destroySocket() Closing socket in case of Connection error after socket creation.
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
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
com.singlestore.jdbc.client.Completion	readPacket(com.singlestore.jdbc.message.ClientMessage message) Read a MySQL packet from socket
com.singlestore.jdbc.client.Completion	readPacket(Statement stmt, com.singlestore.jdbc.message.ClientMessage message, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion) Read server response packet.
void	readResponse(com.singlestore.jdbc.message.ClientMessage message) Read server response
List<com.singlestore.jdbc.client.Completion>	readResponse(Statement stmt, com.singlestore.jdbc.message.ClientMessage message, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion) Read server responses for a client message
void	readStreamingResults(List<com.singlestore.jdbc.client.Completion> completions, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion) Read results
void	reset() Reset connection
int	sendQuery(com.singlestore.jdbc.message.ClientMessage message) Send client message to server
void	setReadOnly(boolean readOnly) Switch to a writer/read-only connection, no effet on mono-connection
void	setSocketTimeout(int milliseconds) Set socket timeout

Methods inherited from class java.lang.Object

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

Field Detail

exceptionFactory

protected final ExceptionFactory exceptionFactory

writer

protected Writer writer

context

protected com.singlestore.jdbc.client.Context context

Constructor Detail

StandardClient

public StandardClient(Configuration conf,
                      HostAddress hostAddress,
                      ClosableLock lock,
                      boolean skipPostCommands)
               throws SQLException

Constructor

Parameters:

conf - configuration

hostAddress - host

lock - thread locker

skipPostCommands - must connection post command be skipped

Throws:

SQLException - if connection fails

Method Detail

destroySocket

protected void destroySocket()

Closing socket in case of Connection error after socket creation.

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

sendQuery

public int sendQuery(com.singlestore.jdbc.message.ClientMessage message)
              throws SQLException

Send client message to server

Parameters:

message - client message

Returns:

number of command send

Throws:

SQLException - if socket 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

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

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

readResponse

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

Read server responses for a client message

Parameters:

stmt - statement that issue the message

message - client message sent

fetchSize - fetch size

maxRows - maximum number of rows

resultSetConcurrency - concurrency

resultSetType - result-set type

closeOnCompletion - close statement on resultset completion

Returns:

list of result

Throws:

SQLException - if any error occurs

readResponse

public void readResponse(com.singlestore.jdbc.message.ClientMessage message)
                  throws SQLException

Read server response

Parameters:

message - client message that was sent

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

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

readPacket

public com.singlestore.jdbc.client.Completion readPacket(com.singlestore.jdbc.message.ClientMessage message)
                                                  throws SQLException

Read a MySQL packet from socket

Parameters:

message - client message issuing the result

Returns:

a mysql result

Throws:

SQLException - if any error occurs

readPacket

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

Read server response packet.

Parameters:

stmt - current statement (null if internal)

message - current message

fetchSize - default fetch size

resultSetConcurrency - concurrency

resultSetType - type

maxRows - max rows

closeOnCompletion - must resultset close statement on completion

Returns:

completion result

Throws:

SQLException - if any exception

checkNotClosed

protected void checkNotClosed()
                       throws SQLException

Throw an exception if client is closed

Throws:

SQLException - if closed

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

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

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

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

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

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

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

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