JDBC Interfaces A-L

getArray()

Yes

getArray(long index, int count)

Yes

getArray(long index, int count, Map map)

Yes

getArray(Map map)

Yes

getBaseType()

Yes

getBaseTypeName()

Yes

getResultSet()

Yes

getResultSet(long index, int count)

Yes

getResultSet(long index, int count, Map map)

Yes

getResultSet(Map map)

Yes

Syntax

public Object getArray() throws SQLException

Return

An array in the Java programming language that contains the ordered elements of the SQL ARRAY value designated by this Array object.

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

This method uses the type map associated with the connection for customizations of the type mappings of Struct objects received from the database. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

Syntax

public Object getArray(long index, int count) throws SQLException

where the parameter:

• index is the array index of the first element to retrieve;

  the first element is at index 1

• count is the number of successive SQL array elements to retrieve

Return

An array containing up to count consecutive elements of the SQL array, beginning with element index.

Note:  This method is supported beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04, and may only be used with a one-dimensional ARRAY type.

This method uses the type map associated with the connection for customizations of the type mappings of Struct objects received from the database. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

Syntax

public Object getArray(long index, int count, Map map) throws SQLException

where the parameter:

• index is the array index of the first element to retrieve;

  the first element is at index 1

• count is the number of successive SQL array elements to retrieve
• map is a java.util.Map object that contains SQL type names and the classes in the Java programming language to which they are mapped

Return

An array containing up to count consecutive elements of the SQL ARRAY value designated by this Array object, beginning with element index.

Note:  This method is supported beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04, and may only be used with a one-dimensional ARRAY type.

This method uses the specified type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

Syntax

public Object getArray(Map map) throws SQLException

where the parameter:

• map is a java.util.Map object that contains mappings of SQL type names to classes in the Java programming language

Return

An array in the Java programming language that contains the ordered elements of the SQL array designated by this object.

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

This method uses the specified type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

Syntax

public int getBaseType() throws SQLException

Return

A constant from the class java.sql.Types that is the type code for the elements in the array designated by this Array object.

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

Syntax

public String getBaseTypeName() throws SQLException

Return

a String that is the database-specific name for a built-in base type; or the fully-qualified SQL type name for a base type that is a UDT.

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

Syntax

public ResultSet getResultSet() throws SQLException

Return

a java.sql.ResultSet object containing one row for each of the elements in the array designated by this Array object, with the rows in ascending order based on the indices.

Note:  This method is supported beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04, and may only be used with a one-dimensional ARRAY type.

This method uses the type map associated with the connection for customizations of the type mappings of Struct objects received from the database. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

Syntax

public ResultSet getResultSet(long index, int count) throws SQLException

where the parameter:

• index is the array index of the first element to retrieve;

  the first element is at index 1

• count is the number of successive SQL array elements to retrieve

Return

A ResultSet object containing up to count consecutive elements of the SQL array designated by this Array object, starting at index index.

Note:  This method is supported beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04, and may only be used with a one-dimensional ARRAY type.

This method uses the type map associated with the connection for customizations of the type mappings of Struct objects received from the database. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

Syntax

public ResultSet getResultSet(long index, int count, Map map) throws SQLException

where the parameter:

• index is the array index of the first element to retrieve;

  the first element is at index 1

• count is the number of successive SQL array elements to retrieve
• map is a java.util.Map object that contains SQL type names and the classes in the Java programming language to which they are mapped

Return

A ResultSet object containing up to count consecutive elements of the SQL array designated by this Array object, starting at index index.

Note:  This method is supported beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04, and may only be used with a one-dimensional ARRAY type.

This method uses the specified type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

The result set contains one row for each array element, with two columns in each row. The second column stores the element value; the first column stores the index into the array for that element (with the first array element being at index 1). The rows are in ascending order corresponding to the order of the indices.

Syntax

public ResultSet getResultSet(Map map) throws SQLException

where the parameter:

• map is a java.util.Map object that contains mappings of SQL user-defined type names to classes in the Java programming language

Return

A ResultSet object containing one row for each of the elements in the array designated by this Array object, with the rows in ascending order based on the indices.

Note:  This method is supported beginning with Teradata Database 14.0 and Teradata JDBC Driver 14.00.00.04, and may only be used with a one-dimensional ARRAY type.

This method uses the specified type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. An Array object created by the Connection createArrayOf method is not subject to JDBC custom type mapping.

The result set contains one row for each array element, with two columns in each row. The second column stores the element value; the first column stores the index into the array for that element (with the first array element being at index 1). The rows are in ascending order corresponding to the order of the indices.

free()

Yes

getBinaryStream()

Yes

getBytes(long pos, int length)

Yes

length()

Yes

position(Blob pattern, long start)

No

position(byte[] pattern, long start)

No

setBinaryStream(long pos)

Yes

setBytes(long pos, byte[] bytes)

Yes

setBytes(long pos, byte[] bytes, int offset, int len)

Yes

truncate(long len)

Yes

Syntax

public void free() throws SQLException

Syntax

public InputStream getBinaryStream() throws SQLException

Return

A stream containing the BLOB data is returned.

Syntax

public byte[] getBytes(long pos, integer length) throws SQLException

where

• pos is the ordinal position of the first byte in the BLOB value that is extracted.

  The first byte is position 1.

• length is the number of consecutive bytes that is copied

Return

A byte array of size length containing consecutive bytes from the BLOB value is returned.

Syntax

public long length() throws SQLException

Return

The length of the BLOB in bytes is returned.

Syntax

public OutputStream setBinaryStream(long pos) throws SQLException

where the parameter pos is the position in the BLOB value at which to start writing

Return

A java.io.OutputStream object to which data can be written is returned.

Syntax

public int setBytes(long pos, byte[] bytes) throws SQLException

where the parameter:

• pos is the position in the BLOB object at which to start writing
• bytes is the array of bytes to be written to the BLOB value that this BLOB object represents

Return

The number of bytes written is returned.

 

Note:  The maximum length of bytes that can be set is 64000.

Syntax

public int setBytes(long pos, byte[] bytes, int offset, int len) throws SQLException

where the parameter:

• pos is the position in the BLOB object at which to start writing
• bytes is the array of bytes to be written to this BLOB object
• offset is the offset into the array bytes at which to start reading the bytes to be set
• len is the number of bytes to be written to the BLOB value from the array of bytes

Return

The number of bytes written is returned.

 

Note:  The maximum length of bytes that can be set is 64000.

Syntax

public void truncate(long len) throws SQLException

where the parameter len is the length, in bytes, to truncate the BLOB value that this BLOB object represents

free()

Yes

getAsciiStream()

Yes

getCharacterStream()

Yes

getSubString(long pos, int length)

Yes

length()

Yes

position(Clob searchstr, long start)

No

position(String searchstr, long start)

No

setAsciiStream(long pos)

Yes

setCharacterStream(long pos)

Yes

setString(long pos, String str)

Yes

setString(long pos, String str, int offset, int len)

Yes

truncate(long len)

Yes

Syntax

public void free() throws SQLException

Syntax

public InputStream getAsciiStream() throws SQLException

Return

A java.io.InputStream object containing the data in the CLOB is returned.

Syntax

public Reader getCharacterStream() throws SQLException

Return

A java.io.Reader object containing the data in the CLOB is returned.

Syntax

public String getSubString(long pos, int length) throws SQLException

where the parameter:

