DatabaseMetaData (Java 2 Platform SE v1.4.1)

java.sql
Interface DatabaseMetaData

public interface DatabaseMetaData

Comprehensive information about the database as a whole.
Implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBC^TM technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.
A user for this interface is commonly a tool that needs to discover how to deal with the underlying DBMS. This is especially true for applications that are intended to be used with more than one DBMS. For example, a tool might use the method getTypeInfo to find out what data types can be used in a CREATE table statement. Or a user might call the method supportsCorrelatedSubqueries to see if it is possible to use a correlated subquery or supportsBatchUpdates to see if it is possible to use batch updates.
Some DatabaseMetaData methods return lists of information in the form of ResultSet objects. Regular ResultSet methods, such as getString and getInt, can be used to retrieve the data from these ResultSet objects. If a given form of metadata is not available, the ResultSet getter methods throw an SQLException.
Some DatabaseMetaData methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern are returned. If a search pattern argument is set to null, that argument's criterion will be dropped from the search.
A method that gets information about a feature that the driver does not support will throw an SQLException. In the case of methods that return a ResultSet object, either a ResultSet object (which may be empty) is returned or an SQLException is thrown.

Field Summary
static short attributeNoNulls
    Indicates that NULL values might not be allowed.
static short attributeNullable
    Indicates that NULL values are definitely allowed.
static short attributeNullableUnknown
    Indicates that whether NULL values are allowed is not known.
static int bestRowNotPseudo
    Indicates that the best row identifier is NOT a pseudo column.
static int bestRowPseudo
    Indicates that the best row identifier is a pseudo column.
static int bestRowSession
    Indicates that the scope of the best row identifier is the remainder of the current session.
static int bestRowTemporary
    Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.
static int bestRowTransaction
    Indicates that the scope of the best row identifier is the remainder of the current transaction.
static int bestRowUnknown
    Indicates that the best row identifier may or may not be a pseudo column.
static int columnNoNulls
    Indicates that the column might not allow NULL values.
static int columnNullable
    Indicates that the column definitely allows NULL values.
static int columnNullableUnknown
    Indicates that the nullability of columns is unknown.
static int importedKeyCascade
    For the column UPDATE_RULE, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it.
static int importedKeyInitiallyDeferred
    Indicates deferrability.
static int importedKeyInitiallyImmediate
    Indicates deferrability.
static int importedKeyNoAction
    For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key has been imported, it cannot be updated or deleted.
static int importedKeyNotDeferrable
    Indicates deferrability.
static int importedKeyRestrict
    For the column UPDATE_RULE, indicates that a primary key may not be updated if it has been imported by another table as a foreign key.
static int importedKeySetDefault
    For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.
static int importedKeySetNull
    For the columns UPDATE_RULE and DELETE_RULE, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL.
static int procedureColumnIn
    Indicates that the column stores IN parameters.
static int procedureColumnInOut
    Indicates that the column stores INOUT parameters.
static int procedureColumnOut
    Indicates that the column stores OUT parameters.
static int procedureColumnResult
    Indicates that the column stores results.
static int procedureColumnReturn
    Indicates that the column stores return values.
static int procedureColumnUnknown
    Indicates that type of the column is unknown.
static int procedureNoNulls
    Indicates that NULL values are not allowed.
static int procedureNoResult
    Indicates that the procedure does not return a result.
static int procedureNullable
    Indicates that NULL values are allowed.
static int procedureNullableUnknown
    Indicates that whether NULL values are allowed is unknown.
static int procedureResultUnknown
    Indicates that it is not known whether the procedure returns a result.
static int procedureReturnsResult
    Indicates that the procedure returns a result.
static int sqlStateSQL99
    Indicates that the value is an SQL99 SQLSTATE value.
static int sqlStateXOpen
    Indicates that the value is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.
static short tableIndexClustered
    Indicates that this table index is a clustered index.
static short tableIndexHashed
    Indicates that this table index is a hashed index.
static short tableIndexOther
    Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.
static short tableIndexStatistic
    Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.
static int typeNoNulls
    Indicates that a NULL value is NOT allowed for this data type.
static int typeNullable
    Indicates that a NULL value is allowed for this data type.
static int typeNullableUnknown
    Indicates that it is not known whether a NULL value is allowed for this data type.
static int typePredBasic
    Indicates that one can base all WHERE search clauses except WHERE .
static int typePredChar
    Indicates that the only WHERE search clause that can be based on this type is WHERE .
static int typePredNone
    Indicates that WHERE search clauses are not supported for this type.
static int typeSearchable
    Indicates that all WHERE search clauses can be based on this type.
static int versionColumnNotPseudo
    Indicates that this version column is NOT a pseudo column.
static int versionColumnPseudo
    Indicates that this version column is a pseudo column.
static int versionColumnUnknown
    Indicates that this version column may or may not be a pseudo column.

Method Summary
boolean allProceduresAreCallable()
    Retrieves whether the current user can call all the procedures returned by the method getProcedures.
boolean allTablesAreSelectable()
    Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.
boolean dataDefinitionCausesTransactionCommit()
    Retrieves whether a data definition statement within a transaction forces the transaction to commit.
boolean dataDefinitionIgnoredInTransactions()
    Retrieves whether this database ignores a data definition statement within a transaction.
boolean deletesAreDetected(int type)
    Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted.
boolean doesMaxRowSizeIncludeBlobs()
    Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.
ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)
    Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.
ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
    Retrieves a description of a table's optimal set of columns that uniquely identifies a row.
ResultSet getCatalogs()
    Retrieves the catalog names available in this database.
String getCatalogSeparator()
    Retrieves the String that this database uses as the separator between a catalog and table name.
String getCatalogTerm()
    Retrieves the database vendor's preferred term for "catalog".
ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)
    Retrieves a description of the access rights for a table's columns.
ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
    Retrieves a description of table columns available in the specified catalog.
Connection getConnection()
    Retrieves the connection that produced this metadata object.
ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)
    Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key columns of the given primary key table (describe how one table imports another's key).
int getDatabaseMajorVersion()
    Retrieves the major version number of the underlying database.
int getDatabaseMinorVersion()
    Retrieves the minor version number of the underlying database.
String getDatabaseProductName()
    Retrieves the name of this database product.
String getDatabaseProductVersion()
    Retrieves the version number of this database product.
int getDefaultTransactionIsolation()
    Retrieves this database's default transaction isolation level.
int getDriverMajorVersion()
    Retrieves this JDBC driver's major version number.
int getDriverMinorVersion()
    Retrieves this JDBC driver's minor version number.
String getDriverName()
    Retrieves the name of this JDBC driver.
String getDriverVersion()
    Retrieves the version number of this JDBC driver as a String.
ResultSet getExportedKeys(String catalog, String schema, String table)
    Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).
String getExtraNameCharacters()
    Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
String getIdentifierQuoteString()
    Retrieves the string used to quote SQL identifiers.
ResultSet getImportedKeys(String catalog, String schema, String table)
    Retrieves a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).
ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
    Retrieves a description of the given table's indices and statistics.
int getJDBCMajorVersion()
    Retrieves the major JDBC version number for this driver.
int getJDBCMinorVersion()
    Retrieves the minor JDBC version number for this driver.
int getMaxBinaryLiteralLength()
    Retrieves the maximum number of hex characters this database allows in an inline binary literal.
int getMaxCatalogNameLength()
    Retrieves the maximum number of characters that this database allows in a catalog name.
int getMaxCharLiteralLength()
    Retrieves the maximum number of characters this database allows for a character literal.
int getMaxColumnNameLength()
    Retrieves the maximum number of characters this database allows for a column name.
int getMaxColumnsInGroupBy()
    Retrieves the maximum number of columns this database allows in a GROUP BY clause.
int getMaxColumnsInIndex()
    Retrieves the maximum number of columns this database allows in an index.
int getMaxColumnsInOrderBy()
    Retrieves the maximum number of columns this database allows in an ORDER BY clause.
int getMaxColumnsInSelect()
    Retrieves the maximum number of columns this database allows in a SELECT list.
int getMaxColumnsInTable()
    Retrieves the maximum number of columns this database allows in a table.
int getMaxConnections()
    Retrieves the maximum number of concurrent connections to this database that are possible.
int getMaxCursorNameLength()
    Retrieves the maximum number of characters that this database allows in a cursor name.
int getMaxIndexLength()
    Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.
int getMaxProcedureNameLength()
    Retrieves the maximum number of characters that this database allows in a procedure name.
int getMaxRowSize()
    Retrieves the maximum number of bytes this database allows in a single row.
int getMaxSchemaNameLength()
    Retrieves the maximum number of characters that this database allows in a schema name.
int getMaxStatementLength()
    Retrieves the maximum number of characters this database allows in an SQL statement.
int getMaxStatements()
    Retrieves the maximum number of active statements to this database that can be open at the same time.
int getMaxTableNameLength()
    Retrieves the maximum number of characters this database allows in a table name.
int getMaxTablesInSelect()
    Retrieves the maximum number of tables this database allows in a SELECT statement.
int getMaxUserNameLength()
    Retrieves the maximum number of characters this database allows in a user name.
String getNumericFunctions()
    Retrieves a comma-separated list of math functions available with this database.
ResultSet getPrimaryKeys(String catalog, String schema, String table)
    Retrieves a description of the given table's primary key columns.
ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
    Retrieves a description of the given catalog's stored procedure parameter and result columns.
ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern)
    Retrieves a description of the stored procedures available in the given catalog.
