MySQL Connector/J 9.2.0 · com.mysql.cj.NativeSession

Modifier and Type	Field and Description
private transient Timer	cancelTimer
private NativeMessageBuilder	commandBuilder
private Throwable	forceClosedReason Why was this session implicitly closed, if known?
private boolean	isClosed Has this session been closed?
private long	lastQueryFinishedTime When did the last query finish?
private CopyOnWriteArrayList<WeakReference<Session.SessionEventListener>>	listeners
private boolean	needsPing Does this connection need to be tested?
private String	queryComment The comment (if any) to prepend to all queries sent to the server (to show up in "SHOW PROCESSLIST")
private static final long	serialVersionUID
private static final String	SERVER_VERSION_STRING_VAR_NAME
private CacheAdapter<String, Map<String, String>>	serverConfigCache

Access	Constructor and Description
public	NativeSession(HostInfo hostInfo, PropertySet propSet)

Method Summary

Modifier and Type	Method and Description
public void	addListener(Session.SessionEventListener `SessionEventListener` instance. l) Overrides com.mysql.cj.CoreSession.addListener. Implements com.mysql.cj.Session.addListener. Add listener for this session status changes.
public void	checkClosed()
public void	clearInputStream()
public void	connect(HostInfo hi, String user, String password, String database, int loginTimeout, TransactionEventHandler transactionManager)
private void	createConfigCacheIfNeeded(Lock lock)
public void	disableMultiQueries()
public void	dumpPacketRingBuffer()
public void	enableMultiQueries()
public < extends `Resultset` T extends Resultset> T	Returns: a ResultSet holding the results execSQL(Query `Query` object callingQuery, String the SQL statement to be executed query, int rows limit maxRows, NativePacketPayload `NativePacketPayload` packet, boolean whether a stream result should be created streamResults, ProtocolEntityFactory<T, NativePacketPayload> `ProtocolEntityFactory` resultSetFactory, ColumnDefinition use this metadata instead of the one provided on wire cachedMetadata, boolean is it a batch query isBatch) Send a query to the server.
private String	findProcessHost(long threadId)
public void	forceClose() Overrides com.mysql.cj.CoreSession.forceClose. Implements com.mysql.cj.Session.forceClose. Clobbers the physical network connection and marks this session as closed.
public Timer	getCancelTimer()
public int	getCommandCount()
public long	getConnectionCreationTimeMillis()
public long	getCurrentTimeNanosOrMillis()
public Throwable	getForceClosedReason()
public String	getIdentifierQuoteString() Overrides com.mysql.cj.CoreSession.getIdentifierQuoteString. Implements com.mysql.cj.Session.getIdentifierQuoteString.
public long	getIdleFor()
public InputStream	getLocalInfileInputStream()
public NetworkResources	getNetworkResources()
public String	getProcessHost() Implements com.mysql.cj.Session.getProcessHost.
public NativeProtocol	getProtocol()
public String	getQueryComment() Overrides com.mysql.cj.CoreSession.getQueryComment. Implements com.mysql.cj.Session.getQueryComment. Returns the comment that will be prepended to all statements sent to the server.
public SocketAddress	getRemoteSocketAddress() Overrides com.mysql.cj.CoreSession.getRemoteSocketAddress. Implements com.mysql.cj.Session.getRemoteSocketAddress.
public int	getSessionMaxRows()
public NativePacketPayload	Returns: A packet to send data with getSharedSendPacket() Returns the packet used for sending data (used by PreparedStatement) with position set to 0.
public long	getSlowQueryThreshold()
public int	getSocketTimeout()
public boolean	hadWarnings()
public void	invokeCleanupListeners(Throwable whyCleanedUp)
protected void	invokeNormalCloseListeners()
public <T extends Resultset> T	invokeQueryInterceptorsPost(Supplier<String> sql, Query interceptedQuery, T originalResultSet, boolean forceExecute)
public <T extends Resultset> T	invokeQueryInterceptorsPre(Supplier<String> sql, Query interceptedQuery, boolean forceExecute)
protected void	invokeReconnectListeners()
public boolean	isClosed() Implements com.mysql.cj.Session.isClosed.
public boolean	isNeedsPing()
public boolean	isServerLocal(Session sess)
public boolean	isSetNeededForAutoCommitMode(boolean autoCommitFlag) Overrides com.mysql.cj.CoreSession.isSetNeededForAutoCommitMode. Implements com.mysql.cj.Session.isSetNeededForAutoCommitMode.
public boolean	isSSLEstablished() Overrides com.mysql.cj.CoreSession.isSSLEstablished. Implements com.mysql.cj.Session.isSSLEstablished.
public void	loadServerVariables(Lock synchronization lock lock, String driver version string version) Loads pertinent server variables so that the driver can configure itself.
public void	ping(boolean checkForClosedConnection, int timeoutMillis)
public String	Returns: server variable value queryServerVariable(String server variable name varName) Get the variable value from server.
public void	quit() Overrides com.mysql.cj.CoreSession.quit. Implements com.mysql.cj.Session.quit. Log-off of the MySQL server and close the socket.
public void	removeListener(Session.SessionEventListener `SessionEventListener` instance. listener) Overrides com.mysql.cj.CoreSession.removeListener. Implements com.mysql.cj.Session.removeListener. Remove session listener.
public void	resetSessionState()
public void	setConnectionCreationTimeMillis(long connectionCreationTimeMillis)
public void	setForceClosedReason(Throwable forceClosedReason)
public void	setLocalInfileInputStream(InputStream stream)
public void	setNeedsPing(boolean needsPing)
public void	setQueryComment(String query comment string comment) Overrides com.mysql.cj.CoreSession.setQueryComment. Implements com.mysql.cj.Session.setQueryComment. Sets the comment that will be prepended to all statements sent to the server.
public void	setQueryInterceptors(List<QueryInterceptor> queryInterceptors)
public void	setSessionMaxRows(int sessionMaxRows)
public void	setSessionVariables()
public void	setSocketTimeout(int milliseconds)
public boolean	shouldIntercept()
public void	shutdownServer() Used by MiniAdmin to shutdown a MySQL server

