Build 1.0_r1(from source)

java.sql
Interface DatabaseMetaData


public interface DatabaseMetaData

An interface which provides comprehensive information about the database.

This interface is implemented by JDBC driver writers in order to provide information about the underlying Database capabilities and the JDBC driver capabilities taken together.

Some of the methods in this interface take String parameters which are Patterns. Within these string Patterns, '%' and '_' characters have special meanings. '%' means "match any substring of 0 or more characters". '_' means "match any one character". Only metadata entries that match the pattern are returned. If such a search pattern string is set to null, that argument's criteria are dropped from the search.


Field Summary
static short attributeNoNulls
          States that it may not be permitted to store NULL values.
static short attributeNullable
          States that NULL values are definitely permitted.
static short attributeNullableUnknown
          States that whether NULL values are permitted is unknown.
static int bestRowNotPseudo
          States the best row identifier is NOT a pseudo column.
static int bestRowPseudo
          States that the best row identifier is a pseudo column.
static int bestRowSession
          States that the remainder of the current session is used as the scope for the best row identifier.
static int bestRowTemporary
          States that best row identifier scope lasts only while the row is being used.
static int bestRowTransaction
          States that the remainder of the current transaction is used as the scope for the best row identifier.
static int bestRowUnknown
          States that the best row identifier may or may not be a pseudo column.
static int columnNoNulls
          States that the column might not allow NULL values.
static int columnNullable
          States that the column definitely allows NULL values.
static int columnNullableUnknown
          States that it is unknown whether the columns may be nulled.
static int importedKeyCascade
          For the column UPDATE_RULE, States that when the primary key is updated, the foreign key (imported key) is changed to agree with it.
static int importedKeyInitiallyDeferred
          States deferrability.
static int importedKeyInitiallyImmediate
          States defer-ability.
static int importedKeyNoAction
          For the columns UPDATE_RULE and DELETE_RULE, States that if the primary key has been imported, it cannot be updated or deleted.
static int importedKeyNotDeferrable
          States defer-ability.
static int importedKeyRestrict
          States that a primary key must not be updated when imported as a foreign key by some other table.
static int importedKeySetDefault
          States that when the primary key is modified (updated or deleted) the foreign (imported) key is changed to its default value.
static int importedKeySetNull
          States that when the primary key is modified (updated or deleted) the foreign (imported) key is changed to NULL.
static int procedureColumnIn
          States that this column stores IN type parameters.
static int procedureColumnInOut
          States that this column stores INOUT type parameters.
static int procedureColumnOut
          States that this column stores OUT type parameters.
static int procedureColumnResult
          States that the column stores results
static int procedureColumnReturn
          States that the column stores return values.
static int procedureColumnUnknown
          States that type of the column is unknown.
static int procedureNoNulls
          States that NULL values are not permitted.
static int procedureNoResult
          States that the procedure does not return a result.
static int procedureNullable
          States that NULL values are permitted.
static int procedureNullableUnknown
          States that whether NULL values are permitted is unknown.
static int procedureResultUnknown
          States that it is unknown whether or not the procedure returns a result.
static int procedureReturnsResult
          States that the procedure returns a result.
static int sqlStateSQL99
          States that the value is an SQL99 SQLSTATE value.
static int sqlStateXOpen
          States that the value is an SQL CLI SQLSTATE value as defined by X/Open (who are now know as Open Group) .
static short tableIndexClustered
          States that this table index is a clustered index.
static short tableIndexHashed
          States that this table index is a hashed index.
static short tableIndexOther
          States this table's index is neither a clustered index, not a hashed index, and not a table statistics index; i.e.
static short tableIndexStatistic
          States this column has the table's statistics, and that it is returned in conjunction with the table's index description.
static int typeNoNulls
          States that a NULL value is NOT permitted for this data type.
static int typeNullable
          States that a NULL value is permitted for this data type.
static int typeNullableUnknown
          States that it is unknown if a NULL value is permitted for this data type.
static int typePredBasic
          States that one can base all WHERE search clauses except WHERE .
static int typePredChar
          States that WHERE is the only WHERE search clause that may be based on this type.
static int typePredNone
          States that this type does not support WHERE search clauses.
static int typeSearchable
          States that all WHERE search clauses may be based on this type.
static int versionColumnNotPseudo
          States that the version column is known to be not a pseudo column.
static int versionColumnPseudo
          States that this version column is known to be a pseudo column.
static int versionColumnUnknown
          States that the version column may be a pseudo column or not.
 