String getProcedureTerm()
    Retrieves the database vendor's preferred term for "procedure".
int getResultSetHoldability()
    Retrieves the default holdability of this ResultSet object.
ResultSet getSchemas()
    Retrieves the schema names available in this database.
String getSchemaTerm()
    Retrieves the database vendor's preferred term for "schema".
String getSearchStringEscape()
    Retrieves the string that can be used to escape wildcard characters.
String getSQLKeywords()
    Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL92 keywords.
int getSQLStateType()
    Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL99.
String getStringFunctions()
    Retrieves a comma-separated list of string functions available with this database.
ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern)
    Retrieves a description of the table hierarchies defined in a particular schema in this database.
ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)
    Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.
String getSystemFunctions()
    Retrieves a comma-separated list of system functions available with this database.
ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)
    Retrieves a description of the access rights for each table available in a catalog.
ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)
    Retrieves a description of the tables available in the given catalog.
ResultSet getTableTypes()
    Retrieves the table types available in this database.
String getTimeDateFunctions()
    Retrieves a comma-separated list of the time and date functions available with this database.
ResultSet getTypeInfo()
    Retrieves a description of all the standard SQL types supported by this database.
ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)
    Retrieves a description of the user-defined types (UDTs) defined in a particular schema.
String getURL()
    Retrieves the URL for this DBMS.
String getUserName()
    Retrieves the user name as known to this database.
ResultSet getVersionColumns(String catalog, String schema, String table)
    Retrieves a description of a table's columns that are automatically updated when any value in a row is updated.
boolean insertsAreDetected(int type)
    Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.
boolean isCatalogAtStart()
    Retrieves whether a catalog appears at the start of a fully qualified table name.
boolean isReadOnly()
    Retrieves whether this database is in read-only mode.
boolean locatorsUpdateCopy()
    Indicates whether updates made to a LOB are made on a copy or directly to the LOB.
boolean nullPlusNonNullIsNull()
    Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.
boolean nullsAreSortedAtEnd()
    Retrieves whether NULL values are sorted at the end regardless of sort order.
boolean nullsAreSortedAtStart()
    Retrieves whether NULL values are sorted at the start regardless of sort order.
boolean nullsAreSortedHigh()
    Retrieves whether NULL values are sorted high.
boolean nullsAreSortedLow()
    Retrieves whether NULL values are sorted low.
boolean othersDeletesAreVisible(int type)
    Retrieves whether deletes made by others are visible.
boolean othersInsertsAreVisible(int type)
    Retrieves whether inserts made by others are visible.
boolean othersUpdatesAreVisible(int type)
    Retrieves whether updates made by others are visible.
boolean ownDeletesAreVisible(int type)
    Retrieves whether a result set's own deletes are visible.
boolean ownInsertsAreVisible(int type)
    Retrieves whether a result set's own inserts are visible.
boolean ownUpdatesAreVisible(int type)
    Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.
boolean storesLowerCaseIdentifiers()
    Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.
boolean storesLowerCaseQuotedIdentifiers()
    Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.
boolean storesMixedCaseIdentifiers()
    Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.
boolean storesMixedCaseQuotedIdentifiers()
    Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.
boolean storesUpperCaseIdentifiers()
    Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.
boolean storesUpperCaseQuotedIdentifiers()
    Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.
boolean supportsAlterTableWithAddColumn()
    Retrieves whether this database supports ALTER table with add column.
boolean supportsAlterTableWithDropColumn()
    Retrieves whether this database supports ALTER table with drop column.
boolean supportsANSI92EntryLevelSQL()
    Retrieves whether this database supports the ANSI92 entry level SQL grammar.
boolean supportsANSI92FullSQL()
    Retrieves whether this database supports the ANSI92 full SQL grammar supported.
boolean supportsANSI92IntermediateSQL()
    Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.
boolean supportsBatchUpdates()
    Retrieves whether this database supports batch updates.
boolean supportsCatalogsInDataManipulation()
    Retrieves whether a catalog name can be used in a data manipulation statement.
boolean supportsCatalogsInIndexDefinitions()
    Retrieves whether a catalog name can be used in an index definition statement.
boolean supportsCatalogsInPrivilegeDefinitions()
    Retrieves whether a catalog name can be used in a privilege definition statement.
boolean supportsCatalogsInProcedureCalls()
    Retrieves whether a catalog name can be used in a procedure call statement.
boolean supportsCatalogsInTableDefinitions()
    Retrieves whether a catalog name can be used in a table definition statement.
boolean supportsColumnAliasing()
    Retrieves whether this database supports column aliasing.
boolean supportsConvert()
    Retrieves whether this database supports the CONVERT function between SQL types.
boolean supportsConvert(int fromType, int toType)
    Retrieves whether this database supports the CONVERT for two given SQL types.
boolean supportsCoreSQLGrammar()
    Retrieves whether this database supports the ODBC Core SQL grammar.
boolean supportsCorrelatedSubqueries()
    Retrieves whether this database supports correlated subqueries.
boolean supportsDataDefinitionAndDataManipulationTransactions()
    Retrieves whether this database supports both data definition and data manipulation statements within a transaction.
boolean supportsDataManipulationTransactionsOnly()
    Retrieves whether this database supports only data manipulation statements within a transaction.
boolean supportsDifferentTableCorrelationNames()
    Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.
boolean supportsExpressionsInOrderBy()
    Retrieves whether this database supports expressions in ORDER BY lists.
boolean supportsExtendedSQLGrammar()
    Retrieves whether this database supports the ODBC Extended SQL grammar.
boolean supportsFullOuterJoins()
    Retrieves whether this database supports full nested outer joins.
boolean supportsGetGeneratedKeys()
    Retrieves whether auto-generated keys can be retrieved after a statement has been executed.
boolean supportsGroupBy()
    Retrieves whether this database supports some form of GROUP BY clause.
boolean supportsGroupByBeyondSelect()
    Retrieves whether this database supports using columns not included in the SELECT statement in a GROUP BY clause provided that all of the columns in the SELECT statement are included in the GROUP BY clause.
boolean supportsGroupByUnrelated()
    Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.
boolean supportsIntegrityEnhancementFacility()
    Retrieves whether this database supports the SQL Integrity Enhancement Facility.
boolean supportsLikeEscapeClause()
    Retrieves whether this database supports specifying a LIKE escape clause.
boolean supportsLimitedOuterJoins()
    Retrieves whether this database provides limited support for outer joins.
boolean supportsMinimumSQLGrammar()
    Retrieves whether this database supports the ODBC Minimum SQL grammar.
boolean supportsMixedCaseIdentifiers()
    Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.
boolean supportsMixedCaseQuotedIdentifiers()
    Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.
boolean supportsMultipleOpenResults()
    Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.
boolean supportsMultipleResultSets()
    Retrieves whether this database supports getting multiple ResultSet objects from a single call to the method execute.
boolean supportsMultipleTransactions()
    Retrieves whether this database allows having multiple transactions open at once (on different connections).
boolean supportsNamedParameters()
    Retrieves whether this database supports named parameters to callable statements.
boolean supportsNonNullableColumns()
    Retrieves whether columns in this database may be defined as non-nullable.
boolean supportsOpenCursorsAcrossCommit()
    Retrieves whether this database supports keeping cursors open across commits.
boolean supportsOpenCursorsAcrossRollback()
    Retrieves whether this database supports keeping cursors open across rollbacks.
boolean supportsOpenStatementsAcrossCommit()
    Retrieves whether this database supports keeping statements open across commits.
boolean supportsOpenStatementsAcrossRollback()
    Retrieves whether this database supports keeping statements open across rollbacks.
boolean supportsOrderByUnrelated()
    Retrieves whether this database supports using a column that is not in the SELECT statement in an ORDER BY clause.
boolean supportsOuterJoins()
    Retrieves whether this database supports some form of outer join.
boolean supportsPositionedDelete()
    Retrieves whether this database supports positioned DELETE statements.
boolean supportsPositionedUpdate()
    Retrieves whether this database supports positioned UPDATE statements.
boolean supportsResultSetConcurrency(int type, int concurrency)
    Retrieves whether this database supports the given concurrency type in combination with the given result set type.
boolean supportsResultSetHoldability(int holdability)
    Retrieves whether this database supports the given result set holdability.
boolean supportsResultSetType(int type)
    Retrieves whether this database supports the given result set type.
boolean supportsSavepoints()
    Retrieves whether this database supports savepoints.
boolean supportsSchemasInDataManipulation()
    Retrieves whether a schema name can be used in a data manipulation statement.
boolean supportsSchemasInIndexDefinitions()
    Retrieves whether a schema name can be used in an index definition statement.
boolean supportsSchemasInPrivilegeDefinitions()
    Retrieves whether a schema name can be used in a privilege definition statement.
boolean supportsSchemasInProcedureCalls()
    Retrieves whether a schema name can be used in a procedure call statement.
boolean supportsSchemasInTableDefinitions()
    Retrieves whether a schema name can be used in a table definition statement.
boolean supportsSelectForUpdate()
    Retrieves whether this database supports SELECT FOR UPDATE statements.
boolean supportsStatementPooling()
    Retrieves whether this database supports statement pooling.
boolean supportsStoredProcedures()
    Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.
boolean supportsSubqueriesInComparisons()
    Retrieves whether this database supports subqueries in comparison expressions.
