JDBC Interfaces M-Z

getParameterClassName(int param)

Yes

getParameterCount()

Yes

getParameterType(int param)

Yes

getParameterMode(int param)

Yes

getParameterTypeName(int param)

Yes

getPrecision(int param)

Yes

getScale(int param)

Yes

isNullable(int param)

Yes

isSigned(int param)

Yes

Syntax

public int getParameterCount() throws SQLException

Return

The number of parameters is returned.

Syntax

public int isNullable(int param) throws SQLException

where the param parameter is the parameter to check–the first parameter is 1, the second parameter is 2, and so on.

Return

The nullability status of the given parameter is returned; one of:

ParameterMetaData.parameterNoNulls ParameterMetaData.parameterNullable ParameterMetaData.parameterNullableUnknown.

Syntax

public boolean isSigned(int param) throws SQLException

where the param parameter is the parameter to check–the first parameter is 1, the second parameter is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public int getPrecision(int param) throws SQLException

where the param parameter is the parameter to check–the first parameter is 1, the second parameter is 2, and so on.

Return

precision. Zero is returned if precision is not applicable to the parameter

Syntax

public int getScale(int param) throws SQLException

where the param parameter is the parameter is check–the first parameter is 1, the second parameter is 2, and so on.

Return

scale. Zero is returned if scale is not applicable to the parameter.

Syntax

public int getParameterType(int param) throws SQLException

where the param parameter is the parameter to check–the first parameter is 1, the second parameter is 2, and so on

Return

SQL type from java.sql.Types. java.sql.Types.NULL will be returned if the parameter type cannot be determined.

Syntax

public String getParameterTypeName(int param) throws SQLException

where the param parameter is the parameter to check–the first parameter is 1, the second parameter is 2, and so on.

Return

type, the name used by the database If the parameter type is a user-defined type, then a fully qualified type name is returned.

null is returned if the parameter typeName cannot be determined.

Syntax

public String getParameterClassName(int param) throws SQLException

where the param parameter is the parameter to check–the first parameter is 1, the second is 2, and so on.

Return

The fully qualified name of the class in the Java programming language that would be used by the method PreparedStatement.setObject to set the value in the specified parameter is returned. This is the class name used for custom mapping.

null is returned if the Class name cannot be determined.

Syntax

public int getParameterMode(int param) throws SQLException

where the param parameter is the parameter to check–the first parameter is 1, the second is 2, and so on.

Return

Mode of the parameter is returned; one of:

ParameterMetaData.parameterModeIn ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown

addConnectionEventListener(ConnectionEventListener listener)

Yes

close()

Yes

getConnection()

Yes

removeConnectionEventListener(ConnectionEventListener listener)

Yes

Syntax

public void addConnectionEventListener(ConnectionEventListener listener)

where the listener parameter is the object added as a listener to the event.

Syntax

public void close() throws SQLException

Syntax

public Connection getConnection() throws SQLException

Return

A Connection object, a handle to the pooled connection object is returned.

Syntax

public void removeConnectionEventListener(ConnectionEventListener listener)

where the listener parameter is the object removed from being a listener to the event.

addBatch()

Yes

clearParameters()

Yes

execute()

Yes

executeQuery()

Yes

executeUpdate()

Yes

getMetaData()

Yes

getParameterMetaData()

Yes

setArray(int i, Array x)

Yes

setAsciiStream(int parameterIndex, InputStream x, int length)

Yes

setBigDecimal(int parameterIndex, BigDecimal x)

Yes

setBinaryStream(int parameterIndex, InputStream x, int length)

Yes

setBlob(int i, Blob x)

Yes

setBoolean(int parameterIndex, boolean x)

Yes

setByte(int parameterIndex, byte x)

Yes

setBytes(int parameterIndex, byte[] x)

Yes

setCharacterStream(int parameterIndex, Reader reader, int length)

Yes

setClob(int i, Clob x)

Yes

setDate(int parameterIndex, Date x)

Yes

setDate(int parameterIndex, Date x, Calendar cal)

Yes

setDouble(int parameterIndex, Double x)

Yes

setFloat(int parameterIndex, float x)

Yes

setInt(int parameterIndex, int x)

Yes

setLong(int parameterIndex, long x)

Yes

setNull(int parameterIndex, int sqlType)

Yes

setNull(int paramIndex, int sqlType, String typeName)

Yes

setObject(int parameterIndex, Object x)

Yes

setObject(int parameterIndex, Object x, int targetSqlType)

Yes

setObject(int parameterIndex, Object x, int targetSqlType, int scale)

Yes

setRef(int i, Ref x)

No

setShort(int parameterIndex, Short x)

Yes

setSQLXML(int parameterIndex, SQLXML x)

Yes

setString(int parameterIndex, String x)

Yes

setTime(int parameterIndex, Time x)

Yes

setTime(int parameterIndex, Time x, Calendar cal)

Yes

setTimestamp(int parameterIndex, Timestamp x)

Yes

setTimestamp(int parameterIndex, Timestamp x, Calendar cal)

Yes

setUnicodeStream(int parameterIndex, InputStream x, int length) [DEPRECATED]

Yes

Syntax

public void addBatch() throws SQLException

Note:  It is recommended to use this method with auto-commit disabled.

Syntax

public void clearParameters() throws SQLException

Note:  In general, parameter values remain in force for repeated use of a Statement.

Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values. This can be done by calling clearParameters.

Syntax

public boolean execute() throws SQLException

Note:  Some prepared statements return multiple results. The execute method handles these complex statements as well as the simple form of statement handled by the executeQuery and executeUpdate methods.

Syntax

public ResultSet executeQuery() throws SQLException

