org.mariadb.jdbc.internal.protocol

Class AbstractQueryProtocol

java.lang.Object

org.mariadb.jdbc.internal.protocol.AbstractConnectProtocol

org.mariadb.jdbc.internal.protocol.AbstractQueryProtocol

All Implemented Interfaces:

Protocol

Direct Known Subclasses:

MasterProtocol

public class AbstractQueryProtocol
extends AbstractConnectProtocol
implements Protocol

Field Summary

Fields inherited from class org.mariadb.jdbc.internal.protocol.AbstractConnectProtocol

activeResult, charset, connected, currentHost, database, dataTypeMappingFlags, explicitClosed, hasWarnings, lock, moreResultsTypeBinary, packetFetcher, prepareStatementCache, proxy, readOnly, serverStatus, serverThreadId, socket, urlParser, writer

Constructor Summary

Constructors

Constructor and Description
AbstractQueryProtocol(UrlParser urlParser, ReentrantLock lock) Get a protocol instance.

Method Summary

Modifier and Type	Method and Description
void	cancelCurrentQuery() Cancels the current query - clones the current protocol and executes a query using the new connection.
void	closeExplicit()
void	closeIfActiveResult() Close active result.
void	closePreparedStatement(int statementId)
void	executeMultiQueries(Deque<Query> queries, ExecutionResult executionResult, int resultSetScrollType, boolean isRewritable, int rewriteOffset) Execute list of queries.
void	executePreparedQuery(String sql, ExecutionResult executionResult, ParameterHolder[] parameters, PrepareResult prepareResult, MariaDbType[] parameterTypeHeader, int resultSetScrollType)
void	executePreparedQueryAfterFailover(String sql, ExecutionResult executionResult, ParameterHolder[] parameters, PrepareResult prepareResult, MariaDbType[] parameterTypeHeader, int resultSetScrollType)
void	executeQueries(Deque<Query> queries, ExecutionResult executionResult, int resultSetScrollType) Execute list of queries one by one This method is used when using text batch statement and using rewriting (allowMultiQueries || rewriteBatchedStatements).
ExecutionResult	executeQuery(Query query) Execute query.
void	executeQuery(Query query, ExecutionResult executionResult, int resultSetScrollType, int fetchSize) Execute Query.
void	forceReleasePrepareStatement(int statementId) Force release of prepare statement that are not used.
boolean	getAutocommit()
int	getMaxRows()
void	getMoreResults(ExecutionResult executionResult)
void	getResult(ExecutionResult executionResult, int resultSetScrollType, boolean binaryProtocol) Fetch result.
int	getTimeout() Returns the connection timeout in milliseconds.
int	getTransactionIsolationLevel()
boolean	hasUnreadData()
static String	hexdump(byte[] buffer, int offset) Hexdump.
static String	hexdump(ByteBuffer bb, int offset) Hexdump.
boolean	inTransaction()
boolean	ping()
PrepareResult	prepare(String sql)
PrepareStatementCache	prepareStatementCache()
void	releasePrepareStatement(String sql, int statementId)
void	rollback() Rollback transaction.
void	setCatalog(String database)
void	setInternalMaxRows(int max) Set max row retuen by a statement.
void	setLocalInfileInputStream(InputStream inputStream)
void	setMaxRows(int max)
void	setTimeout(int timeout) Sets the connection timeout.
void	setTransactionIsolation(int level) Set transaction isolation.

Methods inherited from class org.mariadb.jdbc.internal.protocol.AbstractConnectProtocol

checkIfMaster, close, close, connect, connectWithoutProxy, getActiveResult, getCalendar, getDatabase, getDataTypeMappingFlags, getHost, getHostAddress, getLock, getMajorServerVersion, getMinorServerVersion, getOptions, getPassword, getPinGlobalTxToPhysicalConnection, getPort, getPrepareStatementCache, getProxy, getReadonly, getServerData, getServerThreadId, getServerVersion, getUrlParser, getUsername, hasMoreResults, hasWarnings, isClosed, isConnected, isExplicitClosed, isMasterConnection, mustBeMasterConnection, noBackslashEscapes, readEofPacket, resetMoreResults, setActiveResult, setHasWarnings, setHostAddress, setHostFailedWithoutProxy, setMoreResults, setProxy, setReadonly, shouldReconnectWithoutProxy, skip, versionGreaterOrEqual

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mariadb.jdbc.internal.protocol.Protocol