boolean supportsSubqueriesInExists()
    Retrieves whether this database supports subqueries in EXISTS expressions.
boolean supportsSubqueriesInIns()
    Retrieves whether this database supports subqueries in IN statements.
boolean supportsSubqueriesInQuantifieds()
    Retrieves whether this database supports subqueries in quantified expressions.
boolean supportsTableCorrelationNames()
    Retrieves whether this database supports table correlation names.
boolean supportsTransactionIsolationLevel(int level)
    Retrieves whether this database supports the given transaction isolation level.
boolean supportsTransactions()
    Retrieves whether this database supports transactions.
boolean supportsUnion()
    Retrieves whether this database supports SQL UNION.
boolean supportsUnionAll()
    Retrieves whether this database supports SQL UNION ALL.
boolean updatesAreDetected(int type)
    Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated.
boolean usesLocalFilePerTable()
    Retrieves whether this database uses a file for each table.
boolean usesLocalFiles()
    Retrieves whether this database stores tables in a local file.

Field Detail

procedureResultUnknown
public static final int procedureResultUnknown
Indicates that it is not known whether the procedure returns a result.
A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.

See Also:
Constant Field Values

procedureNoResult
public static final int procedureNoResult
Indicates that the procedure does not return a result.
A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.

See Also:
Constant Field Values

procedureReturnsResult
public static final int procedureReturnsResult
Indicates that the procedure returns a result.
A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.

See Also:
Constant Field Values

procedureColumnUnknown
public static final int procedureColumnUnknown
Indicates that type of the column is unknown.
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureColumnIn
public static final int procedureColumnIn
Indicates that the column stores IN parameters.
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureColumnInOut
public static final int procedureColumnInOut
Indicates that the column stores INOUT parameters.
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureColumnOut
public static final int procedureColumnOut
Indicates that the column stores OUT parameters.
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureColumnReturn
public static final int procedureColumnReturn
Indicates that the column stores return values.
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureColumnResult
public static final int procedureColumnResult
Indicates that the column stores results.
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureNoNulls
public static final int procedureNoNulls
Indicates that NULL values are not allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureNullable
public static final int procedureNullable
Indicates that NULL values are allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

See Also:
Constant Field Values

procedureNullableUnknown
public static final int procedureNullableUnknown
Indicates that whether NULL values are allowed is unknown.
A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

See Also:
Constant Field Values

columnNoNulls
public static final int columnNoNulls
Indicates that the column might not allow NULL values.
A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

See Also:
Constant Field Values

columnNullable
public static final int columnNullable
Indicates that the column definitely allows NULL values.
A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

See Also:
Constant Field Values

columnNullableUnknown
public static final int columnNullableUnknown
Indicates that the nullability of columns is unknown.
A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

See Also:
Constant Field Values

bestRowTemporary
public static final int bestRowTemporary
Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.
A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

See Also:
Constant Field Values

bestRowTransaction
public static final int bestRowTransaction
Indicates that the scope of the best row identifier is the remainder of the current transaction.
A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

See Also:
Constant Field Values

bestRowSession
public static final int bestRowSession
Indicates that the scope of the best row identifier is the remainder of the current session.
A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

See Also:
Constant Field Values

bestRowUnknown
public static final int bestRowUnknown
Indicates that the best row identifier may or may not be a pseudo column.
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

See Also:
Constant Field Values

bestRowNotPseudo
public static final int bestRowNotPseudo
Indicates that the best row identifier is NOT a pseudo column.
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

See Also:
Constant Field Values

bestRowPseudo
public static final int bestRowPseudo
Indicates that the best row identifier is a pseudo column.
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

See Also:
Constant Field Values

versionColumnUnknown
public static final int versionColumnUnknown
Indicates that this version column may or may not be a pseudo column.
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

See Also:
Constant Field Values

versionColumnNotPseudo
public static final int versionColumnNotPseudo
Indicates that this version column is NOT a pseudo column.
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

See Also:
Constant Field Values

versionColumnPseudo
public static final int versionColumnPseudo
Indicates that this version column is a pseudo column.
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

See Also:
Constant Field Values

importedKeyCascade
public static final int importedKeyCascade
For the column UPDATE_RULE, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it. For the column DELETE_RULE, it indicates that when the primary key is deleted, rows that imported that key are deleted.
A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

importedKeyRestrict
public static final int importedKeyRestrict
For the column UPDATE_RULE, indicates that a primary key may not be updated if it has been imported by another table as a foreign key. For the column DELETE_RULE, indicates that a primary key may not be deleted if it has been imported by another table as a foreign key.
A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

importedKeySetNull
public static final int importedKeySetNull
For the columns UPDATE_RULE and DELETE_RULE, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL.
A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

importedKeyNoAction
public static final int importedKeyNoAction
For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key has been imported, it cannot be updated or deleted.
A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

importedKeySetDefault
public static final int importedKeySetDefault
For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.
A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

importedKeyInitiallyDeferred
public static final int importedKeyInitiallyDeferred
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

importedKeyInitiallyImmediate
public static final int importedKeyInitiallyImmediate
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

importedKeyNotDeferrable
public static final int importedKeyNotDeferrable
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

See Also:
Constant Field Values

typeNoNulls
public static final int typeNoNulls
Indicates that a NULL value is NOT allowed for this data type.
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.

See Also:
Constant Field Values

typeNullable
public static final int typeNullable
Indicates that a NULL value is allowed for this data type.
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.

See Also:
Constant Field Values

typeNullableUnknown
public static final int typeNullableUnknown
Indicates that it is not known whether a NULL value is allowed for this data type.
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.

See Also:
Constant Field Values

typePredNone
public static final int typePredNone
Indicates that WHERE search clauses are not supported for this type.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

See Also:
Constant Field Values

typePredChar
public static final int typePredChar
Indicates that the only WHERE search clause that can be based on this type is WHERE . . . LIKE.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

See Also:
Constant Field Values

typePredBasic
public static final int typePredBasic
Indicates that one can base all WHERE search clauses except WHERE . . . LIKE on this data type.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

See Also:
Constant Field Values

typeSearchable
public static final int typeSearchable
Indicates that all WHERE search clauses can be based on this type.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

See Also:
Constant Field Values

tableIndexStatistic
public static final short tableIndexStatistic
Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

See Also:
Constant Field Values

tableIndexClustered
public static final short tableIndexClustered
Indicates that this table index is a clustered index.
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

See Also:
Constant Field Values

tableIndexHashed
public static final short tableIndexHashed
Indicates that this table index is a hashed index.
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

See Also:
Constant Field Values

tableIndexOther
public static final short tableIndexOther
Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

See Also:
Constant Field Values

attributeNoNulls
public static final short attributeNoNulls
Indicates that NULL values might not be allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

See Also:
Constant Field Values

attributeNullable
public static final short attributeNullable
Indicates that NULL values are definitely allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

See Also:
Constant Field Values

attributeNullableUnknown
public static final short attributeNullableUnknown
Indicates that whether NULL values are allowed is not known.
A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

See Also:
Constant Field Values

sqlStateXOpen
public static final int sqlStateXOpen
Indicates that the value is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.
A possible return value for the method SQLException.getSQLState.

Since:

1.4

See Also:
Constant Field Values

sqlStateSQL99
public static final int sqlStateSQL99
Indicates that the value is an SQL99 SQLSTATE value.
A possible return value for the method SQLException.getSQLState.

Since:

1.4

See Also:
Constant Field Values

Method Detail

allProceduresAreCallable
public boolean allProceduresAreCallable()
                                 throws SQLException
Retrieves whether the current user can call all the procedures returned by the method getProcedures.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

allTablesAreSelectable
public boolean allTablesAreSelectable()
                               throws SQLException
Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

getURL
public String getURL()
              throws SQLException
Retrieves the URL for this DBMS.

Returns:
the URL for this DBMS or null if it cannot be generated
Throws:
SQLException - if a database access error occurs

getUserName
public String getUserName()
                   throws SQLException
Retrieves the user name as known to this database.

Returns:
the database user name
Throws:
SQLException - if a database access error occurs

isReadOnly
public boolean isReadOnly()
                   throws SQLException
Retrieves whether this database is in read-only mode.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

nullsAreSortedHigh
public boolean nullsAreSortedHigh()
                           throws SQLException
Retrieves whether NULL values are sorted high. Sorted high means that NULL values sort higher than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the end. By contrast, the method nullsAreSortedAtEnd indicates whether NULL values are sorted at the end regardless of sort order.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

nullsAreSortedLow
public boolean nullsAreSortedLow()
                          throws SQLException
Retrieves whether NULL values are sorted low. Sorted low means that NULL values sort lower than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the beginning. By contrast, the method nullsAreSortedAtStart indicates whether NULL values are sorted at the beginning regardless of sort order.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

nullsAreSortedAtStart
public boolean nullsAreSortedAtStart()
                              throws SQLException
Retrieves whether NULL values are sorted at the start regardless of sort order.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

nullsAreSortedAtEnd
public boolean nullsAreSortedAtEnd()
                            throws SQLException
Retrieves whether NULL values are sorted at the end regardless of sort order.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

getDatabaseProductName
public String getDatabaseProductName()
                              throws SQLException
Retrieves the name of this database product.

Returns:
database product name
Throws:
SQLException - if a database access error occurs