Return

The ResultSet that contains the date produced by the query is returned. If used inappropriately, returns an exception according to the JDBC standard.

Note:  The ResultSet is never null.

An exception is returned if used to execute a statement that does not return a result set.

The error is 1077 “executeQuery() cannot be used when there is no result set expected; use executeUpdate() or execute()”.

An exception is returned if the request contains multiple statements.

The error is 1079 “% executeQuery() cannot be used when the request contains multiple statements; use execute()”.

Syntax

public int executeUpdate() throws SQLException

Return

Either the row count for INSERT, UPDATE, or DELETE statements, or 0 for SQL statements that return nothing. If used inappropriately, returns an exception according to the JDBC standard.

Note:  The executeUpdate objects can also execute SQL statements that return nothing, such as DDL statements.

An exception is returned if used to execute a statement that returns a result set.

The error is 1078 “executeUpdate() cannot be used when a result set is expected; use executeQuery() or execute()”.

An exception is returned if the request contains multiple statements.

The error is 1079 “% executeUpdate() cannot be used when the request contains multiple statements; use execute()”.

Beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.25, for row count values received from the database that are too large to fit into a signed 32-bit integer, the Teradata JDBC Driver will return an update count of Integer.MAX_VALUE to the application, and will provide a SQLWarning with error code 1474 that lists the actual row count in the message text.

Syntax

public ResultSetMetaData getMetaData() throws SQLException

Return

The description of a ResultSet’s columns is returned.

Syntax

public ParameterMetaData getParameterMetaData() throws SQLException

Return

A ParameterMetaData object is returned. An exception is thrown if ParameterMetaData is not available.

Syntax

