MySQL Connector/J 9.2.0 · com.mysql.cj.protocol.a.NativeProtocol

Modifier and Type	Field and Description
private boolean	autoGenerateTestcaseScript
private int	commandCount
protected static final int	COMP_HEADER_LENGTH
protected CompressedPacketSender	compressedPacketSender Track this to manually shut down.
pack-priv static Map<Class<?>, Supplier<ValueEncoder>>	DEFAULT_ENCODERS
private static final String	EXPLAINABLE_STATEMENT
private static final String[]	EXPLAINABLE_STATEMENT_EXTENSION
protected boolean	hadWarnings
protected static final int	INITIAL_PACKET_SIZE
private SoftReference<NativePacketPayload>	loadFileBufRef Packet used for 'LOAD DATA LOCAL INFILE' We use a SoftReference, so that we don't penalize intermittent use of this feature
private InputStream	localInfileInputStream
private boolean	logSlowQueries
private RuntimeProperty<Boolean>	maintainTimeStats
protected static final int	MAX_QUERY_SIZE_TO_EXPLAIN
private RuntimeProperty<Integer>	maxAllowedPacket
private RuntimeProperty<Integer>	maxQuerySizeToLog
private BaseMetricsHolder	metricsHolder
private NativeMessageBuilder	nativeMessageBuilder
protected MessageReader<NativePacketHeader, NativePacketPayload>	packetReader
protected MessageSender<NativePacketPayload>	packetSender
protected byte	packetSequence
private boolean	profileSQL
protected Map<Class<? extends ProtocolEntity>, ProtocolEntityReader<? extends ProtocolEntity, ? extends Message>>	PROTOCOL_ENTITY_CLASS_TO_BINARY_READER
protected Map<Class<? extends ProtocolEntity>, ProtocolEntityReader<? extends ProtocolEntity, ? extends Message>>	PROTOCOL_ENTITY_CLASS_TO_TEXT_READER
private List<QueryInterceptor>	queryInterceptors
protected NativePacketPayload	reusablePacket Use this when reading in rows to avoid thousands of new() calls, because the byte arrays just get copied out of the packet anyway
protected NativeServerSession	serverSession
protected NativePacketPayload	sharedSendPacket
private long	slowQueryThreshold
protected static final int	SSL_REQUEST_LENGTH
private int	statementExecutionDepth
private ResultsetRows	streamingData
private boolean	useAutoSlowLog
protected boolean	useCompression
private RuntimeProperty<Boolean>	useServerPrepStmts
private int	warningCount

Access	Constructor and Description
public	NativeProtocol(Log logger)

Method Summary

Modifier and Type	Method and Description
public void	afterHandshake() Implements com.mysql.cj.protocol.Protocol.afterHandshake.
private int	alignPacketSize(int a, int l)
private void	appendDeadlockStatusInformation(Session sess, String xOpen, StringBuilder errorBuf)
private StringBuilder	appendResultSetSlashGStyle(StringBuilder appendTo, Resultset rs)
public void	applyPacketDecorators(MessageSender<NativePacketPayload> `MessageSender` sender, MessageReader<NativePacketHeader, NativePacketPayload> `MessageReader` messageReader) Apply optional decorators to configured PacketSender and PacketReader.
public void	beforeHandshake() Implements com.mysql.cj.protocol.Protocol.beforeHandshake.
private void	calculateSlowQueryThreshold()
public void	changeDatabase(String database) Implements com.mysql.cj.protocol.Protocol.changeDatabase.
public void	changeUser(String user name user, String password password, String database name database) Implements com.mysql.cj.protocol.Protocol.changeUser. Re-authenticates as the given user and password
public NativePacketPayload	checkErrorMessage() Implements com.mysql.cj.protocol.Protocol.checkErrorMessage. Read one message from the MySQL server, checks for errors in it, and if none, returns the message, ready for reading
private NativePacketPayload	Returns: NativePacketPayload checkErrorMessage(int the command being issued (if used) command) Checks for errors in the reply packet, and if none, returns the reply packet, ready for reading
public void	checkErrorMessage(NativePacketPayload resultPacket)
private void	checkForOutstandingStreamingData()
public void	checkTransactionState()
public void	clearInputStream()
public void	close() Implements com.mysql.cj.protocol.Protocol.close.
public void	configureTimeZone() Implements com.mysql.cj.protocol.Protocol.configureTimeZone. Configures the client's timezone if required.
public void	connect(String DB user name user, String DB user password password, String database name database) Implements com.mysql.cj.protocol.Protocol.connect. Create a new session.
public SQLWarning	Returns: the SQLWarning chain (or null if no warnings) convertShowWarningsToSQLWarnings(boolean if this method should only scan for data truncation warnings forTruncationOnly) Turns output of 'SHOW WARNINGS' into JDBC SQLWarning instances.
public void	dumpPacketRingBuffer()
public void	explainSlowQuery(String full query string query, String query string truncated for profiling truncatedQuery) Runs an 'EXPLAIN' on the given query and dumps the results to the log
public static MysqlType	findMysqlType(PropertySet propertySet, int mysqlTypeId, short colFlag, long length, LazyString tableName, LazyString originalTableName, int collationIndex, String encoding)
public StringBuilder	generateQueryCommentBlock(StringBuilder buf)
public int	getCommandCount()
public long	getCurrentTimeNanosOrMillis()
private BufferedInputStream	getFileStream(String fileName)
public static NativeProtocol	getInstance(Session session, SocketConnection socketConnection, PropertySet propertySet, Log log, TransactionEventHandler transactionManager)
public InputStream	getLocalInfileInputStream() Implements com.mysql.cj.protocol.Protocol.getLocalInfileInputStream. Returns the InputStream instance that will be used to send data in response to a "LOAD DATA LOCAL INFILE" statement.
public MessageBuilder<NativePacketPayload>	getMessageBuilder() Overrides com.mysql.cj.protocol.AbstractProtocol.getMessageBuilder. Implements com.mysql.cj.protocol.Protocol.getMessageBuilder.
public BaseMetricsHolder	getMetricsHolder()
private NativeMessageBuilder	getNativeMessageBuilder()
public MessageReader<NativePacketHeader, NativePacketPayload>	getPacketReader()
public MessageSender<NativePacketPayload>	getPacketSender()
public List<QueryInterceptor>	getQueryInterceptors()
public NativePacketPayload	getReusablePacket()
public NativeServerSession	getServerSession() Implements com.mysql.cj.protocol.Protocol.getServerSession.
public Session	getSession()
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 ResultsetRows	getStreamingData()
public Supplier<ValueEncoder>	getValueEncoderSupplier(Object obj) Implements com.mysql.cj.protocol.Protocol.getValueEncoderSupplier.
public int	getWarningCount()
public boolean	hadWarnings()
public void	handlePropertyChange(RuntimeProperty<?> prop) Implements com.mysql.cj.conf.RuntimeProperty.RuntimePropertyListener.handlePropertyChange.
public void	init(Session `Session` sess, SocketConnection `SocketConnection` phConnection, PropertySet `PropertySet` propSet, TransactionEventHandler `TransactionEventHandler` trManager) Overrides com.mysql.cj.protocol.AbstractProtocol.init. Implements com.mysql.cj.protocol.Protocol.init. Init method takes the place of constructor.
public void	initServerSession() Implements com.mysql.cj.protocol.Protocol.initServerSession.
public <T extends Resultset> T	invokeQueryInterceptorsPost(Supplier<String> sql, Query interceptedQuery, T originalResultSet, boolean forceExecute)
public < extends `Message` M extends Message> M	Returns: T instance invokeQueryInterceptorsPost(M `NativePacketPayload` containing query queryPacket, M `NativePacketPayload` containing response originalResponsePacket, boolean currently ignored forceExecute)
public <T extends Resultset> T	invokeQueryInterceptorsPre(Supplier<String> sql, Query interceptedQuery, boolean forceExecute)
public < extends `Message` M extends Message> M	Returns: M instance invokeQueryInterceptorsPre(M `NativePacketPayload` containing query queryPacket, boolean currently ignored forceExecute)
protected boolean	isDataAvailable()
public void	negotiateSSLConnection() Implements com.mysql.cj.protocol.Protocol.negotiateSSLConnection. Negotiates the SSL communication channel used when connecting to a MySQL server that has SSL enabled.
public final NativePacketPayload	probeMessage(NativePacketPayload reuse)
public final void	quit() Log-off of the MySQL server and close the socket.
public <T extends ProtocolEntity> T	read(Class<T> requiredClass, ProtocolEntityFactory<T, NativePacketPayload> protocolEntityFactory) Implements com.mysql.cj.protocol.Protocol.read.
public <T extends ProtocolEntity> T	read(Class<Resultset> required Resultset class requiredClass, int the maximum number of rows to read (-1 means all rows) maxRows, boolean should the driver leave the results on the wire, and read them only when needed? streamResults, NativePacketPayload the first packet of information in the result set resultPacket, boolean true if the binary protocol is used (for server prepared statements) isBinaryEncoded, ColumnDefinition use this metadata instead of the one provided on wire metadata, ProtocolEntityFactory<T, NativePacketPayload> `ProtocolEntityFactory` instance protocolEntityFactory) Implements com.mysql.cj.protocol.Protocol.read. Read protocol entity.
public <T extends Resultset> T	readAllResults(int maxRows, boolean streamResults, NativePacketPayload resultPacket, boolean isBinaryEncoded, ColumnDefinition metadata, ProtocolEntityFactory<T, NativePacketPayload> resultSetFactory)
public final NativePacketPayload	readMessage(NativePacketPayload `Message` instance to read into, may be null reuse) Implements com.mysql.cj.protocol.Protocol.readMessage. Read one message from the MySQL server into the reusable buffer if provided or into the new one.
public ColumnDefinition	readMetadata() Implements com.mysql.cj.protocol.Protocol.readMetadata.
public < extends `ProtocolEntity` T extends ProtocolEntity> T	Returns: T instance readNextResultset(T T instance currentProtocolEntity, int rows limit maxRows, boolean whether a stream result should be created streamResults, boolean true for binary protocol isBinaryEncoded, ProtocolEntityFactory<T, NativePacketPayload> `ProtocolEntityFactory` resultSetFactory) Read next result set from multi-result chain.
public <T extends QueryResult> T	readQueryResult(ResultBuilder<T> `ResultBuilder` instance resultBuilder) Implements com.mysql.cj.protocol.Protocol.readQueryResult. Read messages from server and deliver them to resultBuilder.
public NativeCapabilities	readServerCapabilities() Implements com.mysql.cj.protocol.Protocol.readServerCapabilities. Retrieve ServerCapabilities from server.
public final <T> T	readServerStatusForResultSets(NativePacketPayload rowPacket, boolean saveOldStatus)
public void	reclaimLargeReusablePacket() Don't hold on to overly-large packets
private void	reclaimLargeSharedSendPacket()
public void	rejectProtocol(NativePacketPayload msg)
public void	releaseResources()
public void	scanForAndThrowDataTruncation()
public final void	send(Message `Message` packet, int length of header + payload packetLen) Implements com.mysql.cj.protocol.Protocol.send.
public final NativePacketPayload	sendCommand(Message a packet pre-loaded with data for the protocol (eg. from a client-side prepared statement). The first byte of this packet is the MySQL protocol 'command' from MysqlDefs queryPacket, boolean do not call checkErrorPacket() if true skipCheck, int timeout timeoutMillis) Implements com.mysql.cj.protocol.Protocol.sendCommand. Send a command to the MySQL server.
public final NativePacketPayload	Returns: NativePacketPayload sendFileToServer(String the file name to send. fileName) Reads and sends a file to the server for LOAD DATA LOCAL INFILE
public final < extends `Resultset` T extends Resultset> T	Returns: T instance sendQueryPacket(Query `Query` callingQuery, NativePacketPayload `NativePacketPayload` containing query queryPacket, int rows limit maxRows, boolean whether a stream result should be created streamResults, ColumnDefinition use this metadata instead of the one provided on wire cachedMetadata, ProtocolEntityFactory<T, NativePacketPayload> `ProtocolEntityFactory` resultSetFactory) Send a query stored in a packet to the server.
public void	setHadWarnings(boolean hadWarnings)
public void	setLocalInfileInputStream(InputStream input stream stream) Implements com.mysql.cj.protocol.Protocol.setLocalInfileInputStream. Sets an InputStream instance that will be used to send data to the MySQL server for a "LOAD DATA LOCAL INFILE" statement rather than a FileInputStream or URLInputStream that represents the path given as an argument to the statement.
public void	setQueryInterceptors(List<QueryInterceptor> queryInterceptors)
public void	setSocketTimeout(int milliseconds)
public void	setStreamingData(ResultsetRows streamingData)
public void	setWarningCount(int warningCount)
public final void	skipPacket() Reads and discards a single MySQL packet.
public void	unsetStreamingData(ResultsetRows streamer)
protected boolean	useNanosForElapsedTime()
public boolean	versionMeetsMinimum(int major, int minor, int subminor) Implements com.mysql.cj.protocol.Protocol.versionMeetsMinimum.

Inherited from com.mysql.cj.protocol.AbstractProtocol:: addListener getAuthenticationProvider getExceptionInterceptor getPacketReceivedTimeHolder getPacketSentTimeHolder getPropertySet getQueryTimingUnits getSocketConnection invokeListeners removeListener reset setPacketReceivedTimeHolder setPacketSentTimeHolder setPropertySet

public Class NativeProtocol

Field Summary

Constructor Summary

Method Summary