getDatabaseProductVersion
public String getDatabaseProductVersion()
                                 throws SQLException
Retrieves the version number of this database product.

Returns:
database version number
Throws:
SQLException - if a database access error occurs

getDriverName
public String getDriverName()
                     throws SQLException
Retrieves the name of this JDBC driver.

Returns:
JDBC driver name
Throws:
SQLException - if a database access error occurs

getDriverVersion
public String getDriverVersion()
                        throws SQLException
Retrieves the version number of this JDBC driver as a String.

Returns:
JDBC driver version
Throws:
SQLException - if a database access error occurs

getDriverMajorVersion
public int getDriverMajorVersion()
Retrieves this JDBC driver's major version number.

Returns:
JDBC driver major version

getDriverMinorVersion
public int getDriverMinorVersion()
Retrieves this JDBC driver's minor version number.

Returns:
JDBC driver minor version number

usesLocalFiles
public boolean usesLocalFiles()
                       throws SQLException
Retrieves whether this database stores tables in a local file.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

usesLocalFilePerTable
public boolean usesLocalFilePerTable()
                              throws SQLException
Retrieves whether this database uses a file for each table.

Returns:
true if this database uses a local file for each table; false otherwise
Throws:
SQLException - if a database access error occurs

supportsMixedCaseIdentifiers
public boolean supportsMixedCaseIdentifiers()
                                     throws SQLException
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

storesUpperCaseIdentifiers
public boolean storesUpperCaseIdentifiers()
                                   throws SQLException
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

storesLowerCaseIdentifiers
public boolean storesLowerCaseIdentifiers()
                                   throws SQLException
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

storesMixedCaseIdentifiers
public boolean storesMixedCaseIdentifiers()
                                   throws SQLException
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsMixedCaseQuotedIdentifiers
public boolean supportsMixedCaseQuotedIdentifiers()
                                           throws SQLException
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

storesUpperCaseQuotedIdentifiers
public boolean storesUpperCaseQuotedIdentifiers()
                                         throws SQLException
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

storesLowerCaseQuotedIdentifiers
public boolean storesLowerCaseQuotedIdentifiers()
                                         throws SQLException
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

storesMixedCaseQuotedIdentifiers
public boolean storesMixedCaseQuotedIdentifiers()
                                         throws SQLException
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

getIdentifierQuoteString
public String getIdentifierQuoteString()
                                throws SQLException
Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.

Returns:
the quoting string or a space if quoting is not supported
Throws:
SQLException - if a database access error occurs

getSQLKeywords
public String getSQLKeywords()
                      throws SQLException
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL92 keywords.

Returns:
the list of this database's keywords that are not also SQL92 keywords
Throws:
SQLException - if a database access error occurs

getNumericFunctions
public String getNumericFunctions()
                           throws SQLException
Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.

Returns:
the list of math functions supported by this database
Throws:
SQLException - if a database access error occurs

getStringFunctions
public String getStringFunctions()
                          throws SQLException
Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.

Returns:
the list of string functions supported by this database
Throws:
SQLException - if a database access error occurs

getSystemFunctions
public String getSystemFunctions()
                          throws SQLException
Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.

Returns:
a list of system functions supported by this database
Throws:
SQLException - if a database access error occurs

getTimeDateFunctions
public String getTimeDateFunctions()
                            throws SQLException
Retrieves a comma-separated list of the time and date functions available with this database.

Returns:
the list of time and date functions supported by this database
Throws:
SQLException - if a database access error occurs

getSearchStringEscape
public String getSearchStringEscape()
                             throws SQLException
Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).
The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.

Returns:
the string used to escape wildcard characters
Throws:
SQLException - if a database access error occurs

getExtraNameCharacters
public String getExtraNameCharacters()
                              throws SQLException
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

Returns:
the string containing the extra characters
Throws:
SQLException - if a database access error occurs

supportsAlterTableWithAddColumn
public boolean supportsAlterTableWithAddColumn()
                                        throws SQLException
Retrieves whether this database supports ALTER table with add column.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsAlterTableWithDropColumn
public boolean supportsAlterTableWithDropColumn()
                                         throws SQLException
Retrieves whether this database supports ALTER table with drop column.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsColumnAliasing
public boolean supportsColumnAliasing()
                               throws SQLException
Retrieves whether this database supports column aliasing.
If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

nullPlusNonNullIsNull
public boolean nullPlusNonNullIsNull()
                              throws SQLException
Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsConvert
public boolean supportsConvert()
                        throws SQLException
Retrieves whether this database supports the CONVERT function between SQL types.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsConvert
public boolean supportsConvert(int fromType,
                               int toType)
                        throws SQLException
Retrieves whether this database supports the CONVERT for two given SQL types.

Parameters:
fromType - the type to convert from; one of the type codes from the class java.sql.Types
toType - the type to convert to; one of the type codes from the class java.sql.Types
Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs
See Also:
Types

supportsTableCorrelationNames
public boolean supportsTableCorrelationNames()
                                      throws SQLException
Retrieves whether this database supports table correlation names.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsDifferentTableCorrelationNames
public boolean supportsDifferentTableCorrelationNames()
                                               throws SQLException
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsExpressionsInOrderBy
public boolean supportsExpressionsInOrderBy()
                                     throws SQLException
Retrieves whether this database supports expressions in ORDER BY lists.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsOrderByUnrelated
public boolean supportsOrderByUnrelated()
                                 throws SQLException
Retrieves whether this database supports using a column that is not in the SELECT statement in an ORDER BY clause.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsGroupBy
public boolean supportsGroupBy()
                        throws SQLException
Retrieves whether this database supports some form of GROUP BY clause.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsGroupByUnrelated
public boolean supportsGroupByUnrelated()
                                 throws SQLException
Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsGroupByBeyondSelect
public boolean supportsGroupByBeyondSelect()
                                    throws SQLException
Retrieves whether this database supports using columns not included in the SELECT statement in a GROUP BY clause provided that all of the columns in the SELECT statement are included in the GROUP BY clause.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsLikeEscapeClause
public boolean supportsLikeEscapeClause()
                                 throws SQLException
Retrieves whether this database supports specifying a LIKE escape clause.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsMultipleResultSets
public boolean supportsMultipleResultSets()
                                   throws SQLException
Retrieves whether this database supports getting multiple ResultSet objects from a single call to the method execute.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsMultipleTransactions
public boolean supportsMultipleTransactions()
                                     throws SQLException
Retrieves whether this database allows having multiple transactions open at once (on different connections).

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsNonNullableColumns
public boolean supportsNonNullableColumns()
                                   throws SQLException
Retrieves whether columns in this database may be defined as non-nullable.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsMinimumSQLGrammar
public boolean supportsMinimumSQLGrammar()
                                  throws SQLException
Retrieves whether this database supports the ODBC Minimum SQL grammar.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsCoreSQLGrammar
public boolean supportsCoreSQLGrammar()
                               throws SQLException
Retrieves whether this database supports the ODBC Core SQL grammar.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsExtendedSQLGrammar
public boolean supportsExtendedSQLGrammar()
                                   throws SQLException
Retrieves whether this database supports the ODBC Extended SQL grammar.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsANSI92EntryLevelSQL
public boolean supportsANSI92EntryLevelSQL()
                                    throws SQLException
Retrieves whether this database supports the ANSI92 entry level SQL grammar.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsANSI92IntermediateSQL
public boolean supportsANSI92IntermediateSQL()
                                      throws SQLException
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsANSI92FullSQL
public boolean supportsANSI92FullSQL()
                              throws SQLException
Retrieves whether this database supports the ANSI92 full SQL grammar supported.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsIntegrityEnhancementFacility
public boolean supportsIntegrityEnhancementFacility()
                                             throws SQLException
Retrieves whether this database supports the SQL Integrity Enhancement Facility.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsOuterJoins
public boolean supportsOuterJoins()
                           throws SQLException
Retrieves whether this database supports some form of outer join.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsFullOuterJoins
public boolean supportsFullOuterJoins()
                               throws SQLException
Retrieves whether this database supports full nested outer joins.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsLimitedOuterJoins
public boolean supportsLimitedOuterJoins()
                                  throws SQLException
Retrieves whether this database provides limited support for outer joins. (This will be true if the method supportsFullOuterJoins returns true).

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

getSchemaTerm
public String getSchemaTerm()
                     throws SQLException
Retrieves the database vendor's preferred term for "schema".

Returns:
the vendor term for "schema"
Throws:
SQLException - if a database access error occurs

getProcedureTerm
public String getProcedureTerm()
                        throws SQLException
Retrieves the database vendor's preferred term for "procedure".

Returns:
the vendor term for "procedure"
Throws:
SQLException - if a database access error occurs

getCatalogTerm
public String getCatalogTerm()
                      throws SQLException
Retrieves the database vendor's preferred term for "catalog".

Returns:
the vendor term for "catalog"
Throws:
SQLException - if a database access error occurs

isCatalogAtStart
public boolean isCatalogAtStart()
                         throws SQLException
Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.

Returns:
true if the catalog name appears at the beginning of a fully qualified table name; false otherwise
Throws:
SQLException - if a database access error occurs

getCatalogSeparator
public String getCatalogSeparator()
                           throws SQLException
Retrieves the String that this database uses as the separator between a catalog and table name.

Returns:
the separator string
Throws:
SQLException - if a database access error occurs

supportsSchemasInDataManipulation
public boolean supportsSchemasInDataManipulation()
                                          throws SQLException