Inherited from com.mysql.cj.CoreSession:: changeUser getDataStoreMetadata getExceptionInterceptor getHostInfo getLog getMessageBuilder getProfilerEventHandler getPropertySet getQueryTimingUnits getServerSession getSessionLock getTelemetryHandler getThreadId setExceptionInterceptor setTelemetryHandler versionMeetsMinimum

cancelTimer	back to summary
private transient Timer cancelTimer

commandBuilder	back to summary
private NativeMessageBuilder commandBuilder

forceClosedReason	back to summary
private Throwable forceClosedReason Why was this session implicitly closed, if known? (for diagnostics)

isClosed	back to summary
private boolean isClosed Has this session been closed?

lastQueryFinishedTime	back to summary
private long lastQueryFinishedTime When did the last query finish?

listeners	back to summary
private CopyOnWriteArrayList<WeakReference<Session.SessionEventListener>> listeners

needsPing	back to summary
private boolean needsPing Does this connection need to be tested?

queryComment	back to summary
private String queryComment The comment (if any) to prepend to all queries sent to the server (to show up in "SHOW PROCESSLIST")

serialVersionUID	back to summary
private static final long serialVersionUID

SERVER_VERSION_STRING_VAR_NAME	back to summary
private static final String SERVER_VERSION_STRING_VAR_NAME

serverConfigCache	back to summary
private CacheAdapter<String, Map<String, String>> serverConfigCache

NativeSession	back to summary
public NativeSession(HostInfo hostInfo, PropertySet propSet)

Method Detail

addListener back to summary

addListener	back to summary
public void addListener(Session.SessionEventListener l) Overrides com.mysql.cj.CoreSession.addListener. Implements com.mysql.cj.Session.addListener. Doc from com.mysql.cj.Session.addListener. Add listener for this session status changes. Parameters l:Session.SessionEventListener `SessionEventListener` instance. Annotations @Override

public void addListener(Session.SessionEventListener l)

Overrides com.mysql.cj.CoreSession.addListener.

Implements com.mysql.cj.Session.addListener.

Doc from com.mysql.cj.Session.addListener.

Add listener for this session status changes.

Parameters

l:Session.SessionEventListener: SessionEventListener instance.

Annotations

@Override

checkClosed	back to summary
public void checkClosed()

clearInputStream	back to summary
public void clearInputStream()

connect	back to summary
public void connect(HostInfo hi, String user, String password, String database, int loginTimeout, TransactionEventHandler transactionManager) throws IOException

createConfigCacheIfNeeded	back to summary
private void createConfigCacheIfNeeded(Lock lock)

disableMultiQueries	back to summary
public void disableMultiQueries()

dumpPacketRingBuffer	back to summary
public void dumpPacketRingBuffer()

enableMultiQueries	back to summary
public void enableMultiQueries()

execSQL back to summary

execSQL	back to summary
public <T extends Resultset> T execSQL(Query callingQuery, String query, int maxRows, NativePacketPayload packet, boolean streamResults, ProtocolEntityFactory<T, NativePacketPayload> resultSetFactory, ColumnDefinition cachedMetadata, boolean isBatch) Send a query to the server. Returns one of the ResultSet objects. To ensure that Statement's queries are serialized, calls to this method should be enclosed in a connection locked block. Parameters <T> extends `Resultset` callingQuery:Query `Query` object query:String the SQL statement to be executed maxRows:int rows limit packet:NativePacketPayload `NativePacketPayload` streamResults:boolean whether a stream result should be created resultSetFactory:ProtocolEntityFactory<T, NativePacketPayload> `ProtocolEntityFactory` cachedMetadata:ColumnDefinition use this metadata instead of the one provided on wire isBatch:boolean is it a batch query Returns:T a ResultSet holding the results