Method Summary
 boolean allProceduresAreCallable()
          Returns whether all procedures returned by getProcedures can be called by the current user.
 boolean allTablesAreSelectable()
          Returns whether all the tables returned by getTables can be used by the current user in a SELECT statement.
 boolean dataDefinitionCausesTransactionCommit()
          Returns if a data definition statement in a transaction forces a commit of the transaction.
 boolean dataDefinitionIgnoredInTransactions()
          Returns whether the database ignores data definition statements within a transaction.
 boolean deletesAreDetected(int type)
          Returns whether a visible row delete can be detected by calling ResultSet.rowDeleted.
 boolean doesMaxRowSizeIncludeBlobs()
          Returns whether the return value of getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.
 ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)
          Returns a description of the specified attribute of the specified type for an SQL User Defined Type (UDT) for a specified schema and catalog.
 ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
          Returns a list of a table's optimal set of columns that uniquely identifies a row.
 ResultSet getCatalogs()
          Returns the set of catalog names available in this database.
 String getCatalogSeparator()
          Returns the separator that this database uses between a catalog name and table name.
 String getCatalogTerm()
          Returns the term that the database vendor prefers term for "catalog".
 ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)
          Returns a description of access rights for a table's columns.
 ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
          Returns a description of table columns available in a specified catalog.
 Connection getConnection()
          Returns the database connection that created this metadata.
 ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)
          Returns a list of foreign key columns in a given foreign key table that reference the primary key columns of a supplied primary key table.
 int getDatabaseMajorVersion()
          Returns the major version number of the database software.
 int getDatabaseMinorVersion()
          Returns the minor version number of the database software.
 String getDatabaseProductName()
          Returns the name of the database software.
 String getDatabaseProductVersion()
          Returns the version number of this database software.
 int getDefaultTransactionIsolation()
          Returns the default transaction isolation level for this database.
 int getDriverMajorVersion()
          Returns the JDBC driver's major version number.
 int getDriverMinorVersion()
          Returns the JDBC driver's minor version number.
 String getDriverName()
          Returns the name of this JDBC driver.
 String getDriverVersion()
          Returns the version number of this JDBC driver.
 ResultSet getExportedKeys(String catalog, String schema, String table)
          Returns a list of the foreign key columns that reference the primary key columns of a specified table (the foreign keys exported by a table).
 String getExtraNameCharacters()
          Returns a string of characters that may be used in unquoted identifier names.
 String getIdentifierQuoteString()
          Returns the string used to quote SQL identifiers.
 ResultSet getImportedKeys(String catalog, String schema, String table)
          Returns a list columns in a table that are both primary keys and referenced by the table's foreign key columns (that is, the primary keys imported by a table).
 ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
          Returns a list of indices and statistics for a specified table.
 int getJDBCMajorVersion()
          Returns this driver's major JDBC version number.
 int getJDBCMinorVersion()
          Returns the minor JDBC version number for this driver.
 int getMaxBinaryLiteralLength()
          Get the maximum number of hex characters in an in-line binary literal for this database.
 int getMaxCatalogNameLength()
          Returns the maximum size of a Catalog name in this database.
 int getMaxCharLiteralLength()
          Returns the maximum size for a character literal in this database.
 int getMaxColumnNameLength()
          Returns the maximum size for a Column name for this database.
 int getMaxColumnsInGroupBy()
          Get the maximum number of columns in a GROUP BY clause for this database.
 int getMaxColumnsInIndex()
          Returns the maximum number of columns in an Index for this database.
 int getMaxColumnsInOrderBy()
          Returns the maximum number of columns in an ORDER BY clause for this database.
 int getMaxColumnsInSelect()
          Returns the maximum number of columns in a SELECT list for this database.
 int getMaxColumnsInTable()
          Returns the maximum number of columns in a table for this database.
 int getMaxConnections()
          Returns the database's maximum number of concurrent connections.
 int getMaxCursorNameLength()
          Returns the maximum length of a cursor name for this database.
 int getMaxIndexLength()
          Returns the maximum length in bytes for an Index for this database.
 int getMaxProcedureNameLength()
          Returns the maximum number of characters for a procedure name in this database.
 int getMaxRowSize()
          Returns the maximum number of bytes within a single row for this database.
 int getMaxSchemaNameLength()
          Returns the maximum number of characters in a schema name for this database.
 int getMaxStatementLength()
          Returns the maximum number of characters in an SQL statement for this database.
 int getMaxStatements()
          Get the maximum number of simultaneously open active statements for this database.
 int getMaxTableNameLength()
          Returns the maximum size for a table name in the database.
 int getMaxTablesInSelect()
          Returns the maximum number of tables permitted in a SELECT statement for the database.
 int getMaxUserNameLength()
          Returns the maximum number of characters in a user name for the database.
 String getNumericFunctions()
          Returns a list of the math functions available with this database.
 ResultSet getPrimaryKeys(String catalog, String schema, String table)
          Returns a list of the primary key columns of a specified table.
 ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
          Returns a list of parameter and result columns for the stored procedures belonging to a specified Catalog.
 ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern)
          Returns a list of the stored procedures available in a specified catalog.
 String getProcedureTerm()
          Returns the database vendor's preferred name for "procedure".
 int getResultSetHoldability()
          Returns the result set's default hold-ability.
 ResultSet getSchemas()
          Returns a list of the schema names in the database.
 String getSchemaTerm()
          Returns the database vendor's preferred term for "schema".
 String getSearchStringEscape()
          Returns the string that is used to escape wildcard characters.
 String getSQLKeywords()
          Returns a list of all the SQL keywords that are NOT also SQL92 keywords for the database.
 int getSQLStateType()
          States the type of SQLState value returned by SQLException.getSQLState.
 String getStringFunctions()
          Returns a list of string functions available with the database.
 ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern)
          Returns a listing of the hierarchies of tables in a specified schema in the database.
 ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)
          Returns the User Defined Type (UDT) hierarchies for a given schema.
 String getSystemFunctions()
          Returns a list of system functions available with the database.
 ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)
          Returns a description of access rights for each table present in a catalog.
 ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)
          Returns a description of the tables in a specified catalog.
 ResultSet getTableTypes()
          Returns a list of table types supported by the database.
 String getTimeDateFunctions()
          Returns a list of time and date functions available for the database.
 ResultSet getTypeInfo()
          Get a list of the standard SQL Types supported by this database.
 ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)
          Returns a description of the User Defined Types (UDTs) defined in a given schema, which includes the types DISTINCT, STRUCT and JAVA_OBJECT.
 String getURL()
          Returns the URL for this database.
 String getUserName()
          Determine the user name as known by the database.
 ResultSet getVersionColumns(String catalog, String schema, String table)
          Returns which of a table's columns are automatically updated when any value in a row is updated.
 boolean insertsAreDetected(int type)
          Determine if a visible row insert can be detected by calling ResultSet.rowInserted.
 boolean isCatalogAtStart()
          Determine whether a fully qualified table name is prefixed or suffixed to a fully qualified table name.
 boolean isReadOnly()
          Determine if the database is in read-only mode.
 boolean locatorsUpdateCopy()
          Determine if updates are made to a copy of, or directly on, Large Objects (LOBs).
 boolean nullPlusNonNullIsNull()
          Determine if the database handles concatenations between NULL and non-NULL values by producing a NULL output.
 boolean nullsAreSortedAtEnd()
          Determine if NULL values are always sorted to the end of sorted results regardless of requested sort order.
 boolean nullsAreSortedAtStart()
          Determine if NULL values are always sorted at the start of the sorted list, irrespective of the sort order.
 boolean nullsAreSortedHigh()
          Determine if NULL values are sorted high - i.e.
 boolean nullsAreSortedLow()
          Determine if NULL values are sorted low - ie they are sorted as if they are lower than any other values.
 boolean othersDeletesAreVisible(int type)
          Determine if deletes made by others are visible, for a specified ResultSet type.
 boolean othersInsertsAreVisible(int type)
          Determine if inserts made by others are visible, for a specified ResultSet type.
 boolean othersUpdatesAreVisible(int type)
          Determine if updates made by others are visible, for a specified ResultSet type.
 boolean ownDeletesAreVisible(int type)
          Determine if a ResultSet's own deletes are visible, for a specified ResultSet type.
 boolean ownInsertsAreVisible(int type)
          Determine if its own inserts are visible to a given ResultSet type.
 boolean ownUpdatesAreVisible(int type)
          Determine if for a supplied type of ResultSet, the ResultSet's own updates are visible.
 boolean storesLowerCaseIdentifiers()
          Determine whether the database treats SQL identifiers that are in mixed case (and unquoted) as case insensitive.
 boolean storesLowerCaseQuotedIdentifiers()
          Determine whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in lower case.
 boolean storesMixedCaseIdentifiers()
          Determine whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.
 boolean storesMixedCaseQuotedIdentifiers()
          Determine whether the database considers identifiers as case insensitive if they are mixed case quoted SQL.
 boolean storesUpperCaseIdentifiers()
          Determine whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.
 boolean storesUpperCaseQuotedIdentifiers()
          Determine whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in upper case.
 boolean supportsAlterTableWithAddColumn()
          Determine if the database supports ALTER TABLE operation with add column.
 boolean supportsAlterTableWithDropColumn()
          Determine if the database supports ALTER TABLE operation with drop column.
 boolean supportsANSI92EntryLevelSQL()
          Determine if the database supports the ANSI92 entry level SQL grammar.
 boolean supportsANSI92FullSQL()
          Determine if the database supports the ANSI92 full SQL grammar.
 boolean supportsANSI92IntermediateSQL()
          Determine if the database supports the ANSI92 intermediate SQL Grammar.
 boolean supportsBatchUpdates()
          Determine if the database supports Batch Updates.
 boolean supportsCatalogsInDataManipulation()
          Determine whether catalog names may be used in data manipulation statements.
 boolean supportsCatalogsInIndexDefinitions()
          Determine if catalog names can be used in Index Definition statements.
 boolean supportsCatalogsInPrivilegeDefinitions()
          Determine if catalog names can be used in privilege definition statements.
 boolean supportsCatalogsInProcedureCalls()
          Determine if catalog names can be used in procedure call statements.
 boolean supportsCatalogsInTableDefinitions()
          Determine if catalog names may be used in table definition statements.
 boolean supportsColumnAliasing()
          Determine if the database supports column aliasing.
 boolean supportsConvert()
          Determine if the database supports the CONVERT operation between SQL types.
 boolean supportsConvert(int fromType, int toType)
          Determine if the database supports CONVERT operation for two supplied SQL types.
 boolean supportsCoreSQLGrammar()
          Determine if the database supports the Core SQL Grammar for ODBC.
 boolean supportsCorrelatedSubqueries()
          Determine if the database supports correlated sub-queries.
 boolean supportsDataDefinitionAndDataManipulationTransactions()
          Determine if the database allows both data definition and data manipulation statements inside a transaction.
 boolean supportsDataManipulationTransactionsOnly()
          Determine if the database only allows data manipulation statements inside a transaction.
 boolean supportsDifferentTableCorrelationNames()
          Determine if table correlation names are restricted to be different from the names of the tables, when they are supported.
 boolean supportsExpressionsInOrderBy()
          Determine whether expressions in ORDER BY lists are supported.
 boolean supportsExtendedSQLGrammar()
          Determine whether the Extended SQL Grammar for ODBC is supported.
 boolean supportsFullOuterJoins()
          Determine if the database supports full nested outer joins.
 boolean supportsGetGeneratedKeys()
          Determine if auto generated keys can be returned when a statement executes.
 boolean supportsGroupBy()
          Determine if the database supports a form of GROUP BY clause.
 boolean supportsGroupByBeyondSelect()
          Determine if the database supports using a column name in a GROUP BY clause not included in the SELECT statement as long as all of the columns in the SELECT statement are used in the GROUP BY clause.
 boolean supportsGroupByUnrelated()
          Determine if the database supports using a column name in a GROUP BY clause that is not in the SELECT statement.
 boolean supportsIntegrityEnhancementFacility()
          Determine whether the database supports SQL Integrity Enhancement Facility.
 boolean supportsLikeEscapeClause()
          Determine if the database supports using a LIKE escape clause.
 boolean supportsLimitedOuterJoins()
          Determine if the database provides limited support for outer Join operations.
 boolean supportsMinimumSQLGrammar()
          Determine if the database supports Minimum SQL Grammar for ODBC.
 boolean supportsMixedCaseIdentifiers()
          Determine if the database treats mixed case unquoted SQL identifiers as case sensitive storing them in mixed case.
 boolean supportsMixedCaseQuotedIdentifiers()
          Determine whether the database considers mixed case quoted SQL identifiers as case sensitive, storing them in mixed case.
 boolean supportsMultipleOpenResults()
          Determine if it is possible for a single CallableStatement to return multiple ResultSets simultaneously.
 boolean supportsMultipleResultSets()
          Determine whether retrieving multiple ResultSets from a single call to the execute method is supported.
 boolean supportsMultipleTransactions()
          Determine whether multiple transactions in progress at at time on different connections are supported.
 boolean supportsNamedParameters()
          Determine whether call-able statements with named parameters is supported.
 boolean supportsNonNullableColumns()
          Determine if columns in the database can be defined as non-nullable.
 boolean supportsOpenCursorsAcrossCommit()
          Determine whether keeping Cursors open across Commit operations is supported.
 boolean supportsOpenCursorsAcrossRollback()
          Determine if the database can keep Cursors open across Rollback operations.
 boolean supportsOpenStatementsAcrossCommit()
          Determine whether keeping Statements open across Commit operations is supported.
 boolean supportsOpenStatementsAcrossRollback()
          Determine whether keeping Statements open across Rollback operations is supported.
 boolean supportsOrderByUnrelated()
          Determine whether using a column in an ORDER BY clause that is not in the SELECT statement is supported.
 boolean supportsOuterJoins()
          Determine whether outer join operations are supported.
 boolean supportsPositionedDelete()
          Determine whether positioned DELETE statements are supported.
 boolean supportsPositionedUpdate()
          Determine whether positioned UPDATE statements are supported.
 boolean supportsResultSetConcurrency(int type, int concurrency)
          Determine whether there is support for a given concurrency style for the given ResultSet.
 boolean supportsResultSetHoldability(int holdability)
          Determine whether the supplied ResultSet holdability is supported.
 boolean supportsResultSetType(int type)
          Determine whether the supplied ResultSet type is supported.
 boolean supportsSavepoints()
          Determine whether Savepoints for transactions are supported.
 boolean supportsSchemasInDataManipulation()
          Determine whether a schema name may be used in a data manipulation statement.
 boolean supportsSchemasInIndexDefinitions()
          Determine whether a schema name may be used in an index definition statement.
 boolean supportsSchemasInPrivilegeDefinitions()
          Determine whether a database schema name can be used in a privilege definition statement.
 boolean supportsSchemasInProcedureCalls()
          Determine if a procedure call statement may be contain in a schema name.
 boolean supportsSchemasInTableDefinitions()
          Determine if a schema name can be used in a table definition statement.
 boolean supportsSelectForUpdate()
          Determine if this SELECT FOR UPDATE statements ar supported.
 boolean supportsStatementPooling()
          Determine whether statement pooling is supported.
 boolean supportsStoredProcedures()
          Determine whether stored procedure calls using the stored procedure escape syntax is supported.
 boolean supportsSubqueriesInComparisons()
          Determine whether subqueries in comparison expressions are supported.
 boolean supportsSubqueriesInExists()
          Determine whether subqueries in EXISTS expressions are supported.
 boolean supportsSubqueriesInIns()
          Determine whether subqueries in IN statements are supported.
 boolean supportsSubqueriesInQuantifieds()
          Determine whether subqueries in quantified expressions are supported.
 boolean supportsTableCorrelationNames()
          Determine whether the database has table correlation names support.
 boolean supportsTransactionIsolationLevel(int level)
          Determine whether a specified transaction isolation level is supported.
 boolean supportsTransactions()
          Determine whether transactions are supported.
 boolean supportsUnion()
          Determine whether the SQL UNION operation is supported.
 boolean supportsUnionAll()
          Determine whether the SQL UNION ALL operation is supported.
 boolean updatesAreDetected(int type)
          Determine if the method ResultSet.rowUpdated can detect a visible row update.
 boolean usesLocalFilePerTable()
          Determine if this database uses a file for each table.
 boolean usesLocalFiles()
          Determine whether this database uses a local file to store tables.
 

Field Detail

attributeNoNulls

static final short attributeNoNulls
States that it may not be permitted to store NULL values.

See Also:
Constant Field Values

attributeNullable

static final short attributeNullable
States that NULL values are definitely permitted.

See Also:
Constant Field Values

attributeNullableUnknown

static final short attributeNullableUnknown
States that whether NULL values are permitted is unknown.

See Also:
Constant Field Values

bestRowNotPseudo

static final int bestRowNotPseudo
States the best row identifier is NOT a pseudo column.

See Also:
Constant Field Values

bestRowPseudo

static final int bestRowPseudo
States that the best row identifier is a pseudo column.

See Also:
Constant Field Values

bestRowSession

static final int bestRowSession
States that the remainder of the current session is used as the scope for the best row identifier.

See Also:
Constant Field Values

bestRowTemporary

static final int bestRowTemporary
States that best row identifier scope lasts only while the row is being used.

See Also:
Constant Field Values

bestRowTransaction

static final int bestRowTransaction
States that the remainder of the current transaction is used as the scope for the best row identifier.

See Also:
Constant Field Values

bestRowUnknown

static final int bestRowUnknown
States that the best row identifier may or may not be a pseudo column.

See Also:
Constant Field Values

columnNoNulls

static final int columnNoNulls
States that the column might not allow NULL values.

See Also:
Constant Field Values

columnNullable

static final int columnNullable
States that the column definitely allows NULL values.

See Also:
Constant Field Values

columnNullableUnknown

static final int columnNullableUnknown
States that it is unknown whether the columns may be nulled.

See Also:
Constant Field Values

importedKeyCascade

static final int importedKeyCascade
For the column UPDATE_RULE, States that when the primary key is updated, the foreign key (imported key) is changed to agree with it.

See Also:
Constant Field Values

importedKeyInitiallyDeferred

static final int importedKeyInitiallyDeferred
States deferrability.

See Also:
Constant Field Values

importedKeyInitiallyImmediate

static final int importedKeyInitiallyImmediate
States defer-ability.

See Also:
Constant Field Values

importedKeyNoAction

static final int importedKeyNoAction
For the columns UPDATE_RULE and DELETE_RULE, States that if the primary key has been imported, it cannot be updated or deleted.

See Also:
Constant Field Values

importedKeyNotDeferrable

static final int importedKeyNotDeferrable
States defer-ability.

See Also:
Constant Field Values

importedKeyRestrict

static final int importedKeyRestrict
States that a primary key must not be updated when imported as a foreign key by some other table. Used for the column UPDATE_RULE.

See Also:
Constant Field Values

importedKeySetDefault