Retrieves whether a schema name can be used in a data manipulation statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSchemasInProcedureCalls
public boolean supportsSchemasInProcedureCalls()
                                        throws SQLException
Retrieves whether a schema name can be used in a procedure call statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSchemasInTableDefinitions
public boolean supportsSchemasInTableDefinitions()
                                          throws SQLException
Retrieves whether a schema name can be used in a table definition statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSchemasInIndexDefinitions
public boolean supportsSchemasInIndexDefinitions()
                                          throws SQLException
Retrieves whether a schema name can be used in an index definition statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSchemasInPrivilegeDefinitions
public boolean supportsSchemasInPrivilegeDefinitions()
                                              throws SQLException
Retrieves whether a schema name can be used in a privilege definition statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsCatalogsInDataManipulation
public boolean supportsCatalogsInDataManipulation()
                                           throws SQLException
Retrieves whether a catalog name can be used in a data manipulation statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsCatalogsInProcedureCalls
public boolean supportsCatalogsInProcedureCalls()
                                         throws SQLException
Retrieves whether a catalog name can be used in a procedure call statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsCatalogsInTableDefinitions
public boolean supportsCatalogsInTableDefinitions()
                                           throws SQLException
Retrieves whether a catalog name can be used in a table definition statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsCatalogsInIndexDefinitions
public boolean supportsCatalogsInIndexDefinitions()
                                           throws SQLException
Retrieves whether a catalog name can be used in an index definition statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsCatalogsInPrivilegeDefinitions
public boolean supportsCatalogsInPrivilegeDefinitions()
                                               throws SQLException
Retrieves whether a catalog name can be used in a privilege definition statement.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsPositionedDelete
public boolean supportsPositionedDelete()
                                 throws SQLException
Retrieves whether this database supports positioned DELETE statements.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsPositionedUpdate
public boolean supportsPositionedUpdate()
                                 throws SQLException
Retrieves whether this database supports positioned UPDATE statements.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSelectForUpdate
public boolean supportsSelectForUpdate()
                                throws SQLException
Retrieves whether this database supports SELECT FOR UPDATE statements.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsStoredProcedures
public boolean supportsStoredProcedures()
                                 throws SQLException
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSubqueriesInComparisons
public boolean supportsSubqueriesInComparisons()
                                        throws SQLException
Retrieves whether this database supports subqueries in comparison expressions.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSubqueriesInExists
public boolean supportsSubqueriesInExists()
                                   throws SQLException
Retrieves whether this database supports subqueries in EXISTS expressions.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSubqueriesInIns
public boolean supportsSubqueriesInIns()
                                throws SQLException
Retrieves whether this database supports subqueries in IN statements.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsSubqueriesInQuantifieds
public boolean supportsSubqueriesInQuantifieds()
                                        throws SQLException
Retrieves whether this database supports subqueries in quantified expressions.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsCorrelatedSubqueries
public boolean supportsCorrelatedSubqueries()
                                     throws SQLException
Retrieves whether this database supports correlated subqueries.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsUnion
public boolean supportsUnion()
                      throws SQLException
Retrieves whether this database supports SQL UNION.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsUnionAll
public boolean supportsUnionAll()
                         throws SQLException
Retrieves whether this database supports SQL UNION ALL.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsOpenCursorsAcrossCommit
public boolean supportsOpenCursorsAcrossCommit()
                                        throws SQLException
Retrieves whether this database supports keeping cursors open across commits.

Returns:
true if cursors always remain open; false if they might not remain open
Throws:
SQLException - if a database access error occurs

supportsOpenCursorsAcrossRollback
public boolean supportsOpenCursorsAcrossRollback()
                                          throws SQLException
Retrieves whether this database supports keeping cursors open across rollbacks.

Returns:
true if cursors always remain open; false if they might not remain open
Throws:
SQLException - if a database access error occurs

supportsOpenStatementsAcrossCommit
public boolean supportsOpenStatementsAcrossCommit()
                                           throws SQLException
Retrieves whether this database supports keeping statements open across commits.

Returns:
true if statements always remain open; false if they might not remain open
Throws:
SQLException - if a database access error occurs

supportsOpenStatementsAcrossRollback
public boolean supportsOpenStatementsAcrossRollback()
                                             throws SQLException
Retrieves whether this database supports keeping statements open across rollbacks.

Returns:
true if statements always remain open; false if they might not remain open
Throws:
SQLException - if a database access error occurs

getMaxBinaryLiteralLength
public int getMaxBinaryLiteralLength()
                              throws SQLException
Retrieves the maximum number of hex characters this database allows in an inline binary literal.

Returns:
max the maximum length (in hex characters) for a binary literal; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxCharLiteralLength
public int getMaxCharLiteralLength()
                            throws SQLException
Retrieves the maximum number of characters this database allows for a character literal.

Returns:
the maximum number of characters allowed for a character literal; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxColumnNameLength
public int getMaxColumnNameLength()
                           throws SQLException
Retrieves the maximum number of characters this database allows for a column name.

Returns:
the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxColumnsInGroupBy
public int getMaxColumnsInGroupBy()
                           throws SQLException
Retrieves the maximum number of columns this database allows in a GROUP BY clause.

Returns:
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxColumnsInIndex
public int getMaxColumnsInIndex()
                         throws SQLException
Retrieves the maximum number of columns this database allows in an index.

Returns:
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxColumnsInOrderBy
public int getMaxColumnsInOrderBy()
                           throws SQLException
Retrieves the maximum number of columns this database allows in an ORDER BY clause.

Returns:
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxColumnsInSelect
public int getMaxColumnsInSelect()
                          throws SQLException
Retrieves the maximum number of columns this database allows in a SELECT list.

Returns:
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxColumnsInTable
public int getMaxColumnsInTable()
                         throws SQLException
Retrieves the maximum number of columns this database allows in a table.

Returns:
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxConnections
public int getMaxConnections()
                      throws SQLException
Retrieves the maximum number of concurrent connections to this database that are possible.

Returns:
the maximum number of active connections possible at one time; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxCursorNameLength
public int getMaxCursorNameLength()
                           throws SQLException
Retrieves the maximum number of characters that this database allows in a cursor name.

Returns:
the maximum number of characters allowed in a cursor name; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxIndexLength
public int getMaxIndexLength()
                      throws SQLException
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

Returns:
the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxSchemaNameLength
public int getMaxSchemaNameLength()
                           throws SQLException
Retrieves the maximum number of characters that this database allows in a schema name.

Returns:
the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxProcedureNameLength
public int getMaxProcedureNameLength()
                              throws SQLException
Retrieves the maximum number of characters that this database allows in a procedure name.

Returns:
the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxCatalogNameLength
public int getMaxCatalogNameLength()
                            throws SQLException
Retrieves the maximum number of characters that this database allows in a catalog name.

Returns:
the maximum number of characters allowed in a catalog name; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxRowSize
public int getMaxRowSize()
                  throws SQLException
Retrieves the maximum number of bytes this database allows in a single row.

Returns:
the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

doesMaxRowSizeIncludeBlobs
public boolean doesMaxRowSizeIncludeBlobs()
                                   throws SQLException
Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

getMaxStatementLength
public int getMaxStatementLength()
                          throws SQLException
Retrieves the maximum number of characters this database allows in an SQL statement.

Returns:
the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxStatements
public int getMaxStatements()
                     throws SQLException
Retrieves the maximum number of active statements to this database that can be open at the same time.

Returns:
the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxTableNameLength
public int getMaxTableNameLength()
                          throws SQLException
Retrieves the maximum number of characters this database allows in a table name.

Returns:
the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxTablesInSelect
public int getMaxTablesInSelect()
                         throws SQLException
Retrieves the maximum number of tables this database allows in a SELECT statement.

Returns:
the maximum number of tables allowed in a SELECT statement; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getMaxUserNameLength
public int getMaxUserNameLength()
                         throws SQLException
Retrieves the maximum number of characters this database allows in a user name.

Returns:
the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs

getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()
                                   throws SQLException
Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection.

Returns:
the default isolation level
Throws:
SQLException - if a database access error occurs
See Also:
Connection

supportsTransactions
public boolean supportsTransactions()
                             throws SQLException
Retrieves whether this database supports transactions. If not, invoking the method commit is a noop, and the isolation level is TRANSACTION_NONE.

Returns:
true if transactions are supported; false otherwise
Throws:
SQLException - if a database access error occurs

supportsTransactionIsolationLevel
public boolean supportsTransactionIsolationLevel(int level)
                                          throws SQLException
Retrieves whether this database supports the given transaction isolation level.

Parameters:
level - one of the transaction isolation levels defined in java.sql.Connection
Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs
See Also:
Connection

supportsDataDefinitionAndDataManipulationTransactions
public boolean supportsDataDefinitionAndDataManipulationTransactions()
                                                              throws SQLException
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

supportsDataManipulationTransactionsOnly
public boolean supportsDataManipulationTransactionsOnly()
                                                 throws SQLException
Retrieves whether this database supports only data manipulation statements within a transaction.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

dataDefinitionCausesTransactionCommit
public boolean dataDefinitionCausesTransactionCommit()
                                              throws SQLException
Retrieves whether a data definition statement within a transaction forces the transaction to commit.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

dataDefinitionIgnoredInTransactions
public boolean dataDefinitionIgnoredInTransactions()
                                            throws SQLException
