com.mysql.cj.protocol.a.result

Class BinaryBufferRow

java.lang.Object

com.mysql.cj.protocol.result.AbstractResultsetRow

com.mysql.cj.protocol.a.result.AbstractBufferRow

com.mysql.cj.protocol.a.result.BinaryBufferRow

All Implemented Interfaces:

ProtocolEntity, ResultsetRow, Row

public class BinaryBufferRow
extends AbstractBufferRow

A BufferRow implementation that holds one row packet from a server-side prepared statement (which is re-used by the driver, and thus saves memory allocations), and tries when possible to avoid allocations to break out the results as individual byte[]s. Rows from a server-side prepared statement are encoded differently, so we have different ways of finding where each column is, and unpacking them. (this isn't possible when doing things like reading floating point values).

Field Summary

Fields

Modifier and Type	Field and Description
private boolean[]	isNull If binary-encoded, the NULL status of each column is at the beginning of the row, so we
private int	preNullBitmaskHomePosition The home position before the is-null bitmask for server-side prepared statement result sets

Fields inherited from class com.mysql.cj.protocol.a.result.AbstractBufferRow

homePosition, lastRequestedIndex, lastRequestedPos, rowFromServer

Fields inherited from class com.mysql.cj.protocol.result.AbstractResultsetRow

exceptionInterceptor, metadata, valueDecoder, wasNull

Constructor Summary

Constructors

Constructor and Description
BinaryBufferRow(NativePacketPayload buf, ColumnDefinition cd, ExceptionInterceptor exceptionInterceptor, ValueDecoder valueDecoder)

Method Summary

Modifier and Type	Method and Description
protected int	findAndSeekToOffset(int index)
byte[]	getBytes(int index) Returns the value at the given column as a byte array.
boolean	getNull(int columnIndex) Check whether a column is NULL and update the 'wasNull' status.
<T> T	getValue(int columnIndex, ValueFactory<T> vf) Implementation of getValue() based on the underlying Buffer object.
boolean	isBinaryEncoded()
void	setBytes(int columnIndex, byte[] value) Sets the given byte array as a raw column value (only works currently with ByteArrayRow).
Row	setMetadata(ColumnDefinition f) Set metadata to enable getValue functionality.
private void	setupIsNullBitmask() Unpacks the bitmask at the head of the row packet that tells us what columns hold null values, and sets the "home" position directly after the bitmask.

Methods inherited from class com.mysql.cj.protocol.result.AbstractResultsetRow

getValueFromBytes, wasNull

Methods inherited from class java.lang.Object

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

Field Detail

preNullBitmaskHomePosition

private int preNullBitmaskHomePosition

The home position before the is-null bitmask for server-side prepared statement result sets

isNull

private boolean[] isNull

If binary-encoded, the NULL status of each column is at the beginning of the row, so we

Constructor Detail

BinaryBufferRow

public BinaryBufferRow(NativePacketPayload buf,
                       ColumnDefinition cd,
                       ExceptionInterceptor exceptionInterceptor,
                       ValueDecoder valueDecoder)

Method Detail

isBinaryEncoded

public boolean isBinaryEncoded()

findAndSeekToOffset

protected int findAndSeekToOffset(int index)

Specified by:

findAndSeekToOffset in class AbstractBufferRow

getBytes

public byte[] getBytes(int index)

Description copied from interface: Row

Returns the value at the given column as a byte array. The bytes represent the raw values returned by the server.

Parameters:

index - index of column (starting at 0) to return from.

Returns:

the value for the given column; if the value is SQL NULL, the value returned is null

getNull

public boolean getNull(int columnIndex)

Check whether a column is NULL and update the 'wasNull' status.

Parameters:

columnIndex - of the column value (starting at 0) to check.

Returns:

true if the column value is NULL, false if not.

setMetadata

public Row setMetadata(ColumnDefinition f)

Description copied from interface: Row

Set metadata to enable getValue functionality.

Specified by:

setMetadata in interface Row

Overrides:

setMetadata in class AbstractResultsetRow

Parameters:

f - ColumnDefinition

Returns:

Row

setupIsNullBitmask

private void setupIsNullBitmask()

Unpacks the bitmask at the head of the row packet that tells us what columns hold null values, and sets the "home" position directly after the bitmask.

getValue

public <T> T getValue(int columnIndex,
                      ValueFactory<T> vf)

Implementation of getValue() based on the underlying Buffer object. Delegate to superclass for decoding.

Type Parameters:

T - type to decode to

Parameters:

columnIndex - index of column to retrieve value from (0-indexed, not JDBC 1-indexed)

vf - value factory used to create the return value after decoding

Returns:

The return value from the value factory

setBytes

public void setBytes(int columnIndex,
                     byte[] value)

Description copied from interface: Row

Sets the given byte array as a raw column value (only works currently with ByteArrayRow).

Parameters:

columnIndex - index of the column (starting at 0) to set to.

value - the (raw) value to set