Class BasePrepareStatement
- java.lang.Object
-
- org.mariadb.jdbc.MariaDbStatement
-
- org.mariadb.jdbc.BasePrepareStatement
-
- All Implemented Interfaces:
AutoCloseable
,Cloneable
,PreparedStatement
,Statement
,Wrapper
- Direct Known Subclasses:
ClientSidePreparedStatement
,ServerSidePreparedStatement
public abstract class BasePrepareStatement extends MariaDbStatement implements PreparedStatement
-
-
Field Summary
Fields Modifier and Type Field Description protected int
autoGeneratedKeys
static DateTimeFormatter
SPEC_ISO_ZONED_DATE_TIME
The ISO-like date-time formatter that formats or parses a date-time with offset and zone, such as '2011-12-03T10:15:30+01:00[Europe/Paris]'.-
Fields inherited from class org.mariadb.jdbc.MariaDbStatement
canUseServerTimeout, closed, connection, exceptionFactory, executing, fetchSize, lock, maxRows, options, protocol, queryTimeout, results, resultSetConcurrency, resultSetScrollType
-
Fields inherited from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
-
-
Constructor Summary
Constructors Constructor Description BasePrepareStatement(MariaDbConnection connection, int resultSetScrollType, int resultSetConcurrency, int autoGeneratedKeys, ExceptionFactory exceptionFactory)
Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BasePrepareStatement
clone(MariaDbConnection connection)
Clone cached object.protected abstract boolean
executeInternal(int fetchSize)
long
executeLargeUpdate()
abstract ParameterMetaData
getParameterMetaData()
Retrieves the number, types and properties of thisPreparedStatement
object's parameters.void
setArray(int parameterIndex, Array array)
Sets the designated parameter to the givenjava.sql.Array
object.void
setAsciiStream(int parameterIndex, InputStream stream)
This function reads up the entire stream and stores it in memory since we need to know the length when sending it to the server use the corresponding method with a length parameter if memory is an issue
Sets the designated parameter to the given input stream.void
setAsciiStream(int parameterIndex, InputStream stream, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setAsciiStream(int parameterIndex, InputStream stream, long length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBigDecimal(int parameterIndex, BigDecimal bigDecimal)
Sets the designated parameter to the givenjava.math.BigDecimal
value.void
setBinaryStream(int parameterIndex, InputStream stream)
This function reads up the entire stream and stores it in memory since we need to know the length when sending it to the server
Sets the designated parameter to the given input stream.void
setBinaryStream(int parameterIndex, InputStream stream, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBinaryStream(int parameterIndex, InputStream stream, long length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBlob(int parameterIndex, InputStream inputStream)
Sets the designated parameter to aInputStream
object.void
setBlob(int parameterIndex, InputStream inputStream, long length)
Sets the designated parameter to aInputStream
object.void
setBlob(int parameterIndex, Blob blob)
Sets the designated parameter to the givenjava.sql.Blob
object.void
setBoolean(int parameterIndex, boolean value)
Sets the designated parameter to the given Javaboolean
value.void
setByte(int parameterIndex, byte bit)
Sets the designated parameter to the given Javabyte
value.void
setBytes(int parameterIndex, byte[] bytes)
Sets the designated parameter to the given Java array of bytes.void
setCharacterStream(int parameterIndex, Reader reader)
Sets the designated parameter to the givenReader
object.void
setCharacterStream(int parameterIndex, Reader reader, int length)
Sets the designated parameter to the givenReader
object, which is the given number of characters long.void
setCharacterStream(int parameterIndex, Reader reader, long length)
Sets the designated parameter to the givenReader
object, which is the given number of characters long.void
setClob(int parameterIndex, Reader reader)
Sets the designated parameter to aReader
object.void
setClob(int parameterIndex, Reader reader, long length)
Sets the designated parameter to aReader
object.void
setClob(int parameterIndex, Clob clob)
Sets the designated parameter to the givenjava.sql.Clob
object.void
setDate(int parameterIndex, Date date)
Sets the designated parameter to the givenjava.sql.Date
value using the default time zone of the virtual machine that is running the application.void
setDate(int parameterIndex, Date date, Calendar cal)
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object.void
setDouble(int parameterIndex, double value)
Sets the designated parameter to the given Javadouble
value.void
setFloat(int parameterIndex, float value)
Sets the designated parameter to the given Javafloat
value.void
setInt(int column, int value)
void
setLong(int parameterIndex, long value)
Sets the designated parameter to the given Javalong
value.void
setNCharacterStream(int parameterIndex, Reader value)
Sets the designated parameter to aReader
object.void
setNCharacterStream(int parameterIndex, Reader value, long length)
Sets the designated parameter to aReader
object.void
setNClob(int parameterIndex, Reader reader)
Sets the designated parameter to aReader
object.void
setNClob(int parameterIndex, Reader reader, long length)
Sets the designated parameter to aReader
object.void
setNClob(int parameterIndex, NClob value)
Sets the designated parameter to ajava.sql.NClob
object.void
setNString(int parameterIndex, String value)
Sets the designated parameter to the givenString
object.void
setNull(int parameterIndex, int sqlType)
Sets the designated parameter to SQLNULL
.void
setNull(int parameterIndex, int sqlType, String typeName)
Sets the designated parameter to SQLNULL
.void
setNull(int parameterIndex, ColumnType mariadbType)
Sets the designated parameter to SQLNULL
.void
setObject(int parameterIndex, Object obj)
Sets the value of the designated parameter using the given object.void
setObject(int parameterIndex, Object obj, int targetSqlType)
Sets the value of the designated parameter with the given object.void
setObject(int parameterIndex, Object obj, int targetSqlType, int scaleOrLength)
Sets the value of the designated parameter with the given object.void
setObject(int parameterIndex, Object obj, SQLType targetSqlType)
void
setObject(int parameterIndex, Object obj, SQLType targetSqlType, int scaleOrLength)
abstract void
setParameter(int parameterIndex, ParameterHolder holder)
void
setRef(int parameterIndex, Ref ref)
Sets the designated parameter to the givenREF(<structured-type>)
value.void
setRowId(int parameterIndex, RowId rowid)
Sets the designated parameter to the givenjava.sql.RowId
object.void
setShort(int parameterIndex, short value)
Sets the designated parameter to the given Javashort
value.void
setSQLXML(int parameterIndex, SQLXML xmlObject)
Sets the designated parameter to the givenjava.sql.SQLXML
object.void
setString(int parameterIndex, String str)
Set string parameter.void
setTime(int parameterIndex, Time time)
Sets the designated parameter to the givenjava.sql.Time
value.void
setTime(int parameterIndex, Time time, Calendar cal)
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object.void
setTimestamp(int parameterIndex, Timestamp timestamp)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setTimestamp(int parameterIndex, Timestamp timestamp, Calendar cal)
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object.void
setUnicodeStream(int parameterIndex, InputStream x, int length)
Deprecated.deprecatedvoid
setURL(int parameterIndex, URL url)
Sets the designated parameter to the givenjava.net.URL
value.-
Methods inherited from class org.mariadb.jdbc.MariaDbStatement
addBatch, cancel, checkClose, checkCloseOnCompletion, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatch, executeBatchEpilogue, executeBatchExceptionEpilogue, executeEpilogue, executeExceptionEpilogue, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeQueryPrologue, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getTimeoutSql, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, isWrapperFor, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setLocalInfileInputStream, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, setTimerTask, skipMoreResults, testExecute, unwrap
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData
-
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
-
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
-
-
-
Field Detail
-
SPEC_ISO_ZONED_DATE_TIME
public static final DateTimeFormatter SPEC_ISO_ZONED_DATE_TIME
The ISO-like date-time formatter that formats or parses a date-time with offset and zone, such as '2011-12-03T10:15:30+01:00[Europe/Paris]'. and without the 'T' time delimiterThis returns an immutable formatter capable of formatting and parsing a format that extends the ISO-8601 extended offset date-time format to add the time-zone.
-
autoGeneratedKeys
protected int autoGeneratedKeys
-
-
Constructor Detail
-
BasePrepareStatement
public BasePrepareStatement(MariaDbConnection connection, int resultSetScrollType, int resultSetConcurrency, int autoGeneratedKeys, ExceptionFactory exceptionFactory)
Constructor. Base class that permit setting parameters for client and server PrepareStatement.- Parameters:
connection
- current connectionresultSetScrollType
- one of the followingResultSet
constants:ResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- one of the followingResultSet
constants:ResultSet.CONCUR_READ_ONLY
orResultSet.CONCUR_UPDATABLE
autoGeneratedKeys
- a flag indicating whether auto-generated keys should be returned; one ofStatement.RETURN_GENERATED_KEYS
orStatement.NO_GENERATED_KEYS
exceptionFactory
- exception factory
-
-
Method Detail
-
clone
public BasePrepareStatement clone(MariaDbConnection connection) throws CloneNotSupportedException
Clone cached object.- Overrides:
clone
in classMariaDbStatement
- Parameters:
connection
- connection- Returns:
- BasePrepareStatement
- Throws:
CloneNotSupportedException
- if cloning exception
-
executeLargeUpdate
public long executeLargeUpdate() throws SQLException
- Specified by:
executeLargeUpdate
in interfacePreparedStatement
- Throws:
SQLException
-
executeInternal
protected abstract boolean executeInternal(int fetchSize) throws SQLException
- Throws:
SQLException
-
setCharacterStream
public void setCharacterStream(int parameterIndex, Reader reader, int length) throws SQLException
Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode datalength
- the number of characters in the stream- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setCharacterStream
public void setCharacterStream(int parameterIndex, Reader reader, long length) throws SQLException
Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode datalength
- the number of characters in the stream- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setCharacterStream
public void setCharacterStream(int parameterIndex, Reader reader) throws SQLException
Sets the designated parameter to the givenReader
object. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStream
which takes a length parameter.- Specified by:
setCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode data- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setRef
public void setRef(int parameterIndex, Ref ref) throws SQLException
Sets the designated parameter to the givenREF(<structured-type>)
value. The driver converts this to an SQLREF
value when it sends it to the database.- Specified by:
setRef
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...ref
- an SQLREF
value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBlob
public void setBlob(int parameterIndex, Blob blob) throws SQLException
Sets the designated parameter to the givenjava.sql.Blob
object. The driver converts this to an SQLBLOB
value when it sends it to the database.- Specified by:
setBlob
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...blob
- aBlob
object that maps an SQLBLOB
value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBlob
public void setBlob(int parameterIndex, InputStream inputStream, long length) throws SQLException
Sets the designated parameter to aInputStream
object. The inputstream must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY
or aBLOB
- Specified by:
setBlob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...inputStream
- An object that contains the data to set the parameter value to.length
- the number of bytes in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
; if the length specified is less than zero or if the number of bytes in the inputstream does not match the specfied length.
-
setBlob
public void setBlob(int parameterIndex, InputStream inputStream) throws SQLException
Sets the designated parameter to aInputStream
object. This method differs from thesetBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY
or aBLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlob
which takes a length parameter.- Specified by:
setBlob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...inputStream
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or if parameterIndex does not correspond to a parameter marker in the SQL statement,
-
setClob
public void setClob(int parameterIndex, Clob clob) throws SQLException
Sets the designated parameter to the givenjava.sql.Clob
object. The driver converts this to an SQLCLOB
value when it sends it to the database.- Specified by:
setClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...clob
- aClob
object that maps an SQLCLOB
value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setClob
public void setClob(int parameterIndex, Reader reader, long length) throws SQLException
Sets the designated parameter to aReader
object. The reader must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR
or aCLOB
- Specified by:
setClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or if the length specified is less than zero.
-
setClob
public void setClob(int parameterIndex, Reader reader) throws SQLException
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR
or aCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClob
which takes a length parameter.- Specified by:
setClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or if parameterIndex does not correspond to a parameter marker in the SQL statement
-
setArray
public void setArray(int parameterIndex, Array array) throws SQLException
Sets the designated parameter to the givenjava.sql.Array
object. The driver converts this to an SQLARRAY
value when it sends it to the database.- Specified by:
setArray
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...array
- anArray
object that maps an SQLARRAY
value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setDate
public void setDate(int parameterIndex, Date date, Calendar cal) throws SQLException
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLDATE
value, which the driver then sends to the database. With aCalendar
object, the driver can calculate the date taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDate
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...date
- the parameter valuecal
- theCalendar
object the driver will use to construct the date- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setDate
public void setDate(int parameterIndex, Date date) throws SQLException
Sets the designated parameter to the givenjava.sql.Date
value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATE
value when it sends it to the database.- Specified by:
setDate
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...date
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setTime
public void setTime(int parameterIndex, Time time, Calendar cal) throws SQLException
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIME
value, which the driver then sends to the database. With aCalendar
object, the driver can calculate the time taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTime
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...time
- the parameter valuecal
- theCalendar
object the driver will use to construct the time- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setTime
public void setTime(int parameterIndex, Time time) throws SQLException
Sets the designated parameter to the givenjava.sql.Time
value. the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTime
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...time
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setTimestamp
public void setTimestamp(int parameterIndex, Timestamp timestamp, Calendar cal) throws SQLException
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIMESTAMP
value, which the driver then sends to the database. With aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimestamp
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...timestamp
- the parameter valuecal
- theCalendar
object the driver will use to construct the timestamp- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setTimestamp
public void setTimestamp(int parameterIndex, Timestamp timestamp) throws SQLException
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLTIMESTAMP
value when it sends it to the database.- Specified by:
setTimestamp
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...timestamp
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setNull
public void setNull(int parameterIndex, int sqlType) throws SQLException
Sets the designated parameter to SQLNULL
.Note: You must specify the parameter's SQL type.
- Specified by:
setNull
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- the SQL type code defined injava.sql.Types
- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setNull
public void setNull(int parameterIndex, ColumnType mariadbType) throws SQLException
Sets the designated parameter to SQLNULL
.Note: You must specify the parameter's SQL type.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...mariadbType
- the type code defined inColumnType
- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setNull
public void setNull(int parameterIndex, int sqlType, String typeName) throws SQLException
Sets the designated parameter to SQLNULL
. This version of the methodsetNull
should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it.
Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
- Specified by:
setNull
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- a value fromjava.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setParameter
public abstract void setParameter(int parameterIndex, ParameterHolder holder) throws SQLException
- Throws:
SQLException
-
setURL
public void setURL(int parameterIndex, URL url) throws SQLException
Sets the designated parameter to the givenjava.net.URL
value. The driver converts this to an SQLDATALINK
value when it sends it to the database.- Specified by:
setURL
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...url
- thejava.net.URL
object to be set- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
getParameterMetaData
public abstract ParameterMetaData getParameterMetaData() throws SQLException
Retrieves the number, types and properties of thisPreparedStatement
object's parameters.- Specified by:
getParameterMetaData
in interfacePreparedStatement
- Returns:
- a
ParameterMetaData
object that contains information about the number, types and properties for each parameter marker of thisPreparedStatement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
- See Also:
ParameterMetaData
-
setRowId
public void setRowId(int parameterIndex, RowId rowid) throws SQLException
Sets the designated parameter to the givenjava.sql.RowId
object. The driver converts this to a SQLROWID
value when it sends it to the database- Specified by:
setRowId
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...rowid
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setNString
public void setNString(int parameterIndex, String value) throws SQLException
Sets the designated parameter to the givenString
object. The driver converts this to a SQLNCHAR
orNVARCHAR
orLONGNVARCHAR
value (depending on the argument's size relative to the driver's limits onNVARCHAR
values) when it sends it to the database.- Specified by:
setNString
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatement
-
setNCharacterStream
public void setNCharacterStream(int parameterIndex, Reader value, long length) throws SQLException
Sets the designated parameter to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Specified by:
setNCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter valuelength
- the number of characters in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatement
-
setNCharacterStream
public void setNCharacterStream(int parameterIndex, Reader value) throws SQLException
Sets the designated parameter to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStream
which takes a length parameter.- Specified by:
setNCharacterStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatement
-
setNClob
public void setNClob(int parameterIndex, NClob value) throws SQLException
Sets the designated parameter to ajava.sql.NClob
object. The driver converts this to a SQLNCLOB
value when it sends it to the database.- Specified by:
setNClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatement
-
setNClob
public void setNClob(int parameterIndex, Reader reader, long length) throws SQLException
Sets the designated parameter to aReader
object. The reader must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR
or aNCLOB
- Specified by:
setNClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatement
-
setNClob
public void setNClob(int parameterIndex, Reader reader) throws SQLException
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR
or aNCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClob
which takes a length parameter.- Specified by:
setNClob
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatement
-
setSQLXML
public void setSQLXML(int parameterIndex, SQLXML xmlObject) throws SQLException
Sets the designated parameter to the givenjava.sql.SQLXML
object. The driver converts this to an SQLXML
value when it sends it to the database.- Specified by:
setSQLXML
in interfacePreparedStatement
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...xmlObject
- aSQLXML
object that maps an SQLXML
value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or thejava.xml.transform.Result
,Writer
orOutputStream
has not been closed for theSQLXML
object
-
setObject
public void setObject(int parameterIndex, Object obj, int targetSqlType, int scaleOrLength) throws SQLException
Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.lang
equivalent objects should be used.If the second argument is an
InputStream
then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReader
then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLException
when the prepared statement is executed.The given Java object will be converted to the given targetSqlType before being sent to the database.
If the object has a custom mapping (is of a class implementing the interface
SQLData
), the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,NClob
,Struct
,java.net.URL
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database-specific abstract data types.
- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...obj
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scaleOrLength
- forjava.sql.Types.DECIMAL
orjava.sql.Types.NUMERIC types
, this is the number of digits after the decimal point. For Java Object typesInputStream
andReader
, this is the length of the data in the stream or reader. For all other types, this value will be ignored.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero- See Also:
Types
-
setObject
public void setObject(int parameterIndex, Object obj, int targetSqlType) throws SQLException
Sets the value of the designated parameter with the given object. This method is like the methodsetObject
above, except that it assumes a scale of zero.- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...obj
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
s- See Also:
Types
-
setObject
public void setObject(int parameterIndex, Object obj) throws SQLException
Sets the value of the designated parameter using the given object. The second parameter must be of typeObject
; therefore, thejava.lang
equivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Object
types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.- Specified by:
setObject
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...obj
- the object containing the input parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement
or the type of the given object is ambiguous
-
setObject
public void setObject(int parameterIndex, Object obj, SQLType targetSqlType, int scaleOrLength) throws SQLException
- Specified by:
setObject
in interfacePreparedStatement
- Throws:
SQLException
-
setObject
public void setObject(int parameterIndex, Object obj, SQLType targetSqlType) throws SQLException
- Specified by:
setObject
in interfacePreparedStatement
- Throws:
SQLException
-
setAsciiStream
public void setAsciiStream(int parameterIndex, InputStream stream, long length) throws SQLException
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setAsciiStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...stream
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setAsciiStream
public void setAsciiStream(int parameterIndex, InputStream stream) throws SQLException
This function reads up the entire stream and stores it in memory since we need to know the length when sending it to the server use the corresponding method with a length parameter if memory is an issue
Sets the designated parameter to the given input stream. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStream
which takes a length parameter.- Specified by:
setAsciiStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...stream
- the Java input stream that contains the ASCII parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setAsciiStream
public void setAsciiStream(int parameterIndex, InputStream stream, int length) throws SQLException
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setAsciiStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...stream
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBinaryStream
public void setBinaryStream(int parameterIndex, InputStream stream, long length) throws SQLException
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setBinaryStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...stream
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBinaryStream
public void setBinaryStream(int parameterIndex, InputStream stream) throws SQLException
This function reads up the entire stream and stores it in memory since we need to know the length when sending it to the server
Sets the designated parameter to the given input stream. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStream
which takes a length parameter.- Specified by:
setBinaryStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...stream
- the java input stream which contains the binary parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBinaryStream
public void setBinaryStream(int parameterIndex, InputStream stream, int length) throws SQLException
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setBinaryStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...stream
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBoolean
public void setBoolean(int parameterIndex, boolean value) throws SQLException
Sets the designated parameter to the given Javaboolean
value. The driver converts this to an SQLBIT
orBOOLEAN
value when it sends it to the database.- Specified by:
setBoolean
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setByte
public void setByte(int parameterIndex, byte bit) throws SQLException
Sets the designated parameter to the given Javabyte
value. The driver converts this to an SQLTINYINT
value when it sends it to the database.- Specified by:
setByte
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...bit
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setShort
public void setShort(int parameterIndex, short value) throws SQLException
Sets the designated parameter to the given Javashort
value. The driver converts this to an SQLSMALLINT
value when it sends it to the database.- Specified by:
setShort
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setString
public void setString(int parameterIndex, String str) throws SQLException
Set string parameter.- Specified by:
setString
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...str
- String- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBytes
public void setBytes(int parameterIndex, byte[] bytes) throws SQLException
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARY
orLONGVARBINARY
(depending on the argument's size relative to the driver's limits onVARBINARY
values) when it sends it to the database.- Specified by:
setBytes
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...bytes
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setUnicodeStream
public void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException
Deprecated.deprecatedSets the designated parameter to the given input stream, which will have the specified number of bytes.
When a very large Unicode value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from Unicode to the database char format.
The byte format of the Unicode stream must be a Java UTF-8, as defined in the Java Virtual Machine Specification.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setUnicodeStream
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- ajava.io.InputStream
object that contains the Unicode parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setInt
public void setInt(int column, int value) throws SQLException
- Specified by:
setInt
in interfacePreparedStatement
- Throws:
SQLException
-
setLong
public void setLong(int parameterIndex, long value) throws SQLException
Sets the designated parameter to the given Javalong
value. The driver converts this to an SQLBIGINT
value when it sends it to the database.- Specified by:
setLong
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setFloat
public void setFloat(int parameterIndex, float value) throws SQLException
Sets the designated parameter to the given Javafloat
value. The driver converts this to an SQLREAL
value when it sends it to the database.- Specified by:
setFloat
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setDouble
public void setDouble(int parameterIndex, double value) throws SQLException
Sets the designated parameter to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value when it sends it to the database.- Specified by:
setDouble
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBigDecimal
public void setBigDecimal(int parameterIndex, BigDecimal bigDecimal) throws SQLException
Sets the designated parameter to the givenjava.math.BigDecimal
value. The driver converts this to an SQLNUMERIC
value when it sends it to the database.- Specified by:
setBigDecimal
in interfacePreparedStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...bigDecimal
- the parameter value- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
-