static final int importedKeySetDefault
States that when the primary key is modified (updated or deleted) the foreign (imported) key is changed to its default value. Applies to the UPDATE_RULE and DELETE_RULE columns.

See Also:
Constant Field Values

importedKeySetNull

static final int importedKeySetNull
States that when the primary key is modified (updated or deleted) the foreign (imported) key is changed to NULL. Applies to the UPDATE_RULE and DELETE_RULE columns.

See Also:
Constant Field Values

procedureColumnIn

static final int procedureColumnIn
States that this column stores IN type parameters.

See Also:
Constant Field Values

procedureColumnInOut

static final int procedureColumnInOut
States that this column stores INOUT type parameters.

See Also:
Constant Field Values

procedureColumnOut

static final int procedureColumnOut
States that this column stores OUT type parameters.

See Also:
Constant Field Values

procedureColumnResult

static final int procedureColumnResult
States that the column stores results

See Also:
Constant Field Values

procedureColumnReturn

static final int procedureColumnReturn
States that the column stores return values.

See Also:
Constant Field Values

procedureColumnUnknown

static final int procedureColumnUnknown
States that type of the column is unknown.

See Also:
Constant Field Values

procedureNoNulls

static final int procedureNoNulls
States that NULL values are not permitted.

See Also:
Constant Field Values

procedureNoResult

static final int procedureNoResult
States that the procedure does not return a result.

See Also:
Constant Field Values

procedureNullable

static final int procedureNullable
States that NULL values are permitted.

See Also:
Constant Field Values

procedureNullableUnknown

static final int procedureNullableUnknown
States that whether NULL values are permitted is unknown.

See Also:
Constant Field Values

procedureResultUnknown

static final int procedureResultUnknown
States that it is unknown whether or not the procedure returns a result.

See Also:
Constant Field Values

procedureReturnsResult

static final int procedureReturnsResult
States that the procedure returns a result.

See Also:
Constant Field Values

sqlStateSQL99

static final int sqlStateSQL99
States that the value is an SQL99 SQLSTATE value.

See Also:
Constant Field Values

sqlStateXOpen

static final int sqlStateXOpen
States that the value is an SQL CLI SQLSTATE value as defined by X/Open (who are now know as Open Group) .

See Also:
Constant Field Values

tableIndexClustered

static final short tableIndexClustered
States that this table index is a clustered index.

See Also:
Constant Field Values

tableIndexHashed

static final short tableIndexHashed
States that this table index is a hashed index.

See Also:
Constant Field Values

tableIndexOther

static final short tableIndexOther
States this table's index is neither a clustered index, not a hashed index, and not a table statistics index; i.e. it is something else.

See Also:
Constant Field Values

tableIndexStatistic

static final short tableIndexStatistic
States this column has the table's statistics, and that it is returned in conjunction with the table's index description.

See Also:
Constant Field Values

typeNoNulls

static final int typeNoNulls
States that a NULL value is NOT permitted for this data type.

See Also:
Constant Field Values

typeNullable

static final int typeNullable
States that a NULL value is permitted for this data type.

See Also:
Constant Field Values

typeNullableUnknown

static final int typeNullableUnknown
States that it is unknown if a NULL value is permitted for this data type.

See Also:
Constant Field Values

typePredBasic

static final int typePredBasic
States that one can base all WHERE search clauses except WHERE .

See Also:
Constant Field Values

typePredChar

static final int typePredChar
States that WHERE is the only WHERE search clause that may be based on this type.

See Also:
Constant Field Values

typePredNone

static final int typePredNone
States that this type does not support WHERE search clauses.

See Also:
Constant Field Values

typeSearchable

static final int typeSearchable
States that all WHERE search clauses may be based on this type.

See Also:
Constant Field Values

versionColumnNotPseudo

static final int versionColumnNotPseudo
States that the version column is known to be not a pseudo column.

See Also:
Constant Field Values

versionColumnPseudo

static final int versionColumnPseudo
States that this version column is known to be a pseudo column.

See Also:
Constant Field Values

versionColumnUnknown

static final int versionColumnUnknown
States that the version column may be a pseudo column or not.

See Also:
Constant Field Values
Method Detail

allProceduresAreCallable

boolean allProceduresAreCallable()
                                 throws SQLException
Returns whether all procedures returned by getProcedures can be called by the current user.

Returns:
true if all procedures can be called by the current user, false otherwise.
Throws:
SQLException - if there is a database error

allTablesAreSelectable

boolean allTablesAreSelectable()
                               throws SQLException
Returns whether all the tables returned by getTables can be used by the current user in a SELECT statement.

Returns:
true if all the tables can be used,false otherwise
Throws:
SQLException - if there is a database error

dataDefinitionCausesTransactionCommit

boolean dataDefinitionCausesTransactionCommit()
                                              throws SQLException
Returns if a data definition statement in a transaction forces a commit of the transaction.

Returns:
true if the statement forces a commit, false otherwise
Throws:
SQLException - if there is a database error

dataDefinitionIgnoredInTransactions

boolean dataDefinitionIgnoredInTransactions()
                                            throws SQLException
Returns whether the database ignores data definition statements within a transaction.

Returns:
true if the database ignores a data definition statement, false otherwise
Throws:
SQLException - if there is a database error

deletesAreDetected

boolean deletesAreDetected(int type)
                           throws SQLException
Returns whether a visible row delete can be detected by calling ResultSet.rowDeleted.

Parameters:
type - the type of the ResultSet involved: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if the visible row delete can be detected, false otherwise
Throws:
SQLException - if there is a database error

doesMaxRowSizeIncludeBlobs

boolean doesMaxRowSizeIncludeBlobs()
                                   throws SQLException
Returns whether the return value of getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

Returns:
true if the return value includes LONGVARBINARY and LONGVARCHAR, otherwise false.
Throws:
SQLException - if there is a database error

getAttributes

ResultSet getAttributes(String catalog,
                        String schemaPattern,
                        String typeNamePattern,
                        String attributeNamePattern)
                        throws SQLException
Returns a description of the specified attribute of the specified type for an SQL User Defined Type (UDT) for a specified schema and catalog. The descriptions returned are ordered by TYPE_SCHEM, TYPE_NAME and ORDINAL_POSITION. The descriptions do not contain inherited attributes.

The returned ResultSet object has rows with the following column names and meanings:

  1. TYPE_CAT - String - the Type Catalog name (possibly null)
  2. TYPE_SCHEM - String - the Type Schema name (possibly null)
  3. TYPE_NAME - String - the Type name
  4. ATTR_NAME - String - the Attribute name
  5. DATA_TYPE - int - the Attribute type as defined in java.sql.Types
  6. ATTR_TYPE_NAME - String - the Attribute type name. This depends on the data source. For a UDT the name is fully qualified. For a REF it is both fully qualified and represents the target type of the reference.
  7. ATTR_SIZE - int - the Column size. When referring to char and date types this value is the maximum number of characters. When referring to numeric types is is the precision.
  8. DECIMAL_DIGITS - int - how many fractional digits are supported
  9. NUM_PREC_RADIX - int - numeric values radix
  10. NULLABLE - int - whether NULL is permitted:
    • DatabaseMetaData.attributeNoNulls - might not allow NULLs
    • DatabaseMetaData.attributeNullable - NULLs definitely permitted
    • DatabaseMetaData.attributeNullableUnknown - unknown
  11. REMARKS - String - A comment describing the attribute (possibly null)
  12. ATTR_DEF - String - Default value for the attribute (possibly null)
  13. SQL_DATA_TYPE - int - not used
  14. SQL_DATETIME_SUB - int - not used
  15. CHAR_OCTET_LENGTH - int - For CHAR types, the max number of bytes in the column
  16. ORDINAL_POSITION - int - The Index of the column in the Table (based on 1)
  17. IS_NULLABLE - String - "NO" = column does not allow NULLs, "YES" = column allows NULLs "" = NULL status unknown
  18. SCOPE_CATALOG - String - Catalog for table, SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
  19. SCOPE_SCHEMA - String - Schema for table, SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
  20. SCOPE_TABLE - String - Table name for SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
  21. SOURCE_DATA_TYPE - String - The source type for user generated REF type or for a Distinct type. (NULL if DATA_TYPE is not DISTINCT or user generated REF)

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
typeNamePattern - a Type name. This pattern must match the type name stored in the database.
attributeNamePattern - an Attribute name. Must match the attribute name as stored in the database.
Returns:
a ResultSet, where each Row is an attribute description
Throws:
SQLException - if there is a database error

getBestRowIdentifier

ResultSet getBestRowIdentifier(String catalog,
                               String schema,
                               String table,
                               int scope,
                               boolean nullable)
                               throws SQLException
Returns a list of a table's optimal set of columns that uniquely identifies a row. The results are ordered by SCOPE (see below).

The results are returned as a table, with one entry for each column, as follows:

  1. SCOPE - short - the SCOPE of the result, as follows:
    • DatabaseMetaData.bestRowTemporary - very temporary, while using row
    • DatabaseMetaData.bestRowTransaction - good for remainder of current transaction
    • DatabaseMetaData.bestRowSession - good for remainder of database session
  2. COLUMN_NAME - String - the column name
  3. DATA_TYPE - int - the Type of the data, as defined in java.sql.Types
  4. TYPE_NAME - String - Name of the type - database dependent. For UDT types the name is fully qualified
  5. COLUMN_SIZE - int - The precision of the data in the column
  6. BUFFER_LENGTH - int - not used
  7. DECIMAL_DIGITS - short - number of fractional digits
  8. PSEUDO_COLUMN - short - whether this is a pseudo column eg. and Oracle ROWID:
    • DatabaseMetaData.bestRowUnknown - don't know whether this is a pseudo column
    • DatabaseMetaData.bestRowNotPseudo - column is not pseudo
    • DatabaseMetaData.bestRowPseudo - column is a pseudo column

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schema - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
table - the table name. This must match the name of the table as declared in the database.
scope - the SCOPE of interest, values as defined above
nullable - true = include columns that are nullable, false = do not include
Returns:
a ResultSet where each row is a description of a column and the complete set of rows is the optimal set for this table.
Throws:
SQLException - if there is a database error

getCatalogs

ResultSet getCatalogs()
                      throws SQLException
Returns the set of catalog names available in this database. The set is returned ordered by catalog name.

Returns:
a ResultSet containing the Catalog names, with each row containing one Catalog name contained as a String in the single column named TABLE_CAT.
Throws:
SQLException - if there is a database error

getCatalogSeparator

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

Returns:
a String containing the separator
Throws:
SQLException - if there is a database error

getCatalogTerm

String getCatalogTerm()
                      throws SQLException
Returns the term that the database vendor prefers term for "catalog".

Returns:
a String with the vendor's term for "catalog"
Throws:
SQLException - if there is a database error

getColumnPrivileges

ResultSet getColumnPrivileges(String catalog,
                              String schema,
                              String table,
                              String columnNamePattern)
                              throws SQLException
Returns a description of access rights for a table's columns. Only access rights matching the criteria for the column name are returned.

The description is returned as a ResultSet with rows of data for each access right, with columns as follows:

  1. TABLE_CAT - String - Catalog name (possibly null)
  2. TABLE_SCHEM - String - Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. COLUMN_NAME - String - The Column name
  5. GRANTOR - String - The grantor of access (possibly null)
  6. PRIVILEGE - String - Access right - one of SELECT, INSERT, UPDATE, REFERENCES,...
  7. IS_GRANTABLE - String - "YES" implies that the receiver can grant access to others, "NO" if the receiver cannot grant access to others, null if unknown.

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schema - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
table - the table name. This must match the name of the table as declared in the database.
columnNamePattern - the column name. This must match the name of a column in the table in the database.
Returns:
a ResultSet containing the access rights, one row for each privilege description
Throws:
SQLException - if there is a database error