public <T extends Resultset> T execSQL(Query callingQuery, String query, int maxRows, NativePacketPayload packet, boolean streamResults, ProtocolEntityFactory<T, NativePacketPayload> resultSetFactory, ColumnDefinition cachedMetadata, boolean isBatch)

Send a query to the server. Returns one of the ResultSet objects. To ensure that Statement's queries are serialized, calls to this method should be enclosed in a connection locked block.

Parameters

<T>: extends Resultset
callingQuery:Query: Query object
query:String: the SQL statement to be executed
maxRows:int: rows limit
packet:NativePacketPayload: NativePacketPayload
streamResults:boolean: whether a stream result should be created
resultSetFactory:ProtocolEntityFactory<T, NativePacketPayload>: ProtocolEntityFactory
cachedMetadata:ColumnDefinition: use this metadata instead of the one provided on wire
isBatch:boolean: is it a batch query

Returns:T

a ResultSet holding the results

findProcessHost	back to summary
private String findProcessHost(long threadId)

forceClose	back to summary
public void forceClose() Overrides com.mysql.cj.CoreSession.forceClose. Implements com.mysql.cj.Session.forceClose. Doc from com.mysql.cj.Session.forceClose. Clobbers the physical network connection and marks this session as closed. Annotations @Override

forceClose

back to summary

public void forceClose()

Overrides com.mysql.cj.CoreSession.forceClose.

Implements com.mysql.cj.Session.forceClose.

Doc from com.mysql.cj.Session.forceClose.

Clobbers the physical network connection and marks this session as closed.

Annotations

@Override

getCancelTimer	back to summary
public Timer getCancelTimer()

getCommandCount	back to summary
public int getCommandCount()

getConnectionCreationTimeMillis	back to summary
public long getConnectionCreationTimeMillis()

getCurrentTimeNanosOrMillis	back to summary
public long getCurrentTimeNanosOrMillis()

getForceClosedReason	back to summary
public Throwable getForceClosedReason()

getIdentifierQuoteString	back to summary
public String getIdentifierQuoteString() Overrides com.mysql.cj.CoreSession.getIdentifierQuoteString. Implements com.mysql.cj.Session.getIdentifierQuoteString. Annotations @Override

getIdentifierQuoteString

back to summary

public String getIdentifierQuoteString()

Overrides com.mysql.cj.CoreSession.getIdentifierQuoteString.

Implements com.mysql.cj.Session.getIdentifierQuoteString.

Annotations

@Override

getIdleFor	back to summary
public long getIdleFor()

getLocalInfileInputStream	back to summary
public InputStream getLocalInfileInputStream()

getNetworkResources	back to summary
public NetworkResources getNetworkResources()

getProcessHost	back to summary
public String getProcessHost() Implements com.mysql.cj.Session.getProcessHost. Annotations @Override

getProcessHost

back to summary

public String getProcessHost()

Implements com.mysql.cj.Session.getProcessHost.

Annotations

@Override

getProtocol	back to summary
public NativeProtocol getProtocol()

getQueryComment	back to summary
public String getQueryComment() Overrides com.mysql.cj.CoreSession.getQueryComment. Implements com.mysql.cj.Session.getQueryComment. Doc from com.mysql.cj.Session.getQueryComment. Returns the comment that will be prepended to all statements sent to the server. Returns:String query comment string Annotations @Override

getQueryComment

back to summary

public String getQueryComment()

Overrides com.mysql.cj.CoreSession.getQueryComment.

Implements com.mysql.cj.Session.getQueryComment.

Doc from com.mysql.cj.Session.getQueryComment.

Returns the comment that will be prepended to all statements sent to the server.

Returns:String

query comment string

Annotations

@Override

getRemoteSocketAddress	back to summary
public SocketAddress getRemoteSocketAddress() Overrides com.mysql.cj.CoreSession.getRemoteSocketAddress. Implements com.mysql.cj.Session.getRemoteSocketAddress. Annotations @Override

getRemoteSocketAddress

back to summary

public SocketAddress getRemoteSocketAddress()

Overrides com.mysql.cj.CoreSession.getRemoteSocketAddress.

Implements com.mysql.cj.Session.getRemoteSocketAddress.

Annotations

@Override

getSessionMaxRows	back to summary
public int getSessionMaxRows()