checkIfMaster, close, connect, connectWithoutProxy, getActiveResult, getCalendar, getDatabase, getDataTypeMappingFlags, getHost, getHostAddress, getLock, getMajorServerVersion, getMinorServerVersion, getOptions, getPassword, getPinGlobalTxToPhysicalConnection, getPort, getProxy, getReadonly, getServerData, getServerThreadId, getServerVersion, getUrlParser, getUsername, hasMoreResults, hasWarnings, isClosed, isConnected, isExplicitClosed, isMasterConnection, mustBeMasterConnection, noBackslashEscapes, setActiveResult, setHasWarnings, setHostAddress, setHostFailedWithoutProxy, setMoreResults, setProxy, setReadonly, shouldReconnectWithoutProxy, skip, versionGreaterOrEqual

Constructor Detail

AbstractQueryProtocol

public AbstractQueryProtocol(UrlParser urlParser,
                             ReentrantLock lock)

Get a protocol instance.

Parameters:

urlParser - connection URL infos

lock - the lock for thread synchronisation

Method Detail

hexdump

public static String hexdump(byte[] buffer,
                             int offset)

Hexdump.

Parameters:

buffer - byte array

offset - offset

Returns:

String

hexdump

public static String hexdump(ByteBuffer bb,
                             int offset)

Hexdump.

Parameters:

bb - bytebuffer

offset - offset

Returns:

String

prepare

public PrepareResult prepare(String sql)
                      throws QueryException

Specified by:

prepare in interface Protocol

Throws:

QueryException

closePreparedStatement

public void closePreparedStatement(int statementId)
                            throws QueryException

Specified by:

closePreparedStatement in interface Protocol

Throws:

QueryException

getAutocommit

public boolean getAutocommit()

Specified by:

getAutocommit in interface Protocol

inTransaction

public boolean inTransaction()

Specified by:

inTransaction in interface Protocol

closeExplicit

public void closeExplicit()

Specified by:

closeExplicit in interface Protocol

rollback

public void rollback()

Rollback transaction.

Specified by:

rollback in interface Protocol

setCatalog

public void setCatalog(String database)
                throws QueryException

Specified by:

setCatalog in interface Protocol

Throws:

QueryException

ping

public boolean ping()
             throws QueryException

Specified by:

ping in interface Protocol

Throws:

QueryException

executeQuery

public ExecutionResult executeQuery(Query query)
                             throws QueryException

Execute query.

Specified by:

executeQuery in interface Protocol

Specified by:

executeQuery in class AbstractConnectProtocol

Parameters:

query - the query to execute

Returns:

queryResult

Throws:

QueryException - exception

executeQuery

public void executeQuery(Query query,
                         ExecutionResult executionResult,
                         int resultSetScrollType,
                         int fetchSize)
                  throws QueryException

Execute Query.

Specified by:

executeQuery in interface Protocol

Parameters:

query - query

executionResult - result

resultSetScrollType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Throws:

QueryException - if error occur

executeMultiQueries

public void executeMultiQueries(Deque<Query> queries,
                                ExecutionResult executionResult,
                                int resultSetScrollType,
                                boolean isRewritable,
                                int rewriteOffset)
                         throws QueryException

Execute list of queries. This method is used when using text batch statement and using rewriting (allowMultiQueries || rewriteBatchedStatements). queries will be send to server according to max_allowed_packet size.

Specified by:

executeMultiQueries in interface Protocol

Parameters:

queries - list of queryes

executionResult - result

resultSetScrollType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

isRewritable - is rewritable flag

rewriteOffset - rewrite offset

Throws:

QueryException - exception

executeQueries

public void executeQueries(Deque<Query> queries,
                           ExecutionResult executionResult,
                           int resultSetScrollType)
                    throws QueryException

Execute list of queries one by one This method is used when using text batch statement and using rewriting (allowMultiQueries || rewriteBatchedStatements). queries will be send to server according to max_allowed_packet size.