getColumns

ResultSet getColumns(String catalog,
                     String schemaPattern,
                     String tableNamePattern,
                     String columnNamePattern)
                     throws SQLException
Returns a description of table columns available in a specified catalog. Only descriptions meeting the specified Catalog, Schema, Table and Column names are returned.

The descriptions are returned as a ResultSet conforming to the following data layout, with one row per table column:

  1. TABLE_CAT - String - Catalog name (possibly null)
  2. TABLE_SCHEM - String - Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. COLUMN_NAME - String - The Column name
  5. DATA_TYPE - int - The SQL type as specified in java.sql.Types
  6. TYPE_NAME - String - Name for the data type, depends on database, UDT names are fully qualified
  7. COLUMN_SIZE - int - Column size - the precision for numeric types, max characters for char and date types
  8. BUFFER_LENGTH - int - Not used
  9. DECIMAL_DIGITS - int - maximum number of fractional digits
  10. NUM_PREC_RADIX - int - the Radix
  11. NULLABLE - int - does the column allow nulls:
    • DatabaseMetaData.columnNoNulls = may not allow NULLs
    • DatabaseMetaData.columnNullable = does allow NULLs
    • DatabaseMetaData.columnNullableUnknown = unknown NULL status
  12. REMARKS - String - A description of the column (possibly null)
  13. COLUMN_DEF - String - Default value for the column (possibly null)
  14. SQL_DATA_TYPE - int - not used
  15. SQL_DATETIME_SUB - int - not used
  16. CHAR_OCTET_LENGTH - int - maximum number of bytes in the char type columns
  17. ORDINAL_POSITION - int - Column index in the table (1 based)
  18. IS_NULLABLE - String - "NO" = column does not allow NULLs, "YES" = column allows NULLs "" = NULL status unknown
  19. SCOPE_CATALOG - String - Catalog for table, SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
  20. SCOPE_SCHEMA - String - Schema for table, scope of Reference attribute. NULL if DATA_TYPE is not REF.
  21. SCOPE_TABLE - String - Table name for scope of Reference attribute. NULL if DATA_TYPE is not REF.
  22. SOURCE_DATA_TYPE - String - The source type for user generated REF type or for a Distinct type. (NULL if DATA_TYPE is not DISTINCT or user generated REF)

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
tableNamePattern - the table name. This must match the name of the table as declared in the database.
columnNamePattern - the column name. This must match the name of a column in the table in the database.
Returns:
the descriptions as a ResultSet with rows in the form defined above
Throws:
SQLException - if there is a database error

getConnection

Connection getConnection()
                         throws SQLException
Returns the database connection that created this metadata.

Returns:
the connection
Throws:
SQLException - if there is a database error

getCrossReference

ResultSet getCrossReference(String primaryCatalog,
                            String primarySchema,
                            String primaryTable,
                            String foreignCatalog,
                            String foreignSchema,
                            String foreignTable)
                            throws SQLException
Returns a list of foreign key columns in a given foreign key table that reference the primary key columns of a supplied primary key table. This describes how one table imports the key of another table. It would be expected to return a single foreign key - primary key pair in most cases.

The descriptions are returned as a ResultSet with one row for each Foreign key, with the following layout:

  1. PKTABLE_CAT - String - from the primary key table : Catalog (possibly null)
  2. PKTABLE_SCHEM - String - from the primary key table : Schema (possibly null)
  3. PKTABLE_NAME - String - primary key table : name
  4. PKCOLUMN_NAME - String - primary key column : name
  5. FKTABLE_CAT - String - from the foreign key table : the catalog name being exported (possibly null)
  6. FKTABLE_SCHEM - String - foreign key table : Schema name being exported (possibly null)
  7. FKTABLE_NAME - String - foreign key table : the name being exported
  8. FKCOLUMN_NAME - String - foreign key column : the name being exported
  9. KEY_SEQ - short - sequence number (in the foreign key)
  10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
  11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - delete those rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
  12. FK_NAME - String - foreign key name (possibly null)
  13. PK_NAME - String - primary key name (possibly null)
  14. DEFERRABILITY - short - can foreign key constraints be deferred until commit (see SQL92 specification for definitions)?:
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

Parameters:
primaryCatalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
primarySchema - a Schema Name. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
primaryTable - the name of the table which exports the key. It must match the name of the table in the database
foreignCatalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
foreignSchema - a Schema Name. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
foreignTable - the name of the table importing the key. It must match the name of the table in the database
Returns:
a ResultSet containing rows with the descriptions of the foreign keys laid out according to the format defined above.
Throws:
SQLException - if there is a database error

getDatabaseMajorVersion

int getDatabaseMajorVersion()
                            throws SQLException
Returns the major version number of the database software.

Returns:
the Major version number of the database software.
Throws:
SQLException - a database error occurred

getDatabaseMinorVersion

int getDatabaseMinorVersion()
                            throws SQLException
Returns the minor version number of the database software.

Returns:
the Minor version number of the database software.
Throws:
SQLException - a database error occurred

getDatabaseProductName

String getDatabaseProductName()
                              throws SQLException
Returns the name of the database software.

Returns:
a String with the name of the database software.
Throws:
SQLException - a database error occurred

getDatabaseProductVersion

String getDatabaseProductVersion()
                                 throws SQLException
Returns the version number of this database software.

Returns:
a String with the version number of the database software.
Throws:
SQLException - a database error occurred

getDefaultTransactionIsolation

int getDefaultTransactionIsolation()
                                   throws SQLException
Returns the default transaction isolation level for this database.

Returns:
the default transaction isolation level. One of TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ or TRANSACTION_SERIALIZABLE.
Throws:
SQLException - a database error occurred

getDriverMajorVersion

int getDriverMajorVersion()
Returns the JDBC driver's major version number.

Returns:
the driver's major version number

getDriverMinorVersion

int getDriverMinorVersion()
Returns the JDBC driver's minor version number.

Returns:
the driver's minor version number

getDriverName

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

Returns:
a String containing the name of the JDBC driver
Throws:
SQLException - a database error occurred

getDriverVersion

String getDriverVersion()
                        throws SQLException
Returns the version number of this JDBC driver.

Returns:
a String containing the complete version number of the JDBC driver
Throws:
SQLException - a database error occurred

getExportedKeys

ResultSet getExportedKeys(String catalog,
                          String schema,
                          String table)
                          throws SQLException
Returns a list of the foreign key columns that reference the primary key columns of a specified table (the foreign keys exported by a table).

The list is returned as a ResultSet with a row for each of the foreign key columns, ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ, with the format for each row being:

  1. PKTABLE_CAT - String - primary key table : Catalog (possibly null)
  2. PKTABLE_SCHEM - String - primary key table : Schema (possibly null)
  3. PKTABLE_NAME - String - primary key table : name
  4. PKCOLUMN_NAME - String - primary key column : name
  5. FKTABLE_CAT - String - foreign key table : Catalog name being exported (possibly null)
  6. FKTABLE_SCHEM - String - foreign key table : Schema name being exported (possibly null)
  7. FKTABLE_NAME - String - foreign key table : name being exported
  8. FKCOLUMN_NAME - String - foreign key column : name being exported
  9. KEY_SEQ - short - sequence number in the foreign key
  10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
  11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - the deletion should also delete rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - it should set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - deletion sets the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
  12. FK_NAME - String - foreign key name (possibly null)
  13. PK_NAME - String - primary key name (possibly null)
  14. DEFERRABILITY - short - defines whether foreign key constraints can be deferred until commit (see SQL92 specification for definitions):
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schema - a Schema Name. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
table - a table name, which must match the name of a table in the database
Returns:
a ResultSet containing a row for each of the foreign key columns, as defined above
Throws:
SQLException - a database error occurred

getExtraNameCharacters

String getExtraNameCharacters()
                              throws SQLException
Returns a string of characters that may be used in unquoted identifier names. The characters a-z, A-Z, 0-9 and _ are always permitted.

Returns:
a String containing all the extra characters
Throws:
SQLException - a database error occurred

getIdentifierQuoteString

String getIdentifierQuoteString()
                                throws SQLException
Returns the string used to quote SQL identifiers. Returns " " (space) if identifier quoting not supported.

Returns:
the String used to quote SQL identifiers.
Throws:
SQLException - a database error occurred

getImportedKeys

ResultSet getImportedKeys(String catalog,
                          String schema,
                          String table)
                          throws SQLException
Returns a list columns in a table that are both primary keys and referenced by the table's foreign key columns (that is, the primary keys imported by a table).

The list returned is a ResultSet with a row entry for each primary key column, ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ, with the following format:

  1. PKTABLE_CAT - String - primary key Catalog name being imported (possibly null)
  2. PKTABLE_SCHEM - String - primary key Schema name being imported (possibly null)
  3. PKTABLE_NAME - String - primary key Table name being imported
  4. PKCOLUMN_NAME - String - primary key column name being imported
  5. FKTABLE_CAT - String - foreign key table catalog name (possibly null)
  6. FKTABLE_SCHEM - String - foreign key table Schema name (possibly null)
  7. FKTABLE_NAME - String - foreign key table name
  8. FKCOLUMN_NAME - String - foreign key column name
  9. KEY_SEQ - short - sequence number in the foreign key
  10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
  11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - delete those rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
  12. FK_NAME - String - foreign key name (possibly null)
  13. PK_NAME - String - primary key name (possibly null)
  14. DEFERRABILITY - short - defines whether foreign key constraints can be deferred until commit (see SQL92 specification for definitions):
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schema - a Schema Name. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
table - a table name, which must match the name of a table in the database
Returns:
a ResultSet containing the list of primary key columns as rows in the format defined above.
Throws:
SQLException - a database error occurred

getIndexInfo

ResultSet getIndexInfo(String catalog,
                       String schema,
                       String table,
                       boolean unique,
                       boolean approximate)
                       throws SQLException
Returns a list of indices and statistics for a specified table.

The list is returned as a ResultSet, with one row for each index or statistic. The list is ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION. Each row has the following format:

  1. TABLE_CAT - String - table catalog name (possibly null)
  2. TABLE_SCHEM - String - Table Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. NON_UNIQUE - boolean - true when index values can be non-unique. Must be false when TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER - String : index catalog name. null when TYPE is 'tableIndexStatistic'
  6. INDEX_NAME - String : index name. null when TYPE is 'tableIndexStatistic'
  7. TYPE - short - the index type. One of:
    • DatabaseMetaData.tableIndexStatistic - table statistics returned with Index descriptions
    • DatabaseMetaData.tableIndexClustered - a clustered Index
    • DatabaseMetaData.tableIndexHashed - a hashed Index
    • DatabaseMetaData.tableIndexOther - other style of Index
  8. ORDINAL_POSITION - short - column sequence within Index. 0 when TYPE is tableIndexStatistic
  9. COLUMN_NAME - String - the column name. null when TYPE is tableIndexStatistic
  10. ASC_OR_DESC - String - column sort sequence. null if sequencing not supported or TYPE is tableIndexStatistic; otherwise "A" means sort ascending and "D" means sort descending.
  11. CARDINALITY - int - Number of unique values in the Index. If TYPE is tableIndexStatistic, this is number of rows in the table.
  12. PAGES - int - Number of pages for current Index. If TYPE is tableIndexStatistic, this is number of pages used for the table.
  13. FILTER_CONDITION - String - Filter condition. (possibly null)

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schema - a Schema Name. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
table - a table name, which must match the name of a table in the database
unique - true means only return indices for unique values, false implies that they can be returned even if not unique.
approximate - true implies that the list can contain approximate or "out of data" values, false implies that all values must be precisely accurate
Returns:
a ResultSet containing the list of indices and statistics for the table, in the format defined above.
Throws:
SQLException - a database error occurred