• pos is the first character of the substring to be extracted.

  The first character is located at position 1.

• length is the number of consecutive characters copied

Return

The specified substring in the CLOB as a String is returned.

Syntax

public long length() throws SQLException

Return

The length of the CLOB is returned.

Syntax

public OutputStream setAsciiStream(long pos) throws SQLException

where the parameter pos is the position at which to start writing to this CLOB object

Return

The stream to which ASCII-encoded characters can be written is returned.

Syntax

public Writer setCharacterStream(long pos) throws SQLException

where the parameter pos is the position at which to start writing to the CLOB value

Return

A stream to which Unicode-encoded characters can be written is returned.

Syntax

public int setString(long pos, String str) throws SQLException

where the parameter:

• pos is the position at which to start writing to the CLOB value that this CLOB object represents
• str is the string to be written to the CLOB value that this CLOB designates

Return

The number of characters written is returned.

Note:  The maximum number of bytes that can be set is 64000.

Syntax

public int setString(long pos, String str, int offset, int len) throws SQLException

where the parameter:

• pos is the position at which to start writing to this CLOB object
• str is the string to be written to the CLOB value that this CLOB object represents
• offset is the offset into str to start reading the characters to be written
• len is the number of characters to be written

Return

The number of characters written is returned.

Note:  The maximum number of bytes that can be set is 64000.

Syntax

public void truncate(long len) throws SQLException

where the parameter len is the length, in bytes, to which the CLOB value truncates

getArray(int parameterIndex)

Yes

getBigDecimal(int parameterIndex)

Yes

getBigDecimal(int parameterIndex, int scale) [DEPRECATED]

Yes

getBlob(int i)

Yes

getBoolean(int parameterIndex)

Yes

getByte(int parameterIndex)

Yes

getBytes(int parameterIndex)

Yes

getClob(int i)

Yes

getDate(int parameterIndex)

Yes

getDate(int parameterIndex, Calendar cal)

Yes

getDouble(int parameterIndex)

Yes

getFloat(int parameterIndex)

Yes

getInt(int parameterIndex)

Yes

getLong(int parameterIndex)

Yes

getObject(int parameterIndex)

Yes

getObject(int i, Map map)

Yes

getRef(int i)

No

getShort(int parameterIndex)

Yes

getSQLXML(int parameterIndex)

Yes

getString(int parameterIndex)

Yes

getTime(int parameterIndex)

Yes

getTime(int parameterIndex, Calendar cal)

Yes

getTimestamp(int parameterIndex)

Yes

getTimestamp(int parameterIndex, Calendar cal)

Yes

registerOutParameter(int parameterIndex, int sqlType)

Yes

registerOutParameter(int parameterIndex, int sqlType, int scale)

Yes

registerOutParameter(int parameterIndex, int sqlType, String typeName)

Yes

wasNull()

Yes

Syntax

