Interface ISQLServerCallableStatement
-
- All Superinterfaces:
java.lang.AutoCloseable
,java.sql.CallableStatement
,ISQLServerPreparedStatement
,ISQLServerStatement
,java.sql.PreparedStatement
,java.io.Serializable
,java.sql.Statement
,java.sql.Wrapper
- All Known Implementing Classes:
SQLServerCallableStatement
public interface ISQLServerCallableStatement extends java.sql.CallableStatement, ISQLServerPreparedStatement
Provides an interface to theSQLServerCallableStatement
class.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.io.InputStream
getAsciiStream(int parameterIndex)
Returns the value of the designated column in the current row of thisResultSet
object as a stream of ASCII characters.java.io.InputStream
getAsciiStream(java.lang.String parameterName)
Returns the value of the designated column in the current row of thisResultSet
object as a stream of ASCII characters.java.math.BigDecimal
getBigDecimal(java.lang.String parameterName, int scale)
Deprecated.java.io.InputStream
getBinaryStream(int parameterIndex)
Returns the value of the designated column in the current row of thisResultSet
object as a stream of uninterpreted bytes.java.io.InputStream
getBinaryStream(java.lang.String parameterName)
Returns the value of the designated column in the current row of thisResultSet
object as a stream of uninterpretedbyte
s.java.sql.Timestamp
getDateTime(int index)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.java.sql.Timestamp
getDateTime(int index, java.util.Calendar cal)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.java.sql.Timestamp
getDateTime(java.lang.String parameterName)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.java.sql.Timestamp
getDateTime(java.lang.String name, java.util.Calendar cal)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.DateTimeOffset
getDateTimeOffset(int parameterIndex)
Returns the DateTimeOffset value of parameter with index parameterIndex.DateTimeOffset
getDateTimeOffset(java.lang.String parameterName)
Returns the DateTimeOffset value of parameter with name parameterName.java.math.BigDecimal
getMoney(int parameterIndex)
Returns the value of the column specified as a java.math.BigDecimal object.java.math.BigDecimal
getMoney(java.lang.String parameterName)
Returns the value of the column specified as a java.math.BigDecimal object.java.sql.Timestamp
getSmallDateTime(int index)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.java.sql.Timestamp
getSmallDateTime(int index, java.util.Calendar cal)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.java.sql.Timestamp
getSmallDateTime(java.lang.String parameterName)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.java.sql.Timestamp
getSmallDateTime(java.lang.String name, java.util.Calendar cal)
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.java.math.BigDecimal
getSmallMoney(int parameterIndex)
Returns the value of the column specified as a java.math.BigDecimal object.java.math.BigDecimal
getSmallMoney(java.lang.String parameterName)
Returns the value of the column specified as a java.math.BigDecimal object.void
registerOutParameter(int parameterIndex, int sqlType, int precision, int scale)
Registers the parameter in ordinal position index to be of JDBC type sqlType.void
registerOutParameter(int parameterIndex, java.sql.SQLType sqlType, int precision, int scale)
Registers the parameter in ordinal position index to be of JDBC type sqlType.void
registerOutParameter(java.lang.String parameterName, int sqlType, int precision, int scale)
Registers the parameter in ordinal position index to be of JDBC type sqlType.void
registerOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType, int precision, int scale)
Registers the parameter in ordinal position index to be of JDBC type sqlType.void
setBigDecimal(java.lang.String parameterName, java.math.BigDecimal value, int precision, int scale)
Sets the designated parameter to the givenjava.math.BigDecimal
value.void
setBigDecimal(java.lang.String parameterName, java.math.BigDecimal value, int precision, int scale, boolean forceEncrypt)
Sets the designated parameter to the givenjava.math.BigDecimal
value.void
setBoolean(java.lang.String parameterName, boolean value, boolean forceEncrypt)
Sets the designated parameter to the given Javaboolean
value.void
setByte(java.lang.String parameterName, byte value, boolean forceEncrypt)
Sets the designated parameter to the given Javabyte
value.void
setBytes(java.lang.String parameterName, byte[] value, boolean forceEncrypt)
Sets the designated parameter to the given Java array of bytes.void
setDate(java.lang.String parameterName, java.sql.Date value, java.util.Calendar calendar, boolean forceEncrypt)
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object.void
setDateTime(java.lang.String parameterName, java.sql.Timestamp value)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setDateTime(java.lang.String parameterName, java.sql.Timestamp value, boolean forceEncrypt)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setDateTimeOffset(java.lang.String parameterName, DateTimeOffset value)
Sets parameter parameterName to DateTimeOffset value.void
setDateTimeOffset(java.lang.String parameterName, DateTimeOffset value, int scale)
Sets parameter parameterName to DateTimeOffset value.void
setDateTimeOffset(java.lang.String parameterName, DateTimeOffset value, int scale, boolean forceEncrypt)
Sets parameter parameterName to DateTimeOffset value.void
setDouble(java.lang.String parameterName, double value, boolean forceEncrypt)
Sets the designated parameter to the given Javadouble
value.void
setFloat(java.lang.String parameterName, float value, boolean forceEncrypt)
Sets the designated parameter to the given Javafloat
value.void
setInt(java.lang.String parameterName, int value, boolean forceEncrypt)
Sets the designated parameter to the given Javaint
value.void
setLong(java.lang.String parameterName, long value, boolean forceEncrypt)
Sets the designated parameter to the given Javalong
value.void
setMoney(java.lang.String parameterName, java.math.BigDecimal value)
Sets the designated parameter to the given Javajava.math.BigDecimal
value.void
setMoney(java.lang.String parameterName, java.math.BigDecimal value, boolean forceEncrypt)
Sets the designated parameter to the given Javajava.math.BigDecimal
value.void
setNString(java.lang.String parameterName, java.lang.String value, boolean forceEncrypt)
Sets the designated parameter to the givenString
object.void
setObject(java.lang.String parameterName, java.lang.Object value, int sqlType, int decimals, boolean forceEncrypt)
Sets the value of the designated parameter with the given object.void
setObject(java.lang.String parameterName, java.lang.Object value, int targetSqlType, java.lang.Integer precision, int scale)
Sets the value of the designated parameter with the given object.void
setObject(java.lang.String parameterName, java.lang.Object value, java.sql.SQLType jdbcType, int scale, boolean forceEncrypt)
Sets the value of the designated parameter with the given object.void
setShort(java.lang.String parameterName, short value, boolean forceEncrypt)
Sets the designated parameter to the given Javashort
value.void
setSmallDateTime(java.lang.String parameterName, java.sql.Timestamp value)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setSmallDateTime(java.lang.String parameterName, java.sql.Timestamp value, boolean forceEncrypt)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setSmallMoney(java.lang.String parameterName, java.math.BigDecimal value)
Sets the designated parameter to the given Javajava.math.BigDecimal
value.void
setSmallMoney(java.lang.String parameterName, java.math.BigDecimal value, boolean forceEncrypt)
Sets the designated parameter to the given Javajava.math.BigDecimal
value.void
setString(java.lang.String parameterName, java.lang.String value, boolean forceEncrypt)
Sets the designated parameter to the given JavaString
value.void
setStructured(java.lang.String parameterName, java.lang.String tvpName, ISQLServerDataRecord tvpDataRecord)
Populates a table valued parameter passed to a stored procedure with an ISQLServerDataRecord object.void
setStructured(java.lang.String parameterName, java.lang.String tvpName, SQLServerDataTable tvpDataTable)
Populates a table valued parameter passed to a stored procedure with a data table.void
setStructured(java.lang.String parameterName, java.lang.String tvpName, java.sql.ResultSet tvpResultSet)
Populates a table valued parameter passed to a stored procedure with a ResultSet retrieved from another tablevoid
setTime(java.lang.String parameterName, java.sql.Time value, int scale)
Sets the designated parameter to the givenjava.sql.Time
value.void
setTime(java.lang.String parameterName, java.sql.Time value, int scale, boolean forceEncrypt)
Sets the designated parameter to the givenjava.sql.Time
value.void
setTime(java.lang.String parameterName, java.sql.Time value, java.util.Calendar calendar, boolean forceEncrypt)
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object.void
setTimestamp(java.lang.String parameterName, java.sql.Timestamp value, int scale)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setTimestamp(java.lang.String parameterName, java.sql.Timestamp value, int scale, boolean forceEncrypt)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setTimestamp(java.lang.String parameterName, java.sql.Timestamp value, java.util.Calendar calendar, boolean forceEncrypt)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setUniqueIdentifier(java.lang.String parameterName, java.lang.String guid)
Sets the designated parameter to the givenString
value.void
setUniqueIdentifier(java.lang.String parameterName, java.lang.String guid, boolean forceEncrypt)
Sets the designated parameter to the givenString
value.-
Methods inherited from interface java.sql.CallableStatement
getArray, getArray, getBigDecimal, getBigDecimal, getBigDecimal, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getDate, getDate, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getURL, getURL, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setURL, wasNull
-
Methods inherited from interface com.microsoft.sqlserver.jdbc.ISQLServerPreparedStatement
getParameterMetaData, getPreparedStatementHandle, getUseFmtOnly, setBigDecimal, setBigDecimal, setBoolean, setByte, setBytes, setDate, setDateTime, setDateTime, setDateTimeOffset, setDateTimeOffset, setDateTimeOffset, setDouble, setFloat, setGeography, setGeometry, setInt, setLong, setMoney, setMoney, setNString, setObject, setObject, setObject, setObject, setShort, setSmallDateTime, setSmallDateTime, setSmallMoney, setSmallMoney, setString, setStructured, setStructured, setStructured, setTime, setTime, setTime, setTimestamp, setTimestamp, setTimestamp, setUniqueIdentifier, setUniqueIdentifier, setUseFmtOnly
-
Methods inherited from interface com.microsoft.sqlserver.jdbc.ISQLServerStatement
getCancelQueryTimeout, getResponseBuffering, setCancelQueryTimeout, setResponseBuffering
-
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
-
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
-
-
-
-
Method Detail
-
getBigDecimal
@Deprecated java.math.BigDecimal getBigDecimal(java.lang.String parameterName, int scale) throws SQLServerException
Deprecated.- Throws:
SQLServerException
-
getDateTime
java.sql.Timestamp getDateTime(int index) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.- Parameters:
index
- the first column is 1, the second is 2, ...- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getDateTime
java.sql.Timestamp getDateTime(java.lang.String parameterName) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.- Parameters:
parameterName
- the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getDateTime
java.sql.Timestamp getDateTime(int index, java.util.Calendar cal) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.- Parameters:
index
- the first column is 1, the second is 2, ...cal
- the java.util.Calendar object to use in constructing the dateTime- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getDateTime
java.sql.Timestamp getDateTime(java.lang.String name, java.util.Calendar cal) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.- Parameters:
name
- the name of the columncal
- the java.util.Calendar object to use in constructing the dateTime- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getSmallDateTime
java.sql.Timestamp getSmallDateTime(int index) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.- Parameters:
index
- the first column is 1, the second is 2, ...- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getSmallDateTime
java.sql.Timestamp getSmallDateTime(java.lang.String parameterName) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.- Parameters:
parameterName
- The name of a column.- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getSmallDateTime
java.sql.Timestamp getSmallDateTime(int index, java.util.Calendar cal) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.- Parameters:
index
- the first column is 1, the second is 2, ...cal
- the java.util.Calendar object to use in constructing the smalldateTime- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getSmallDateTime
java.sql.Timestamp getSmallDateTime(java.lang.String name, java.util.Calendar cal) throws SQLServerException
Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.- Parameters:
name
- The name of a columncal
- the java.util.Calendar object to use in constructing the smalldateTime- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getDateTimeOffset
DateTimeOffset getDateTimeOffset(int parameterIndex) throws SQLServerException
Returns the DateTimeOffset value of parameter with index parameterIndex.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so on- Returns:
- DateTimeOffset value if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- if parameterIndex is out of range; if a database access error occurs or this method is called on a closedCallableStatement
-
getDateTimeOffset
DateTimeOffset getDateTimeOffset(java.lang.String parameterName) throws SQLServerException
Returns the DateTimeOffset value of parameter with name parameterName.- Parameters:
parameterName
- the name of the parameter- Returns:
- DateTimeOffset value if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
getAsciiStream
java.io.InputStream getAsciiStream(int parameterIndex) throws SQLServerException
Returns the value of the designated column in the current row of thisResultSet
object as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARCHAR
values. The JDBC driver will do any necessary conversion from the database format into ASCII.Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return
0
when the methodInputStream.available
is called whether there is data available or not.- Parameters:
parameterIndex
- the first column is 1, the second is 2, ...- Returns:
- a Java input stream that delivers the database column value as a stream of one-byte ASCII characters; if
the value is SQL
NULL
, the value returned isnull
- Throws:
SQLServerException
- if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set
-
getAsciiStream
java.io.InputStream getAsciiStream(java.lang.String parameterName) throws SQLServerException
Returns the value of the designated column in the current row of thisResultSet
object as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARCHAR
values. The JDBC driver will do any necessary conversion from the database format into ASCII.Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return
0
when the methodavailable
is called whether there is data available or not.- Parameters:
parameterName
- the name of the parameter- Returns:
- a Java input stream that delivers the database column value as a stream of one-byte ASCII characters. If
the value is SQL
NULL
, the value returned isnull
. - Throws:
SQLServerException
- if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set
-
getMoney
java.math.BigDecimal getMoney(int parameterIndex) throws SQLServerException
Returns the value of the column specified as a java.math.BigDecimal object.- Parameters:
parameterIndex
- The zero-based ordinal of a column.- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getMoney
java.math.BigDecimal getMoney(java.lang.String parameterName) throws SQLServerException
Returns the value of the column specified as a java.math.BigDecimal object.- Parameters:
parameterName
- The name of a column.- Returns:
- the column value; if the value is SQL NULL, the value returned is null.
- Throws:
SQLServerException
- when an error occurs
-
getSmallMoney
java.math.BigDecimal getSmallMoney(int parameterIndex) throws SQLServerException
Returns the value of the column specified as a java.math.BigDecimal object.- Parameters:
parameterIndex
- The zero-based ordinal of a column.- Returns:
- the column value; if the value is SQL NULL, the value returned is null
- Throws:
SQLServerException
- when an error occurs
-
getSmallMoney
java.math.BigDecimal getSmallMoney(java.lang.String parameterName) throws SQLServerException
Returns the value of the column specified as a java.math.BigDecimal object.- Parameters:
parameterName
- The name of a column.- Returns:
- the column value; if the value is SQL NULL, the value returned is null.
- Throws:
SQLServerException
- when an error occurs
-
getBinaryStream
java.io.InputStream getBinaryStream(int parameterIndex) throws SQLServerException
Returns the value of the designated column in the current row of thisResultSet
object as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARBINARY
values.Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return
0
when the methodInputStream.available
is called whether there is data available or not.- Parameters:
parameterIndex
- the first column is 1, the second is 2, ...- Returns:
- a Java input stream that delivers the database column value as a stream of uninterpreted bytes; if the
value is SQL
NULL
, the value returned isnull
- Throws:
SQLServerException
- if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set
-
getBinaryStream
java.io.InputStream getBinaryStream(java.lang.String parameterName) throws SQLServerException
Returns the value of the designated column in the current row of thisResultSet
object as a stream of uninterpretedbyte
s. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARBINARY
values.Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return
0
when the methodavailable
is called whether there is data available or not.- Parameters:
parameterName
- the name of the parameter- Returns:
- a Java input stream that delivers the database column value as a stream of uninterpreted bytes; if the
value is SQL
NULL
, the result isnull
- Throws:
SQLServerException
- if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set
-
setTimestamp
void setTimestamp(java.lang.String parameterName, java.sql.Timestamp value, java.util.Calendar calendar, boolean forceEncrypt) throws SQLServerException
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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valuecalendar
- a java.util.CalendarforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
CallableStatement.getTimestamp(int)
-
setTime
void setTime(java.lang.String parameterName, java.sql.Time value, java.util.Calendar calendar, boolean forceEncrypt) throws SQLServerException
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 a 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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valuecalendar
- theCalendar
object the driver will use to construct the timeforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
CallableStatement.getTime(int)
-
setDate
void setDate(java.lang.String parameterName, java.sql.Date value, java.util.Calendar calendar, boolean forceEncrypt) throws SQLServerException
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 a 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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valuecalendar
- theCalendar
object the driver will use to construct the dateforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
CallableStatement.getDate(int)
-
setNString
void setNString(java.lang.String parameterName, java.lang.String value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the givenString
object. The driver converts this to a SQLNCHAR
orNVARCHAR
orLONGNVARCHAR
- Parameters:
parameterName
- the name of the parameter to be setvalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; 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 closedCallableStatement
-
setObject
void setObject(java.lang.String parameterName, java.lang.Object value, int sqlType, int decimals, boolean forceEncrypt) throws SQLServerException
Sets the value of the designated parameter with the given object.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.
- Parameters:
parameterName
- the name of the parametervalue
- the object containing the input parameter valuesqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.decimals
- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.forceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
Types
,CallableStatement.getObject(int)
-
setObject
void setObject(java.lang.String parameterName, java.lang.Object value, int targetSqlType, java.lang.Integer precision, int scale) throws SQLServerException
Sets the value of the designated parameter with the given object.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 datatabase- specific abstract data types.
- Parameters:
parameterName
- the name of the parametervalue
- 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.precision
- the precision of the column.scale
- the scale of the column.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
Types
,CallableStatement.getObject(int)
-
setTimestamp
void setTimestamp(java.lang.String parameterName, java.sql.Timestamp value, int scale) throws SQLServerException
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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valuescale
- the scale of the parameter- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
CallableStatement.getTimestamp(int)
-
setTimestamp
void setTimestamp(java.lang.String parameterName, java.sql.Timestamp value, int scale, boolean forceEncrypt) throws SQLServerException
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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valuescale
- the scale of the parameterforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
CallableStatement.getTimestamp(int)
-
setDateTimeOffset
void setDateTimeOffset(java.lang.String parameterName, DateTimeOffset value) throws SQLServerException
Sets parameter parameterName to DateTimeOffset value.- Parameters:
parameterName
- the name of the parametervalue
- DateTimeOffset value- Throws:
SQLServerException
- if an error occurs
-
setDateTimeOffset
void setDateTimeOffset(java.lang.String parameterName, DateTimeOffset value, int scale) throws SQLServerException
Sets parameter parameterName to DateTimeOffset value.- Parameters:
parameterName
- the name of the parametervalue
- DateTimeOffset valuescale
- the scale of the parameter- Throws:
SQLServerException
- if an error occurs
-
setDateTimeOffset
void setDateTimeOffset(java.lang.String parameterName, DateTimeOffset value, int scale, boolean forceEncrypt) throws SQLServerException
Sets parameter parameterName to DateTimeOffset value.- Parameters:
parameterName
- the name of the parametervalue
- DateTimeOffset valuescale
- the scale of the parameterforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if an error occurs
-
setTime
void setTime(java.lang.String parameterName, java.sql.Time value, int scale) throws SQLServerException
Sets the designated parameter to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valuescale
- the scale of the column- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
CallableStatement.getTime(int)
-
setTime
void setTime(java.lang.String parameterName, java.sql.Time value, int scale, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valuescale
- the scale of the columnforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
CallableStatement.getTime(int)
-
setDateTime
void setDateTime(java.lang.String parameterName, java.sql.Timestamp value) throws SQLServerException
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLDATETIME
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter value- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setDateTime
void setDateTime(java.lang.String parameterName, java.sql.Timestamp value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLDATETIME
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setSmallDateTime
void setSmallDateTime(java.lang.String parameterName, java.sql.Timestamp value) throws SQLServerException
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLSMALLDATETIME
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter value- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setSmallDateTime
void setSmallDateTime(java.lang.String parameterName, java.sql.Timestamp value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLSMALLDATETIME
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setUniqueIdentifier
void setUniqueIdentifier(java.lang.String parameterName, java.lang.String guid) throws SQLServerException
Sets the designated parameter to the givenString
value. The driver converts this to an SQLuniqueIdentifier
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterguid
- the parameter value- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setUniqueIdentifier
void setUniqueIdentifier(java.lang.String parameterName, java.lang.String guid, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the givenString
value. The driver converts this to an SQLuniqueIdentifier
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterguid
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setBytes
void setBytes(java.lang.String parameterName, byte[] value, boolean forceEncrypt) throws SQLServerException
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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setByte
void setByte(java.lang.String parameterName, byte value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javabyte
value. The driver converts this to an SQLTINYINT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setString
void setString(java.lang.String parameterName, java.lang.String value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given JavaString
value. The driver converts this to an SQLVARCHAR
orLONGVARCHAR
value (depending on the argument's size relative to the driver's limits onVARCHAR
values) when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setMoney
void setMoney(java.lang.String parameterName, java.math.BigDecimal value) throws SQLServerException
Sets the designated parameter to the given Javajava.math.BigDecimal
value. The driver converts this to an SQLMoney
value.- Parameters:
parameterName
- the name of the parametervalue
- the parameter value- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setMoney
void setMoney(java.lang.String parameterName, java.math.BigDecimal value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javajava.math.BigDecimal
value. The driver converts this to an SQLMoney
value.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setSmallMoney
void setSmallMoney(java.lang.String parameterName, java.math.BigDecimal value) throws SQLServerException
Sets the designated parameter to the given Javajava.math.BigDecimal
value. The driver converts this to an SQLsmallMoney
value.- Parameters:
parameterName
- the name of the parametervalue
- the parameter value- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setSmallMoney
void setSmallMoney(java.lang.String parameterName, java.math.BigDecimal value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javajava.math.BigDecimal
value. The driver converts this to an SQLsmallMoney
value.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setBigDecimal
void setBigDecimal(java.lang.String parameterName, java.math.BigDecimal value, int precision, int scale) throws SQLServerException
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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueprecision
- the precision of the columnscale
- the scale of the column- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setBigDecimal
void setBigDecimal(java.lang.String parameterName, java.math.BigDecimal value, int precision, int scale, boolean forceEncrypt) throws SQLServerException
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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueprecision
- the precision of the columnscale
- the scale of the columnforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setDouble
void setDouble(java.lang.String parameterName, double value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setFloat
void setFloat(java.lang.String parameterName, float value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javafloat
value. The driver converts this to an SQLFLOAT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setInt
void setInt(java.lang.String parameterName, int value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javaint
value. The driver converts this to an SQLINTEGER
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setLong
void setLong(java.lang.String parameterName, long value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javalong
value. The driver converts this to an SQLBIGINT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setShort
void setShort(java.lang.String parameterName, short value, boolean forceEncrypt) throws SQLServerException
Sets the designated parameter to the given Javashort
value. The driver converts this to an SQLSMALLINT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setBoolean
void setBoolean(java.lang.String parameterName, boolean value, boolean forceEncrypt) throws SQLServerException
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.- Parameters:
parameterName
- the name of the parametervalue
- the parameter valueforceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
-
setStructured
void setStructured(java.lang.String parameterName, java.lang.String tvpName, SQLServerDataTable tvpDataTable) throws SQLServerException
Populates a table valued parameter passed to a stored procedure with a data table.- Parameters:
parameterName
- the name of the parametertvpName
- the name of the type TVPtvpDataTable
- the data table object- Throws:
SQLServerException
- when an error occurs
-
setStructured
void setStructured(java.lang.String parameterName, java.lang.String tvpName, java.sql.ResultSet tvpResultSet) throws SQLServerException
Populates a table valued parameter passed to a stored procedure with a ResultSet retrieved from another table- Parameters:
parameterName
- the name of the parametertvpName
- the name of the type TVPtvpResultSet
- the source result set object- Throws:
SQLServerException
- when an error occurs
-
setStructured
void setStructured(java.lang.String parameterName, java.lang.String tvpName, ISQLServerDataRecord tvpDataRecord) throws SQLServerException
Populates a table valued parameter passed to a stored procedure with an ISQLServerDataRecord object.- Parameters:
parameterName
- the name of the parametertvpName
- the name of the type TVPtvpDataRecord
- ISQLServerDataRecord is used for streaming data and the user decides how to use it. tvpDataRecord is an ISQLServerDataRecord object.the source result set object- Throws:
SQLServerException
- when an error occurs
-
registerOutParameter
void registerOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType, int precision, int scale) throws SQLServerException
Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.
- Parameters:
parameterName
- the name of the parametersqlType
- the JDBC type code defined by SQLType to use to register the OUT Parameter.precision
- the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.scale
- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLServerException
- If any errors occur.
-
registerOutParameter
void registerOutParameter(int parameterIndex, java.sql.SQLType sqlType, int precision, int scale) throws SQLServerException
Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.
- Parameters:
parameterIndex
- the first column is 1, the second is 2, ...sqlType
- the JDBC type code defined by SQLType to use to register the OUT Parameter.precision
- the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.scale
- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLServerException
- If any errors occur.
-
registerOutParameter
void registerOutParameter(int parameterIndex, int sqlType, int precision, int scale) throws SQLServerException
Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.
- Parameters:
parameterIndex
- the first column is 1, the second is 2, ...sqlType
- the JDBC type code defined by SQLType to use to register the OUT Parameter.precision
- the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.scale
- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLServerException
- If any errors occur.
-
registerOutParameter
void registerOutParameter(java.lang.String parameterName, int sqlType, int precision, int scale) throws SQLServerException
Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.
- Parameters:
parameterName
- the name of the parametersqlType
- the JDBC type code defined by SQLType to use to register the OUT Parameter.precision
- the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.scale
- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
SQLServerException
- If any errors occur.
-
setObject
void setObject(java.lang.String parameterName, java.lang.Object value, java.sql.SQLType jdbcType, int scale, boolean forceEncrypt) throws SQLServerException
Sets the value of the designated parameter with the given object.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 datatabase- specific abstract data types.
- Parameters:
parameterName
- the name of the parametervalue
- the object containing the input parameter valuejdbcType
- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scale
- the scale of the column.forceEncrypt
- If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.- Throws:
SQLServerException
- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatement
- See Also:
Types
,CallableStatement.getObject(int)
-
-