getJDBCMajorVersion

int getJDBCMajorVersion()
                        throws SQLException
Returns this driver's major JDBC version number.

Returns:
the major JDBC version number
Throws:
SQLException - a database error occurred

getJDBCMinorVersion

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

Returns:
the Minor JDBC Version Number
Throws:
SQLException - a database error occurred

getMaxBinaryLiteralLength

int getMaxBinaryLiteralLength()
                              throws SQLException
Get the maximum number of hex characters in an in-line binary literal for this database.

Returns:
the maximum number of hex characters in an in-line binary literal. If the number is unlimited then the result is zero.
Throws:
SQLException - a database error occurred

getMaxCatalogNameLength

int getMaxCatalogNameLength()
                            throws SQLException
Returns the maximum size of a Catalog name in this database.

Returns:
the maximum size in characters for a Catalog name. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxCharLiteralLength

int getMaxCharLiteralLength()
                            throws SQLException
Returns the maximum size for a character literal in this database.

Returns:
the maximum size in characters for a character literal. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxColumnNameLength

int getMaxColumnNameLength()
                           throws SQLException
Returns the maximum size for a Column name for this database.

Returns:
the maximum number of characters for a Column name. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxColumnsInGroupBy

int getMaxColumnsInGroupBy()
                           throws SQLException
Get the maximum number of columns in a GROUP BY clause for this database.

Returns:
the maximum number of columns in a GROUP BY clause. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxColumnsInIndex

int getMaxColumnsInIndex()
                         throws SQLException
Returns the maximum number of columns in an Index for this database.

Returns:
the maximum number of columns in an Index. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxColumnsInOrderBy

int getMaxColumnsInOrderBy()
                           throws SQLException
Returns the maximum number of columns in an ORDER BY clause for this database.

Returns:
the maximum number of columns in an ORDER BY clause. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxColumnsInSelect

int getMaxColumnsInSelect()
                          throws SQLException
Returns the maximum number of columns in a SELECT list for this database.

Returns:
the maximum number of columns in a SELECT list. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxColumnsInTable

int getMaxColumnsInTable()
                         throws SQLException
Returns the maximum number of columns in a table for this database.

Returns:
the maximum number of columns in a table. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxConnections

int getMaxConnections()
                      throws SQLException
Returns the database's maximum number of concurrent connections.

Returns:
the maximum number of connections. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxCursorNameLength

int getMaxCursorNameLength()
                           throws SQLException
Returns the maximum length of a cursor name for this database.

Returns:
the maximum number of characters in a cursor name. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxIndexLength

int getMaxIndexLength()
                      throws SQLException
Returns the maximum length in bytes for an Index for this database. This covers all the parts of a composite index.

Returns:
the maximum length in bytes for an Index. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxProcedureNameLength

int getMaxProcedureNameLength()
                              throws SQLException
Returns the maximum number of characters for a procedure name in this database.

Returns:
the maximum number of character for a procedure name. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxRowSize

int getMaxRowSize()
                  throws SQLException
Returns the maximum number of bytes within a single row for this database.

Returns:
the maximum number of bytes for a single row. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxSchemaNameLength

int getMaxSchemaNameLength()
                           throws SQLException
Returns the maximum number of characters in a schema name for this database.

Returns:
the maximum number of characters in a Schema name. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxStatementLength

int getMaxStatementLength()
                          throws SQLException
Returns the maximum number of characters in an SQL statement for this database.

Returns:
the maximum number of characters in an SQL statement. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxStatements

int getMaxStatements()
                     throws SQLException
Get the maximum number of simultaneously open active statements for this database.

Returns:
the maximum number of open active statements. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxTableNameLength

int getMaxTableNameLength()
                          throws SQLException
Returns the maximum size for a table name in the database.

Returns:
the maximum size in characters for a table name. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxTablesInSelect

int getMaxTablesInSelect()
                         throws SQLException
Returns the maximum number of tables permitted in a SELECT statement for the database.

Returns:
the maximum number of tables permitted in a SELECT statement. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getMaxUserNameLength

int getMaxUserNameLength()
                         throws SQLException
Returns the maximum number of characters in a user name for the database.

Returns:
the maximum number of characters in a user name. If the limit is unknown, or the value is unlimited, then the result is zero.
Throws:
SQLException - a database error occurred

getNumericFunctions

String getNumericFunctions()
                           throws SQLException
Returns a list of the math functions available with this database. These are used in the JDBC function escape clause and are the Open Group CLI math function names.

Returns:
a String which contains the list of Math functions as a comma separated list.
Throws:
SQLException - a database error occurred

getPrimaryKeys

ResultSet getPrimaryKeys(String catalog,
                         String schema,
                         String table)
                         throws SQLException
Returns a list of the primary key columns of a specified table.

The list is returned as a ResultSet with one row for each primary key column, ordered by COLUMN_NAME, with each row having the structure as follows:

  1. TABLE_CAT - String - table catalog name (possibly null)
  2. TABLE_SCHEM - String - Table Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. COLUMN_NAME - String - The Column name
  5. KEY_SEQ - short - the sequence number for this column in the primary key
  6. PK_NAME - String - the primary key name (possibly null)

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with the empty string used to retrieve those without a Catalog Name.
schema - a Schema Name. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with the empty string used to retrieve those without a Schema name.
table - the name of a table, which must match the name of a table in the database
Returns:
a ResultSet containing the list of keys in the format defined above
Throws:
SQLException - a database error occurred

getProcedureColumns

ResultSet getProcedureColumns(String catalog,
                              String schemaPattern,
                              String procedureNamePattern,
                              String columnNamePattern)
                              throws SQLException
Returns a list of parameter and result columns for the stored procedures belonging to a specified Catalog.

The list is returned as a ResultSet with one row for each parameter or result column. The data is ordered by PROCEDURE_SCHEM and PROCEDURE_NAME, while for each procedure, the return value (if any) is first, followed by the parameters in the order they appear in the stored procedure call, followed by ResultSet columns in column number order. Each row has the following structure:

  1. PROCEDURE_CAT - String - the procedure catalog name
  2. PROCEDURE_SCHEM - String - the procedure schema name (possibly null)
  3. PROCEDURE_NAME - String - the procedure name
  4. COLUMN_NAME - String - the name of the column
  5. COLUMN_TYPE - short - the kind of column or parameter, as follows:
    • DatabaseMetaData.procedureColumnUnknown - type unknown
    • DatabaseMetaData.procedureColumnIn - an IN parameter
    • DatabaseMetaData.procedureColumnInOut - an INOUT parameter
    • DatabaseMetaData.procedureColumnOut - an OUT parameter
    • DatabaseMetaData.procedureColumnReturn - a return value
    • DatabaseMetaData.procedureReturnsResult - a result column in a result set
  6. DATA_TYPE - int - the SQL type of the data, as in java.sql.Types
  7. TYPE_NAME - String - the SQL type name, for a UDT it is fully qualified
  8. PRECISION - int - the precision
  9. LENGTH - int - the length of the data in bytes
  10. SCALE - short - the scale for numeric types
  11. RADIX - short - the Radix for numeric data (typically 2 or 10)
  12. NULLABLE - short - can the data contain null:
    • DatabaseMetaData.procedureNoNulls - NULLs not permitted
    • DatabaseMetaData.procedureNullable - NULLs are permitted
    • DatabaseMetaData.procedureNullableUnknown - NULL status unknown
  13. REMARKS - String - an explanatory comment about the data item

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
procedureNamePattern - a pattern that must match the name of the procedure stored in the database
columnNamePattern - a column name pattern. The name must match the column name stored in the database.
Returns:
a ResultSet with the list of parameter and result columns in the format defined above
Throws:
SQLException - a database error occurred

getProcedures

ResultSet getProcedures(String catalog,
                        String schemaPattern,
                        String procedureNamePattern)
                        throws SQLException
Returns a list of the stored procedures available in a specified catalog.

The list is returned as a ResultSet with one row for each stored procedure, ordered by PROCEDURE_SCHEME and PROCEDURE_NAME, with the data in each row as follows:

  1. PROCEDURE_CAT - String : the procedure catalog name
  2. PROCEDURE_SCHEM - String : the procedure schema name (possibly null)
  3. PROCEDURE_NAME - String : the procedure name
  4. Reserved
  5. Reserved
  6. Reserved
  7. REMARKS - String - information about the procedure
  8. PROCEDURE_TYPE - short : one of:
    • DatabaseMetaData.procedureResultUnknown - procedure may return a result
    • DatabaseMetaData.procedureNoResult - procedure does not return a result
    • DatabaseMetaData.procedureReturnsResult - procedure definitely returns a result

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
procedureNamePattern - a procedure name pattern, which must match the procedure name stored in the database
Returns:
a ResultSet where each row is a description of a stored procedure in the format defined above.
Throws:
SQLException - a database error occurred

getProcedureTerm

String getProcedureTerm()
                        throws SQLException
Returns the database vendor's preferred name for "procedure".

Returns:
a String with the vendor's preferred name for "procedure"
Throws:
SQLException - a database error occurred

getResultSetHoldability

int getResultSetHoldability()
                            throws SQLException
Returns the result set's default hold-ability.

Returns:
one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
SQLException - a database error occurred

getSchemas

ResultSet getSchemas()
                     throws SQLException
Returns a list of the schema names in the database. The list is returned as a ResultSet, ordered by the Schema name, with one row per Schema in the following format:
  1. TABLE_SCHEM - String - the Schema name
  2. TABLE_CATALOG - String - the Catalog name (possibly null)

Returns:
a ResultSet with one row for each schema in the format defined above.
Throws:
SQLException - a database error occurred

getSchemaTerm

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

Returns:
a String which is the vendor's preferred term for schema
Throws:
SQLException - a database error occurred

getSearchStringEscape

String getSearchStringEscape()
                             throws SQLException
Returns the string that is used to escape wildcard characters. This string is used to escape the '_' and '%' wildcard characters in catalog search strings which are a pattern and so which use the wildcard characters. '_' is used to represent any single character wile '%' is used for a sequence of zero or more characters.

Returns:
a String used to escape the wildcard characters
Throws:
SQLException - a database error occurred

getSQLKeywords

String getSQLKeywords()
                      throws SQLException
Returns a list of all the SQL keywords that are NOT also SQL92 keywords for the database.

Returns:
a String containing the list of SQL keywords in a comma separated format.
Throws:
SQLException - a database error occurred

getSQLStateType

int getSQLStateType()
                    throws SQLException
States the type of SQLState value returned by SQLException.getSQLState. This can either be the X/Open (now known as Open Group) SQL CLI form or the SQL99 form.

Returns:
an integer, which is either DatabaseMetaData.sqlStateSQL99 or DatabaseMetaData.sqlStateXOpen.
Throws:
SQLException - a database error occurred

getStringFunctions

String getStringFunctions()
                          throws SQLException
Returns a list of string functions available with the database. These functions are used in JDBC function escape clause and follow the Open Group CLI string function names definition.

Returns:
a String containing the list of string functions in comma separated format.
Throws:
SQLException - a database error occurred

getSuperTables

ResultSet getSuperTables(String catalog,
                         String schemaPattern,
                         String tableNamePattern)
                         throws SQLException
Returns a listing of the hierarchies of tables in a specified schema in the database.

The listing only contains entries for tables that have a super table. Super and sub tables must be defined in the same Catalog and Schema. The list is returned as a ResultSet, with one row for each table that has a super table, in the following format:

  1. TABLE_CAT - String - table catalog name (possibly null)
  2. TABLE_SCHEM - String - Table Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. SUPERTABLE_NAME - String - The Super Table name

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
tableNamePattern - a Table Name, which should match the Table name as stored in the database. it may be a fully qualified name. If it is fully qualified the Catalog Name and Schema Name parameters are ignored.
Returns:
a ResultSet with one row for each table which has a super table, in the format defined above. An empty ResultSet is returned if the database does not support table hierarchies.
Throws:
SQLException - a database error occurred

getSuperTypes

ResultSet getSuperTypes(String catalog,
                        String schemaPattern,
                        String typeNamePattern)
                        throws SQLException
Returns the User Defined Type (UDT) hierarchies for a given schema. Only the immediate parent/child relationship is described. If a UDT does not have a direct supertype, it is not listed.

The listing is returned as a ResultSet where there is one row for a specific UDT which describes its supertype, with the data organized in columns as follows:

  1. TYPE_CAT - String - the UDT Catalog name (possibly null)
  2. TYPE_SCHEM - String - the UDT Schema name (possibly null)
  3. TYPE_NAME - String - the UDT type name
  4. SUPERTYPE_CAT - String - direct supertype's Catalog name (possibly null)
  5. SUPERTYPE_SCHEM - String - direct supertype's Schema name (possibly null)
  6. SUPERTYPE_NAME - String - direct supertype's name

Parameters:
catalog - the Catalog name. "" means get the UDTs without a catalog. null means don't use the catalog name to restrict the search.
schemaPattern - the Schema pattern name. "" means get the UDT's without a schema.
typeNamePattern - the UDT name pattern. This may be a fully qualified name. When a fully qualified name is specified, the Catalog name and Schema name parameters are ignored.
Returns:
a ResultSet in which each row gives information about a particular UDT in the format defined above. An empty ResultSet is returned for a database that does not support type hierarchies.
Throws:
SQLException - a database error occurred

getSystemFunctions

String getSystemFunctions()
                          throws SQLException
Returns a list of system functions available with the database. These are names used in the JDBC function escape clause and are Open Group CLI function names.

Returns:
a String containing the list of system functions in a comma separated format
Throws:
SQLException - a database error occurred

getTablePrivileges

ResultSet getTablePrivileges(String catalog,
                             String schemaPattern,
                             String tableNamePattern)
                             throws SQLException
Returns a description of access rights for each table present in a catalog. Table privileges can apply to one or more columns in the table - but are not guaranteed to apply to all columns.

The privileges are returned as a ResultSet, with one row for each privilege, ordered by TABLE_SCHEM, TABLE_NAME, PRIVILEGE, and each row has data as defined in the following column definitions:

  1. TABLE_CAT - String - table catalog name (possibly null)
  2. TABLE_SCHEM - String - Table Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. GRANTOR - String - who granted the access
  5. GRANTEE - String - who received the access grant
  6. PRIVILEGE - String - the type of access granted - one of SELECT, INSERT, UPDATE, REFERENCES,...
  7. IS_GRANTABLE - String - "YES" implies the grantee can grant access to others, "NO" implies guarantee cannot grant access to others, null means this status is unknown

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
tableNamePattern - a Table Name, which should match the Table name as stored in the database.
Returns:
a ResultSet containing a list with one row for each table in the format defined above.
Throws:
SQLException - a database error occurred

getTables

ResultSet getTables(String catalog,
                    String schemaPattern,
                    String tableNamePattern,
                    String[] types)
                    throws SQLException
Returns a description of the tables in a specified catalog.

The descriptions are returned as rows in a ResultSet, one row for each Table. The ResultSet is ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME. Each row in the ResultSet consists of a series of columns as follows:

  1. TABLE_CAT - String - table catalog name (possibly null)
  2. TABLE_SCHEM - String - Table Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. TABLE_TYPE - String - Typical names include "TABLE", "VIEW", "SYSTEM TABLE", "ALIAS", "SYNONYM", "GLOBAL TEMPORARY"
  5. REMARKS - String - A comment describing the table
  6. TYPE_CAT - String - the 'Types' catalog(possibly null)
  7. TYPE_SCHEM - String - the 'Types' schema(possibly null)
  8. TYPE_NAME - String - the 'Types' name (possibly null)
  9. SELF_REFERENCING_COL_NAME - String - the name of a designated identifier column in a typed table (possibly null)
  10. REF_GENERATION - String - one of the following values : "SYSTEM" | "USER" | "DERIVED" - specifies how values in the SELF_REFERENCING_COL_NAME are created (possibly null)

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
tableNamePattern - a Table Name, which should match the Table name as stored in the database.
types - a list of table types to include in the list. null implies list all types.
Returns:
a ResultSet with one row per table in the format defined above.
Throws:
SQLException - a database error occurred

getTableTypes

ResultSet getTableTypes()
                        throws SQLException
Returns a list of table types supported by the database.

The list is returned as a ResultSet with one row per table type, ordered by the table type. The information in the ResultSet is structured into a single column per row, as follows:

  1. TABLE_TYPE - String - the Table Type. Typical names include "TABLE", "VIEW", "SYSTEM TABLE", "ALIAS", "SYNONYM", "GLOBAL TEMPORARY"

Returns:
a ResultSet with one row per table type in the format defined above.
Throws:
SQLException - a database error occurred

getTimeDateFunctions

String getTimeDateFunctions()
                            throws SQLException
Returns a list of time and date functions available for the database.

Returns:
a String contain a comma separated list of the time and date functions.
Throws:
SQLException - a database error occurred

getTypeInfo

ResultSet getTypeInfo()
                      throws SQLException
Get a list of the standard SQL Types supported by this database. The list is returned as a ResultSet, with one row for each type, ordered by the DATA_TYPE value, where the data in each row is structured into the following columns:
  1. TYPE_NAMR - String : the Type name
  2. DATA_TYPE - int : the SQL data type value as defined in java.sql.Types
  3. PRECISION - int - the maximum precision of the type
  4. LITERAL_PREFIX - String : the prefix to be used when quoting a literal value (possibly null)
  5. LITERAL_SUFFIX - String : the suffix to be used when quoting a literal value (possibly null)
  6. CREATE_PARAMS - String : params used when creating the type (possibly null)
  7. NULLABLE - short : shows if the value is null-able:
    • DatabaseMetaData.typeNoNulls : NULLs not permitted
    • DatabaseMetaData.typeNullable : NULLs are permitted
    • DatabaseMetaData.typeNullableUnknown : NULL status unknown
  8. CASE_SENSITIVE - boolean : true if the type is case sensitive
  9. SEARCHABLE - short : how this type can be used with WHERE clauses:
    • DatabaseMetaData.typePredNone - cannot be used
    • DatabaseMetaData.typePredChar - support for WHERE...LIKE only
    • DatabaseMetaData.typePredBasic - support except for WHERE...LIKE
    • DatabaseMetaData.typeSearchable - support for all WHERE clauses
  10. UNSIGNED_ATTRIBUTE - boolean - the type is unsigned or not
  11. FIXED_PREC_SCALE - boolean - fixed precision = it can be used as a money value
  12. AUTO_INCREMENT - boolean - can be used as an auto-increment value
  13. LOCAL_TYPE_NAME - String - a localized version of the type name (possibly null)
  14. MINIMUM_SCALE - short - the minimum scale supported
  15. MAXIMUM_SCALE - short - the maximum scale supported
  16. SQL_DATA_TYPE - int - not used
  17. SQL_DATETIME_SUB - int - not used
  18. NUM_PREC_RADIX - int - number radix (typically 2 or 10)

Returns:
a ResultSet which is structured as described above
Throws:
SQLException - a database error occurred

getUDTs

ResultSet getUDTs(String catalog,
                  String schemaPattern,
                  String typeNamePattern,
                  int[] types)
                  throws SQLException
Returns a description of the User Defined Types (UDTs) defined in a given schema, which includes the types DISTINCT, STRUCT and JAVA_OBJECT.

The types matching the supplied the specified Catalog, Schema, Type Name and Type are returned as rows in a ResultSet with columns of information as follows:

  1. TABLE_CAT - String - Catalog name (possibly null)
  2. TABLE_SCHEM - String - Schema name (possibly null)
  3. TABLE_NAME - String - The Table name
  4. CLASS_NAME - String - The Java class name
  5. DATA_TYPE - int - The SQL type as specified in java.sql.Types. One of DISTINCT, STRUCT and JAVA_OBJECT
  6. REMARKS - String - A comment which describes the type
  7. BASE_TYPE - short - A type code. For a DISTINCT type, the source type. For a structured type this is the type that implements the user generated reference type of the SELF_REFERENCING_COLUMN. This is defined in java.sql.Types, and will be null if the DATA_TYPE does not match these criteria.
If the driver does not support UDTs, the ResultSet will be empty.

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schemaPattern - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
typeNamePattern - a Type Name, which should match a Type name as stored in the database. It may be fully qualified.
types - a list of the UDT types to include in the list - one of DISTINCT, STRUCT or JAVA_OBJECT.
Returns:
a ResultSet in the format described above
Throws:
SQLException - a database error occurred

getURL

String getURL()
              throws SQLException
Returns the URL for this database.

Returns:
the URL for the database. null if it cannot be generated.
Throws:
SQLException - a database error occurred

getUserName

String getUserName()
                   throws SQLException
Determine the user name as known by the database.

Returns:
the user name
Throws:
SQLException - a database error occurred

getVersionColumns

ResultSet getVersionColumns(String catalog,
                            String schema,
                            String table)
                            throws SQLException
Returns which of a table's columns are automatically updated when any value in a row is updated.

The result is laid-out in the following columns:

  1. SCOPE - short - not used
  2. COLUMN_NAME - String - Column name
  3. DATA_TYPE - int - The SQL data type, as defined in java.sql.Types
  4. TYPE_NAME - String - The SQL type name, data source dependent
  5. COLUMN_SIZE - int - Precision for numeric types
  6. BUFFER_LENGTH - int - Length of a column value in bytes
  7. DECIMAL_DIGITS - short - Number of digits after the decimal point
  8. PSEUDO_COLUMN - short - If this is a pseudo-column (for example, an Oracle ROWID):
    • DatabaseMetaData.bestRowUnknown - don't know whether this is a pseudo column
    • DatabaseMetaData.bestRowNotPseudo - column is not pseudo
    • DatabaseMetaData.bestRowPseudo - column is a pseudo column

Parameters:
catalog - a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name.
schema - a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name.
table - a table name. It must match the name of a table in the database.
Returns:
a ResultSet containing the descriptions, one row for each column, in the format defined above.
Throws:
SQLException - a database error occurred

insertsAreDetected

boolean insertsAreDetected(int type)
                           throws SQLException
Determine if a visible row insert can be detected by calling ResultSet.rowInserted.

Parameters:
type - the ResultSet type. This may be one of ResultSet.TYPE_SCROLL_SENSITIVE or ResultSet.TYPE_SCROLL_INSENSITIVE or ResultSet.TYPE_FORWARD_ONLY,
Returns:
true if ResultSet.rowInserted detects a visible row insert otherwise false.
Throws:
SQLException - a database error occurred

isCatalogAtStart

boolean isCatalogAtStart()
                         throws SQLException
Determine whether a fully qualified table name is prefixed or suffixed to a fully qualified table name.

Returns:
true if the catalog appears at the start of a fully qualified table name, false otherwise.
Throws:
SQLException - a database error occurred

isReadOnly

boolean isReadOnly()
                   throws SQLException
Determine if the database is in read-only mode.

Returns:
true if the database is in read-only mode, false otherwise.
Throws:
SQLException - a database error occurred

locatorsUpdateCopy

boolean locatorsUpdateCopy()
                           throws SQLException
Determine if updates are made to a copy of, or directly on, Large Objects (LOBs).

Returns:
true if updates are made to a copy of the Large Object, false otherwise
Throws:
SQLException - a database error occurred

nullPlusNonNullIsNull

boolean nullPlusNonNullIsNull()
                              throws SQLException