getSharedSendPacket	back to summary
public NativePacketPayload getSharedSendPacket() Returns the packet used for sending data (used by PreparedStatement) with position set to 0. Returns:NativePacketPayload A packet to send data with

getSharedSendPacket

back to summary

public NativePacketPayload getSharedSendPacket()

Returns the packet used for sending data (used by PreparedStatement) with position set to 0.

Returns:NativePacketPayload: A packet to send data with

getSlowQueryThreshold	back to summary
public long getSlowQueryThreshold()

getSocketTimeout	back to summary
public int getSocketTimeout()

hadWarnings	back to summary
public boolean hadWarnings()

invokeCleanupListeners	back to summary
public void invokeCleanupListeners(Throwable whyCleanedUp)

invokeNormalCloseListeners	back to summary
protected void invokeNormalCloseListeners()

invokeQueryInterceptorsPost	back to summary
public <T extends Resultset> T invokeQueryInterceptorsPost(Supplier<String> sql, Query interceptedQuery, T originalResultSet, boolean forceExecute)

invokeQueryInterceptorsPre	back to summary
public <T extends Resultset> T invokeQueryInterceptorsPre(Supplier<String> sql, Query interceptedQuery, boolean forceExecute)

invokeReconnectListeners	back to summary
protected void invokeReconnectListeners()

isClosed	back to summary
public boolean isClosed() Implements com.mysql.cj.Session.isClosed. Annotations @Override

isClosed

back to summary

public boolean isClosed()

Implements com.mysql.cj.Session.isClosed.

Annotations

@Override

isNeedsPing	back to summary
public boolean isNeedsPing()

isServerLocal	back to summary
public boolean isServerLocal(Session sess)

isSetNeededForAutoCommitMode

back to summary

public boolean isSetNeededForAutoCommitMode(boolean autoCommitFlag)

Overrides com.mysql.cj.CoreSession.isSetNeededForAutoCommitMode.

Implements com.mysql.cj.Session.isSetNeededForAutoCommitMode.

Annotations

@Override

isSSLEstablished

back to summary

public boolean isSSLEstablished()

Overrides com.mysql.cj.CoreSession.isSSLEstablished.

Implements com.mysql.cj.Session.isSSLEstablished.

Annotations

@Override

loadServerVariables

back to summary

public void loadServerVariables(Lock lock, String version)

Loads pertinent server variables so that the driver can configure itself.

Parameters

lock:Lock: synchronization lock
version:String: driver version string

ping	back to summary
public void ping(boolean checkForClosedConnection, int timeoutMillis)

queryServerVariable

back to summary

public String queryServerVariable(String varName)

Get the variable value from server.

Parameters

varName:String: server variable name

Returns:String

server variable value

quit

back to summary

public void quit()

Overrides com.mysql.cj.CoreSession.quit.

Implements com.mysql.cj.Session.quit.

Doc from com.mysql.cj.Session.quit.

Log-off of the MySQL server and close the socket.

Annotations

@Override

removeListener back to summary

public void removeListener(Session.SessionEventListener listener)

Overrides com.mysql.cj.CoreSession.removeListener.

Implements com.mysql.cj.Session.removeListener.

Doc from com.mysql.cj.Session.removeListener.

Remove session listener.

Parameters

listener:Session.SessionEventListener: SessionEventListener instance.

Annotations

@Override

resetSessionState	back to summary
public void resetSessionState()

setConnectionCreationTimeMillis	back to summary
public void setConnectionCreationTimeMillis(long connectionCreationTimeMillis)

setForceClosedReason	back to summary
public void setForceClosedReason(Throwable forceClosedReason)

setLocalInfileInputStream	back to summary
public void setLocalInfileInputStream(InputStream stream)

setNeedsPing	back to summary
public void setNeedsPing(boolean needsPing)

setQueryComment

back to summary

public void setQueryComment(String comment)

Overrides com.mysql.cj.CoreSession.setQueryComment.

Implements com.mysql.cj.Session.setQueryComment.

Doc from com.mysql.cj.Session.setQueryComment.

Sets the comment that will be prepended to all statements sent to the server. Do not use slash-star or star-slash tokens in the comment as these will be added by the driver itself.

Parameters

comment:String: query comment string

Annotations

@Override

setQueryInterceptors	back to summary
public void setQueryInterceptors(List<QueryInterceptor> queryInterceptors)

setSessionMaxRows	back to summary
public void setSessionMaxRows(int sessionMaxRows)

setSessionVariables	back to summary
public void setSessionVariables()

setSocketTimeout	back to summary
public void setSocketTimeout(int milliseconds)

shouldIntercept	back to summary
public boolean shouldIntercept()

shutdownServer	back to summary
public void shutdownServer() Used by MiniAdmin to shutdown a MySQL server

public Class NativeSession

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail