com.mysql.cj

Class AbstractQuery

java.lang.Object

com.mysql.cj.AbstractQuery

All Implemented Interfaces:

Query

Direct Known Subclasses:

ClientPreparedQuery, SimpleQuery

public abstract class AbstractQuery
extends java.lang.Object
implements Query

Nested Class Summary

Nested classes/interfaces inherited from interface com.mysql.cj.Query

Query.CancelStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.Object>	batchedArgs Holds batched commands
protected java.lang.Object	cancelTimeoutMutex Mutex to prevent race between returning query results and noticing that query has been timed-out or cancelled.
protected java.lang.String	charEncoding The character encoding to use (if available)
protected boolean	clearWarningsCalled Has clearWarnings() been called?
protected java.lang.String	currentDb The database in use
protected int	fetchSize The number of rows to fetch at a time (currently ignored)
protected RuntimeProperty<java.lang.Integer>	maxAllowedPacket
protected QueryAttributesBindings	queryAttributesBindings Query attributes bindings
protected Resultset.Type	resultSetType The type of this result set (scroll sensitive or in-sensitive)
NativeSession	session
protected java.util.concurrent.atomic.AtomicBoolean	statementExecuting Currently executing a statement?
protected int	statementId Used to identify this statement when profiling.
protected int	timeoutInMillis The timeout for a query

Constructor Summary

Constructors

Constructor and Description
AbstractQuery(NativeSession sess)

Method Summary

Modifier and Type	Method and Description
void	addBatch(java.lang.Object batch)
void	checkCancelTimeout()
void	clearBatchedArgs()
void	closeQuery()
java.util.List<java.lang.Object>	getBatchedArgs() Get the batched args as added by the addBatch method(s).
java.lang.Object	getCancelTimeoutMutex()
java.lang.String	getCurrentDatabase()
long	getExecuteTime() Returns the elapsed time for the server to execute the query.
int	getId() Returns the query id used when profiling
QueryAttributesBindings	getQueryAttributesBindings()
int	getResultFetchSize()
<T extends Resultset,M extends Message> ProtocolEntityFactory<T,M>	getResultSetFactory()
Resultset.Type	getResultType()
NativeSession	getSession()
java.util.concurrent.atomic.AtomicBoolean	getStatementExecuting()
int	getTimeoutInMillis()
boolean	isClearWarningsCalled()
void	resetCancelledState()
void	setCancelStatus(Query.CancelStatus cs)
void	setClearWarningsCalled(boolean clearWarningsCalled)
void	setCurrentDatabase(java.lang.String currentDb)
void	setExecuteTime(long executeTime)
void	setResultFetchSize(int fetchSize)
void	setResultType(Resultset.Type resultSetType)
void	setTimeoutInMillis(int timeoutInMillis)
CancelQueryTask	startQueryTimer(Query stmtToCancel, int timeout)
void	statementBegins()
void	stopQueryTimer(CancelQueryTask timeoutTask, boolean rethrowCancelReason, boolean checkCancelTimeout)

Methods inherited from class java.lang.Object

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

Field Detail

session

public NativeSession session

statementId

protected int statementId

Used to identify this statement when profiling.

maxAllowedPacket

protected RuntimeProperty<java.lang.Integer> maxAllowedPacket

charEncoding

protected java.lang.String charEncoding

The character encoding to use (if available)

cancelTimeoutMutex

protected java.lang.Object cancelTimeoutMutex

Mutex to prevent race between returning query results and noticing that query has been timed-out or cancelled.

timeoutInMillis

protected int timeoutInMillis

The timeout for a query

batchedArgs

protected java.util.List<java.lang.Object> batchedArgs

Holds batched commands

resultSetType

protected Resultset.Type resultSetType

The type of this result set (scroll sensitive or in-sensitive)

fetchSize

protected int fetchSize

The number of rows to fetch at a time (currently ignored)

statementExecuting

protected final java.util.concurrent.atomic.AtomicBoolean statementExecuting

Currently executing a statement?

currentDb

protected java.lang.String currentDb

The database in use

clearWarningsCalled

protected boolean clearWarningsCalled

Has clearWarnings() been called?

queryAttributesBindings

protected QueryAttributesBindings queryAttributesBindings

Query attributes bindings

Constructor Detail

AbstractQuery

public AbstractQuery(NativeSession sess)

Method Detail

getId

public int getId()

Description copied from interface: Query

Returns the query id used when profiling

Specified by:

getId in interface Query

Returns:

id

setCancelStatus

public void setCancelStatus(Query.CancelStatus cs)

Specified by:

setCancelStatus in interface Query

getExecuteTime

public long getExecuteTime()

Description copied from interface: Query

Returns the elapsed time for the server to execute the query.

Specified by:

getExecuteTime in interface Query

Returns:

the time it took for the server to execute the query.

setExecuteTime

public void setExecuteTime(long executeTime)

Specified by:

setExecuteTime in interface Query

checkCancelTimeout

public void checkCancelTimeout()

Specified by:

checkCancelTimeout in interface Query

resetCancelledState

public void resetCancelledState()

Specified by:

resetCancelledState in interface Query

getResultSetFactory

public <T extends Resultset,M extends Message> ProtocolEntityFactory<T,M> getResultSetFactory()

Specified by:

getResultSetFactory in interface Query

getSession

public NativeSession getSession()

Specified by:

getSession in interface Query

getCancelTimeoutMutex

public java.lang.Object getCancelTimeoutMutex()

Specified by:

getCancelTimeoutMutex in interface Query

closeQuery

public void closeQuery()

Specified by:

closeQuery in interface Query

addBatch

public void addBatch(java.lang.Object batch)

Specified by:

addBatch in interface Query

getBatchedArgs

public java.util.List<java.lang.Object> getBatchedArgs()

Description copied from interface: Query

Get the batched args as added by the addBatch method(s). The list is unmodifiable and might contain any combination of String, ClientPreparedQueryBindings, or ServerPreparedQueryBindings depending on how the parameters were batched.

Specified by:

getBatchedArgs in interface Query

Returns:

an unmodifiable List of batched args

clearBatchedArgs

public void clearBatchedArgs()

Specified by:

clearBatchedArgs in interface Query

getQueryAttributesBindings

public QueryAttributesBindings getQueryAttributesBindings()

Specified by:

getQueryAttributesBindings in interface Query

getResultFetchSize

public int getResultFetchSize()

Specified by:

getResultFetchSize in interface Query

setResultFetchSize

public void setResultFetchSize(int fetchSize)

Specified by:

setResultFetchSize in interface Query

getResultType

public Resultset.Type getResultType()

Specified by:

getResultType in interface Query

setResultType

public void setResultType(Resultset.Type resultSetType)

Specified by:

setResultType in interface Query

getTimeoutInMillis

public int getTimeoutInMillis()

Specified by:

getTimeoutInMillis in interface Query

setTimeoutInMillis

public void setTimeoutInMillis(int timeoutInMillis)

Specified by:

setTimeoutInMillis in interface Query

startQueryTimer

public CancelQueryTask startQueryTimer(Query stmtToCancel,
                                       int timeout)

Specified by:

startQueryTimer in interface Query

stopQueryTimer

public void stopQueryTimer(CancelQueryTask timeoutTask,
                           boolean rethrowCancelReason,
                           boolean checkCancelTimeout)

Specified by:

stopQueryTimer in interface Query

getStatementExecuting

public java.util.concurrent.atomic.AtomicBoolean getStatementExecuting()

Specified by:

getStatementExecuting in interface Query

getCurrentDatabase

public java.lang.String getCurrentDatabase()

Specified by:

getCurrentDatabase in interface Query

setCurrentDatabase

public void setCurrentDatabase(java.lang.String currentDb)

Specified by:

setCurrentDatabase in interface Query

isClearWarningsCalled

public boolean isClearWarningsCalled()

Specified by:

isClearWarningsCalled in interface Query

setClearWarningsCalled

public void setClearWarningsCalled(boolean clearWarningsCalled)

Specified by:

setClearWarningsCalled in interface Query

statementBegins

public void statementBegins()

Specified by:

statementBegins in interface Query