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

Modifier and Type	Field and Description
private Function<Session, BindValue>	bindValueConstructor
private BindValue[]	bindValues Bind values for individual fields
private ColumnDefinition	columnDefinition
private static final Map<Class<?>, MysqlType>	DEFAULT_MYSQL_TYPES
private boolean	isLoadDataQuery Is this query a LOAD DATA query?
private boolean	longParameterSwitchDetected Flag indicating whether or not the long parameters have been 'switched' back to normal parameters.
private int	numberOfExecutions
private AtomicBoolean	sendTypesToServer Do we need to send/resend types to the server?
private Session	session

Access	Constructor and Description
public	NativeQueryBindings(int parameterCount, Session sess, Function<Session, BindValue> bindValueConstructor)

Method Summary

Modifier and Type	Method and Description
public void	checkAllParametersSet() Implements com.mysql.cj.QueryBindings.checkAllParametersSet.
public void	checkParameterSet(int columnIndex) Implements com.mysql.cj.QueryBindings.checkParameterSet.
public boolean	clearBindValues() Implements com.mysql.cj.QueryBindings.clearBindValues.
public QueryBindings	clone() Overrides java.lang.Object.clone. Implements com.mysql.cj.QueryBindings.clone. Creates and returns a copy of this object.
public BindValue	Returns: BindValue getBinding(int 0-based parameterIndex, boolean is this for a stream? forLongData) Implements com.mysql.cj.QueryBindings.getBinding. Returns the structure representing the value that (can be)/(is) bound at the given parameter index.
public BindValue[]	getBindValues() Implements com.mysql.cj.QueryBindings.getBindValues.
public byte[]	getBytesRepresentation(int parameterIndex) Implements com.mysql.cj.QueryBindings.getBytesRepresentation.
public int	getNumberOfExecutions() Implements com.mysql.cj.QueryBindings.getNumberOfExecutions.
public AtomicBoolean	getSendTypesToServer() Implements com.mysql.cj.QueryBindings.getSendTypesToServer.
public boolean	isLongParameterSwitchDetected() Implements com.mysql.cj.QueryBindings.isLongParameterSwitchDetected.
public boolean	isNull(int parameterIndex) Implements com.mysql.cj.QueryBindings.isNull.
public void	setAsciiStream(int parameterIndex, InputStream x, int length) Implements com.mysql.cj.QueryBindings.setAsciiStream.
public void	setBigDecimal(int parameterIndex, BigDecimal x) Implements com.mysql.cj.QueryBindings.setBigDecimal.
public void	setBigInteger(int parameterIndex, BigInteger x) Implements com.mysql.cj.QueryBindings.setBigInteger.
public void	setBinaryStream(int parameterIndex, InputStream x, int length) Implements com.mysql.cj.QueryBindings.setBinaryStream.
public void	setBindValues(BindValue[] bindValues) Implements com.mysql.cj.QueryBindings.setBindValues.
public void	setBlob(int parameterIndex, Blob x) Implements com.mysql.cj.QueryBindings.setBlob.
public void	setBoolean(int parameterIndex, boolean x) Implements com.mysql.cj.QueryBindings.setBoolean.
public void	setByte(int parameterIndex, byte x) Implements com.mysql.cj.QueryBindings.setByte.
public void	setBytes(int parameterIndex, byte[] x, boolean escapeIfNeeded) Implements com.mysql.cj.QueryBindings.setBytes.
public void	setCharacterStream(int parameterIndex, Reader reader, int length) Implements com.mysql.cj.QueryBindings.setCharacterStream.
public void	setClob(int parameterIndex, Clob x) Implements com.mysql.cj.QueryBindings.setClob.
public void	setColumnDefinition(ColumnDefinition colDef) Implements com.mysql.cj.QueryBindings.setColumnDefinition.
public void	setDate(int parameterIndex, Date x, Calendar cal) Implements com.mysql.cj.QueryBindings.setDate.
public void	setDouble(int parameterIndex, double x) Implements com.mysql.cj.QueryBindings.setDouble.
public void	setFloat(int parameterIndex, float x) Implements com.mysql.cj.QueryBindings.setFloat.
public void	setFromBindValue(int parameterIndex, BindValue bv) Implements com.mysql.cj.QueryBindings.setFromBindValue.
public void	setInt(int parameterIndex, int x) Implements com.mysql.cj.QueryBindings.setInt.
public void	setLong(int parameterIndex, long x) Implements com.mysql.cj.QueryBindings.setLong.
public void	setLongParameterSwitchDetected(boolean longParameterSwitchDetected) Implements com.mysql.cj.QueryBindings.setLongParameterSwitchDetected.
public void	setNCharacterStream(int parameterIndex, Reader reader, long length) Implements com.mysql.cj.QueryBindings.setNCharacterStream.
public void	setNClob(int parameterIndex, NClob value) Implements com.mysql.cj.QueryBindings.setNClob.
public void	setNString(int parameterIndex, String x) Implements com.mysql.cj.QueryBindings.setNString.
public void	setNull(int parameterIndex) Implements com.mysql.cj.QueryBindings.setNull.
public void	setNumberOfExecutions(int numberOfExecutions) Implements com.mysql.cj.QueryBindings.setNumberOfExecutions.
public void	setObject(int parameterIndex, Object parameterObj) Implements com.mysql.cj.QueryBindings.setObject.
public void	setObject(int the first parameter is 1... parameterIndex, Object the object containing the input parameter value parameterObj, MysqlType The MysqlType to be send to the database targetMysqlType, int For Types.DECIMAL or Types.NUMERIC types this is the number of digits after the decimal. For all other types this value will be ignored. scaleOrLength) Implements com.mysql.cj.QueryBindings.setObject. Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.
protected final void	setSerializableObject(int parameter index parameterIndex, Object value parameterObj) Sets the value for the placeholder as a serialized Java object (used by various forms of setObject()
public void	setShort(int parameterIndex, short x) Implements com.mysql.cj.QueryBindings.setShort.
public void	setString(int parameterIndex, String x) Implements com.mysql.cj.QueryBindings.setString.
public void	setTime(int parameterIndex, Time x, Calendar cal) Implements com.mysql.cj.QueryBindings.setTime.
public void	setTimestamp(int parameterIndex, Timestamp x, Calendar targetCalendar, Field field, MysqlType targetMysqlType) Implements com.mysql.cj.QueryBindings.setTimestamp.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

bindValueConstructor	back to summary
private Function<Session, BindValue> bindValueConstructor

bindValues	back to summary
private BindValue[] bindValues Bind values for individual fields

columnDefinition	back to summary
private ColumnDefinition columnDefinition

DEFAULT_MYSQL_TYPES	back to summary
private static final Map<Class<?>, MysqlType> DEFAULT_MYSQL_TYPES

isLoadDataQuery	back to summary
private boolean isLoadDataQuery Is this query a LOAD DATA query?

longParameterSwitchDetected	back to summary
private boolean longParameterSwitchDetected Flag indicating whether or not the long parameters have been 'switched' back to normal parameters. We cannot execute() if clearParameters() has not been called in this case.

numberOfExecutions	back to summary
private int numberOfExecutions

sendTypesToServer	back to summary
private AtomicBoolean sendTypesToServer Do we need to send/resend types to the server?

session	back to summary
private Session session

NativeQueryBindings	back to summary
public NativeQueryBindings(int parameterCount, Session sess, Function<Session, BindValue> bindValueConstructor)

Method Detail

checkAllParametersSet	back to summary
public void checkAllParametersSet() Implements com.mysql.cj.QueryBindings.checkAllParametersSet. Annotations @Override

checkAllParametersSet

back to summary

public void checkAllParametersSet()

Implements com.mysql.cj.QueryBindings.checkAllParametersSet.

Annotations

@Override

checkParameterSet	back to summary
public void checkParameterSet(int columnIndex) Implements com.mysql.cj.QueryBindings.checkParameterSet. Annotations @Override

checkParameterSet

back to summary

public void checkParameterSet(int columnIndex)

Implements com.mysql.cj.QueryBindings.checkParameterSet.

Annotations

@Override

clearBindValues	back to summary
public boolean clearBindValues() Implements com.mysql.cj.QueryBindings.clearBindValues. Returns:boolean Doc from com.mysql.cj.QueryBindings.clearBindValues. true if bind values had long data Annotations @Override

clearBindValues

back to summary

public boolean clearBindValues()

Implements com.mysql.cj.QueryBindings.clearBindValues.

Returns:boolean

Doc from com.mysql.cj.QueryBindings.clearBindValues.

true if bind values had long data

Annotations

@Override

clone back to summary

clone	back to summary
public QueryBindings clone() Overrides java.lang.Object.clone. Implements com.mysql.cj.QueryBindings.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:QueryBindings a clone of this instance. Annotations @Override

public QueryBindings clone()

Overrides java.lang.Object.clone.

Implements com.mysql.cj.QueryBindings.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:QueryBindings

a clone of this instance.

Annotations

@Override

getBinding	back to summary
public BindValue getBinding(int parameterIndex, boolean forLongData) Implements com.mysql.cj.QueryBindings.getBinding. Returns the structure representing the value that (can be)/(is) bound at the given parameter index. Parameters parameterIndex:int 0-based forLongData:boolean is this for a stream? Returns:BindValue BindValue Annotations @Override

getBinding

back to summary

public BindValue getBinding(int parameterIndex, boolean forLongData)

Implements com.mysql.cj.QueryBindings.getBinding.

Returns the structure representing the value that (can be)/(is) bound at the given parameter index.

Parameters

parameterIndex:int: 0-based
forLongData:boolean: is this for a stream?

Returns:BindValue

BindValue

Annotations

@Override

getBindValues	back to summary
public BindValue[] getBindValues() Implements com.mysql.cj.QueryBindings.getBindValues. Annotations @Override

getBindValues

back to summary

public BindValue[] getBindValues()

Implements com.mysql.cj.QueryBindings.getBindValues.

Annotations

@Override

getBytesRepresentation	back to summary
public byte[] getBytesRepresentation(int parameterIndex) Implements com.mysql.cj.QueryBindings.getBytesRepresentation. Annotations @Override

getBytesRepresentation

back to summary

public byte[] getBytesRepresentation(int parameterIndex)

Implements com.mysql.cj.QueryBindings.getBytesRepresentation.

Annotations

@Override

getNumberOfExecutions	back to summary
public int getNumberOfExecutions() Implements com.mysql.cj.QueryBindings.getNumberOfExecutions. Annotations @Override

getNumberOfExecutions

back to summary

public int getNumberOfExecutions()

Implements com.mysql.cj.QueryBindings.getNumberOfExecutions.

Annotations

@Override

getSendTypesToServer	back to summary
public AtomicBoolean getSendTypesToServer() Implements com.mysql.cj.QueryBindings.getSendTypesToServer. Annotations @Override

getSendTypesToServer

back to summary

public AtomicBoolean getSendTypesToServer()

Implements com.mysql.cj.QueryBindings.getSendTypesToServer.

Annotations

@Override

isLongParameterSwitchDetected	back to summary
public boolean isLongParameterSwitchDetected() Implements com.mysql.cj.QueryBindings.isLongParameterSwitchDetected. Annotations @Override

isLongParameterSwitchDetected

back to summary

public boolean isLongParameterSwitchDetected()

Implements com.mysql.cj.QueryBindings.isLongParameterSwitchDetected.

Annotations

@Override

isNull	back to summary
public boolean isNull(int parameterIndex) Implements com.mysql.cj.QueryBindings.isNull. Annotations @Override

isNull

back to summary

public boolean isNull(int parameterIndex)

Implements com.mysql.cj.QueryBindings.isNull.

Annotations

@Override

setAsciiStream	back to summary
public void setAsciiStream(int parameterIndex, InputStream x, int length) Implements com.mysql.cj.QueryBindings.setAsciiStream. Annotations @Override

setAsciiStream

back to summary

public void setAsciiStream(int parameterIndex, InputStream x, int length)

Implements com.mysql.cj.QueryBindings.setAsciiStream.

Annotations

@Override

setBigDecimal	back to summary
public void setBigDecimal(int parameterIndex, BigDecimal x) Implements com.mysql.cj.QueryBindings.setBigDecimal. Annotations @Override

setBigDecimal

back to summary

public void setBigDecimal(int parameterIndex, BigDecimal x)

Implements com.mysql.cj.QueryBindings.setBigDecimal.

Annotations

@Override

setBigInteger	back to summary
public void setBigInteger(int parameterIndex, BigInteger x) Implements com.mysql.cj.QueryBindings.setBigInteger. Annotations @Override

setBigInteger

back to summary

public void setBigInteger(int parameterIndex, BigInteger x)

Implements com.mysql.cj.QueryBindings.setBigInteger.

Annotations

@Override

setBinaryStream	back to summary
public void setBinaryStream(int parameterIndex, InputStream x, int length) Implements com.mysql.cj.QueryBindings.setBinaryStream. Annotations @Override

setBinaryStream

back to summary

public void setBinaryStream(int parameterIndex, InputStream x, int length)

Implements com.mysql.cj.QueryBindings.setBinaryStream.

Annotations

@Override

setBindValues	back to summary
public void setBindValues(BindValue[] bindValues) Implements com.mysql.cj.QueryBindings.setBindValues. Annotations @Override

setBindValues

back to summary

public void setBindValues(BindValue[] bindValues)

Implements com.mysql.cj.QueryBindings.setBindValues.

Annotations

@Override

setBlob	back to summary
public void setBlob(int parameterIndex, Blob x) Implements com.mysql.cj.QueryBindings.setBlob. Annotations @Override

setBlob

back to summary

public void setBlob(int parameterIndex, Blob x)

Implements com.mysql.cj.QueryBindings.setBlob.

Annotations

@Override

setBoolean	back to summary
public void setBoolean(int parameterIndex, boolean x) Implements com.mysql.cj.QueryBindings.setBoolean. Annotations @Override

setBoolean

back to summary

public void setBoolean(int parameterIndex, boolean x)

Implements com.mysql.cj.QueryBindings.setBoolean.

Annotations

@Override

setByte	back to summary
public void setByte(int parameterIndex, byte x) Implements com.mysql.cj.QueryBindings.setByte. Annotations @Override

setByte

back to summary

public void setByte(int parameterIndex, byte x)

Implements com.mysql.cj.QueryBindings.setByte.

Annotations

@Override

setBytes	back to summary
public void setBytes(int parameterIndex, byte[] x, boolean escapeIfNeeded) Implements com.mysql.cj.QueryBindings.setBytes. Annotations @Override

setBytes

back to summary

public void setBytes(int parameterIndex, byte[] x, boolean escapeIfNeeded)

Implements com.mysql.cj.QueryBindings.setBytes.

Annotations

@Override

setCharacterStream	back to summary
public void setCharacterStream(int parameterIndex, Reader reader, int length) Implements com.mysql.cj.QueryBindings.setCharacterStream. Annotations @Override

setCharacterStream

back to summary

public void setCharacterStream(int parameterIndex, Reader reader, int length)

Implements com.mysql.cj.QueryBindings.setCharacterStream.

Annotations

@Override

setClob	back to summary
public void setClob(int parameterIndex, Clob x) Implements com.mysql.cj.QueryBindings.setClob. Annotations @Override

setClob

back to summary

public void setClob(int parameterIndex, Clob x)

Implements com.mysql.cj.QueryBindings.setClob.

Annotations

@Override

setColumnDefinition	back to summary
public void setColumnDefinition(ColumnDefinition colDef) Implements com.mysql.cj.QueryBindings.setColumnDefinition. Annotations @Override

setColumnDefinition

back to summary

public void setColumnDefinition(ColumnDefinition colDef)

Implements com.mysql.cj.QueryBindings.setColumnDefinition.

Annotations

@Override

setDate	back to summary
public void setDate(int parameterIndex, Date x, Calendar cal) Implements com.mysql.cj.QueryBindings.setDate. Annotations @Override

setDouble	back to summary
public void setDouble(int parameterIndex, double x) Implements com.mysql.cj.QueryBindings.setDouble. Annotations @Override

setDouble

back to summary

public void setDouble(int parameterIndex, double x)

Implements com.mysql.cj.QueryBindings.setDouble.

Annotations

@Override

setFloat	back to summary
public void setFloat(int parameterIndex, float x) Implements com.mysql.cj.QueryBindings.setFloat. Annotations @Override

setFloat

back to summary

public void setFloat(int parameterIndex, float x)

Implements com.mysql.cj.QueryBindings.setFloat.

Annotations

@Override

setFromBindValue	back to summary
public void setFromBindValue(int parameterIndex, BindValue bv) Implements com.mysql.cj.QueryBindings.setFromBindValue. Annotations @Override

setFromBindValue

back to summary

public void setFromBindValue(int parameterIndex, BindValue bv)

Implements com.mysql.cj.QueryBindings.setFromBindValue.

Annotations

@Override

setInt	back to summary
public void setInt(int parameterIndex, int x) Implements com.mysql.cj.QueryBindings.setInt. Annotations @Override

setInt

back to summary

public void setInt(int parameterIndex, int x)

Implements com.mysql.cj.QueryBindings.setInt.

Annotations

@Override

setLong	back to summary
public void setLong(int parameterIndex, long x) Implements com.mysql.cj.QueryBindings.setLong. Annotations @Override

setLong

back to summary

public void setLong(int parameterIndex, long x)

Implements com.mysql.cj.QueryBindings.setLong.

Annotations

@Override

setLongParameterSwitchDetected	back to summary
public void setLongParameterSwitchDetected(boolean longParameterSwitchDetected) Implements com.mysql.cj.QueryBindings.setLongParameterSwitchDetected. Annotations @Override

setLongParameterSwitchDetected

back to summary

public void setLongParameterSwitchDetected(boolean longParameterSwitchDetected)

Implements com.mysql.cj.QueryBindings.setLongParameterSwitchDetected.

Annotations

@Override

setNCharacterStream	back to summary
public void setNCharacterStream(int parameterIndex, Reader reader, long length) Implements com.mysql.cj.QueryBindings.setNCharacterStream. Annotations @Override

setNCharacterStream

back to summary

public void setNCharacterStream(int parameterIndex, Reader reader, long length)

Implements com.mysql.cj.QueryBindings.setNCharacterStream.

Annotations

@Override

setNClob	back to summary
public void setNClob(int parameterIndex, NClob value) Implements com.mysql.cj.QueryBindings.setNClob. Annotations @Override

setNClob

back to summary

public void setNClob(int parameterIndex, NClob value)

Implements com.mysql.cj.QueryBindings.setNClob.

Annotations

@Override

setNString	back to summary
public void setNString(int parameterIndex, String x) Implements com.mysql.cj.QueryBindings.setNString. Annotations @Override

setNString

back to summary

public void setNString(int parameterIndex, String x)

Implements com.mysql.cj.QueryBindings.setNString.

Annotations

@Override

setNull	back to summary
public void setNull(int parameterIndex) Implements com.mysql.cj.QueryBindings.setNull. Annotations @Override

setNull

back to summary

public void setNull(int parameterIndex)

Implements com.mysql.cj.QueryBindings.setNull.

Annotations

@Override

setNumberOfExecutions	back to summary
public void setNumberOfExecutions(int numberOfExecutions) Implements com.mysql.cj.QueryBindings.setNumberOfExecutions. Annotations @Override

setNumberOfExecutions

back to summary

public void setNumberOfExecutions(int numberOfExecutions)

Implements com.mysql.cj.QueryBindings.setNumberOfExecutions.

Annotations

@Override

setObject	back to summary
public void setObject(int parameterIndex, Object parameterObj) Implements com.mysql.cj.QueryBindings.setObject. Annotations @Override

setObject

back to summary

public void setObject(int parameterIndex, Object parameterObj)

Implements com.mysql.cj.QueryBindings.setObject.

Annotations

@Override

setObject	back to summary
public void setObject(int parameterIndex, Object parameterObj, MysqlType targetMysqlType, int scaleOrLength) Implements com.mysql.cj.QueryBindings.setObject. Set the value of a parameter using an object; use the java.lang equivalent objects for integral values. The given Java object will be converted to the targetMysqlType before being sent to the database. Parameters parameterIndex:int the first parameter is 1... parameterObj:Object the object containing the input parameter value targetMysqlType:MysqlType The MysqlType to be send to the database scaleOrLength:int For Types.DECIMAL or Types.NUMERIC types this is the number of digits after the decimal. For all other types this value will be ignored. Annotations @Override

setObject

back to summary

public void setObject(int parameterIndex, Object parameterObj, MysqlType targetMysqlType, int scaleOrLength)

Implements com.mysql.cj.QueryBindings.setObject.

Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.

The given Java object will be converted to the targetMysqlType before being sent to the database.

Parameters

parameterIndex:int: the first parameter is 1...
parameterObj:Object: the object containing the input parameter value
targetMysqlType:MysqlType: The MysqlType to be send to the database
scaleOrLength:int: For Types.DECIMAL or Types.NUMERIC types this is the number of digits after the decimal. For all other types this value will be ignored.

Annotations