public Array getArray(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value as an Array Object is returned. If the value is SQL NULL, 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 BigDecimal getBigDecimal(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value in full precision is returned. If the value is SQL NULL, the result is null.

Syntax

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

where:

• the first parameterIndex parameter is 1, the second is 2, and so on
• scale is the number of digits to the right of the decimal point

Return

The parameter value in full precision is returned. If the value is SQL NULL, the result is null.

Syntax

public boolean getBoolean(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is false.

Syntax

public byte getByte(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is 0.

Syntax

public byte[] getBytes(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Syntax

public Date getDate(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Note:  Maps to ResultSet.getDate(); see this method for further information.

Syntax

public Date getDate(int parameterIndex, Calendar cal) throws SQLException

where

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

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Note:  Maps to ResultSet.getDate(); see this method for further information.

Syntax

public double getDouble(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is 0.

Syntax

public float getFloat(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is 0.

Syntax

public int getInt(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is 0.

Syntax

public InputStream getLobData() throws SQLException

Return

The Lob data from the input stream to the database is returned.

Syntax

public int getLong(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is 0.

Syntax

public Object getObject(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

A java.lang.Object holding the OUT parameter value is returned.

Note:  This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

Syntax

public short getShort(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is 0.

Syntax

public SQLXML getSQLXML(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

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 String getString(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Note:  For the fixed-length type JDBC CHAR, the String object returned has exactly the same value the JDBC CHAR value had in the database, including any padding added by the database.

Syntax

public Time getTime(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Note:  Maps to ResultSet.getDate(); see this method for further information.

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Note:  Maps to ResultSet.getTime(); see this method for further information.

Syntax

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

where

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

Note:  Maps to ResultSet.getDate(); see this method for further information.

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Note:  Maps to ResultSet.getTime(); see this method for further information.

Syntax

public Timestamp getTimestamp(int parameterIndex) throws SQLException

where the first parameterIndex parameter is 1, the second is 2, and so on

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Note:  Maps to ResultSet.getTimestamp(); see this method for further information.

Syntax

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

where

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

Return

The parameter value is returned. If the value is SQL NULL, the result is null.

Note:  Maps to ResultSet.getTimestamp(); see this method for further information.

Syntax

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

where

• the first parameterIndex parameter is 1, the second is 2, and so on
• sqlType is the JDBC type code defined by java.sql.Types. If the parameter is of type Numeric or Decimal, the version of registerOutParameter that accepts a scale value should be used.

Note:  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.

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method getObject(int) retrieves the value.

Syntax

public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException

where

• the first parameterIndex parameter is 1, the second is 2, and so on
• sqlType is the JDBC type code defined by java.sql.Types. If the parameter is of type Numeric or Decimal, the version of registerOutParameter that accepts a scale value should be used.
• scale is the desired number of digits to the right of the decimal point. It must be greater than or equal to 0.

Note:  This method must be called 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.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Syntax

public void registerOutParameter(int parameterIndex, int sqlType, String typename) throws SQLException

where

• the first parameterIndex parameter is 1, the second is 2, and so on
• sqlType is the JDBC type code defined by java.sql.Types. If the parameter is of type Numeric or Decimal, the version of registerOutParameter that accepts a scale value should be used.
• typename is the fully qualified name of an SQL structured type.

Note:  The last parameter is ignored.

Syntax

public boolean wasNull() throws SQLException

Return

True, if the last parameter read was SQL NULL

False, otherwise

Note:  This method should be called only after calling the get method; otherwise, there is no value to use in determining whether it is null or not.

clearWarnings()

Yes

close()

Yes

commit()

Yes

createArrayOf(String typeName, Object[] elements)

Yes

createBlob()

Yes

createClob()

Yes

createSQLXML()

Yes

createStatement()

Yes

createStatement(int resultSetType, int resultSetConcurrency)

Yes

createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)

Yes

createStruct(String typeName, Object[] attributes)

Yes

getAutoCommit()

Yes

getCatalog()

Yes*

getClientInfo()

Yes

getClientInfo(String name)

Yes

getHoldability()

Yes

getMetaData()

Yes

getTransactionIsolation()

Yes

getTypeMap()

Yes

getWarnings()

Yes

isClosed()

Yes

isReadOnly() (always returns False)

Yes*

nativeSQL(String sql)

Yes

prepareCall(String sql)

Yes

prepareCall(String sql, int resultSetType, int resultSetConcurrency)

Yes

prepareStatement(String sql)

Yes

prepareStatement(String sql, int autoGeneratedKeys)

Yes

prepareStatement(String sql, int[ ] columnIndexes)

Yes

prepareStatement(String sql, String[ ] columnNames)

Yes

prepareStatement(String sql, int resultSetType, int resultSetConcurrency)

Yes

prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)

Yes

rollback()

Yes

setAutoCommit(boolean autoCommit)

Yes

setCatalog(String catalog)

Yes*

setClientInfo(Properties properties)

Yes

setClientInfo(String name, String value)

Yes

setHoldability(int holdability)

Yes

setReadOnly(boolean readonly)

No

setTransactionIsolation(int level)

Yes

setTypeMap(Map map)

Yes

Syntax

public void clearWarnings() throws SQLException

Syntax

public void close() throws SQLException

Note:  A Connection is automatically closed when it is garbage collected. Certain fatal errors also result in a closed Connection.

Syntax

public void commit() throws SQLException

Note:  This method is only to be used when auto-commit is disabled. See also setAutoCommit(boolean autoCommit).

Syntax

public Array createArrayOf(String typeName, Object[] elements) throws SQLException

where the parameter:

• typeName is the SQL name of the type the elements of the array map to
• elements is the elements that populate the returned object

Return

An Array whose elements map to the specified SQL type.

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

Syntax

public Blob createBlob() throws SQLException

Return

An object that implements the Blob interface.

Note:  This method is supported beginning with Teradata JDBC Driver 20.00.00.43.

Syntax

public Clob createClob() throws SQLException

Return

An object that implements the Clob interface.

Note:  This method is supported beginning with Teradata JDBC Driver 20.00.00.43.

Syntax

public SQLXML createSQLXML() throws SQLException

Return

An object that implements the SQLXML interface.

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 Statement createStatement() throws SQLException

Return

A new statement object is returned.

Note:  SQL statements without parameters are normally executed using statement objects. If the same SQL statement is executed many times, it is more efficient to use a prepared statement.

Syntax

public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException

where the parameter:

• resultSetType is a result set type
• resultSetConcurrency is a concurrency type

Return

A new statement object is returned.

Note:  SQL statements without parameters are normally executed using statement objects. If the same SQL statement is executed many times, it is more efficient to use a prepared statement.

Syntax

public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException

where the parameter:

• resultSetType is a result set type
• resultSetConcurrency is a result set concurrency
• resultSetHoldability is a result set holdability

Return

A new statement object is returned.

Note:  SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement.

Syntax

public Struct createStruct(String typeName, Object[] attributes) throws SQLException

where the parameter:

• typeName is the SQL type name of the SQL structured type that this Struct object maps to
• attributes is the attributes that populate the returned object

Return

A Struct object that maps to the given SQL type and is populated wtih the given attributes.

Note:  This method is available beginning with Teradata Database 13.10 and Teradata JDBC Driver 13.10.00.12.

Syntax

public boolean getAutoCommit() throws SQLException

Return

Current state of auto-commit mode is returned.

Syntax

public String getCatalog() throws SQLException

Return

Catalog name for the connection or null is returned.

Note:  Since the database does not support catalogs, ““ is always returned.

Syntax

public Properties getClientInfo() throws SQLException

Return

A Properties object that contains the name and value of each item in the Connection query band. This method returns an empty Properties object if no query band has been set. If the same query band name is active for multiple contexts, only one of the corresponding query band values will be returned. Transaction query band values take precedence over session query band values, which take precedence over profile query band values.

Note:  This method is supported beginning with Teradata Database 12.0 and Teradata JDBC Driver 14.00.00.33.

JDK 6.0 or later is required to use this method.

Profile query band values are supported beginning with Teradata Database 15.10 and Teradata JDBC Driver 15.00.00.23.

Syntax

public String getClientInfo(String name) throws SQLException

where the parameter:

• name is a Query Band name

Return

The query band value specified by name. This method returns null if the specified name has not been set in the query band. If the same query band name is active for multiple contexts, only one of the corresponding query band values will be returned. Transaction query band values take precedence over session query band values, which take precedence over profile query band values.

Note:  This method is supported beginning with Teradata Database 12.0 and Teradata JDBC Driver 14.00.00.33.

JDK 6.0 or later is required to use this method.

Profile query band values are supported beginning with Teradata Database 15.10 and Teradata JDBC Driver 15.00.00.23.

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 DatabaseMetaData getMetaData() throws SQLException

Return

A DatabaseMetaData object for this Connection is returned.

Syntax

public int getTransactionIsolation() throws SQLException

Return

Returns the current transaction isolation level, which will be one of the following constants: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, Connection.TRANSACTION_SERIALIZABLE, or Connection.TRANSACTION_NONE

Syntax

public Map<String,Class<?>> getTypeMap() throws SQLException

Return

Returns the java.util.Map object associated with this Connection object.

Syntax

public SQLWarning getWarnings() throws SQLException

Return

The first SQL warning or null is returned.

Note:  Subsequent warnings will be chained to this SQL warning.

Syntax

public boolean isClosed() throws SQLException

Return

True, if the Connection is closed

False, if the Connection is still open

Syntax

public boolean isReadOnly() throws SQLException

Return

True, if the connection is read-only

False, if the connection is otherwise

Note:  isReadOnly always returns False.

Note:  isReadOnly always returns False.

Syntax

public String nativeSQL(String sql) throws SQLException

where the sql parameter is an SQL statement that may contain one or more question-mark parameter placeholders

Return

The native form of this statement is returned.

Syntax

public CallableStatement prepareCall(String sql) throws SQLException

where the sql parameter is an SQL statement that may contain one or more question-mark parameter placeholders

Typically this statement is a JDBC function call escape string.

Return

A new CallableStatement object containing the prepared SQL statement is returned.

Note:  The CallableStatement provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done. Others may wait until the CallableStatement is executed. Though this has no direct effect on users, it does affect which method throws certain SQLExceptions.

ResultSets created using the returned CallableStatement have forward-only type and read-only concurrence, by default.

Syntax

public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException

where the parameter:

• sql is an SQL statement that may contain one or more question-mark parameter placeholders. Typically, this statement is a JDBC function call escape string.
• resultSetType is a result set type
• resultSetConcurrency is a concurrency type

Return

A new CallableStatement object containing the prepared SQL statement is returned.

Note:  The CallableStatement provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done. Others may wait until the CallableStatement is executed. Though this has no direct effect on users, it does affect which method throws certain SQLExceptions.

ResultSets created using the returned CallableStatement have forward‑only type and read‑only concurrence, by default.

Syntax

public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException

where the parameter:

• sql is a SQL statement that may contain one or more question-mark parameter placeholders. Typically, this statement is a JDBC procedure call escape string.
• resultSetType is a result set type
• resultSetConcurrency is a result set concurrency
• resultSetHoldability is a result set holdability

Return

A new CallableStatement object containing the prepared SQL statement is returned.

Note:  The CallableStatement provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done. Others may wait until the CallableStatement is executed. Though this has no direct effect on users, it does affect which method throws certain SQLExceptions.

ResultSets created using the returned CallableStatement have forward‑only type and read‑only concurrence, by default.

Syntax

public PreparedStatement prepareStatement(String sql) throws SQLException

where the sql parameter is an SQL statement that may contain one or more question-mark IN parameter placeholders

Return

A new PreparedStatement object containing the prepared statement is returned.

Note:  An SQL statement with or without IN parameters can be prepared and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

This method is optimized for handling parametric SQL statements that benefit from precompilation.

If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation.

Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement is executed. Though this has no direct effect on users, it does affect which method throws certain SQLExceptions.

ResultSets created using the returned PreparedStatement have forward‑only type and read‑only concurrence, by default.

Connection.prepareStatement(String query) will send the query to the database for parsing. If there is an error with the query, an exception will be generated at this time (example: the table is not yet created).

For earlier releases, Connection.prepareStatement(String query) only stored the query instead of sending it to the database for parsing, so no JDBC Exception is generated (example: if the table had not yet been created).

Syntax

public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException

where the parameter:

• sql is an SQL statement that may contain one or more question-mark IN parameter placeholders
• columnIndexes is an array of column indexes indicating the columns that should be returned from the inserted row or rows

Return

A new PreparedStatement object, containing the prepared statement that is capable of returning the auto-generated keys designated by the given array of column indexes is returned.

Syntax

public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException

where the parameter:

• sql is an SQL statement that may contain one or more question-mark IN parameter placeholders
• columnNames is an array of column names indicating the columns that should be returned from the inserted row or rows

Return

A new PreparedStatement object, containing the prepared statement that is capable of returning the auto-generated keys designated by the given array of column names is returned.

Syntax

public PreparedStatement prepareStatement(String sql, int autogeneratedKeys) throws SQLException

where the parameter:

• sql is an SQL statement that may contain one or more question-mark IN parameter placeholders
• autogeneratedKeys is a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

Return

A new PreparedStatement object, containing the prepared SQL statement that will have the capability of returning auto-generated keys is returned.

Note:  If a database access error occurs or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned, throws and SQLException.

Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement is executed. Though this has no direct effect on users, it does affect which method throws certain SQLExceptions.

ResultSets created using the returned PreparedStatement have forward‑only type and read‑only concurrence, by default.

Syntax

public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException

where the parameter:

• sql is an SQL statement that may contain one or more question-mark IN parameter placeholders
• resultSetType is a result set type
• resultSetConcurrency is a concurrency type

Return

A new PreparedStatement object containing the prepared statement is returned.

Note:  An SQL statement with or without IN parameters can be prepared and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

This method is optimized for handling parametric SQL statements that benefit from precompilation.

Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement is executed. Though this has no direct effect on users, it does affect which method throws certain SQLExceptions.

Syntax

public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException

where the parameter:

• sql is a SQL statement that may contain one or more question-mark IN parameter placeholders
• resultSetType is a result set type
• resultSetConcurrency is a result set concurrency
• resultSetHoldability is a result set holdability

Return

A new PreparedStatement object containing the prepared statement is returned.

Note:  A SQL statement with or without IN parameters can be prepared and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

This method is optimized for handling parametric SQL statements that benefit from precompilation.

Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement is executed. Though this has no direct effect on users, it does affect which method throws certain SQLExceptions.

Syntax

public void rollback() throws SQLException

Note:  This method is only to be used when auto-commit is disabled.

See also setAutoCommit(boolean autoCommit).

Syntax

public void setAutoCommit(boolean autoCommit) throws SQLException

where the autoCommit parameter is the enable/disable specification:

True enables auto-commit

False disables auto-commit

Note:  The commit occurs when the statement completes or the next execute occurs, whichever comes first.

In the case of statements returning a ResultSet, the statement completes when the last row of the ResultSet has been retrieved or the ResultSet has been closed.

In advanced cases, a single statement may return multiple results as well as output parameter values. Here the commit occurs when all results and output parameter values have been retrieved.

Syntax

public void setCatalog(String catalog) throws SQLException

where the catalog parameter is a catalog name

Note:  As per the standard, setCatalog is silently ignored.

Syntax

public void setClientInfo(Properties properties) throws SQLClientInfoException

where the parameter:

• properties is a list of client info properties used to replace the current query band. If properties is null or empty, all current properties of the query band are cleared.

Note:  If auto-commit is on, the session query band is replaced and if auto-commit is off, the transaction query band is replaced.

This method is supported beginning with Teradata Database 13.10 and Teradata JDBC Driver 20.00.00.00.

JDK 6.0 or later is required to use this method.

Profile query band values are supported beginning with Teradata Database 15.10 and Teradata JDBC Driver 15.00.00.23.

Syntax

public void setClientInfo(String name, String value) throws SQLClientInfoException

where the parameter:

• name is a Query Band name
• value is a Query Band value. If value is null, this property will be removed from the query band.

Note:  If auto-commit is on, the session query band is updated and if auto-commit is off, the transaction query band is updated.

This method is supported beginning with Teradata Database 13.10 and Teradata JDBC Driver 20.00.00.00.

JDK 6.0 or later is required to use this method.

Profile query band values are supported beginning with Teradata Database 15.10 and Teradata JDBC Driver 15.00.00.23.

Syntax

public void setHoldability(int holdability) throws SQLException

where the holdability parameter is one of the following ResultSet constants:

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.

Changing the result set holdability of the Connection does not change the result set holdability of existing Statement, PreparedStatement, and CallableStatement objects. Changing the result set holdability of the Connection only specifies the result set holdability for Statement, PreparedStatement, and CallableStatement objects subsequently created on that Connection using one of the Connection create/prepare methods without a holdability argument. When a Statement, PreparedStatement, or CallableStatement is created using a Connection create/prepare method having a holdability argument, then the method's holdability argument overrides the Connection's result set holdability.

When auto-commit is on for the Connection, CLOSE_CURSORS_AT_COMMIT applies to result sets of Statements other than the Statement being executed.

CLOSE_CURSORS_AT_COMMIT applies to query result sets, and also applies to generated-key result sets returned by the Statement.getGeneratedKeys method.

A multi-statement request (MSR) can return multiple result sets. When an auto-commit or an explicit commit occurs, the Teradata JDBC Driver closes all MSR result sets with CLOSE_CURSORS_AT_COMMIT holdability for which at least one row has been received from the database. When the application subsequently calls the Statement.getMoreResults and Statement.getResultSet methods, it is possible for the Statement.getResultSet method to return a result set that is already closed. In contrast, an MSR result set will not be closed if none of its rows have been received yet from the database.

Syntax

public void setTransactionIsolation(int level) throws SQLException

where the level parameter is one of the following Connection constants:

Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE

Note:  Connection.TRANSACTION_NONE cannot be used because it specifies that transactions are not supported.

Note:  If the requested transaction isolation level is not supported, it will be mapped to a higher, more restrictive supported transaction isolation level. The DatabaseMetaData method supportsTransactionIsolationLevel may be used to determine whether or not the driver supports a given level.

Syntax

public void setTypeMap(Map<String,Class<?>> map) throws SQLException

where the map parameter is the java.util.Map object to install as the replacement for this Connection object's default type map

connectionClosed(ConnectionEvent event)

Yes

connectionErrorOccurred(ConnectionEvent event)

Yes

Syntax

public void connectionClosed(ConnectionEvent event)

where the event parameter is an event object describing the source of the event

Syntax

public void connectionErrorOccurred(ConnectionEvent event)

where the event parameter is an event object describing the source of the event. It contains the SQLException that the driver throws.

getLoginTimeout()

Yes

getLogWriter()

Yes

getMaxStatements()

Yes

getPooledConnection()

Yes

getPooledConnection(String username, String password)

Yes

setLoginTimeout(int seconds)

Yes

setLogWriter(PrintWriter out)

Yes

Syntax

public int getLoginTimeout() throws SQLException

Return

The DataSource login timeout value is returned.

Syntax

public PrintWriter getLogWriter() throws SQLException

Return

The log writer for this connection pool data source object is returned; a null if disabled.

Syntax

public PooledConnection getPooledConnection() throws SQLException

Return

A pooled connection to the database is returned.

Syntax

public PooledConnection getPooledConnection(String username, String password) throws SQLException

where the parameter:

• username is the database user on whose behalf the Connection is being made
• password is the user’s password

Return

A Connection to the database is returned.

Syntax

public void setLoginTimeout(int seconds) throws SQLException

where the seconds parameter is the data source login time limit

Note:  Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies no timeout. When a DataSource object is created, the login timeout is initially zero.

Syntax

public void setLogWriter(PrintWriter out) throws SQLException

where the out parameter is the new log writer; to disable logging, set to null

Return

The log writer for this data source is returned; a null if disabled.

Note:  The log writer is a character output stream to which all logging and tracing messages for this data source object instance are printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on.

Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created, the log writer is initially null; logging is disabled.

allProceduresAreCallable()

Yes

allTablesAreSelectable()

Yes

dataDefinitionCausesTransactionCommit()

Yes

dataDefinitionIgnoredInTransactions()

Yes

deletesAreDetected(int type)

Yes

doesMaxRowSizeIncludeBlobs()

Yes

getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)

Yes

getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)

Yes

getCatalogs()

Yes*

getCatalogSeparator()

Yes*

getCatalogTerm()

Yes*

getClientInfoProperties()

Yes

getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)

Yes

getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)

Yes

getConnection()

Yes

getCrossReference(String primaryCatalog, String primarySchemaPattern, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)

Yes

getDatabaseMajorVersion()

Yes

getDatabaseMinorVersion()

Yes

getDatabaseProductName()

Yes

getDatabaseProductVersion()

Yes

getDefaultTransactionIsolation()

Yes

getDriverMajorVersion()

Yes

getDriverMinorVersion()

Yes

getDriverName()

Yes

getDriverVersion()

Yes

getExportedKeys(String catalog, String schema, String table)

Yes

getExtraNameCharacters()

Yes

getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern)

Yes

getFunctions(String catalog, String schemaPattern, String functionNamePattern)

Yes

getIdentifierQuoteString()

Yes

getImportedKeys(String catalog, String schema, String table)

Yes

getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)

Yes

getMaxBinaryLiteralLength()

Yes

getMaxCatalogNameLength()

Yes*

getMaxCharLiteralLength()

Yes

getMaxColumnNameLength()

Yes

getMaxColumnsInGroupBy()

Yes

getMaxColumnsInIndex()

Yes

getMaxColumnsInOrderBy()

Yes

getMaxColumnsInSelect()

Yes

getMaxColumnsInTable()

Yes

getMaxConnections()

Yes

getMaxCursorNameLength()

Yes

getMaxIndexLength()

Yes

getMaxProcedureNameLength()

Yes

getMaxRowSize()

Yes

getMaxSchemaNameLength()

Yes

getMaxStatementLength()

Yes

getMaxStatements()

Yes

getMaxTableNameLength()

Yes

getMaxTablesInSelect()

Yes

getMaxUserNameLength()

Yes

getNumericFunctions()

Yes

getPrimaryKeys(String catalog, String schema, String table)

Yes

getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)

Yes

getProcedures(String catalog, String schemaPattern, String procedureNamePattern)

Yes

getProcedureTerm()

Yes

getResultSetHoldability()

Yes

getSchemas()

Yes

getSchemas(String catalog, String schemaPattern)

Yes

getSchemaTerm()

Yes

getSearchStringEscape()

Yes

getSQLKeywords()

Yes

getSQLStateType()

Yes

getStringFunctions()

Yes

getSuperTables(String, String, String)

Yes

getSuperTypes(String, String, String)

Yes

getSystemFunctions()

Yes

getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)

Yes

getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)

Yes

getTableTypes()

Yes

getTimeDateFunctions()

Yes

getTypeInfo()

Yes

getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)

Yes

getURL()

Yes

getUserName()

Yes

getVersionColumns(String catalog, String schema, String table)

Yes

insertsAreDetected(int type)

Yes

isCatalogAtStart()

Yes*

isReadOnly()

Yes

locatorsUpdateCopy()

Yes

nullPlusNonNullIsNull()

Yes

nullsAreSortedAtEnd()

Yes

nullsAreSortedAtStart()

Yes

nullsAreSortedHigh()

Yes

nullsAreSortedLow()

Yes

othersDeletesAreVisible(int type)

Yes*

othersInsertsAreVisible(int type)

Yes*

othersUpdatesAreVisible(int type)

Yes*

ownDeletesAreVisible(int type)

Yes*

ownInsertsAreVisible(int type)

Yes*

ownUpdatesAreVisible(int type)

Yes*

storesLowerCaseIdentifiers()

Yes

storesLowerCaseQuotedIdentifiers()

Yes

storesMixedCaseIdentifiers()

Yes

storesMixedCaseQuotedIdentifiers()

Yes

storesUpperCaseIdentifiers()

Yes

storesUpperCaseQuotedIdentifiers()

Yes

supportsAlterTableWithAddColumn()

Yes

supportsAlterTableWithDropColumn()

Yes

supportsANSI92EntryLevelSQL()

Yes

supportsANSI92FullSQL()

Yes

supportsANSI92IntermediateSQL()

Yes

supportsBatchUpdates()

Yes

supportsCatalogsInDataManipulation()

Yes

supportsCatalogsInIndexDefinitions()

Yes

supportsCatalogsInPrivilegeDefinitions()

Yes

supportsCatalogsInProcedureCalls()

Yes

supportsCatalogsInTableDefinitions()

Yes

supportsColumnAliasing()

Yes

supportsConvert()

Yes

supportsConvert(int fromType, toType)

Yes

supportsCoreSQLGrammar()

Yes

supportsCorrelatedSubqueries()

Yes

supportsDataDefinitionAndDataManipulationTransactions()

Yes

supportsDataManipulationTransactionsOnly()

Yes

supportsDifferentTableCorrelationNames()

Yes

supportsExpressionsInOrderBy()

Yes

supportsExtendedSQLGrammar()

Yes

supportsFullOuterJoins()

Yes

supportsGeneratedKeys()

Yes

supportsGroupBy()

Yes

supportsGroupByBeyondSelect()

Yes

supportsGroupByUnrelated()

Yes

supportsIntegrityEnhancementFacility()

Yes

supportsLikeEscapeClause()

Yes

supportsLimitedOuterJoins()

Yes

supportsMinimumSQLGrammar()

Yes

supportsMixedCaseIdentifiers()

Yes

supportsMixedCaseQuotedIdentifiers()

Yes

supportsMultipleResultSets()

Yes

supportsMultipleTransactions()

Yes

supportsNonNullableColumns()

Yes

supportsOpenCursorsAcrossCommit()

Yes

supportsOpenCursorsAcrossRollback()

Yes

supportsOpenStatementsAcrossCommit()

Yes

supportsOpenStatementsAcrossRollback()

Yes

supportsOrderByUnrelated()

Yes

supportsOuterJoins()

Yes

supportsPositionedDelete()

Yes

supportsPositionedUpdate()

Yes

supportsResultSetConcurrency(int type, int concurrency)

Yes

supportsResultSetHoldability(int holdability)

Yes

supportsResultSetType(int type)

Yes

supportsSchemasInDataManipulation()

Yes

supportsSchemasInIndexDefinitions()

Yes

supportsSchemasInPrivilegeDefinitions()

Yes

supportsSchemasInProcedureCalls()

Yes

supportsSchemasInTableDefinitions()

Yes

supportsSelectForUpdate()

Yes

supportsStoredProcedures()

Yes

supportsSubqueriesInComparisons()

Yes

supportsSubqueriesInExists()

Yes

supportsSubqueriesInIns()

Yes

supportsSubqueriesInQuantifieds()

Yes

supportsTableCorrelationNames()

Yes

supportsTransactionIsolationLevel(int level)

Yes

supportsTransactions()

Yes

supportsUnion()

Yes

supportsUnionAll()

Yes

updatesAreDetected(int type)

Yes*

usesLocalFilePerTable()

Yes

usesLocalFiles()

Yes

Syntax

public boolean allProceduresAreCallable() throws SQLException

Return

True, if all of the procedures returned by getProcedures can be called by the current user

False, if they cannot be called by the current user

Syntax

public boolean allTablesAreSelectable() throws SQLException

Return

True, if all of the tables returned by getTable can be selected by the current user

False, if they cannot be selected by the current user

Syntax

public boolean dataDefinitionCausesTransactionCommit() throws SQLException

Return

True, if a data definition statement within a transaction forces the transaction to commit

False, if a data definition statement within a transaction does not force the transaction to commit

Syntax

public boolean dataDefinitionIgnoredInTransactions() throws SQLException

Return

True, if a data definition statement within a transaction is ignored

False, if a data definition statement within a transaction is not ignored

Syntax

public boolean deletesAreDetected(int type) throws SQLException

Return

True, if changes are detected by the resultset type

False, if changes are not detected by the resultset type

Syntax

public boolean doesMaxRowSizeIncludeBlobs() throws SQLException

Return

True, if getMaxRowSize() includes LONGVARCHAR and LONGVARBINARY Blobs

False, if getMaxRowSize() does not include LONGVARCHAR and LONGVARBINARY Blobs

TYPE_CAT String

Type catalog (may be null)

TYPE_SCHEM String

Type schema (may be null)

TYPE_NAME String

Type name

ATTR_NAME String

Attribute name

DATA_TYPE int

Attribute type SQL type from java.sql.Types

ATTR_TYPE_NAME String

Data source dependent type name. For a UDT, the type name is fully qualified.

For a REF, the type name is fully qualified and represents the target type of the reference type.

ATTR_SIZE int

Column size. For char or date types, this is the maximum number of characters. For numeric or decimal types, this is precision.

DECIMAL_DIGITS int

The number of fractional digits

NUM_PREC_RADIX int

Radix (typically either 10 or 2)

NULLABLE int

Is NULL allowed?

• attributeNoNulls–Might not allow NULL values
• attributeNullable–Definitely allows NULL values
• attributeNullableUnknown–Nullability unknown

REMARKS String

Comment describing column (may be null)

ATTR_DEF String

Default value (may be null)

SQL_DATA_TYPE int

Not used

SQL_DATETIME_SUB int

Not used

CHAR_OCTET_LENGTH int

For char types, the maximum number of bytes in the column

ORDINAL_POSITION int

Index of column in table (starting at 1)

IS_NULLABLE String

NO–the column definitely does not allow NULL values

Yes–the column might allow NULL values. An empty string means unknown.

SCOPE_CATALOG String

Catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)

SCOPE_SCHEMA String

Schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)

SCOPE_TABLE String

Source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF)

SOURCE_DATA_TYPE short

Source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF)

Syntax

public ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException

where the parameter:

• catalog is a catalog name; must match the catalog name as it is stored in the database: "" –retrieve those without a catalog null –drop catalog name from the selection criteria
• schemaPattern is a schema name; must match the schema name as it is stored in the database: "" –retrieve those without a schema. null –drop schema name from the selection criteria
• typeNamePattern is a type name pattern
• attributeNamePattern is an attribute name pattern

Return

ResultSet–each row is an attribute description

SCOPE Short

Actual scope of results:

• bestRowTemporary –very temporary, while using row
• bestRowTransaction–valid for remainder of current transaction
• bestRowSession–valid for remainder of current session

COLUMN_NAME String

Column name

DATA_TYPE int

SQL data type from java.sql.Types

TYPE_NAME String

Data source dependent type name. For a UDT, the type name is fully qualified.

COLUMN_SIZE int

Precision

BUFFER_LENGTH int

Is not used

DECIMAL_DIGITS short

Scale

PSEUDO_COLUMN short

• bestRowUnknown–may or may not be pseudo column
• best RowNotPseudo–is NOT a pseudo column
• bestRowPseudo–is a pseudo column

Syntax

public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException

where the parameter:

• catalog is a catalog name; must match the catalog name as it is stored in the database: " –retrieve those without a catalog null –the catalog name is not to be used to narrow the search
• schema is a schema name pattern; must match the schema name as it is stored in the database: "" –retrieve those without a schema name null –the schema name is not to be used to narrow the search
• table is a table name; must match the table name as it is stored in the database
• scope is the scope of interest; use same values as SCOPE
• nullable includes columns that are nullable

Return

ResultSet–each row is a column description

TABLE_CAT String

Table catalog name

Syntax

public ResultSet getCatalogs() throws SQLException

Return

The results are ordered by catalog name. Each row has a single String column that is a catalog name.

Note:  Currently returns a null. Will be changed in a future release to return an empty result set.

Syntax

public String getCatalogSeparator() throws SQLException

Return

The separator string between catalog and table name is returned.

Note:  Always returns a "". Catalogs are not supported on the database.

Note:  Always returns a "". Catalogs are not supported on the database.

Syntax

public String getCatalogTerm() throws SQLException

Return

The preferred vendor term for catalog is returned.

Note:  Always returns a ““. Catalogs are not supported on the database.

Note:  Always returns a ““. Catalogs are not supported on the database.

NAME String

The name of the client info property, corresponding to the Query Band name

MAX_LEN int

The maximum length of the value for the property

DEFAULT_VALUE String

The default value of the property

DESCRIPTION String

A description of the property. This typically contains information as to where this property is stored in the database.

Syntax

public ResultSet getClientInfoProperties() throws SQLException

Return

ResultSet–each row is a supported client info property

TABLE_CAT String

Table catalog (may be null)

TABLE_SCHEM String

Table schema (may be null)

TABLE_NAME String

Table name

COLUMN_NAME String

Column name

GRANTOR String

Grantor of access (may be null)

GRANTEE String

Grantee of access

PRIVILEGE String

Name of access (SELECT, INSERT, UPDATE, REFRENCES, and so on)

IS_GRANTABLE String

YES if grantee is permitted to grant to others; NO if not; null if unknown

Syntax

public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException

where the parameter:

• catalog is a catalog name; must match the catalog name as it is stored in the database: "" –retrieves those without a catalog null –the catalog name is not to be used to narrow the search
• schema is a schema name pattern; must match the schema name as it is stored in the database: "" –retrieve those without a schema name null –the schema name is not to be used to narrow the search
• table is a table name; must match the table name as it is stored in the database
• columnNamePattern is a column name pattern; must match the column name as it is stored in the database

Return

ResultSet–each row is a column privilege description

Note:  See also the method getSearchStringEscape().

TABLE_CAT String

Table catalog (may be null)

TABLE_SCHEM String

Table schema (may be null)

TABLE_NAME String

Table name

COLUMN_NAME String

Column name

DATA_TYPE int

SQL type from java.sql.Types

TYPE_NAME String

Data source dependent type name. For a UDT, the type name is fully qualified.

COLUMN_SIZE int

Column size. For char or date types, this is the maximum number of characters. For numeric or decimal types, this is precision.

BUFFER_LENGTH

Is not used

DECIMAL_DIGITS int

The number of fractional digits

NUM_PREC_RADIX int

Radix (typically either 10 or 2)

NULLABLE int

• columnNoNulls–Might not allow NULL values
• columnNullable–Definitely allows NULL values
• columnNullableUnknown–Nullability unknown

REMARKS String

Comment describing column (may be null)

COLUMN_DEF String

Default value (may be null)

SQL_DATA_TYPE int

Not used

SQL_DATETIME_SUB int

Not used

CHAR_OCTET_LENGTH int

For char types, the maximum number of bytes in the column

ORDINAL_POSITION int

Index of column in table (starting at 1)

IS_NULLABLE String

NO–the column definitely does not allow NULL values

YES–the column might allow NULL values; an empty string means unknown

SCOPE_CATALOG String

Catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn’t REF)

SCOPE_SCHEMA String

Schema of table that is the scope of a reference attribute (null if DATA_TYPE isn’t REF)

SCOPE_TABLE String

Table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)

SOURCE_DATA_TYPE short

Source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn’t DISTINCT or user-generated REF)

Syntax

public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException

where the parameter:

• catalog is a catalog name ““ –retrieves those without a catalog null –drop catalog name from the selection criteria
• schemaPattern is a schema name pattern ““ –retrieves those without a schema null –drop schema name from the selection criteria
• tableNamePattern is a table name pattern
• columnNamePattern is a column name pattern

Return

ResultSet with each row providing a column description

Note:  See also the method getSearchStringEscape().

Syntax

public Connection getConnection() throws SQLException

Return

The connection that produced this metadata object is returned.

PKTABLE_CAT String

Primary key table catalog (may be null)

PKTABLE_SCHEM String

Primary key table schema (may be null)

PKTABLE_NAME String

Primary key table name

PKCOLUMN_NAME String

Primary key column name

FKTABLE_CAT String

Foreign key table catalog (may be null) being exported (may be null)

FKTABLE_SCHEM String

Foreign key table schema (may be null) being exported (may be null)

FKTABLE_NAME String

Foreign key column name being exported

FKCOLUMN_NAME String

Foreign key column name being exported

KEY_SEQ short

Sequence number within foreign key

UPDATE_RULE short

What happens to foreign key when primary is updated:

• importedNoAction–do not allow update of primary key if it has been imported
• importedKeyCascade–change imported key to agree with primary key update
• importedKeySetNull–change imported key to NULL if its primary key has been updated
• importedKeySetDefault–change imported key to default values if its primary key has been updated
• importedKeyRestrict–same as importedKeyNoAction (for ODBC 2.x compatibility)

DELETE_RULE short

What happens to the foreign key when primary is deleted:

• importedKeyNoAction–do not allow delete of primary key if it has been imported.
• importedKeyCascade–delete rows that import a deleted key.
• importedKeySetNull–change imported key to NULL if its primary key has been deleted.
• importedKeyRestrict–same as importedKeyNoAction (for ODBC 2.x compatibility).
• importedKeySetDefault–change imported key to default if its primary key has been deleted.

FK_NAME String

Foreign key name (may be null)

PK_NAME String

Primary key name (may be null)

DEFERRABILITY short

Can the evaluation of foreign key constraints be deferred until commit:

• importedKeyInitiallyDeferred–Actions related to foreign keys are initially deferred
• importedKeyInitiallyImmediate –Actions related to foreign keys are initially immediate
• importedKeyNotDeferrable–Actions related to foreign keys are not deferrable

Syntax

public ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException

where the parameter:

• primaryCatalog is a catalog name; must match the catalog name as it is stored in the database: ““ –retrieves those without a catalog null –drop catalog name from the selection criteria
• primarySchema is a schema name pattern; must match the schema name as it is stored in the database: ““ –retrieves those without a schema null –drop schema name from the selection criteria
• primaryTable is the name of the table that exports the key; must match the table name as it is stored in the database
• foreignCatalog is a catalog name; must match the catalog name as it is stored in the database: ““ –retrieves those without a catalog null –drop catalog name from the selection criteria
• foreignSchema is a schema name; must match the schema name as it is stored in the database: ““ –retrieves those without a schema null –drop schema name from the selection criteria
• foreignTable is the name of the table that imports the key; must match the table name as it is stored in the database

Return

ResultSet–each row is a foreign key column description

Note:  See also the getImportedKeys(String, String, String) method.

Syntax

public int getDatabaseMajorVersion()

Returns

The underlying database’s major version is returned.

Note:  The major version is the value following the letter V for supported database releases prior to 12.0, such as it returns value 2 for database release V2R6, but it returns value 12 for database release 12.0.

Syntax

public int getDatabaseMinorVersion()

Return

The underlying database’s minor version is returned.

Note:  The minor version is the value following the letter R for supported database releases prior to 12.0, such as it returns value 6 for database release V2R6, but it returns value 0 for database release 12.0.

Syntax

public String getDatabaseProductName() throws SQLException

Return

The database product name is returned.

Syntax

public String getDatabaseProductVersion() throws SQLException

Return

The database version is returned.

Note:  The database version is a string that always begins with Teradata Database and that includes V2R for supported database releases prior to 12.0, but does not include V2R for 12.0.

Syntax

public int getDefaultTransactionIsolation() throws SQLException

Return

The default isolation level is returned.

Note:  The values are defined in java.sql.Connection.

Syntax

public int getDriverMajorVersion()

Return

The JDBC Driver major version number is returned.

Syntax

public int getDriverMinorVersion()

Return

The JDBC Driver minor version number is returned.

Syntax

public String getDriverName() throws SQLException

Return

The JDBC Driver name is returned.

Syntax

public String getDriverVersion() throws SQLException

Return

The JDBC Driver version is returned.

Syntax

public String getExtraNameCharacters() throws SQLException

Return

The string containing extra characters is returned.

FUNCTION_CAT String

Function catalog (may be null)

FUNCTION_SCHEM String

Function schema (may be null)

FUNCTION_NAME String

Function name

COLUMN_NAME String

Parameter, return type, or column name

COLUMN_TYPE short

• functionColumnUnknown - unknown type
• functionColumnIn - IN parameter
• functionColumnInOut - INOUT parameter
• functionColumnOut - OUT parameter
• functionColumnResult - ResultSet column
• functionReturn - function return type

DATA_TYPE int

SQL type from java.sql.Types

TYPE_NAME String

Data source dependent type name. For a UDT, the type name is fully qualified.

PRECISION int

Numeric precision

LENGTH int

Parameter, return type, or column length

SCALE short

The number of fractional digits

RADIX short

Radix (typically either 10 or 2)

NULLABLE short

• functionNoNulls - forbids NULL values
• functionNullable - allows NULL values
• functionNullableUnknown - unknown nullability

REMARKS String

Comment describing parameter, return type, or column (may be null)

CHAR_OCTET_LENGTH int

Parameter, return type, or column length

ORDINAL_POSITION int

Ordinal position, starting from 1, of the parameter or column, or 0 for a return type

IS_NULLABLE String

NO - forbids NULL values

YES - allows NULL values

empty string - unknown nullability

SPECIFIC_NAME String

Unique function name that may differ from FUNCTION_NAME for an overloaded function

Syntax

public ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException

where the parameter:

• catalog is a catalog name. The empty string retrieves those without a catalog, and null omits the catalog from the selection criteria.
• schemaPattern is a schema name pattern. The empty string retrieves those without a schema, and null omits the schema from the selection criteria.
• functionNamePattern is a function name pattern
• columnNamePattern is a parameter, return type, or column name pattern

Return

ResultSet with each row providing a parameter description, column description, or return type description

Note:  This method is supported beginning with Teradata JDBC Driver 15.10.00.28.

JDK 6.0 or later is required to use this method.

See also the method getSearchStringEscape().

FUNCTION_CAT String

Function catalog (may be null)

FUNCTION_SCHEM String

Function schema (may be null)

FUNCTION_NAME String

Function name

REMARKS String

Comment describing the function (may be null)

FUNCTION_TYPE short

• functionReturnsTable - table function or table operator
• functionNoTable - function does not return a table

SPECIFIC_NAME String

Unique function name that may differ from FUNCTION_NAME for an overloaded function

Syntax

public ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException

where the parameter:

• catalog is a catalog name. The empty string retrieves those without a catalog, and null omits the catalog from the selection criteria.
• schemaPattern is a schema name pattern. The empty string retrieves those without a schema, and null omits the schema from the selection criteria.
• functionNamePattern is a function name pattern

Return

ResultSet with each row providing a function description

Note:  This method is supported beginning with Teradata JDBC Driver 15.10.00.28.

JDK 6.0 or later is required to use this method.

See also the method getSearchStringEscape().

Syntax

public String getIdentifierQuoteString() throws SQLException

Return

If identifier quoting is supported, it returns the string used to quote SQL identifiers;

If identifier quoting is not supported, a space is returned

Note:  A JDBC-compliant driver always uses a double-quote character.

TABLE_CAT String

Table catalog (may be null)

TABLE_SCHEM String

Table schema (may be null)

TABLE_NAME String

Table name

NON_UNIQUE String

Can index values be non-unique? False when TYPE is tableIndexStatistic

INDEX_QUALIFIER String

Index catalog (may be null), null when TYPE is tableIndexStatistic. Teradata JDBC Driver 14.00.00.25 and later, in conjunction with Teradata Database 14.10 and later, provide the database name of join and hash indexes.

INDEX_NAME String

Index Name. null when TYPE is tableIndexStatistic, or when the index is unnamed.

Teradata permits unnamed indices; refer to the Teradata SQL Reference Data Definition Statements for more information.

TYPE short

Index Type:

• tableIndexStatistic identifies the table statistics that are returned in conjunction with a table's index descriptions. Teradata JDBC Driver 14.00.00.24 and later do not provide tableIndexStatistic.
• tableIndexClustered identifies a clustered index. Teradata JDBC Driver 14.00.00.24 and later identify primary indexes as tableIndexClustered. While primary indexes are not actually clustered indexes, they are conceptually similar in that a primary index is the "most important" index for a base table, and there can be at most one primary index per base table.
• tableIndexHashed identifies a hashed index. Teradata JDBC Driver 14.00.00.24 and later identify secondary indexes as tableIndexHashed. Unique secondary indexes (USI) are hash-distributed, but non-unique secondary indexes (NUSI) are not hash-distributed. However, for consistency, both kinds of secondary indexes are identified as tableIndexHashed.
• tableIndexOther identifies some other style of index. Teradata JDBC Driver 14.00.00.24 and later identify join and hash indexes as tableIndexOther.

ORDINAL_POSITION short

Column sequence number within index. Zero when TYPE is tableIndexStatistic.

COLUMN_NAME String

Column Name. Null when TYPE is tableIndexStatistic.

ASC_OR_DESC String

Column sort sequence:

• A (ascending)
• D (descending)

May be null if sort sequence is not supported. Null when TYPE is tableIndexStatistic.

CARDINALITY int

When TYPE is tableIndexStatistic, this is the number of rows in the table. Otherwise, it is the number of unique values in the Index.

PAGES int

When TYPE is tableIndexStatistic, this is the number of pages used for the table. Otherwise, it is the number of pages used for the current index. Teradata JDBC Driver 14.00.00.24 and later provide null.

FILTER_CONDITION String

Filter conditions, if any (may be null)

Syntax

public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException

where the parameter:

• catalog is a catalog name: ““ –retrieves those without a catalog null –drop catalog name from the selection criteria
• schema is a schema name: ““ –retrieves those without a schema
• table is a table name
• unique is indice uniqueness: True–returns only indices for unique values False–returns indices regardless of whether unique or not
• approximate is approximate values: True–result is allowed to reflect approximate or out-of-data values False–results are requested to be accurate

Return

ResultSet–each row is an index column description

Syntax

public int getMaxBinaryLiteralLength() throws SQLException

Return

The maximum binary literal length in hex characters is returned.

Note:  A result of zero indicates that there is no limit to the binary literal or the limit is unknown.

Syntax

public int getMaxCatalogNameLength() throws SQLException

Return

The maximum catalog name length in bytes is returned.

Note:  A result of zero indicates that there is no limit to the catalog name or the limit is unknown.

Syntax

public int getMaxCharLiteralLength() throws SQLException

Return

The maximum literal length is returned.

Note:  A result of zero indicates that there is no limit to the Character literal or the limit is unknown.

Syntax

public int getMaxColumnNameLength() throws SQLException

Return

The maximum literal length for a column name is returned.

Syntax

public int getMaxColumnsInGroupBy() throws SQLException

Return

The maximum number of columns in a GROUP BY clause is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxColumnsInIndex() throws SQLException

Return

The maximum number of columns allowed in an index is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxColumnsInOrderBy() throws SQLException

Return

The maximum number of columns allowed in an ORDER BY clause is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxColumnsInSelect() throws SQLException

Return

The maximum number of columns allowed in a SELECT list is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxColumnsInTable() throws SQLException

Return

The maximum number of columns allowed in a table is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxConnections() throws SQLException

Return

The maximum active connections allowed at a time to this database is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxCursorNameLength() throws SQLException

Return

The maximum cursor name length in bytes is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxIndexLength() throws SQLException

Return

The maximum length of an index in bytes is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxProcedureNameLength() throws SQLException

Return

The maximum procedure name length in bytes is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxRowSize() throws SQLException

Return

The maximum length of a single row in bytes is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxSchemaNameLength() throws SQLException

Return

The maximum length allowed for a schema name in bytes is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxStatementLength() throws SQLException

Return

The maximum length of an SQL statement in bytes is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxStatements() throws SQLException

Return

The maximum number of active statements allowed at one time is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxTableNameLength() throws SQLException

Return

The maximum length of a table name in bytes is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.

Syntax

public int getMaxTablesInSelect() throws SQLException

Return

The maximum number of tables allowed in a SELECT statement is returned.

Note:  A result of zero indicates that there is no limit or the limit is unknown.