Specified by:

executeQueries in interface Protocol

Parameters:

queries - list of queries

executionResult - result

resultSetScrollType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Throws:

QueryException - exception

getResult

public void getResult(ExecutionResult executionResult,
                      int resultSetScrollType,
                      boolean binaryProtocol)
               throws QueryException

Fetch result.

Specified by:

getResult in interface Protocol

Parameters:

executionResult - result

resultSetScrollType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

binaryProtocol - is binary protocol

Throws:

QueryException - id any exception occur

executePreparedQueryAfterFailover

public void executePreparedQueryAfterFailover(String sql,
                                              ExecutionResult executionResult,
                                              ParameterHolder[] parameters,
                                              PrepareResult prepareResult,
                                              MariaDbType[] parameterTypeHeader,
                                              int resultSetScrollType)
                                       throws QueryException

Specified by:

executePreparedQueryAfterFailover in interface Protocol

Throws:

QueryException

executePreparedQuery

public void executePreparedQuery(String sql,
                                 ExecutionResult executionResult,
                                 ParameterHolder[] parameters,
                                 PrepareResult prepareResult,
                                 MariaDbType[] parameterTypeHeader,
                                 int resultSetScrollType)
                          throws QueryException

Specified by:

executePreparedQuery in interface Protocol

Throws:

QueryException

releasePrepareStatement

public void releasePrepareStatement(String sql,
                                    int statementId)
                             throws QueryException

Specified by:

releasePrepareStatement in interface Protocol

Throws:

QueryException

forceReleasePrepareStatement

public void forceReleasePrepareStatement(int statementId)
                                  throws QueryException

Force release of prepare statement that are not used. This method will be call when adding a new preparestatement in cache, so the packet can be send to server without problem.

Specified by:

forceReleasePrepareStatement in interface Protocol

Parameters:

statementId - prepared statement Id to remove.

Throws:

QueryException - if connection exception.

cancelCurrentQuery

public void cancelCurrentQuery()
                        throws QueryException,
                               IOException

Cancels the current query - clones the current protocol and executes a query using the new connection.

Specified by:

cancelCurrentQuery in interface Protocol

Throws:

QueryException - never thrown

IOException - if Host is not responding

getMoreResults

public void getMoreResults(ExecutionResult executionResult)
                    throws QueryException

Specified by:

getMoreResults in interface Protocol

Specified by:

getMoreResults in class AbstractConnectProtocol

Throws:

QueryException

hasUnreadData

public boolean hasUnreadData()

Specified by:

hasUnreadData in interface Protocol

setInternalMaxRows

public void setInternalMaxRows(int max)

Set max row retuen by a statement.

Specified by:

setInternalMaxRows in interface Protocol

Parameters:

max - row number max value

getMaxRows

public int getMaxRows()

Specified by:

getMaxRows in interface Protocol

setMaxRows

public void setMaxRows(int max)
                throws QueryException

Specified by:

setMaxRows in interface Protocol

Throws:

QueryException

setLocalInfileInputStream

public void setLocalInfileInputStream(InputStream inputStream)

Specified by:

setLocalInfileInputStream in interface Protocol

getTimeout

public int getTimeout()
               throws SocketException

Returns the connection timeout in milliseconds.

Specified by:

getTimeout in interface Protocol

Returns:

the connection timeout in milliseconds.

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error.

setTimeout

public void setTimeout(int timeout)
                throws SocketException

Sets the connection timeout.

Specified by:

setTimeout in interface Protocol

Parameters:

timeout - the timeout, in milliseconds

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error.

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws QueryException

Set transaction isolation.

Specified by:

setTransactionIsolation in interface Protocol

Parameters:

level - transaction level.

Throws:

QueryException - if transaction level is unknown

getTransactionIsolationLevel

public int getTransactionIsolationLevel()

Specified by:

getTransactionIsolationLevel in interface Protocol

closeIfActiveResult

public void closeIfActiveResult()
                         throws SQLException

Close active result.

Specified by:

closeIfActiveResult in interface Protocol

Throws:

SQLException

prepareStatementCache

public PrepareStatementCache prepareStatementCache()

Specified by:

prepareStatementCache in interface Protocol