Retrieves whether this database ignores a data definition statement within a transaction.

Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs

getProcedures
public ResultSet getProcedures(String catalog,
                               String schemaPattern,
                               String procedureNamePattern)
                        throws SQLException
Retrieves a description of the stored procedures available in the given catalog.
Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME.
Each procedure description has the the following columns:

PROCEDURE_CAT String => procedure catalog (may be null)
PROCEDURE_SCHEM String => procedure schema (may be null)
PROCEDURE_NAME String => procedure name
reserved for future use
reserved for future use
reserved for future use
REMARKS String => explanatory comment on the procedure
PROCEDURE_TYPE short => kind of procedure:

procedureResultUnknown - May return a result
procedureNoResult - Does not return a result
procedureReturnsResult - Returns a result

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
procedureNamePattern - a procedure name pattern; must match the procedure name as it is stored in the database
Returns:
ResultSet - each row is a procedure description
Throws:
SQLException - if a database access error occurs
See Also:
getSearchStringEscape()

getProcedureColumns
public ResultSet getProcedureColumns(String catalog,
                                     String schemaPattern,
                                     String procedureNamePattern,
                                     String columnNamePattern)
                              throws SQLException
Retrieves a description of the given catalog's stored procedure parameter and result columns.
Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the ResultSet is a parameter description or column description with the following fields:

PROCEDURE_CAT String => procedure catalog (may be null)
PROCEDURE_SCHEM String => procedure schema (may be null)
PROCEDURE_NAME String => procedure name
COLUMN_NAME String => column/parameter name
COLUMN_TYPE Short => kind of column/parameter:

procedureColumnUnknown - nobody knows
procedureColumnIn - IN parameter
procedureColumnInOut - INOUT parameter
procedureColumnOut - OUT parameter
procedureColumnReturn - procedure return value
procedureColumnResult - result column in ResultSet

DATA_TYPE int => SQL type from java.sql.Types
TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
PRECISION int => precision
LENGTH int => length in bytes of data
SCALE short => scale
RADIX short => radix
NULLABLE short => can it contain NULL.

procedureNoNulls - does not allow NULL values
procedureNullable - allows NULL values
procedureNullableUnknown - nullability unknown

REMARKS String => comment describing parameter/column

Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
procedureNamePattern - a procedure name pattern; must match the procedure name as it is stored in the database
columnNamePattern - a column name pattern; must match the column name as it is stored in the database
Returns:
ResultSet - each row describes a stored procedure parameter or column
Throws:
SQLException - if a database access error occurs
See Also:
getSearchStringEscape()

getTables
public ResultSet getTables(String catalog,
                           String schemaPattern,
                           String tableNamePattern,
                           String[] types)
                    throws SQLException
Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by table_TYPE, table_SCHEM and table_NAME.
Each table description has the following columns:

table_CAT String => table catalog (may be null)
table_SCHEM String => table schema (may be null)
table_NAME String => table name
table_TYPE String => table type. Typical types are "table", "VIEW", "SYSTEM table", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
REMARKS String => explanatory comment on the table
TYPE_CAT String => the types catalog (may be null)
TYPE_SCHEM String => the types schema (may be null)
TYPE_NAME String => type name (may be null)
SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null)
REF_GENERATION String => specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be null)

Note: Some databases may not return information for all tables.

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
tableNamePattern - a table name pattern; must match the table name as it is stored in the database
types - a list of table types to include; null returns all types
Returns:
ResultSet - each row is a table description
Throws:
SQLException - if a database access error occurs
See Also:
getSearchStringEscape()

getSchemas
public ResultSet getSchemas()
                     throws SQLException
Retrieves the schema names available in this database. The results are ordered by schema name.
The schema column is:

table_SCHEM String => schema name
table_CATALOG String => catalog name (may be null)

Returns:
a ResultSet object in which each row is a schema decription
Throws:
SQLException - if a database access error occurs

getCatalogs
public ResultSet getCatalogs()
                      throws SQLException
Retrieves the catalog names available in this database. The results are ordered by catalog name.
The catalog column is:

table_CAT String => catalog name

Returns:
a ResultSet object in which each row has a single String column that is a catalog name
Throws:
SQLException - if a database access error occurs

getTableTypes
public ResultSet getTableTypes()
                        throws SQLException
Retrieves the table types available in this database. The results are ordered by table type.
The table type is:

table_TYPE String => table type. Typical types are "table", "VIEW", "SYSTEM table", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

Returns:
a ResultSet object in which each row has a single String column that is a table type
Throws:
SQLException - if a database access error occurs

getColumns
public ResultSet getColumns(String catalog,
                            String schemaPattern,
                            String tableNamePattern,
                            String columnNamePattern)
                     throws SQLException
Retrieves a description of table columns available in the specified catalog.
Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by table_SCHEM, table_NAME, and ORDINAL_POSITION.
Each column description has the following columns:

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 => is NULL allowed.

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 => unused
SQL_DATETIME_SUB int => unused
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" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.
SCOPE_CATLOG 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 the DATA_TYPE isn't REF)
SCOPE_table String => table name that this the scope of a reference attribure (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)

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
tableNamePattern - a table name pattern; must match the table name as it is stored in the database
columnNamePattern - a column name pattern; must match the column name as it is stored in the database
Returns:
ResultSet - each row is a column description
Throws:
SQLException - if a database access error occurs
See Also:
getSearchStringEscape()

getColumnPrivileges
public ResultSet getColumnPrivileges(String catalog,
                                     String schema,
                                     String table,
                                     String columnNamePattern)
                              throws SQLException
Retrieves a description of the access rights for a table's columns.
Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:

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 => grantor of access (may be null)
GRANTEE String => grantee of access
PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
IS_GRANtable String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in the database
columnNamePattern - a column name pattern; must match the column name as it is stored in the database
Returns:
ResultSet - each row is a column privilege description
Throws:
SQLException - if a database access error occurs
See Also:
getSearchStringEscape()

getTablePrivileges
public ResultSet getTablePrivileges(String catalog,
                                    String schemaPattern,
                                    String tableNamePattern)
                             throws SQLException
Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)
Only privileges matching the schema and table name criteria are returned. They are ordered by table_SCHEM, table_NAME, and PRIVILEGE.
Each privilige description has the following columns:

table_CAT String => table catalog (may be null)
table_SCHEM String => table schema (may be null)
table_NAME String => table name
GRANTOR => grantor of access (may be null)
GRANTEE String => grantee of access
PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
IS_GRANtable String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
tableNamePattern - a table name pattern; must match the table name as it is stored in the database
Returns:
ResultSet - each row is a table privilege description
Throws:
SQLException - if a database access error occurs
See Also:
getSearchStringEscape()

getBestRowIdentifier
public ResultSet getBestRowIdentifier(String catalog,
                                      String schema,
                                      String table,
                                      int scope,
                                      boolean nullable)
                               throws SQLException
Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.
Each column description has the following columns:

SCOPE short => actual scope of result

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 => not used
DECIMAL_DIGITS short => scale
PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID

bestRowUnknown - may or may not be pseudo column
bestRowNotPseudo - is NOT a pseudo column
bestRowPseudo - is a pseudo column

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in the database
scope - the scope of interest; use same values as SCOPE
nullable - include columns that are nullable.
Returns:
ResultSet - each row is a column description
Throws:
SQLException - if a database access error occurs

getVersionColumns
public ResultSet getVersionColumns(String catalog,
                                   String schema,
                                   String table)
                            throws SQLException
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.
Each column description has the following columns:

SCOPE short => is not used
COLUMN_NAME String => column name
DATA_TYPE int => SQL data type from java.sql.Types
TYPE_NAME String => Data source-dependent type name
COLUMN_SIZE int => precision
BUFFER_LENGTH int => length of column value in bytes
DECIMAL_DIGITS short => scale
PSEUDO_COLUMN short => whether this is pseudo column like an Oracle ROWID

versionColumnUnknown - may or may not be pseudo column
versionColumnNotPseudo - is NOT a pseudo column
versionColumnPseudo - is a pseudo column

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in the database
Returns:
a ResultSet object in which each row is a column description
Throws:
SQLException - if a database access error occurs

getPrimaryKeys
public ResultSet getPrimaryKeys(String catalog,
                                String schema,
                                String table)
                         throws SQLException
Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.
Each primary key column description has the following columns:

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
KEY_SEQ short => sequence number within primary key
PK_NAME String => primary key name (may be null)

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in the database
Returns:
ResultSet - each row is a primary key column description
Throws:
SQLException - if a database access error occurs

getImportedKeys
public ResultSet getImportedKeys(String catalog,
                                 String schema,
                                 String table)
                          throws SQLException
Retrieves a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table). They are ordered by PKtable_CAT, PKtable_SCHEM, PKtable_NAME, and KEY_SEQ.
Each primary key column description has the following columns:

PKtable_CAT String => primary key table catalog being imported (may be null)
PKtable_SCHEM String => primary key table schema being imported (may be null)
PKtable_NAME String => primary key table name being imported
PKCOLUMN_NAME String => primary key column name being imported
FKtable_CAT String => foreign key table catalog (may be null)
FKtable_SCHEM String => foreign key table schema (may be null)
FKtable_NAME String => foreign key table name
FKCOLUMN_NAME String => foreign key column name
KEY_SEQ short => sequence number within a foreign key
UPDATE_RULE short => What happens to a foreign key when the primary key 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 - see SQL92 for definition
importedKeyInitiallyImmediate - see SQL92 for definition
importedKeyNotDeferrable - see SQL92 for definition

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in the database
Returns:
ResultSet - each row is a primary key column description
Throws:
SQLException - if a database access error occurs
See Also:
getExportedKeys(java.lang.String, java.lang.String, java.lang.String)