public void setArray(int parameterIndex, Array x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification. The first parameter is 1, the second parameter is 2, and so on
• x is an Array object that maps an SQL ARRAY value

Note:  This method is available beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04.

Syntax

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

where the parameter:

• parameterIndex is the parameter specification. The first parameter is 1, the second parameter is 2, and so on
• x is the Java input stream that contains the ASCII parameter value
• length is the number of bytes in the stream

Note:  When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it using a java.io.InputStream.

JDBC will read the data from the stream as needed, until it reaches end-of-file. The JDBC driver will do any necessary conversion from ASCII to the database char format.

This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Syntax

public void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification. The first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Note:  Beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.09, the Teradata JDBC Driver sends the BigDecimal value to the database as the SQL NUMBER data type. With prior software versions, the Teradata JDBC Driver sends the BigDecimal value to the database as the SQL DECIMAL data type.

Syntax

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

where the parameter:

• parameterIndex is the parameter specification. The first parameter is 1, the second parameter is 2, and so on
• x is the Java input stream that contains the binary parameter value
• length is the number of bytes in the stream

Note:  When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it using a java.io.InputStream.

JDBC will read the data from the stream as needed, until it reaches end-of-file.

This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Syntax

public void setBlob(int i, Blob x) throws SQLException

where the parameter:

• i is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is a BLOB object that maps an SQL BLOB value

public void setBoolean(int parameterIndex, boolean x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setByte(int parameterIndex, byte x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setBytes(int parameterIndex, byte[] x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

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

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• reader is the java reader that contains the UNICODE data
• length is the number of characters in the stream

Note:  When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it using a java.io.Reader. JDBC will read the data from the stream as needed, until it reaches end-of-file. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Syntax

public void setClob(int i, Clob x) throws SQLException

where the parameter:

• i is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is a CLOB object that maps an SQL CLOB value

Syntax

public void setDate(int parameterIndex, Date x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setDate(int parameterIndex, Date x, Calendar cal) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value
• cal is the Calendar object the driver will use to construct the date

Note:  With a Calendar object, the driver can calculate the date taking into account a custom timezone and locale.

If no Calendar object is specified, the driver uses the default timezone and locale.

The driver ignores the Calendar object since the Teradata Database does not support time zones for dates.

Syntax

public void setDouble(int parameterIndex, double x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setFloat(int parameterIndex, float x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setInt(int parameterIndex, int x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setLong(int parameterIndex, long x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setNull(int parameterIndex, int sqlType) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• sqlType is the SQL type code defined in java.sql.Types

Note:  You must specify the sqlType parameter.

Null Expressions: If any expression in a comparison is null, the result of the comparison is unknown. For a comparison to provide a TRUE result when comparing fields that might result in nulls, the statement must include the IS (NOT) NULL operator.

Syntax

public void setNull(int paramIndex, int sqlType, String typeName) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• sqlType is the SQL type code defined in java.sql.Types
• typeName is the fully qualified name of an SQL user-named type, ignored if the parameter is not a user-named type or REF

Note:  To be portable, applications must give the SQL type code and the fully qualified SQL name when specifying a NULL user-defined or REF parameter.

Null Expressions: If any expression in a comparison is null, the result of the comparison is unknown. For a comparison to provide a TRUE result when comparing fields that might result in nulls, the statement must include the IS [NOT] NULL operator.

In the case of a user-named type, the name is the type name of the parameter itself.

If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-named 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-named or REF type, the given typeName is ignored.

Syntax

public void setObject(int parameterIndex, Object x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the object containing the input parameter value

Note:  The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument java object will be converted to the corresponding SQL type before being sent to the database.

Note that this method may be used to pass database specific abstract data types, by using a Driver-specific java type.

If the object is of a class implementing SQLData, the JDBC driver should call its method writeSQL to write it to the SQL data stream.

If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, then the driver should pass it to the database as a value of the corresponding SQL type.

This method throws an exception if there is an ambiguity; for example, if the object is of a class implementing more than one of those interfaces.

Syntax

public void setObject(int parameterIndex, Object x, int targetSqlType) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the object containing the input parameter value
• targetSqlType is the SQL type (as defined in java.sql.Types) to be sent to the database

Syntax

public void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the object containing the input parameter value
• targetSqlType is the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
• scale is the number of digits after the decimal point–for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types. For all other types, this value is ignored.

Note:  The given Java object will be converted to the targetSqlType before being sent to the database.

If the object has a custom mapping (is of a class implementing SQLData), the JDBC driver should call its method writeSQL to write it to the SQL data stream.

If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

This method may be used to pass database-specific abstract data types.

Syntax

public void setShort(int parameterIndex, short x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setSQLXML(int parameterIndex, SQLXML x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Note:  This method is supported beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.19.

JDK 6.0 or later is required to use SQLXML functionality.

Syntax

public void setString(int parameterIndex, String x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setTime(int parameterIndex, Time x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setTime(int parameterIndex, Time x, Calendar cal) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value
• cal is the Calendar object the driver will use to construct the time

Note:  The driver uses the Calendar object to construct an SQL TIME, which the driver then sends to the database.

With a Calendar object, the driver can calculate the time taking into account a custom timezone and locale.

If no Calendar object is specified, the driver uses the default timezone and locale.

Syntax

public void setTimestamp(int parameterIndex, Timestamp x) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value

Syntax

public void setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the parameter value
• cal is the Calendar object the driver will use to construct the time

Note:  The driver uses the Calendar object to construct an SQL TIMESTAMP, which the driver then sends to the database.

With a Calendar object, the driver can calculate the timestamp taking into account a custom timezone and locale.

If no Calendar object is specified, the driver uses the default timezone and locale.

Syntax

public void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException

where the parameter:

• parameterIndex is the parameter specification; the first parameter is 1, the second parameter is 2, and so on
• x is the java input stream containing the UNICODE parameter value
• length is the bytes in the input stream

absolute(int row)

Yes

afterLast()

Yes

beforeFirst()

Yes

cancelRowUpdates()

Yes

clearWarnings()

Yes

close()

Yes

deleteRow()

Yes

findColumn(String columnName)

Yes

first()

Yes

getArray(int columnIndex)

Yes

getArray(String columnName)

Yes

getAsciiStream(int columnIndex)

Yes

getAsciiStream(String columnName)

Yes

getBigDecimal(int columnIndex)

Yes

getBigDecimal(int columnIndex, int scale) [Deprecated]

Yes

getBigDecimal(String columnName)

Yes

getBigDecimal(String columnName, int scale) [Deprecated]

Yes

getBinaryStream(int columnIndex)

Yes

getBinaryStream(String columnName)

Yes

getBlob(int i)

Yes

getBlob(String columnName)

Yes

getBoolean(int columnIndex)

Yes

getBoolean(String columnName)

Yes

getByte(int columnIndex)

Yes

getByte(String columnName)

Yes

getBytes(int columnIndex)

Yes

getBytes(String columnName)

Yes

getCharacterStream(int columnIndex)

Yes

getCharacterStream(String columnName)

Yes

getClob(int i)

Yes

getClob(String columnName)

Yes

getConcurrency()

Yes

getCursorName()

No

getDate(int columnIndex)

Yes

getDate(String columnName)

Yes

getDate(int columnIndex, Calendar cal)

Yes

getDate(String columnName, Calendar cal)

Yes

getDouble(int columnIndex)

Yes

getDouble(String columnName)

Yes

getFetchDirection()

Yes

getFetchSize()

Yes

getFloat(int columnIndex)

Yes

getFloat(String columnName)

Yes

getHoldability()

Yes

getInt(int columnIndex)

Yes

getInt(String columnName)

Yes

getLong(int columnIndex)

Yes

getLong(String columnName)

Yes

getMetaData()

Yes

getObject(int columnIndex)

Yes

getObject(int i, Map map)

Yes

getObject(String columnName)

Yes

getObject(String columnName, Map map)

Yes

getRef(int i)

No

getRef(String columnName)

No

getRow()

Yes

getShort(int columnIndex)

Yes

getShort(String columnName)

Yes

getSQLXML(int columnIndex)

Yes

getSQLXML(String columnName)

Yes

getStatement()

Yes

getString(int columnIndex)

Yes

getString(String columnName)

Yes

getTime(int columnIndex)

Yes

getTime(int columnIndex, Calendar cal)

Yes

getTime(String columnName)

Yes

getTime(String columnName, Calendar cal)

Yes

getTimeStamp(int columnIndex)

Yes

getTimeStamp(int columnIndex, Calendar cal)

Yes

getTimeStamp(String columnName)

Yes

getTimeStamp(String columnName, Calendar cal)

Yes

getType()

Yes

getUnicodeStream(int columnIndex)[Deprecated]

Yes

getUnicodeStream(String columnName)[Deprecated]

Yes

getWarnings()

Yes

insertRow()

Yes

isAfterLast()

Yes

isBeforeFirst()

Yes

isFirst()

Yes

isLast()

Yes

last()

Yes

moveToCurrentRow()

Yes

moveToInsertRow()

Yes

next()

Yes

previous()

Yes

refreshRow()

Yes

relative(int rows)

Yes

rowDeleted()

Yes

rowInserted()

Yes

rowUpdated()

Yes

setFetchDirection(int direction)

Yes*

setFetchSize(int rows)

Yes

updateArray(int columnIndex, Array x)

No

updateArray(String columnName, Array x)

No

updateAsciiStream(int columnIndex, InputStream x, int length)

Yes

updateAsciiStream(String columnName, InputStream x, int length)

Yes

updateBigDecimal(int columnIndex, BigDecimal x)

Yes

updateBigDecimal(String columnName, BigDecimal x)

Yes

updateBinaryStream(int columnIndex, InputStream x, int length)

Yes

updateBinaryStream(String columnName, InputStream x, int length)

Yes

updateBlob(int columnIndex, Blob x)

Yes

updateBlob(String columnName, Blob x)

Yes

updateBoolean(int columnIndex, boolean x)

No

updateBoolean(String columnName, boolean x)

No

updateByte(int columnIndex, byte x)

Yes

updateByte(String columnName, byte x)

Yes

updateBytes(int columnIndex, byte[] x)

Yes

updateBytes(String columnName, byte[] x)

Yes

updateCharacterStream(int columnIndex, Reader x, int length)

Yes

updateCharacterStream(String columnName, Reader x, int length)

Yes

updateClob(int columnIndex, Clob x)

Yes

updateClob(String columnName, Clob x)

Yes

updateDate(int columnIndex, Date x)

Yes

updateDate(String columnName, Date x)

Yes

updateDouble(int columnIndex, double x)

Yes

updateDouble(String columnName, double x)

Yes

updateFloat(int columnIndex, float x)

Yes

updateFloat(String columnName, float x)

Yes

updateInt(int columnIndex, int x)

Yes

updateInt(String columnName, int x)

Yes

updateLong(int columnIndex, long x)

Yes

updateLong(String columnName, long x)

Yes

updateNull(int columnIndex)

Yes

updateNull(String columnName)

Yes

updateObject(int columnIndex, Object x)

Yes

updateObject(int columnIndex, Object x, int scale)

Yes

updateObject(String columnName, Object x)

Yes

updateObject(String columnName, Object x, int scale)

Yes

updateRef(int columnIndex, Ref x)

No

updateRef(String columnName, Ref x)

No

updateRow()

Yes

updateShort(int columnIndex, short x)

Yes

updateShort(String columnName, short x)

Yes

updateSQLXML(int columnIndex, SQLXML x)

Yes

updateSQLXML(String columnName, SQLXML x)

Yes

updateString(int columnIndex, String x)

Yes

updateString(String columnName, String x)

Yes

updateTime(int columnIndex, Time x)

Yes

updateTime(String columnName, Time x)

Yes

updateTimestamp(int columnIndex, Timestamp x)

Yes

updateTimestamp(String columnName, Timestamp x)

Yes

wasNull()

Yes

Syntax

public int absolute(int row) throws SQLException

where the row parameter contains the number of the row where the cursor should move. If the row number is positive, the cursor moves in relation to the first row. If the row number is negative, the cursor position moves in relation to the last row.

Result

True, if the cursor is located on the ResultSet

False, if it is not

Note:  Throws the SQLException if a database access error occurs, or if the ResultSetType is TYPE_FORWARD_ONLY.

A call absolute(1) is the same as calling first()

A call absolute(-1) is the same as calling last()

Syntax

public void afterLast() throws SQLException

Note:  If the ResultSet contains no rows, this method has no effect.

Throws the SQLException if a database access error occurs, or if the ResultSetType is TYPE_FORWARD_ONLY.

Syntax

public void beforeFirst() throws SQLException

Note:  If the ResultSet contains no rows, this method has no effect.

Throws the SQLException if a database access error occurs, or if the ResultSetType is TYPE_FORWARD_ONLY.

Syntax

public void cancelRowUpdate() throws SQLException

Note:  Throws the SQLException if a database access error occurs or if this method is called when the cursor is on the insert row.

Syntax

public void clearWarnings() throws SQLException

Syntax

public void close() throws SQLException

Note:  A ResultSet is automatically closed by the statement that generated it when that statement is closed, re-executed, or used to retrieve the next result from a sequence of multiple results. A ResultSet is also automatically closed when it is garbage collected.

Syntax

public void deleteRow() throws SQLException

Note:  Throws the SQLException if a database access error occurs or if this method is called when the cursor is on the insert row

Syntax

public int findColumn(String columnName) throws SQLException

where the columnName parameter is the name of the column

Return

The column index of columnName is returned.

Syntax

public boolean first() throws SQLException

Return

True, if the location of the cursor is a valid row

False, if there are no rows in the ResultSet

Note:  Throws the SQLException if a database access error occurs, or if the ResultSetType is TYPE_FORWARD_ONLY.

Syntax

public Array getArray(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

An Array object representing the SQL ARRAY value in the specified column. If the value is SQL NULL, then the result is null.

Note:  This method is available beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04.

Syntax

public Array getArray(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

An Array object representing the SQL ARRAY value in the specified column. If the value is SQL NULL, then the result is null.

Note:  This method is available beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04.

Syntax

public InputStream getAsciiStream(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

A Java input stream that delivers the database column value as a stream of one-byte ASCII characters. If the value is SQL NULL, then the result is null.

Note:  This method is particularly suitable for retrieving large LONGVARCHAR values. The JDBC driver will do any necessary conversion from the database format into ASCII.

All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream.

Also, a stream may return 0 when the method available is called whether there is data available or not.

Syntax

public InputStream getAsciiStream(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

A Java input stream that delivers the database column value as a stream of one-byte ASCII characters.

Note:  This method is particularly suitable for retrieving large LONGVARCHAR values. The JDBC driver will do any necessary conversion from the database format into ASCII.

If the value is SQL NULL then the result is null.

All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream.

Also, a stream may return 0 when the method available is called whether there is data available or not.

Syntax

public BigDecimal getBigDecimal(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The column value is returned.

Note:  If the value is sQL NULL, the result is NULL.

Note:  If the value is sQL NULL, the result is NULL.

Syntax

public BigDecimal getBigDecimal(int columnIndex, int scale) throws SQLException

where the parameter:

• columnIndex is the column specification; the first column is 1, the second column is 2, and so on
• scale is the number of digits to the right of the decimal point

Return

If the value is SQL NULL, the result is NULL.

Syntax

public BigDecimal getBigDecimal(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The column value is returned.

Note:  If the value is SQL NULL, the result is NULL.

Syntax

public BigDecimal getBigDecimal(String columnName, int scale) throws SQLException

where the parameter:

• columnName is the SQL name of the column
• scale is the number of digits to the right of the decimal point

Return

The column value is returned.

Note:  If the value is SQL NULL, the result is NULL.

Syntax

public InputStream getBinaryStream(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

A Java input stream that delivers the database column value as a stream of uninterpreted bytes is returned.

Note:  If the value is SQL NULL, then the result is null.

All the data in the returned stream must be read before getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return zero for available() whether data is available or not.

Syntax

public InputStream getBinaryStream(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

A Java input stream that delivers the database column value as a stream of uninterpreted bytes is returned. If the value is SQL NULL, then the result is null.

Note:  This method is particularly suitable for retrieving large LONGVARBINARY values.

All the data in the returned stream must be read before getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return zero for available() whether data is available or not.

Syntax

public Blob getBlob(int i) throws SQLException

where the i parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

Returns a Blob object representing the SQL BLOB value in the specified column.

Syntax

public Blob getBlob(String colName) throws SQLException

where the colName parameter is the name of the column from which to retrieve the value

Return

Returns a Blob object representing the SQL BLOB value in the specified column.

Syntax

public boolean getBoolean(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the value is SQL NULL, the result is false.

Syntax

public boolean getBoolean(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the value is SQL NULL, the result is false.

Syntax

public byte getByte(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the value is SQL NULL, the result is 0.

Syntax

public byte getByte(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the value is SQL NULL, the result is 0.

Syntax

public byte[] getBytes(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the value is SQL NULL, the result is null.

Syntax

public byte[] getBytes(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the value is SQL NULL, the result is null.

Syntax

public Reader getCharacterStream(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value in the specified column as a java.io.Reader is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Reader getCharacterStream(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value in the specified column as a java.io.Reader is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Clob getClob(int i) throws SQLException

where the i parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

Returns a Clob object representing the SQL CLOB value in the specified column.

Syntax

public Blob getClob(String colName) throws SQLException

where the colName parameter is the name of the column from which to retrieve the value

Return

Returns a Clob object representing the SQL CLOB value in the specified column.

Syntax

public int getConcurrency() throws SQLException

Return

The concurrency type is returned, either ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

Note:  Throws the SQLException if a database access error occurs.

Syntax

public Date getDate(String columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Date getDate(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Date getDate(String columnIndex, Calendar cal) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so on
• cal is the calendar to use in constructing the date

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method uses the given calendar to construct an appropriate millisecond value for the Date, if the underlying database does not store timezone information.

The time zone is ignored since the database does not support time zones with dates.

Syntax

public Date getDate(String columnName, Calendar cal) throws SQLException

where the parameter:

• columnName is the SQL name of the column from which to retrieve the value
• cal is the calendar to use in constructing the date

Return

The column value as a java.sql.Date.object is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method uses the given calendar to construct an appropriate millisecond value for the Date, if the underlying database does not store timezone information.

The time zone is ignored since the database does not support time zones with dates.

Syntax

public double getDouble(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public double getDouble(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public float getFetchDirection() throws SQLException

Return

The current fetch direction for the ResultSet is returned.

Syntax

public int getFetchSize() throws SQLException

Return

The current fetch size for the ResultSet is returned.

Syntax

public float getFloat(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public float getFloat(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public int getHoldability() throws SQLException

Return

ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Note:   ResultSet.CLOSE_CURSORS_AT_COMMIT is supported beginning with Teradata JDBC Driver 14.00.00.28. Earlier versions of the Teradata JDBC Driver supported only ResultSet.HOLD_CURSORS_OVER_COMMIT.

Syntax

public int getInt(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public int getInt(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public long getLong(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public long getLong(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public ResultSetMetaData getMetaData() throws SQLException

Return

The description of ResultSet object’s columns is returned.

Syntax

public Object getObject(String columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

A java.lang.Object holding the column value is returned.

Note:  This method returns the value of the given column as a Java object. The type of the Java object will be the default Java object type corresponding to the column’s SQL type, following the mapping for built-in types specified in the JDBC specification.

You can also use this method to read database-specific abstract data types.

When the column contains a structured or distinct value, the behavior of this method is as if it were a call to:

getObject(columnIndex, this.getStatement().getConnection().getTypeMap())

Syntax

public Object getObject(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

A java.lang.Object holding the column value is returned.

Note:  A java.lang.Object holding the column value is returned.

You can also use this method to read database-specific abstract data types.

When the column contains a structured or distinct value, the behavior of this method is as if it were a call to:

getObject(columnIndex, this.getStatement().getConnection().getTypeMap())

Syntax

public int getRow() throws SQLException

Return

If there is a current row, returns the row number. The first row number is 1.

If there is no current row, returns 0.

Note:  Throws the SQLException if a database access error occurs.

Syntax

public short getShort(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public short getShort(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is 0.

Syntax

public SQLXML getSQLXML(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method is supported beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.19.

JDK 6.0 or later is required to use SQLXML functionality.

Syntax

public SQLXML getSQLXML(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method is supported beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.19.

JDK 6.0 or later is required to use SQLXML functionality.

Syntax

public Statement getStatement() throws SQLException

Return

The Statement that produced the ResultSet or null if the ResultSet was produced some other way is returned.

Note:  If the ResultSet was generated some other way, such as by a DatabaseMetaData method, this method returns null.

Syntax

public String getString(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public String getString(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Time getTime(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Time getTime(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Time getTime(int columnIndex, Calendar cal) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so on
• cal is the calendar to use in constructing the time.

Return

The value of the designated column as a java.sql.Time object is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method uses the given calendar to construct an appropriate millisecond value for the Time if the underlying database does not store timezone.

When retrieving datatypes with time zone (time and timestamp), the time zone offset is put into calendar time zone offset and can be retrieved using the following command:

cal.getTimeZone().getRawOffset()

This is the milliseconds.

Syntax

public Time getTime(String columnName, Calendar cal) throws SQLException

where the parameter:

• columnName is the SQL name of the column
• cal is the calendar to use in constructing the time.

Return

The value of the designated column as a java.sql.Time object is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method uses the given calendar to construct an appropriate millisecond value for the Time if the underlying database does not store timezone.

When retrieving datatypes with time zone (time and timestamp), the time zone offset is put into calendar time zone offset and can be retrieved using the following command:

cal.getTimeZone().getRawOffset()

This is the milliseconds.

Syntax

public Timestamp getTimestamp(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Timestamp getTimestamp(String columnName) throws SQLException

where the columnName parameter is the SQL name of the column

Return

The value of the designated column is returned.

Note:  If the column value returned is SQL NULL, the result is null.

Syntax

public Timestamp getTimestamp(int columnIndex, Calendar cal) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so on
• cal is the calendar to use in constructing the timestamp

Return

The value of the designated column as a java.sql.TimeStamp object is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method uses the given calendar to construct an appropriate millisecond value for the Timestamp if the underlying database does not store timezone information.

When retrieving datatypes with time zone (time and timestamp), the time zone offset is put into calendar time zone offset and can be retrieved using the following command:

cal.getTimeZone().getRawOffset()

This is the milliseconds.

Syntax

public Timestamp getTimestamp(String columnName, Calendar cal) throws SQLException

where the parameter:

• columnName is the SQL name of the column
• cal is the calendar to use in constructing the timestamp

Return

The value of the designated column as a java.sql.TimeStamp object is returned.

Note:  If the column value returned is SQL NULL, the result is null.

This method uses the given calendar to construct an appropriate millisecond value for the Timestamp if the underlying database does not store timezone information.

When retrieving datatypes with time zone (time and timestamp), the time zone offset is put into calendar time zone offset and can be retrieved using the following command:

cal.getTimeZone().getRawOffset()

This is the milliseconds.

Syntax

public int getType() throws SQLException

Return

ResultSet.TYPE_FORWARD_ONLY

ResultSet.TYPE_SCROLL_INSENSITIVE, or

ResultSet.TYPE_SCROLL_SENSITIVE

Note:  Throws the SQLException if a database access error occurs.

Syntax

public InputStream getUnicodeStream(int columnIndex) throws SQLException

where the columnIndex parameter is the column specification. The first column is 1, the second column is 2, and so on

Return

A Java input stream that delivers the database column value as a stream of two-byte Unicode characters is returned.

Note:  If the value is SQL NULL, then the result is null.

This method is particularly suitable for retrieving large LONGVARCHAR values. The JDBC driver will do any necessary conversion from the database format into Unicode.

The byte format of the Unicode stream must be Java UTF8, as defined in the Java Virtual Machine Specification.

All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream.

Also, a stream may return 0 when the method available is called, whether there is data available or not.

Syntax

public InputStream getUnicodeStream(String columnName) throws SQLException

where columnName is the SQL name of the column

Return

A Java input stream that delivers the database column value as a stream of two-byte Unicode characters is returned.

Note:  If the value is SQL NULL, then the result is null.

This method is particularly suitable for retrieving large LONGVARCHAR values. The JDBC driver will do any necessary conversion from the database format into Unicode.

The byte format of the Unicode stream must be Java UTF8, as defined in the Java Virtual Machine Specification.

All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream.

Also, a stream may return 0 when the method available is called, whether there is data available or not.

Syntax

public SQLWarning getWarnings() throws SQLException

Return

The first SQLWarning or null is returned.

Note:  This warning chain only covers warnings caused by ResultSet methods. Any warning caused by statement methods (such as reading OUT parameters) will be chained on the Statement object.

Syntax

public void insertRow() throws SQLException

Note:  Throws the SQLException if a database access error occurs, if this method is called when the cursor is not on the insert row, or if not all of non-nullable columns in the insert row have been given a value

Syntax

public boolean isAfterLast() throws SQLException

Return

True, if the cursor is located after the last row in the ResultSet object

False, if the ResultSet object contains no rows, or if the cursor is not located after the last row

Note:  Throws the SQLException if a database access error occurs.

Syntax

public boolean isBeforeFirst() throws SQLException

Return

True, if the cursor is located before the first row in the ResultSet object

False, if the ResultSet object contains no rows, or if the cursor is not located before the first row

Note:  Throws the SQLException if a database access error occurs.

Syntax

public boolean isFirst() throws SQLException

Return

True, if the cursor is located on the first row in the ResultSet object

False, if the cursor is not located on the first row

Note:  Throws the SQLException if a database access error occurs.

Syntax

public boolean isLast() throws SQLException

Return

True, if the cursor is located on the last row in the ResultSet object

False, if the cursor is not located on the last row

Note:  Throws the SQLException if a database access error occurs.

Calling isLast() may require the driver to fetch ahead one row to determine if the current row of the ResultSet object is the last row.

Syntax

public boolean last() throws SQLException

Return

True, if the cursor is repositioned to a valid row in the ResultSet object

False, if the cursor is not repositioned to a valid row in the ResultSet object

Note:  Throws the SQLException if a database access error occurs, or if the ResultSet type is TYPE_FORWARD_ONLY.

Syntax

public void moveToCurrentRow() throws SQLException

Note:  Throws the SQLException if a database access error occurs or the result set is not updatable.

Syntax

public void moveToInsertRow() throws SQLException

Note:  Throws the SQLException if a database access error occurs or the result set is not updatable.

Syntax

public boolean next() throws SQLException

Result

True, if the row where the cursor is repositioned is valid

False, if there are no more rows

Note:  A ResultSet cursor is initially positioned before its first row. The first call to next makes the first row the current row. The second call makes the second row the current row, and so forth.

If an input stream from the previous row is open, it is implicitly closed. The ResultSet’s warning chain is cleared when a new row is read.

Syntax

public boolean previous() throws SQLException

Return

True, if the row where the cursor is repositioned is valid

False, if the cursor is repositioned off the ResultSet

Note:  Throws the SQLException if a database access error occurs, or if the ResultSet type is TYPE_FORWARD_ONLY.

Syntax

public void refreshRow() throws SQLException

Note:  Throws the SQLException if a database access error occurs or if this method is called when the cursor is on the insert row.

Syntax

public boolean relative(int rows) throws SQLException

where the rows parameter is an integer that specifies the number of rows to move from the current position. To move forward, specify a positive number. Although 0 is valid, the cursor position will not change.

Return

True, if the row where the cursor is repositioned is valid

False, if otherwise

Note:  Throws the SQLException if a database access error occurs, if there is no current row, or if the ResultSet type is TYPE_FORWARD_ONLY.

Syntax

public boolean rowDeleted() throws SQLException

Return

True, if a row was deleted and the deletion was detected

False, if otherwise

Note:  The value returned is dependent on whether the ResultSet object is capable of detecting deletions.

Syntax

public boolean rowInserted() throws SQLException

Return

True, if insertions were made into the current row and the insertion was detected

False, if insertions were not made into the current row or the insertion was not detected

Note:  The value returned is dependent on whether the ResultSet object is capable of detecting visible inserts.

Syntax

public boolean rowUpdated() throws SQLException

Return

True, if updates were made into the current row and the updates were detected

False, if updates were not made into the current row or the updates were not detected

Note:  The value returned is dependent on whether the ResultSet object is capable of detecting visible updates.

Syntax

public void setFetchDirection(int direction) throws SQLException

where the direction parameter is the new fetch direction.

Syntax

public void setFetchSize(int rows) throws SQLException

where the rows parameter is the new fetch size.

Syntax

public void updateAsciiStream(int columnIndex, InputStream x, int length) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value
• length is the length of the stream

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateAsciiStream(String columnName, InputStream x, int length) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value
• length is the length of the stream

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBigDecimal(int columnIndex, BigDecimal x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBigDecimal(String columnName, BigDecimal x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBinaryStream(int columnIndex, InputStream x, int length) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value
• length is the length of the stream

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBinaryStream(String columnName, InputStream x, int length) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value
• length is the length of the stream

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBlob(int columnIndex, Blob x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBlob(String columnName, Blob x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateByte(int columnIndex, byte x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateByte(String columnName, byte x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBytes(int columnIndex, byte[] x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateBytes(String columnName, byte[] x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateCharacterStream(int columnIndex, Reader x, int length) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value
• length is the length of the stream

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateCharacterStream(String columnName, Reader x, int length) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value
• length is the length of the stream

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateClob(int columnIndex, Clob x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateClob(String columnName, Clob x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateDate(int columnIndex, Date x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateDate(String columnName, Date x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateDouble(int columnIndex, double x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateDouble(String columnName, double x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateFloat(int columnIndex, float x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateFloat(String columnName, float x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateInt(int columnIndex, int x)throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateInt(String columnName, int x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateLong(int columnIndex, long x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateLong(String columnName, long x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateNull(int columnIndex) throws SQLException

where the parameter columnIndex is the column specification. The first column is 1, the second column is 2, and so forth

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateNull(String columnName)throws SQLException

where the parameter columnName is the name of the column

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateObject(int columnIndex, Object x)throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateObject(int columnIndex, Object x, int scale)throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value
• scale is the number of digits after the decimal point (for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC). For all other types, this value is ignored.

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateObject(String columnName, Object x)throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateObject(String columnName, Object x, int scale) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value
• scale is the number of digits after the decimal point (for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types). For all other types, this value is ignored.

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateRow()throws SQLException

Note:  Throws the SQLException if a database access error occurs or if this method is called when the cursor is on the insert row.

Syntax

public void updateShort(int columnIndex, short x)throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateShort(String columnName, short x)throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateSQLXML(int columnIndex, SQLXML x) throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws SQLException if a database access error occurs.

This method is supported beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.19.

JDK 6.0 or later is required to use SQLXML functionality.

Syntax

public void updateShort(String columnName, short x) throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws SQLException if a database access error occurs.

This method is supported beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.19.

JDK 6.0 or later is required to use SQLXML functionality.

Syntax

public void updateString(int columnIndex, String x)throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateString(String columnName, String x)throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateTime(int columnIndex, Time x)throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateTime(String columnName, Time x)throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateTimestamp(int columnIndex, Timestamp x)throws SQLException

where the parameter:

• columnIndex is the column specification. The first column is 1, the second column is 2, and so forth
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public void updateTimestamp(String columnName, Timestamp x)throws SQLException

where the parameter:

• columnName is the name of the column
• x is the new column value

Note:  Throws the SQLException if a database access error occurs.

Syntax

public boolean wasNull() throws SQLException

Return

True, if the last column read was SQL NULL

False, if otherwise

Note:  You must first call getXXX on a column to try to read its value and then call wasNull() to find if the value was the SQL NULL.

getCatalogName(int column)

Yes

getColumnClassName(int column)

Yes

getColumnCount()

Yes

getColumnDisplaySize(int column)

Yes

getColumnLabel(int column)

Yes

getColumnName(int column)

Yes

getColumnType(int column)

Yes

getColumnTypeName(int column)

Yes

getPrecision(int column)

Yes

getScale(int column)

Yes

getSchemaName(int column)

Yes

getTableName(int column)

Yes

isAutoIncrement(int column)

Yes

isCaseSensitive(int column)

Yes

isCurrency(int column)

Yes*

isDefinitelyWritable(int column)

Yes

isNullable(int column)

Yes

isReadOnly(int column)

Yes

isSearchable(int column)

Yes

isSigned(int column)

Yes

isWritable(int column)

Yes

Syntax

public String getCatalogName(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

A zero-length string "" by default, to indicate that the database does not support catalogs.

Or a JSON string containing all the result set column metadata received from the database, when the escape function {fn teradata_provide(request_scope_catalog_json)} is specified in the SQL request, beginning with Teradata JDBC Driver 20.00.00.06.

Syntax

public String getColumnClassName(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second is 2, and so on.

Return

The fully qualified name of the class in the Java programming language whose instances would be returned by the method PreparedStatementResultSet.getObject. If there is an entry in the connection's type map for the object, the Java class name mapped to the UDT is returned.

null is returned if the Class name cannot be determined.

Syntax

public int getColumnCount() throws SQLException

Return

The number of columns is returned.

Syntax

public int getColumnDisplaySize(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

column width in characters; zero if not applicable.

With Teradata Database V2R6.1 and earlier, the display size for any character data type is calculated with respect to the Teradata session character set, and assumes that the DBSControl Export Width Table ID is set to zero. The display size may not be accurate for character data types if the CLIENT_CHARSET connection parameter is specified, or if the DBSControl Export Width Table ID is set to something other than zero.

Syntax

public String getColumnLabel(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

column title if connection parameter COLUMN_NAME=OFF is specified, or COLUMN_NAME is omitted, or JDBC Escape function {fn teradata_provide(request_scope_column_name_off)} is specified in the SQL request.

Beginning with Teradata JDBC Driver 16.00.00.28, returns AS-clause name if available, or the column name if available, or the column title, if connection parameter COLUMN_NAME=ON is specified, or JDBC Escape function {fn teradata_provide(request_scope_column_name_on)} is specified in the SQL request.

Syntax

public String getColumnName(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

AS-clause name if available, or the column name if available, or the column title, if connection parameter COLUMN_NAME=OFF is specified, or COLUMN_NAME is omitted, or JDBC Escape function {fn teradata_provide(request_scope_column_name_off)} is specified in the SQL request.

Beginning with Teradata JDBC Driver 16.00.00.28, returns column name if available, if connection parameter COLUMN_NAME=ON is specified, or JDBC Escape function {fn teradata_provide(request_scope_column_name_on)} is specified in the SQL request.

Syntax

public int getColumnType(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on

Return

SQL type from java.sql.Types.

java.sql.Types.NULL will be returned if the column type cannot be determined.

Syntax

public String getColumnTypeName(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

the name of the column's data type, as used by the database. If the column type is a user-defined type, then a fully qualified type name is returned.

null is returned if the column typeName cannot be determined.

Syntax

public int getPrecision(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

precision. Zero is returned if precision is not applicable to the column.

Syntax

public int getScale(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

scale. Zero is returned if scale is not applicable to the column.

Syntax

public String getSchemaName(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

schema name, or "" (zero-length string) if not applicable.

Syntax

public String getTableName(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

table name, or "" (zero-length string) if not applicable.

Syntax

public boolean isAutoIncrement(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public boolean isCaseSensitive(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public boolean isCurrency(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public boolean isDefinitelyWritable(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public int isNullable(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

the column's nullability status; one of the values:

ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown.

Beginning with Teradata JDBC Driver 16.00.00.28, when connection parameter MAYBENULL=ON is specified, and/or JDBC escape function {fn teradata_provide(request_scope_maybenull_on)} is specified in the SQL request, and StatementInfo parcel support is available, the return value is determined from the StatementInfo parcel MayBeNull field, rather than the IsNullable field.

Syntax

public boolean isReadOnly(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public boolean isSearchable(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public boolean isSigned(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

Syntax

public boolean isWritable(int column) throws SQLException

where the column parameter specifies the column - the first column is 1, the second column is 2, and so on.

Return

True, if so; False, otherwise

free()

Yes

getBinaryStream()

Yes

getCharacterStream()

Yes

getSource(Class<T> sourceClass)

Yes

getString()

Yes

setBinaryStream()

Yes

setCharacterStream()

Yes

setResult(Class<T> resultClass)

Yes

setString()

Yes

Syntax

public void free() throws SQLException

Note:  This method is supported beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.19.

JDK 6.0 or later is required to use SQLXML functionality.

The SQLXML Object becomes not readable and not writable after this method is called.

Syntax

public InputStream getBinaryStream() throws SQLException

Return

A Stream containing the XML data.

Note:  This method is supported beginning with Teradata Database 14.10 and Teradata JDBC Driver 14.00.00.19.