Determine if the database handles concatenations between NULL and non-NULL values by producing a NULL output.

Returns:
true if NULL to non-NULL concatenations produce a NULL result, false otherwise.
Throws:
SQLException - a database error occurred

nullsAreSortedAtEnd

boolean nullsAreSortedAtEnd()
                            throws SQLException
Determine if NULL values are always sorted to the end of sorted results regardless of requested sort order. This means that they will appear at the end of sorted lists whatever other non-NULL values may be present.

Returns:
true if NULL values are sorted at the end, false otherwise
Throws:
SQLException - a database error occurred

nullsAreSortedAtStart

boolean nullsAreSortedAtStart()
                              throws SQLException
Determine if NULL values are always sorted at the start of the sorted list, irrespective of the sort order. This means that they appear at the start of sorted lists, whatever other values may be present.

Returns:
true if NULL values are sorted at the start, false otherwise
Throws:
SQLException - a database error occurred

nullsAreSortedHigh

boolean nullsAreSortedHigh()
                           throws SQLException
Determine if NULL values are sorted high - i.e. they are sorted as if they are higher than any other values.

Returns:
true if NULL values are sorted high, false otherwise.
Throws:
SQLException - a database error occurred

nullsAreSortedLow

boolean nullsAreSortedLow()
                          throws SQLException
Determine if NULL values are sorted low - ie they are sorted as if they are lower than any other values.

Returns:
true if NULL values are sorted low, false otherwise.
Throws:
SQLException - a database error occurred

othersDeletesAreVisible

boolean othersDeletesAreVisible(int type)
                                throws SQLException
Determine if deletes made by others are visible, for a specified ResultSet type.

Parameters:
type - the type of the ResultSet. It may be either ResultSet.TYPE_FORWARD_ONLY or ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE)
Returns:
true if others' deletes are visible, false otherwise.
Throws:
SQLException - a database error occurred

othersInsertsAreVisible

boolean othersInsertsAreVisible(int type)
                                throws SQLException
Determine if inserts made by others are visible, for a specified ResultSet type.

Parameters:
type - the type of the ResultSet. May be ResultSet.TYPE_FORWARD_ONLY, or ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if others' inserts are visible otherwise false.
Throws:
SQLException - a database error occurred

othersUpdatesAreVisible

boolean othersUpdatesAreVisible(int type)
                                throws SQLException
Determine if updates made by others are visible, for a specified ResultSet type.

Parameters:
type - the type of the ResultSet. May be ResultSet.TYPE_FORWARD_ONLY, or ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if others' inserts are visible otherwise false.
Throws:
SQLException - a database error occurred

ownDeletesAreVisible

boolean ownDeletesAreVisible(int type)
                             throws SQLException
Determine if a ResultSet's own deletes are visible, for a specified ResultSet type.

Parameters:
type - the type of the ResultSet: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if the delete's are seen by the own ResultSet otherwise false.
Throws:
SQLException - a database error occurred

ownInsertsAreVisible

boolean ownInsertsAreVisible(int type)
                             throws SQLException
Determine if its own inserts are visible to a given ResultSet type.

Parameters:
type - the type of the ResultSet: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if inserts are visible for this type false otherwise.
Throws:
SQLException - a database error occurred

ownUpdatesAreVisible

boolean ownUpdatesAreVisible(int type)
                             throws SQLException
Determine if for a supplied type of ResultSet, the ResultSet's own updates are visible.

Parameters:
type - the type of the ResultSet: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if updates are visible to in this ResultSet type otherwise false.
Throws:
SQLException - a database error occurred

storesLowerCaseIdentifiers

boolean storesLowerCaseIdentifiers()
                                   throws SQLException
Determine whether the database treats SQL identifiers that are in mixed case (and unquoted) as case insensitive. If true then the database stores them in lower case.

Returns:
true if unquoted SQL identifiers are stored in lower case, false otherwise.
Throws:
SQLException - a database error occurred

storesLowerCaseQuotedIdentifiers

boolean storesLowerCaseQuotedIdentifiers()
                                         throws SQLException
Determine whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

Returns:
true if quoted SQL identifiers are stored in lower case, false otherwise.
Throws:
SQLException - a database error occurred

storesMixedCaseIdentifiers

boolean storesMixedCaseIdentifiers()
                                   throws SQLException
Determine whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

Returns:
true if unquoted SQL identifiers as stored in mixed case, false otherwise.
Throws:
SQLException - a database error occurred

storesMixedCaseQuotedIdentifiers

boolean storesMixedCaseQuotedIdentifiers()
                                         throws SQLException
Determine whether the database considers identifiers as case insensitive if they are mixed case quoted SQL. The database stores them in mixed case.

Returns:
true if quoted SQL identifiers are stored in mixed case, false otherwise.
Throws:
SQLException - a database error occurred

storesUpperCaseIdentifiers

boolean storesUpperCaseIdentifiers()
                                   throws SQLException
Determine whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

Returns:
true if unquoted SQL identifiers are stored in upper case, false otherwise.
Throws:
SQLException - a database error occurred

storesUpperCaseQuotedIdentifiers

boolean storesUpperCaseQuotedIdentifiers()
                                         throws SQLException
Determine whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

Returns:
true if quoted SQL identifiers are stored in upper case, false otherwise.
Throws:
SQLException - a database error occurred

supportsAlterTableWithAddColumn

boolean supportsAlterTableWithAddColumn()
                                        throws SQLException
Determine if the database supports ALTER TABLE operation with add column.

Returns:
true if ALTER TABLE with add column is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsAlterTableWithDropColumn

boolean supportsAlterTableWithDropColumn()
                                         throws SQLException
Determine if the database supports ALTER TABLE operation with drop column.

Returns:
true if ALTER TABLE with drop column is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsANSI92EntryLevelSQL

boolean supportsANSI92EntryLevelSQL()
                                    throws SQLException
Determine if the database supports the ANSI92 entry level SQL grammar.

Returns:
true if the ANSI92 entry level SQL grammar is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsANSI92FullSQL

boolean supportsANSI92FullSQL()
                              throws SQLException
Determine if the database supports the ANSI92 full SQL grammar.

Returns:
true if the ANSI92 full SQL grammar is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsANSI92IntermediateSQL

boolean supportsANSI92IntermediateSQL()
                                      throws SQLException
Determine if the database supports the ANSI92 intermediate SQL Grammar.

Returns:
true if the ANSI92 intermediate SQL grammar is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsBatchUpdates

boolean supportsBatchUpdates()
                             throws SQLException
Determine if the database supports Batch Updates.

Returns:
true if batch updates are supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsCatalogsInDataManipulation

boolean supportsCatalogsInDataManipulation()
                                           throws SQLException
Determine whether catalog names may be used in data manipulation statements.

Returns:
true if catalog names can be used in data manipulation statements, false otherwise.
Throws:
SQLException - a database error occurred

supportsCatalogsInIndexDefinitions

boolean supportsCatalogsInIndexDefinitions()
                                           throws SQLException
Determine if catalog names can be used in Index Definition statements.

Returns:
true if catalog names can be used in Index Definition statements, false otherwise.
Throws:
SQLException - a database error occurred

supportsCatalogsInPrivilegeDefinitions

boolean supportsCatalogsInPrivilegeDefinitions()
                                               throws SQLException
Determine if catalog names can be used in privilege definition statements.

Returns:
true if catalog names can be used in privilege definition statements, false otherwise.
Throws:
SQLException - a database error occurred

supportsCatalogsInProcedureCalls

boolean supportsCatalogsInProcedureCalls()
                                         throws SQLException
Determine if catalog names can be used in procedure call statements.

Returns:
true if catalog names can be used in procedure call statements.
Throws:
SQLException - a database error occurred

supportsCatalogsInTableDefinitions

boolean supportsCatalogsInTableDefinitions()
                                           throws SQLException
Determine if catalog names may be used in table definition statements.

Returns:
true if catalog names can be used in definition statements, false otherwise.
Throws:
SQLException - a database error occurred

supportsColumnAliasing

boolean supportsColumnAliasing()
                               throws SQLException
Determine if the database supports column aliasing.

If aliasing is supported, then the SQL AS clause is used to provide names for computed columns and provide alias names for columns.

Returns:
true if column aliasing is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsConvert

boolean supportsConvert()
                        throws SQLException
Determine if the database supports the CONVERT operation between SQL types.

Returns:
true if the CONVERT operation is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsConvert

boolean supportsConvert(int fromType,
                        int toType)
                        throws SQLException
Determine if the database supports CONVERT operation for two supplied SQL types.

Parameters:
fromType - the Type to convert from, as defined by java.sql.Types
toType - the Type to convert to, as defined by java.sql.Types
Returns:
true if the CONVERT operation is supported for these types, false otherwise.
Throws:
SQLException - a database error occurred

supportsCoreSQLGrammar

boolean supportsCoreSQLGrammar()
                               throws SQLException
Determine if the database supports the Core SQL Grammar for ODBC.

Returns:
true if the Core SQL Grammar is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsCorrelatedSubqueries

boolean supportsCorrelatedSubqueries()
                                     throws SQLException
Determine if the database supports correlated sub-queries.

Returns:
true if the database does support correlated sub-queries and false otherwise.
Throws:
SQLException - a database error occurred

supportsDataDefinitionAndDataManipulationTransactions

boolean supportsDataDefinitionAndDataManipulationTransactions()
                                                              throws SQLException
Determine if the database allows both data definition and data manipulation statements inside a transaction.

Returns:
true if both types of statement are permitted, false otherwise.
Throws:
SQLException - a database error occurred

supportsDataManipulationTransactionsOnly

boolean supportsDataManipulationTransactionsOnly()
                                                 throws SQLException
Determine if the database only allows data manipulation statements inside a transaction.

Returns:
true if only data manipulation statements are permitted, false otherwise.
Throws:
SQLException - a database error occurred

supportsDifferentTableCorrelationNames

boolean supportsDifferentTableCorrelationNames()
                                               throws SQLException
Determine if table correlation names are restricted to be different from the names of the tables, when they are supported.

Returns:
true if correlation names must be different to table names, false otherwise.
Throws:
SQLException - a database error occurred

supportsExpressionsInOrderBy

boolean supportsExpressionsInOrderBy()
                                     throws SQLException
Determine whether expressions in ORDER BY lists are supported.

Returns:
true if expressions in ORDER BY lists are supported.
Throws:
SQLException - a database error occurred

supportsExtendedSQLGrammar

boolean supportsExtendedSQLGrammar()
                                   throws SQLException
Determine whether the Extended SQL Grammar for ODBC is supported.

Returns:
true if the Extended SQL Grammar is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsFullOuterJoins

boolean supportsFullOuterJoins()
                               throws SQLException
Determine if the database supports full nested outer joins.

Returns:
true if full nested outer joins are supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsGetGeneratedKeys

boolean supportsGetGeneratedKeys()
                                 throws SQLException
Determine if auto generated keys can be returned when a statement executes.

Returns:
true if auto generated keys can be returned, false otherwise.
Throws:
SQLException - a database error occurred

supportsGroupBy

boolean supportsGroupBy()
                        throws SQLException
Determine if the database supports a form of GROUP BY clause.

Returns:
true if a form of GROUP BY clause is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsGroupByBeyondSelect

boolean supportsGroupByBeyondSelect()
                                    throws SQLException
Determine if the database supports using a column name in a GROUP BY clause not included in the SELECT statement as long as all of the columns in the SELECT statement are used in the GROUP BY clause.

Returns:
true if GROUP BY clauses can use column names in this way, false otherwise.
Throws:
SQLException - a database error occurred

supportsGroupByUnrelated

boolean supportsGroupByUnrelated()
                                 throws SQLException
Determine if the database supports using a column name in a GROUP BY clause that is not in the SELECT statement.

Returns:
true if GROUP BY clause can use a column name not in the SELECT statement, false otherwise.
Throws:
SQLException - a database error occurred

supportsIntegrityEnhancementFacility

boolean supportsIntegrityEnhancementFacility()
                                             throws SQLException
Determine whether the database supports SQL Integrity Enhancement Facility.

Returns:
true if the Integrity Enhancement Facility is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsLikeEscapeClause

boolean supportsLikeEscapeClause()
                                 throws SQLException
Determine if the database supports using a LIKE escape clause.

Returns:
true if LIKE escape clause is supported, false otherwise
Throws:
SQLException - a database error occurred

supportsLimitedOuterJoins

boolean supportsLimitedOuterJoins()
                                  throws SQLException
Determine if the database provides limited support for outer Join operations.

Returns:
true if there is limited support for outer Join operations, false otherwise. This will be true if supportsFullOuterJoins returns true.
Throws:
SQLException - a database error occurred

supportsMinimumSQLGrammar

boolean supportsMinimumSQLGrammar()
                                  throws SQLException
Determine if the database supports Minimum SQL Grammar for ODBC.

Returns:
true if the Minimum SQL Grammar is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsMixedCaseIdentifiers

boolean supportsMixedCaseIdentifiers()
                                     throws SQLException
Determine if the database treats mixed case unquoted SQL identifiers as case sensitive storing them in mixed case.

Returns:
true if unquoted SQL identifiers are stored in mixed case, false otherwise.
Throws:
SQLException - a database error occurred

supportsMixedCaseQuotedIdentifiers

boolean supportsMixedCaseQuotedIdentifiers()
                                           throws SQLException
Determine whether the database considers mixed case quoted SQL identifiers as case sensitive, storing them in mixed case.

Returns:
true if quoted SQL identifiers are stored in mixed case, false otherwise.
Throws:
SQLException - a database error occurred

supportsMultipleOpenResults

boolean supportsMultipleOpenResults()
                                    throws SQLException
Determine if it is possible for a single CallableStatement to return multiple ResultSets simultaneously.

Returns:
true if a single CallableStatement can return multiple ResultSets simultaneously, false otherwise.
Throws:
SQLException - a database error occurred

supportsMultipleResultSets

boolean supportsMultipleResultSets()
                                   throws SQLException
Determine whether retrieving multiple ResultSets from a single call to the execute method is supported.

Returns:
true if multiple ResultSets can be retrieved, false otherwise.
Throws:
SQLException - a database error occurred

supportsMultipleTransactions

boolean supportsMultipleTransactions()
                                     throws SQLException
Determine whether multiple transactions in progress at at time on different connections are supported.

Returns:
true if multiple open transactions are supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsNamedParameters

boolean supportsNamedParameters()
                                throws SQLException
Determine whether call-able statements with named parameters is supported.

Returns:
true if named parameters can be used with call-able statements, false otherwise.
Throws:
SQLException - a database error occurred

supportsNonNullableColumns

boolean supportsNonNullableColumns()
                                   throws SQLException
Determine if columns in the database can be defined as non-nullable.

Returns:
true if Columns can be defined non-nullable, false otherwise.
Throws:
SQLException - a database error occurred

supportsOpenCursorsAcrossCommit

boolean supportsOpenCursorsAcrossCommit()
                                        throws SQLException
Determine whether keeping Cursors open across Commit operations is supported.

Returns:
true if Cursors can be kept open across Commit operations, false if they might get closed.
Throws:
SQLException - a database error occurred

supportsOpenCursorsAcrossRollback

boolean supportsOpenCursorsAcrossRollback()
                                          throws SQLException
Determine if the database can keep Cursors open across Rollback operations.

Returns:
true if Cursors can be kept open across Rollback operations, false if they might get closed.
Throws:
SQLException - a database error occurred

supportsOpenStatementsAcrossCommit

boolean supportsOpenStatementsAcrossCommit()
                                           throws SQLException
Determine whether keeping Statements open across Commit operations is supported.

Returns:
true if Statements can be kept open, false if they might not.
Throws:
SQLException - a database error occurred

supportsOpenStatementsAcrossRollback

boolean supportsOpenStatementsAcrossRollback()
                                             throws SQLException
Determine whether keeping Statements open across Rollback operations is supported.

Returns:
true if Statements can be kept open, false if they might not.
Throws:
SQLException - a database error occurred

supportsOrderByUnrelated

boolean supportsOrderByUnrelated()
                                 throws SQLException
Determine whether using a column in an ORDER BY clause that is not in the SELECT statement is supported.

Returns:
true if it is possible to ORDER using a column not in the SELECT, false otherwise.
Throws:
SQLException - a database error occurred

supportsOuterJoins

boolean supportsOuterJoins()
                           throws SQLException
Determine whether outer join operations are supported.

Returns:
true if outer join operations are supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsPositionedDelete

boolean supportsPositionedDelete()
                                 throws SQLException
Determine whether positioned DELETE statements are supported.

Returns:
true if the database supports positioned DELETE statements.
Throws:
SQLException - a database error occurred

supportsPositionedUpdate

boolean supportsPositionedUpdate()
                                 throws SQLException
Determine whether positioned UPDATE statements are supported.

Returns:
true if the database supports positioned UPDATE statements, false otherwise.
Throws:
SQLException - a database error occurred

supportsResultSetConcurrency

boolean supportsResultSetConcurrency(int type,
                                     int concurrency)
                                     throws SQLException
Determine whether there is support for a given concurrency style for the given ResultSet.

Parameters:
type - the ResultSet type, as defined in java.sql.ResultSet: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
concurrency - a concurrency type, which may be one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE.
Returns:
true if that concurrency and ResultSet type pairing is supported otherwise false.
Throws:
SQLException - a database error occurred

supportsResultSetHoldability

boolean supportsResultSetHoldability(int holdability)
                                     throws SQLException
Determine whether the supplied ResultSet holdability is supported.

Parameters:
holdability - as specified in java.sql.ResultSet: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
true if the given ResultSet holdability is supported and if it isn't then false.
Throws:
SQLException - a database error occurred

supportsResultSetType

boolean supportsResultSetType(int type)
                              throws SQLException
Determine whether the supplied ResultSet type is supported.

Parameters:
type - the ResultSet type as defined in java.sql.ResultSet: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true if the ResultSet type is supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsSavepoints

boolean supportsSavepoints()
                           throws SQLException
Determine whether Savepoints for transactions are supported.

Returns:
true if Savepoints are supported, false otherwise.
Throws:
SQLException - a database error occurred

supportsSchemasInDataManipulation

boolean supportsSchemasInDataManipulation()
                                          throws SQLException
Determine whether a schema name may be used in a data manipulation statement.

Returns:
true if a schema name can be used in a data manipulation otherwise false.
Throws:
SQLException - a database error occurred

supportsSchemasInIndexDefinitions

boolean supportsSchemasInIndexDefinitions()
                                          throws SQLException
Determine whether a schema name may be used in an index definition statement.

Returns:
true if a schema name can be used in an index definition otherwise false.
Throws:
SQLException - a database error occurred

supportsSchemasInPrivilegeDefinitions

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

Returns:
true if a database schema name may be used in a privilege definition otherwise false
Throws:
SQLException - a database error occurred

supportsSchemasInProcedureCalls

boolean supportsSchemasInProcedureCalls()
                                        throws SQLException
Determine if a procedure call statement may be contain in a schema name.

Returns:
true if a schema name can be used in a procedure call otherwise false.
Throws:
SQLException - a database error occurred

supportsSchemasInTableDefinitions

boolean supportsSchemasInTableDefinitions()
                                          throws SQLException
Determine if a schema name can be used in a table definition statement.

Returns:
true if a schema name can be used in a table definition otherwise false.
Throws:
SQLException - a database error occurred

supportsSelectForUpdate

boolean supportsSelectForUpdate()
                                throws SQLException
Determine if this SELECT FOR UPDATE statements ar supported.

Returns:
true if SELECT FOR UPDATE statements are supported otherwise false.
Throws:
SQLException - a database error occurred

supportsStatementPooling

boolean supportsStatementPooling()
                                 throws SQLException
Determine whether statement pooling is supported.

Returns:
true of the database does support statement pooling otherwise false.
Throws:
SQLException - a database error occurred

supportsStoredProcedures

boolean supportsStoredProcedures()
                                 throws SQLException
Determine whether stored procedure calls using the stored procedure escape syntax is supported.

Returns:
true if stored procedure calls using the stored procedure escape syntax are supported otherwise false.
Throws:
SQLException - a database error occurred

supportsSubqueriesInComparisons

boolean supportsSubqueriesInComparisons()
                                        throws SQLException
Determine whether subqueries in comparison expressions are supported.

Returns:
true if subqueries are supported in comparison expressions.
Throws:
SQLException - a database error occurred

supportsSubqueriesInExists

boolean supportsSubqueriesInExists()
                                   throws SQLException
Determine whether subqueries in EXISTS expressions are supported.

Returns:
true if subqueries are supported in EXISTS expressions otherwise false.
Throws:
SQLException - a database error occurred

supportsSubqueriesInIns

boolean supportsSubqueriesInIns()
                                throws SQLException
Determine whether subqueries in IN statements are supported.

Returns:
true if subqueries are supported in IN statements otherwise false.
Throws:
SQLException - a database error occurred

supportsSubqueriesInQuantifieds

boolean supportsSubqueriesInQuantifieds()
                                        throws SQLException
Determine whether subqueries in quantified expressions are supported.

Returns:
true if subqueries are supported otherwise false.
Throws:
SQLException - a database error occurred

supportsTableCorrelationNames

boolean supportsTableCorrelationNames()
                                      throws SQLException
Determine whether the database has table correlation names support.

Returns:
true if table correlation names are supported otherwise false.
Throws:
SQLException - a database error occurred

supportsTransactionIsolationLevel

boolean supportsTransactionIsolationLevel(int level)
                                          throws SQLException
Determine whether a specified transaction isolation level is supported.

Parameters:
level - the transaction isolation level, as specified in java.sql.Connection: TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
Returns:
true if the specific isolation level is supported otherwise false.
Throws:
SQLException - a database error occurred

supportsTransactions

boolean supportsTransactions()
                             throws SQLException
Determine whether transactions are supported.

If transactions are not supported, then the commit method does nothing and the transaction isolation level is always TRANSACTION_NONE.

Returns:
true if transactions are supported otherwise false.
Throws:
SQLException - a database error occurred

supportsUnion

boolean supportsUnion()
                      throws SQLException
Determine whether the SQL UNION operation is supported.

Returns:
true of the database does support UNION otherwise false.
Throws:
SQLException - a database error occurred

supportsUnionAll

boolean supportsUnionAll()
                         throws SQLException
Determine whether the SQL UNION ALL operation is supported.

Returns:
true if the database does support UNION ALL otherwise false.
Throws:
SQLException - a database error occurred

updatesAreDetected

boolean updatesAreDetected(int type)
                           throws SQLException
Determine if the method ResultSet.rowUpdated can detect a visible row update.

Parameters:
type - ResultSet type: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns:
true detecting changes is possible otherwise false.
Throws:
SQLException - a database error occurred

usesLocalFilePerTable

boolean usesLocalFilePerTable()
                              throws SQLException
Determine if this database uses a file for each table.

Returns:
true if the database uses one file for each table otherwise false.
Throws:
SQLException - a database error occurred

usesLocalFiles

boolean usesLocalFiles()
                       throws SQLException
Determine whether this database uses a local file to store tables.

Returns:
true of the database does store tables in a local file otherwise false.
Throws:
SQLException - a database error occurred

Build 1.0_r1(from source)

Please submit a feedback, bug or feature