getExportedKeys
public ResultSet getExportedKeys(String catalog,
                                 String schema,
                                 String table)
                          throws SQLException
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKtable_CAT, FKtable_SCHEM, FKtable_NAME, and KEY_SEQ.
Each foreign key column description has the following columns:

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 table 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 - see SQL92 for definition
importedKeyInitiallyImmediate - see SQL92 for definition
importedKeyNotDeferrable - see SQL92 for definition

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in this database
Returns:
a ResultSet object in which each row is a foreign key column description
Throws:
SQLException - if a database access error occurs
See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

getCrossReference
public ResultSet getCrossReference(String primaryCatalog,
                                   String primarySchema,
                                   String primaryTable,
                                   String foreignCatalog,
                                   String foreignSchema,
                                   String foreignTable)
                            throws SQLException
Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key columns of the given primary key table (describe how one table imports another's key). This should normally return a single foreign key/primary key pair because most tables import a foreign key from a table only once. They are ordered by FKtable_CAT, FKtable_SCHEM, FKtable_NAME, and KEY_SEQ.
Each foreign key column description has the following columns:

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 table 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 - see SQL92 for definition
importedKeyInitiallyImmediate - see SQL92 for definition
importedKeyNotDeferrable - see SQL92 for definition

Parameters:
primaryCatalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
primarySchema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria
primaryTable - the name of the table that exports the key; must match the table name as it is stored in the database
foreignCatalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
foreignSchema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria
foreignTable - the name of the table that imports the key; must match the table name as it is stored in the database
Returns:
ResultSet - each row is a foreign key column description
Throws:
SQLException - if a database access error occurs
See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

getTypeInfo
public ResultSet getTypeInfo()
                      throws SQLException
Retrieves a description of all the standard SQL types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.
Each type description has the following columns:

TYPE_NAME String => Type name
DATA_TYPE int => SQL data type from java.sql.Types
PRECISION int => maximum precision
LITERAL_PREFIX String => prefix used to quote a literal (may be null)
LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
CREATE_PARAMS String => parameters used in creating the type (may be null)
NULLABLE short => can you use NULL for this type.

typeNoNulls - does not allow NULL values
typeNullable - allows NULL values
typeNullableUnknown - nullability unknown

CASE_SENSITIVE boolean=> is it case sensitive.
SEARCHABLE short => can you use "WHERE" based on this type:

typePredNone - No support
typePredChar - Only supported with WHERE .. LIKE
typePredBasic - Supported except for WHERE .. LIKE
typeSearchable - Supported for all WHERE ..

UNSIGNED_ATTRIBUTE boolean => is it unsigned.
FIXED_PREC_SCALE boolean => can it be a money value.
AUTO_INCREMENT boolean => can it be used for an auto-increment value.
LOCAL_TYPE_NAME String => localized version of type name (may be null)
MINIMUM_SCALE short => minimum scale supported
MAXIMUM_SCALE short => maximum scale supported
SQL_DATA_TYPE int => unused
SQL_DATETIME_SUB int => unused
NUM_PREC_RADIX int => usually 2 or 10

Returns:
a ResultSet object in which each row is an SQL type description
Throws:
SQLException - if a database access error occurs

getIndexInfo
public ResultSet getIndexInfo(String catalog,
                              String schema,
                              String table,
                              boolean unique,
                              boolean approximate)
                       throws SQLException
Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.
Each index column description has the following columns:

table_CAT String => table catalog (may be null)
table_SCHEM String => table schema (may be null)
table_NAME String => table name
NON_UNIQUE boolean => Can index values be non-unique. false when TYPE is tableIndexStatistic
INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
TYPE short => index type:

tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
tableIndexClustered - this is a clustered index
tableIndexHashed - this is a hashed index
tableIndexOther - this is some other style of index

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, then 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 tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
FILTER_CONDITION String => Filter condition, if any. (may be null)

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in this database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in this database
unique - when true, return only indices for unique values; when false, return indices regardless of whether unique or not
approximate - when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate
Returns:
ResultSet - each row is an index column description
Throws:
SQLException - if a database access error occurs

supportsResultSetType
public boolean supportsResultSetType(int type)
                              throws SQLException
Retrieves whether this database supports the given result set type.

Parameters:
type - defined in java.sql.ResultSet
Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

See Also:
Connection

supportsResultSetConcurrency
public boolean supportsResultSetConcurrency(int type,
                                            int concurrency)
                                     throws SQLException
Retrieves whether this database supports the given concurrency type in combination with the given result set type.

Parameters:
type - defined in java.sql.ResultSet
concurrency - type defined in java.sql.ResultSet
Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

See Also:
Connection

ownUpdatesAreVisible
public boolean ownUpdatesAreVisible(int type)
                             throws SQLException
Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if updates are visible for the given result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

ownDeletesAreVisible
public boolean ownDeletesAreVisible(int type)
                             throws SQLException
Retrieves whether a result set's own deletes are visible.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if deletes are visible for the given result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

ownInsertsAreVisible
public boolean ownInsertsAreVisible(int type)
                             throws SQLException
Retrieves whether a result set's own inserts are visible.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if inserts are visible for the given result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

othersUpdatesAreVisible
public boolean othersUpdatesAreVisible(int type)
                                throws SQLException
Retrieves whether updates made by others are visible.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if updates made by others are visible for the given result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

othersDeletesAreVisible
public boolean othersDeletesAreVisible(int type)
                                throws SQLException
Retrieves whether deletes made by others are visible.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if deletes made by others are visible for the given result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

othersInsertsAreVisible
public boolean othersInsertsAreVisible(int type)
                                throws SQLException
Retrieves whether inserts made by others are visible.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if inserts made by others are visible for the given result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

updatesAreDetected
public boolean updatesAreDetected(int type)
                           throws SQLException
Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if changes are detected by the result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

deletesAreDetected
public boolean deletesAreDetected(int type)
                           throws SQLException
Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted. If the method deletesAreDetected returns false, it means that deleted rows are removed from the result set.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if deletes are detected by the given result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

insertsAreDetected
public boolean insertsAreDetected(int type)
                           throws SQLException
Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.

Parameters:
type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if changes are detected by the specified result set type; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

supportsBatchUpdates
public boolean supportsBatchUpdates()
                             throws SQLException
Retrieves whether this database supports batch updates.

Returns:
true if this database supports batch upcates; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.2

getUDTs
public ResultSet getUDTs(String catalog,
                         String schemaPattern,
                         String typeNamePattern,
                         int[] types)
                  throws SQLException
Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.
Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.
Each type description has the following columns:

TYPE_CAT String => the type's catalog (may be null)
TYPE_SCHEM String => type's schema (may be null)
TYPE_NAME String => type name
CLASS_NAME String => Java class name
DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
REMARKS String => explanatory comment on the type
BASE_TYPE short => type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in java.sql.Types (null if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)

Note: If the driver does not support UDTs, an empty result set is returned.

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema pattern name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
typeNamePattern - a type name pattern; must match the type name as it is stored in the database; may be a fully qualified name
types - a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include; null returns all types
Returns:
ResultSet object in which each row describes a UDT
Throws:
SQLException - if a database access error occurs
Since:

1.2

getConnection
public Connection getConnection()
                         throws SQLException
Retrieves the connection that produced this metadata object.

Returns:
the connection that produced this metadata object
Throws:
SQLException - if a database access error occurs
Since:

1.2

supportsSavepoints
public boolean supportsSavepoints()
                           throws SQLException
Retrieves whether this database supports savepoints.

Returns:
true if savepoints are supported; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.4

supportsNamedParameters
public boolean supportsNamedParameters()
                                throws SQLException
Retrieves whether this database supports named parameters to callable statements.

Returns:
true if named parameters are supported; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.4

supportsMultipleOpenResults
public boolean supportsMultipleOpenResults()
                                    throws SQLException
Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.

Returns:
true if a CallableStatement object can return multiple ResultSet objects simultaneously; false otherwise
Throws:
SQLException - if a datanase access error occurs
Since:

1.4

supportsGetGeneratedKeys
public boolean supportsGetGeneratedKeys()
                                 throws SQLException
Retrieves whether auto-generated keys can be retrieved after a statement has been executed.

Returns:
true if auto-generated keys can be retrieved after a statement has executed; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.4

getSuperTypes
public ResultSet getSuperTypes(String catalog,
                               String schemaPattern,
                               String typeNamePattern)
                        throws SQLException
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.
Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.
If a UDT does not have a direct super type, it is not listed here. A row of the ResultSet object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:

TYPE_CAT String => the UDT's catalog (may be null)
TYPE_SCHEM String => UDT's schema (may be null)
TYPE_NAME String => type name of the UDT
SUPERTYPE_CAT String => the direct super type's catalog (may be null)
SUPERTYPE_SCHEM String => the direct super type's schema (may be null)
SUPERTYPE_NAME String => the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

Parameters:
catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern - a schema name pattern; "" retrieves those without a schema
typeNamePattern - a UDT name pattern; may be a fully-qualified name
Returns:
a ResultSet object in which a row gives information about the designated UDT
Throws:
SQLException - if a database access error occurs
Since:

1.4

getSuperTables
public ResultSet getSuperTables(String catalog,
                                String schemaPattern,
                                String tableNamePattern)
                         throws SQLException
Retrieves a description of the table hierarchies defined in a particular schema in this database.
Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.
Each type description has the following columns:

table_CAT String => the type's catalog (may be null)
table_SCHEM String => type's schema (may be null)
table_NAME String => type name
SUPERtable_NAME String => the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

Parameters:
catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern - a schema name pattern; "" retrieves those without a schema
tableNamePattern - a table name pattern; may be a fully-qualified name
Returns:
a ResultSet object in which each row is a type description
Throws:
SQLException - if a database access error occurs
Since:

1.4

getAttributes
public ResultSet getAttributes(String catalog,
                               String schemaPattern,
                               String typeNamePattern,
                               String attributeNamePattern)
                        throws SQLException
Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.
Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by TYPE_SCHEM, TYPE_NAME and ORDINAL_POSITION. This description does not contain inherited attributes.
The ResultSet object that is returned has the following columns:

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 => whether NULL is 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 => unused
SQL_DATETIME_SUB int => unused
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" means column definitely does not allow NULL values; "YES" means 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)

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
typeNamePattern - a type name pattern; must match the type name as it is stored in the database
attributeNamePattern - an attribute name pattern; must match the attribute name as it is declared in the database
Returns:
a ResultSet object in which each row is an attribute description
Throws:
SQLException - if a database access error occurs
Since:

1.4

supportsResultSetHoldability
public boolean supportsResultSetHoldability(int holdability)
                                     throws SQLException
Retrieves whether this database supports the given result set holdability.

Parameters:
holdability - one of the following constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
true if so; false otherwise
Throws:
SQLException - if a database access error occurs
Since:

1.4

See Also:
Connection

getResultSetHoldability
public int getResultSetHoldability()
                            throws SQLException
Retrieves the default holdability of this ResultSet object.

Returns:
the default holdability; either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
SQLException - if a database access error occurs
Since:

1.4

getDatabaseMajorVersion
public int getDatabaseMajorVersion()
                            throws SQLException
Retrieves the major version number of the underlying database.

Returns:
the underlying database's major version
Throws:
SQLException - if a database access error occurs
Since:

1.4

getDatabaseMinorVersion
public int getDatabaseMinorVersion()
                            throws SQLException
Retrieves the minor version number of the underlying database.

Returns:
underlying database's minor version
Throws:
SQLException - if a database access error occurs
Since:

1.4

getJDBCMajorVersion
public int getJDBCMajorVersion()
                        throws SQLException
Retrieves the major JDBC version number for this driver.

Returns:
JDBC version major number
Throws:
SQLException - if a database access error occurs
Since:

1.4

getJDBCMinorVersion
public int getJDBCMinorVersion()
                        throws SQLException
Retrieves the minor JDBC version number for this driver.

Returns:
JDBC version minor number
Throws:
SQLException - if a database access error occurs
Since:

1.4

getSQLStateType
public int getSQLStateType()
                    throws SQLException
Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL99.

Returns:
the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL99
Throws:
SQLException - if a database access error occurs
Since:

1.4

locatorsUpdateCopy
public boolean locatorsUpdateCopy()
                           throws SQLException
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

Returns:
true if updates are made to a copy of the LOB; false if updates are made directly to the LOB
Throws:
SQLException - if a database access error occurs
Since:

1.4

supportsStatementPooling
public boolean supportsStatementPooling()
                                 throws SQLException
Retrieves whether this database supports statement pooling.

Returns:
true if so; false otherwise
Throws:
SQLExcpetion - if a database access error occurs
SQLException
Since:

1.4

Field Summary
static short	attributeNoNulls Indicates that NULL values might not be allowed.
static short	attributeNullable Indicates that NULL values are definitely allowed.
static short	attributeNullableUnknown Indicates that whether NULL values are allowed is not known.
static int	bestRowNotPseudo Indicates that the best row identifier is NOT a pseudo column.
static int	bestRowPseudo Indicates that the best row identifier is a pseudo column.
static int	bestRowSession Indicates that the scope of the best row identifier is the remainder of the current session.
static int	bestRowTemporary Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.
static int	bestRowTransaction Indicates that the scope of the best row identifier is the remainder of the current transaction.
static int	bestRowUnknown Indicates that the best row identifier may or may not be a pseudo column.
static int	columnNoNulls Indicates that the column might not allow NULL values.
static int	columnNullable Indicates that the column definitely allows NULL values.
static int	columnNullableUnknown Indicates that the nullability of columns is unknown.
static int	importedKeyCascade For the column UPDATE_RULE, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it.
static int	importedKeyInitiallyDeferred Indicates deferrability.
static int	importedKeyInitiallyImmediate Indicates deferrability.
static int	importedKeyNoAction For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key has been imported, it cannot be updated or deleted.
static int	importedKeyNotDeferrable Indicates deferrability.
static int	importedKeyRestrict For the column UPDATE_RULE, indicates that a primary key may not be updated if it has been imported by another table as a foreign key.
static int	importedKeySetDefault For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.
static int	importedKeySetNull For the columns UPDATE_RULE and DELETE_RULE, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL.
static int	procedureColumnIn Indicates that the column stores IN parameters.
static int	procedureColumnInOut Indicates that the column stores INOUT parameters.
static int	procedureColumnOut Indicates that the column stores OUT parameters.
static int	procedureColumnResult Indicates that the column stores results.
static int	procedureColumnReturn Indicates that the column stores return values.
static int	procedureColumnUnknown Indicates that type of the column is unknown.
static int	procedureNoNulls Indicates that NULL values are not allowed.
static int	procedureNoResult Indicates that the procedure does not return a result.
static int	procedureNullable Indicates that NULL values are allowed.
static int	procedureNullableUnknown Indicates that whether NULL values are allowed is unknown.
static int	procedureResultUnknown Indicates that it is not known whether the procedure returns a result.
static int	procedureReturnsResult Indicates that the procedure returns a result.
static int	sqlStateSQL99 Indicates that the value is an SQL99 SQLSTATE value.
static int	sqlStateXOpen Indicates that the value is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.
static short	tableIndexClustered Indicates that this table index is a clustered index.
static short	tableIndexHashed Indicates that this table index is a hashed index.
static short	tableIndexOther Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.
static short	tableIndexStatistic Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.
static int	typeNoNulls Indicates that a NULL value is NOT allowed for this data type.
static int	typeNullable Indicates that a NULL value is allowed for this data type.
static int	typeNullableUnknown Indicates that it is not known whether a NULL value is allowed for this data type.
static int	typePredBasic Indicates that one can base all WHERE search clauses except WHERE .
static int	typePredChar Indicates that the only WHERE search clause that can be based on this type is WHERE .
static int	typePredNone Indicates that WHERE search clauses are not supported for this type.
static int	typeSearchable Indicates that all WHERE search clauses can be based on this type.
static int	versionColumnNotPseudo Indicates that this version column is NOT a pseudo column.
static int	versionColumnPseudo Indicates that this version column is a pseudo column.
static int	versionColumnUnknown Indicates that this version column may or may not be a pseudo column.

java.sql Interface DatabaseMetaData

Field Summary

Method Summary

Field Detail

procedureResultUnknown

procedureNoResult

procedureReturnsResult

procedureColumnUnknown

procedureColumnIn

procedureColumnInOut

procedureColumnOut

procedureColumnReturn

procedureColumnResult

procedureNoNulls

procedureNullable

procedureNullableUnknown

columnNoNulls

columnNullable

columnNullableUnknown

bestRowTemporary

bestRowTransaction

bestRowSession

bestRowUnknown

bestRowNotPseudo

bestRowPseudo

versionColumnUnknown

versionColumnNotPseudo

versionColumnPseudo

importedKeyCascade

importedKeyRestrict

importedKeySetNull

importedKeyNoAction

importedKeySetDefault

importedKeyInitiallyDeferred

importedKeyInitiallyImmediate

importedKeyNotDeferrable

typeNoNulls

typeNullable

typeNullableUnknown

typePredNone

typePredChar

typePredBasic

typeSearchable

tableIndexStatistic

tableIndexClustered

tableIndexHashed

tableIndexOther

attributeNoNulls

attributeNullable

attributeNullableUnknown

sqlStateXOpen

sqlStateSQL99

Method Detail

allProceduresAreCallable

allTablesAreSelectable

getURL

getUserName

isReadOnly

nullsAreSortedHigh

nullsAreSortedLow

nullsAreSortedAtStart

nullsAreSortedAtEnd

getDatabaseProductName

getDatabaseProductVersion

getDriverName

getDriverVersion

getDriverMajorVersion

getDriverMinorVersion

usesLocalFiles

usesLocalFilePerTable

supportsMixedCaseIdentifiers

storesUpperCaseIdentifiers

storesLowerCaseIdentifiers

storesMixedCaseIdentifiers

supportsMixedCaseQuotedIdentifiers

storesUpperCaseQuotedIdentifiers

storesLowerCaseQuotedIdentifiers

storesMixedCaseQuotedIdentifiers

getIdentifierQuoteString

getSQLKeywords

java.sql
Interface DatabaseMetaData