Skip to content

Most visited

Recently visited

navigation

DatabaseMetaData

public interface DatabaseMetaData
implements Wrapper

java.sql.DatabaseMetaData


Comprehensive information about the database as a whole.

This interface is implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBCTM technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.

A user for this interface is commonly a tool that needs to discover how to deal with the underlying DBMS. This is especially true for applications that are intended to be used with more than one DBMS. For example, a tool might use the method getTypeInfo to find out what data types can be used in a CREATE TABLE statement. Or a user might call the method supportsCorrelatedSubqueries to see if it is possible to use a correlated subquery or supportsBatchUpdates to see if it is possible to use batch updates.

Some DatabaseMetaData methods return lists of information in the form of ResultSet objects. Regular ResultSet methods, such as getString and getInt, can be used to retrieve the data from these ResultSet objects. If a given form of metadata is not available, an empty ResultSet will be returned. Additional columns beyond the columns defined to be returned by the ResultSet object for a given method can be defined by the JDBC driver vendor and must be accessed by their column label.

Some DatabaseMetaData methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern are returned. If a search pattern argument is set to null, that argument's criterion will be dropped from the search.

Summary

Constants

short attributeNoNulls

Indicates that NULL values might not be allowed.

short attributeNullable

Indicates that NULL values are definitely allowed.

short attributeNullableUnknown

Indicates that whether NULL values are allowed is not known.

int bestRowNotPseudo

Indicates that the best row identifier is NOT a pseudo column.

int bestRowPseudo

Indicates that the best row identifier is a pseudo column.

int bestRowSession

Indicates that the scope of the best row identifier is the remainder of the current session.

int bestRowTemporary

Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.

int bestRowTransaction

Indicates that the scope of the best row identifier is the remainder of the current transaction.

int bestRowUnknown

Indicates that the best row identifier may or may not be a pseudo column.

int columnNoNulls

Indicates that the column might not allow NULL values.

int columnNullable

Indicates that the column definitely allows NULL values.

int columnNullableUnknown

Indicates that the nullability of columns is unknown.

int functionColumnIn

Indicates that the parameter or column is an IN parameter.

int functionColumnInOut

Indicates that the parameter or column is an INOUT parameter.

int functionColumnOut

Indicates that the parameter or column is an OUT parameter.

int functionColumnResult

Indicates that the parameter or column is a column in a result set.

int functionColumnUnknown

Indicates that type of the parameter or column is unknown.

int functionNoNulls

Indicates that NULL values are not allowed.

int functionNoTable

Indicates that the function does not return a table.

int functionNullable

Indicates that NULL values are allowed.

int functionNullableUnknown

Indicates that whether NULL values are allowed is unknown.

int functionResultUnknown

Indicates that it is not known whether the function returns a result or a table.

int functionReturn

Indicates that the parameter or column is a return value.

int functionReturnsTable

Indicates that the function returns a table.

int importedKeyCascade

For the column UPDATE_RULE, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it.

int importedKeyInitiallyDeferred

Indicates deferrability.

int importedKeyInitiallyImmediate

Indicates deferrability.

int importedKeyNoAction

For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key has been imported, it cannot be updated or deleted.

int importedKeyNotDeferrable

Indicates deferrability.

int importedKeyRestrict

For the column UPDATE_RULE, indicates that a primary key may not be updated if it has been imported by another table as a foreign key.

int importedKeySetDefault

For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.

int importedKeySetNull

For the columns UPDATE_RULE and DELETE_RULE, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL.

int procedureColumnIn

Indicates that the column stores IN parameters.

int procedureColumnInOut

Indicates that the column stores INOUT parameters.

int procedureColumnOut

Indicates that the column stores OUT parameters.

int procedureColumnResult

Indicates that the column stores results.

int procedureColumnReturn

Indicates that the column stores return values.

int procedureColumnUnknown

Indicates that type of the column is unknown.

int procedureNoNulls

Indicates that NULL values are not allowed.

int procedureNoResult

Indicates that the procedure does not return a result.

int procedureNullable

Indicates that NULL values are allowed.

int procedureNullableUnknown

Indicates that whether NULL values are allowed is unknown.

int procedureResultUnknown

Indicates that it is not known whether the procedure returns a result.

int procedureReturnsResult

Indicates that the procedure returns a result.

int sqlStateSQL

A possible return value for the method DatabaseMetaData.getSQLStateType which is used to indicate whether the value returned by the method SQLException.getSQLState is an SQLSTATE value.

int sqlStateSQL99

A possible return value for the method DatabaseMetaData.getSQLStateType which is used to indicate whether the value returned by the method SQLException.getSQLState is an SQL99 SQLSTATE value.

int sqlStateXOpen

A possible return value for the method DatabaseMetaData.getSQLStateType which is used to indicate whether the value returned by the method SQLException.getSQLState is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.

short tableIndexClustered

Indicates that this table index is a clustered index.

short tableIndexHashed

Indicates that this table index is a hashed index.

short tableIndexOther

Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.

short tableIndexStatistic

Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.

int typeNoNulls

Indicates that a NULL value is NOT allowed for this data type.

int typeNullable

Indicates that a NULL value is allowed for this data type.

int typeNullableUnknown

Indicates that it is not known whether a NULL value is allowed for this data type.

int typePredBasic

Indicates that the data type can be only be used in WHERE search clauses that do not use LIKE predicates.

int typePredChar

Indicates that the data type can be only be used in WHERE search clauses that use LIKE predicates.

int typePredNone

Indicates that WHERE search clauses are not supported for this type.

int typeSearchable

Indicates that all WHERE search clauses can be based on this type.

int versionColumnNotPseudo

Indicates that this version column is NOT a pseudo column.

int versionColumnPseudo

Indicates that this version column is a pseudo column.

int versionColumnUnknown

Indicates that this version column may or may not be a pseudo column.

Public methods

abstract boolean allProceduresAreCallable()

Retrieves whether the current user can call all the procedures returned by the method getProcedures.

abstract boolean allTablesAreSelectable()

Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.

abstract boolean autoCommitFailureClosesAllResultSets()

Retrieves whether a SQLException while autoCommit is true inidcates that all open ResultSets are closed, even ones that are holdable.

abstract boolean dataDefinitionCausesTransactionCommit()

Retrieves whether a data definition statement within a transaction forces the transaction to commit.

abstract boolean dataDefinitionIgnoredInTransactions()

Retrieves whether this database ignores a data definition statement within a transaction.

abstract boolean deletesAreDetected(int type)

Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted.

abstract boolean doesMaxRowSizeIncludeBlobs()

Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

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

Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.

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

Retrieves a description of a table's optimal set of columns that uniquely identifies a row.

abstract String getCatalogSeparator()

Retrieves the String that this database uses as the separator between a catalog and table name.

abstract String getCatalogTerm()

Retrieves the database vendor's preferred term for "catalog".

abstract ResultSet getCatalogs()

Retrieves the catalog names available in this database.

abstract ResultSet getClientInfoProperties()

Retrieves a list of the client info properties that the driver supports.

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

Retrieves a description of the access rights for a table's columns.

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

Retrieves a description of table columns available in the specified catalog.

abstract Connection getConnection()

Retrieves the connection that produced this metadata object.

abstract ResultSet getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)

Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table).

abstract int getDatabaseMajorVersion()

Retrieves the major version number of the underlying database.

abstract int getDatabaseMinorVersion()

Retrieves the minor version number of the underlying database.

abstract String getDatabaseProductName()

Retrieves the name of this database product.

abstract String getDatabaseProductVersion()

Retrieves the version number of this database product.

abstract int getDefaultTransactionIsolation()

Retrieves this database's default transaction isolation level.

abstract int getDriverMajorVersion()

Retrieves this JDBC driver's major version number.

abstract int getDriverMinorVersion()

Retrieves this JDBC driver's minor version number.

abstract String getDriverName()

Retrieves the name of this JDBC driver.

abstract String getDriverVersion()

Retrieves the version number of this JDBC driver as a String.

abstract ResultSet getExportedKeys(String catalog, String schema, String table)

Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).

abstract String getExtraNameCharacters()

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

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

Retrieves a description of the given catalog's system or user function parameters and return type.

abstract ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern)

Retrieves a description of the system and user functions available in the given catalog.

abstract String getIdentifierQuoteString()

Retrieves the string used to quote SQL identifiers.

abstract ResultSet getImportedKeys(String catalog, String schema, String table)

Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table).

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

Retrieves a description of the given table's indices and statistics.

abstract int getJDBCMajorVersion()

Retrieves the major JDBC version number for this driver.

abstract int getJDBCMinorVersion()

Retrieves the minor JDBC version number for this driver.

abstract int getMaxBinaryLiteralLength()

Retrieves the maximum number of hex characters this database allows in an inline binary literal.

abstract int getMaxCatalogNameLength()

Retrieves the maximum number of characters that this database allows in a catalog name.

abstract int getMaxCharLiteralLength()

Retrieves the maximum number of characters this database allows for a character literal.

abstract int getMaxColumnNameLength()

Retrieves the maximum number of characters this database allows for a column name.

abstract int getMaxColumnsInGroupBy()

Retrieves the maximum number of columns this database allows in a GROUP BY clause.

abstract int getMaxColumnsInIndex()

Retrieves the maximum number of columns this database allows in an index.

abstract int getMaxColumnsInOrderBy()

Retrieves the maximum number of columns this database allows in an ORDER BY clause.

abstract int getMaxColumnsInSelect()

Retrieves the maximum number of columns this database allows in a SELECT list.

abstract int getMaxColumnsInTable()

Retrieves the maximum number of columns this database allows in a table.

abstract int getMaxConnections()

Retrieves the maximum number of concurrent connections to this database that are possible.

abstract int getMaxCursorNameLength()

Retrieves the maximum number of characters that this database allows in a cursor name.

abstract int getMaxIndexLength()

Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

abstract int getMaxProcedureNameLength()

Retrieves the maximum number of characters that this database allows in a procedure name.

abstract int getMaxRowSize()

Retrieves the maximum number of bytes this database allows in a single row.

abstract int getMaxSchemaNameLength()

Retrieves the maximum number of characters that this database allows in a schema name.

abstract int getMaxStatementLength()

Retrieves the maximum number of characters this database allows in an SQL statement.

abstract int getMaxStatements()

Retrieves the maximum number of active statements to this database that can be open at the same time.

abstract int getMaxTableNameLength()

Retrieves the maximum number of characters this database allows in a table name.

abstract int getMaxTablesInSelect()

Retrieves the maximum number of tables this database allows in a SELECT statement.

abstract int getMaxUserNameLength()

Retrieves the maximum number of characters this database allows in a user name.

abstract String getNumericFunctions()

Retrieves a comma-separated list of math functions available with this database.

abstract ResultSet getPrimaryKeys(String catalog, String schema, String table)

Retrieves a description of the given table's primary key columns.

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

Retrieves a description of the given catalog's stored procedure parameter and result columns.

abstract String getProcedureTerm()

Retrieves the database vendor's preferred term for "procedure".

abstract ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern)

Retrieves a description of the stored procedures available in the given catalog.

abstract int getResultSetHoldability()

Retrieves this database's default holdability for ResultSet objects.

abstract RowIdLifetime getRowIdLifetime()

Indicates whether or not this data source supports the SQL ROWID type, and if so the lifetime for which a RowId object remains valid.

abstract String getSQLKeywords()

Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.

abstract int getSQLStateType()

Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.

abstract String getSchemaTerm()

Retrieves the database vendor's preferred term for "schema".

abstract ResultSet getSchemas(String catalog, String schemaPattern)

Retrieves the schema names available in this database.

abstract ResultSet getSchemas()

Retrieves the schema names available in this database.

abstract String getSearchStringEscape()

Retrieves the string that can be used to escape wildcard characters.

abstract String getStringFunctions()

Retrieves a comma-separated list of string functions available with this database.

abstract ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern)

Retrieves a description of the table hierarchies defined in a particular schema in this database.

abstract ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)

Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.

abstract String getSystemFunctions()

Retrieves a comma-separated list of system functions available with this database.

abstract ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)

Retrieves a description of the access rights for each table available in a catalog.

abstract ResultSet getTableTypes()

Retrieves the table types available in this database.

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

Retrieves a description of the tables available in the given catalog.

abstract String getTimeDateFunctions()

Retrieves a comma-separated list of the time and date functions available with this database.

abstract ResultSet getTypeInfo()

Retrieves a description of all the data types supported by this database.

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

Retrieves a description of the user-defined types (UDTs) defined in a particular schema.

abstract String getURL()

Retrieves the URL for this DBMS.

abstract String getUserName()

Retrieves the user name as known to this database.

abstract ResultSet getVersionColumns(String catalog, String schema, String table)

Retrieves a description of a table's columns that are automatically updated when any value in a row is updated.

abstract boolean insertsAreDetected(int type)

Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.

abstract boolean isCatalogAtStart()

Retrieves whether a catalog appears at the start of a fully qualified table name.

abstract boolean isReadOnly()

Retrieves whether this database is in read-only mode.

abstract boolean locatorsUpdateCopy()

Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

abstract boolean nullPlusNonNullIsNull()

Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.

abstract boolean nullsAreSortedAtEnd()

Retrieves whether NULL values are sorted at the end regardless of sort order.

abstract boolean nullsAreSortedAtStart()

Retrieves whether NULL values are sorted at the start regardless of sort order.

abstract boolean nullsAreSortedHigh()

Retrieves whether NULL values are sorted high.

abstract boolean nullsAreSortedLow()

Retrieves whether NULL values are sorted low.

abstract boolean othersDeletesAreVisible(int type)

Retrieves whether deletes made by others are visible.

abstract boolean othersInsertsAreVisible(int type)

Retrieves whether inserts made by others are visible.

abstract boolean othersUpdatesAreVisible(int type)

Retrieves whether updates made by others are visible.

abstract boolean ownDeletesAreVisible(int type)

Retrieves whether a result set's own deletes are visible.

abstract boolean ownInsertsAreVisible(int type)

Retrieves whether a result set's own inserts are visible.

abstract boolean ownUpdatesAreVisible(int type)

Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

abstract boolean storesLowerCaseIdentifiers()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.

abstract boolean storesLowerCaseQuotedIdentifiers()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

abstract boolean storesMixedCaseIdentifiers()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

abstract boolean storesMixedCaseQuotedIdentifiers()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.

abstract boolean storesUpperCaseIdentifiers()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

abstract boolean storesUpperCaseQuotedIdentifiers()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

abstract boolean supportsANSI92EntryLevelSQL()

Retrieves whether this database supports the ANSI92 entry level SQL grammar.

abstract boolean supportsANSI92FullSQL()

Retrieves whether this database supports the ANSI92 full SQL grammar supported.

abstract boolean supportsANSI92IntermediateSQL()

Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.

abstract boolean supportsAlterTableWithAddColumn()

Retrieves whether this database supports ALTER TABLE with add column.

abstract boolean supportsAlterTableWithDropColumn()

Retrieves whether this database supports ALTER TABLE with drop column.

abstract boolean supportsBatchUpdates()

Retrieves whether this database supports batch updates.

abstract boolean supportsCatalogsInDataManipulation()

Retrieves whether a catalog name can be used in a data manipulation statement.

abstract boolean supportsCatalogsInIndexDefinitions()

Retrieves whether a catalog name can be used in an index definition statement.

abstract boolean supportsCatalogsInPrivilegeDefinitions()

Retrieves whether a catalog name can be used in a privilege definition statement.

abstract boolean supportsCatalogsInProcedureCalls()

Retrieves whether a catalog name can be used in a procedure call statement.

abstract boolean supportsCatalogsInTableDefinitions()

Retrieves whether a catalog name can be used in a table definition statement.

abstract boolean supportsColumnAliasing()

Retrieves whether this database supports column aliasing.

abstract boolean supportsConvert(int fromType, int toType)

Retrieves whether this database supports the JDBC scalar function CONVERT for conversions between the JDBC types fromType and toType.

abstract boolean supportsConvert()

Retrieves whether this database supports the JDBC scalar function CONVERT for the conversion of one JDBC type to another.

abstract boolean supportsCoreSQLGrammar()

Retrieves whether this database supports the ODBC Core SQL grammar.

abstract boolean supportsCorrelatedSubqueries()

Retrieves whether this database supports correlated subqueries.

abstract boolean supportsDataDefinitionAndDataManipulationTransactions()

Retrieves whether this database supports both data definition and data manipulation statements within a transaction.

abstract boolean supportsDataManipulationTransactionsOnly()

Retrieves whether this database supports only data manipulation statements within a transaction.

abstract boolean supportsDifferentTableCorrelationNames()

Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

abstract boolean supportsExpressionsInOrderBy()

Retrieves whether this database supports expressions in ORDER BY lists.

abstract boolean supportsExtendedSQLGrammar()

Retrieves whether this database supports the ODBC Extended SQL grammar.

abstract boolean supportsFullOuterJoins()

Retrieves whether this database supports full nested outer joins.

abstract boolean supportsGetGeneratedKeys()

Retrieves whether auto-generated keys can be retrieved after a statement has been executed

abstract boolean supportsGroupBy()

Retrieves whether this database supports some form of GROUP BY clause.

abstract boolean supportsGroupByBeyondSelect()

Retrieves whether this database supports using columns not included in the SELECT statement in a GROUP BY clause provided that all of the columns in the SELECT statement are included in the GROUP BY clause.

abstract boolean supportsGroupByUnrelated()

Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.

abstract boolean supportsIntegrityEnhancementFacility()

Retrieves whether this database supports the SQL Integrity Enhancement Facility.

abstract boolean supportsLikeEscapeClause()

Retrieves whether this database supports specifying a LIKE escape clause.

abstract boolean supportsLimitedOuterJoins()

Retrieves whether this database provides limited support for outer joins.

abstract boolean supportsMinimumSQLGrammar()

Retrieves whether this database supports the ODBC Minimum SQL grammar.

abstract boolean supportsMixedCaseIdentifiers()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

abstract boolean supportsMixedCaseQuotedIdentifiers()

Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

abstract boolean supportsMultipleOpenResults()

Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.

abstract boolean supportsMultipleResultSets()

Retrieves whether this database supports getting multiple ResultSet objects from a single call to the method execute.

abstract boolean supportsMultipleTransactions()

Retrieves whether this database allows having multiple transactions open at once (on different connections).

abstract boolean supportsNamedParameters()

Retrieves whether this database supports named parameters to callable statements.

abstract boolean supportsNonNullableColumns()

Retrieves whether columns in this database may be defined as non-nullable.

abstract boolean supportsOpenCursorsAcrossCommit()

Retrieves whether this database supports keeping cursors open across commits.

abstract boolean supportsOpenCursorsAcrossRollback()

Retrieves whether this database supports keeping cursors open across rollbacks.

abstract boolean supportsOpenStatementsAcrossCommit()

Retrieves whether this database supports keeping statements open across commits.

abstract boolean supportsOpenStatementsAcrossRollback()

Retrieves whether this database supports keeping statements open across rollbacks.

abstract boolean supportsOrderByUnrelated()

Retrieves whether this database supports using a column that is not in the SELECT statement in an ORDER BY clause.

abstract boolean supportsOuterJoins()

Retrieves whether this database supports some form of outer join.

abstract boolean supportsPositionedDelete()

Retrieves whether this database supports positioned DELETE statements.

abstract boolean supportsPositionedUpdate()

Retrieves whether this database supports positioned UPDATE statements.

abstract boolean supportsResultSetConcurrency(int type, int concurrency)

Retrieves whether this database supports the given concurrency type in combination with the given result set type.

abstract boolean supportsResultSetHoldability(int holdability)

Retrieves whether this database supports the given result set holdability.

abstract boolean supportsResultSetType(int type)

Retrieves whether this database supports the given result set type.

abstract boolean supportsSavepoints()

Retrieves whether this database supports savepoints.

abstract boolean supportsSchemasInDataManipulation()

Retrieves whether a schema name can be used in a data manipulation statement.

abstract boolean supportsSchemasInIndexDefinitions()

Retrieves whether a schema name can be used in an index definition statement.

abstract boolean supportsSchemasInPrivilegeDefinitions()

Retrieves whether a schema name can be used in a privilege definition statement.

abstract boolean supportsSchemasInProcedureCalls()

Retrieves whether a schema name can be used in a procedure call statement.

abstract boolean supportsSchemasInTableDefinitions()

Retrieves whether a schema name can be used in a table definition statement.

abstract boolean supportsSelectForUpdate()

Retrieves whether this database supports SELECT FOR UPDATE statements.

abstract boolean supportsStatementPooling()

Retrieves whether this database supports statement pooling.

abstract boolean supportsStoredFunctionsUsingCallSyntax()

Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.

abstract boolean supportsStoredProcedures()

Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.

abstract boolean supportsSubqueriesInComparisons()

Retrieves whether this database supports subqueries in comparison expressions.

abstract boolean supportsSubqueriesInExists()

Retrieves whether this database supports subqueries in EXISTS expressions.

abstract boolean supportsSubqueriesInIns()

Retrieves whether this database supports subqueries in IN expressions.

abstract boolean supportsSubqueriesInQuantifieds()

Retrieves whether this database supports subqueries in quantified expressions.

abstract boolean supportsTableCorrelationNames()

Retrieves whether this database supports table correlation names.

abstract boolean supportsTransactionIsolationLevel(int level)

Retrieves whether this database supports the given transaction isolation level.

abstract boolean supportsTransactions()

Retrieves whether this database supports transactions.

abstract boolean supportsUnion()

Retrieves whether this database supports SQL UNION.

abstract boolean supportsUnionAll()

Retrieves whether this database supports SQL UNION ALL.

abstract boolean updatesAreDetected(int type)

Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated.

abstract boolean usesLocalFilePerTable()

Retrieves whether this database uses a file for each table.

abstract boolean usesLocalFiles()

Retrieves whether this database stores tables in a local file.

Inherited methods

From interface java.sql.Wrapper

Constants

attributeNoNulls

Added in API level 1
short attributeNoNulls

Indicates that NULL values might not be allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

Constant Value: 0 (0x00000000)

attributeNullable

Added in API level 1
short attributeNullable

Indicates that NULL values are definitely allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

Constant Value: 1 (0x00000001)

attributeNullableUnknown

Added in API level 1
short attributeNullableUnknown

Indicates that whether NULL values are allowed is not known.

A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

Constant Value: 2 (0x00000002)

bestRowNotPseudo

Added in API level 1
int bestRowNotPseudo

Indicates that the best row identifier is NOT a pseudo column.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

Constant Value: 1 (0x00000001)

bestRowPseudo

Added in API level 1
int bestRowPseudo

Indicates that the best row identifier is a pseudo column.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

Constant Value: 2 (0x00000002)

bestRowSession

Added in API level 1
int bestRowSession

Indicates that the scope of the best row identifier is the remainder of the current session.

A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

Constant Value: 2 (0x00000002)

bestRowTemporary

Added in API level 1
int bestRowTemporary

Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.

A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

Constant Value: 0 (0x00000000)

bestRowTransaction

Added in API level 1
int bestRowTransaction

Indicates that the scope of the best row identifier is the remainder of the current transaction.

A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

Constant Value: 1 (0x00000001)

bestRowUnknown

Added in API level 1
int bestRowUnknown

Indicates that the best row identifier may or may not be a pseudo column.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

Constant Value: 0 (0x00000000)

columnNoNulls

Added in API level 1
int columnNoNulls

Indicates that the column might not allow NULL values.

A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

Constant Value: 0 (0x00000000)

columnNullable

Added in API level 1
int columnNullable

Indicates that the column definitely allows NULL values.

A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

Constant Value: 1 (0x00000001)

columnNullableUnknown

Added in API level 1
int columnNullableUnknown

Indicates that the nullability of columns is unknown.

A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

Constant Value: 2 (0x00000002)

functionColumnIn

Added in API level 9
int functionColumnIn

Indicates that the parameter or column is an IN parameter.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.

Constant Value: 1 (0x00000001)

functionColumnInOut

Added in API level 9
int functionColumnInOut

Indicates that the parameter or column is an INOUT parameter.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.

Constant Value: 2 (0x00000002)

functionColumnOut

Added in API level 9
int functionColumnOut

Indicates that the parameter or column is an OUT parameter.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.

Constant Value: 3 (0x00000003)

functionColumnResult

Added in API level 9
int functionColumnResult

Indicates that the parameter or column is a column in a result set.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.

Constant Value: 5 (0x00000005)

functionColumnUnknown

Added in API level 9
int functionColumnUnknown

Indicates that type of the parameter or column is unknown.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.

Constant Value: 0 (0x00000000)

functionNoNulls

Added in API level 9
int functionNoNulls

Indicates that NULL values are not allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.

Constant Value: 0 (0x00000000)

functionNoTable

Added in API level 9
int functionNoTable

Indicates that the function does not return a table.

A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method getFunctions.

Constant Value: 1 (0x00000001)

functionNullable

Added in API level 9
int functionNullable

Indicates that NULL values are allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.

Constant Value: 1 (0x00000001)

functionNullableUnknown

Added in API level 9
int functionNullableUnknown

Indicates that whether NULL values are allowed is unknown.

A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.

Constant Value: 2 (0x00000002)

functionResultUnknown

Added in API level 9
int functionResultUnknown

Indicates that it is not known whether the function returns a result or a table.

A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method getFunctions.

Constant Value: 0 (0x00000000)

functionReturn

Added in API level 9
int functionReturn

Indicates that the parameter or column is a return value.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.

Constant Value: 4 (0x00000004)

functionReturnsTable

Added in API level 9
int functionReturnsTable

Indicates that the function returns a table.

A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method getFunctions.

Constant Value: 2 (0x00000002)

importedKeyCascade

Added in API level 1
int importedKeyCascade

For the column UPDATE_RULE, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it. For the column DELETE_RULE, it indicates that when the primary key is deleted, rows that imported that key are deleted.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 0 (0x00000000)

importedKeyInitiallyDeferred

Added in API level 1
int importedKeyInitiallyDeferred

Indicates deferrability. See SQL-92 for a definition.

A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 5 (0x00000005)

importedKeyInitiallyImmediate

Added in API level 1
int importedKeyInitiallyImmediate

Indicates deferrability. See SQL-92 for a definition.

A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 6 (0x00000006)

importedKeyNoAction

Added in API level 1
int importedKeyNoAction

For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key has been imported, it cannot be updated or deleted.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 3 (0x00000003)

importedKeyNotDeferrable

Added in API level 1
int importedKeyNotDeferrable

Indicates deferrability. See SQL-92 for a definition.

A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 7 (0x00000007)

importedKeyRestrict

Added in API level 1
int importedKeyRestrict

For the column UPDATE_RULE, indicates that a primary key may not be updated if it has been imported by another table as a foreign key. For the column DELETE_RULE, indicates that a primary key may not be deleted if it has been imported by another table as a foreign key.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 1 (0x00000001)

importedKeySetDefault

Added in API level 1
int importedKeySetDefault

For the columns UPDATE_RULE and DELETE_RULE, indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 4 (0x00000004)

importedKeySetNull

Added in API level 1
int importedKeySetNull

For the columns UPDATE_RULE and DELETE_RULE, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

Constant Value: 2 (0x00000002)

procedureColumnIn

Added in API level 1
int procedureColumnIn

Indicates that the column stores IN parameters.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 1 (0x00000001)

procedureColumnInOut

Added in API level 1
int procedureColumnInOut

Indicates that the column stores INOUT parameters.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 2 (0x00000002)

procedureColumnOut

Added in API level 1
int procedureColumnOut

Indicates that the column stores OUT parameters.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 4 (0x00000004)

procedureColumnResult

Added in API level 1
int procedureColumnResult

Indicates that the column stores results.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 3 (0x00000003)

procedureColumnReturn

Added in API level 1
int procedureColumnReturn

Indicates that the column stores return values.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 5 (0x00000005)

procedureColumnUnknown

Added in API level 1
int procedureColumnUnknown

Indicates that type of the column is unknown.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 0 (0x00000000)

procedureNoNulls

Added in API level 1
int procedureNoNulls

Indicates that NULL values are not allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

Constant Value: 0 (0x00000000)

procedureNoResult

Added in API level 1
int procedureNoResult

Indicates that the procedure does not return a result.

A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.

Constant Value: 1 (0x00000001)

procedureNullable

Added in API level 1
int procedureNullable

Indicates that NULL values are allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

Constant Value: 1 (0x00000001)

procedureNullableUnknown

Added in API level 1
int procedureNullableUnknown

Indicates that whether NULL values are allowed is unknown.

A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

Constant Value: 2 (0x00000002)

procedureResultUnknown

Added in API level 1
int procedureResultUnknown

Indicates that it is not known whether the procedure returns a result.

A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.

Constant Value: 0 (0x00000000)

procedureReturnsResult

Added in API level 1
int procedureReturnsResult

Indicates that the procedure returns a result.

A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.

Constant Value: 2 (0x00000002)

sqlStateSQL

Added in API level 9
int sqlStateSQL

A possible return value for the method DatabaseMetaData.getSQLStateType which is used to indicate whether the value returned by the method SQLException.getSQLState is an SQLSTATE value.

Constant Value: 2 (0x00000002)

sqlStateSQL99

Added in API level 1
int sqlStateSQL99

A possible return value for the method DatabaseMetaData.getSQLStateType which is used to indicate whether the value returned by the method SQLException.getSQLState is an SQL99 SQLSTATE value.

Note:This constant remains only for compatibility reasons. Developers should use the constant sqlStateSQL instead.

Constant Value: 2 (0x00000002)

sqlStateXOpen

Added in API level 1
int sqlStateXOpen

A possible return value for the method DatabaseMetaData.getSQLStateType which is used to indicate whether the value returned by the method SQLException.getSQLState is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.

Constant Value: 1 (0x00000001)

tableIndexClustered

Added in API level 1
short tableIndexClustered

Indicates that this table index is a clustered index.

A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

Constant Value: 1 (0x00000001)

tableIndexHashed

Added in API level 1
short tableIndexHashed

Indicates that this table index is a hashed index.

A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

Constant Value: 2 (0x00000002)

tableIndexOther

Added in API level 1
short tableIndexOther

Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.

A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

Constant Value: 3 (0x00000003)

tableIndexStatistic

Added in API level 1
short tableIndexStatistic

Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.

A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

Constant Value: 0 (0x00000000)

typeNoNulls

Added in API level 1
int typeNoNulls

Indicates that a NULL value is NOT allowed for this data type.

A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.

Constant Value: 0 (0x00000000)

typeNullable

Added in API level 1
int typeNullable

Indicates that a NULL value is allowed for this data type.

A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.

Constant Value: 1 (0x00000001)

typeNullableUnknown

Added in API level 1
int typeNullableUnknown

Indicates that it is not known whether a NULL value is allowed for this data type.

A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.

Constant Value: 2 (0x00000002)

typePredBasic

Added in API level 1
int typePredBasic

Indicates that the data type can be only be used in WHERE search clauses that do not use LIKE predicates.

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

Constant Value: 2 (0x00000002)

typePredChar

Added in API level 1
int typePredChar

Indicates that the data type can be only be used in WHERE search clauses that use LIKE predicates.

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

Constant Value: 1 (0x00000001)

typePredNone

Added in API level 1
int typePredNone

Indicates that WHERE search clauses are not supported for this type.

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

Constant Value: 0 (0x00000000)

typeSearchable

Added in API level 1
int typeSearchable

Indicates that all WHERE search clauses can be based on this type.

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

Constant Value: 3 (0x00000003)

versionColumnNotPseudo

Added in API level 1
int versionColumnNotPseudo

Indicates that this version column is NOT a pseudo column.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

Constant Value: 1 (0x00000001)

versionColumnPseudo

Added in API level 1
int versionColumnPseudo

Indicates that this version column is a pseudo column.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

Constant Value: 2 (0x00000002)

versionColumnUnknown

Added in API level 1
int versionColumnUnknown

Indicates that this version column may or may not be a pseudo column.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

Constant Value: 0 (0x00000000)

Public methods

allProceduresAreCallable

Added in API level 1
boolean allProceduresAreCallable ()

Retrieves whether the current user can call all the procedures returned by the method getProcedures.

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

allTablesAreSelectable

Added in API level 1
boolean allTablesAreSelectable ()

Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.

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

autoCommitFailureClosesAllResultSets

Added in API level 9
boolean autoCommitFailureClosesAllResultSets ()

Retrieves whether a SQLException while autoCommit is true inidcates that all open ResultSets are closed, even ones that are holdable. When a SQLException occurs while autocommit is true, it is vendor specific whether the JDBC driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.

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

dataDefinitionCausesTransactionCommit

Added in API level 1
boolean dataDefinitionCausesTransactionCommit ()

Retrieves whether a data definition statement within a transaction forces the transaction to commit.

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

dataDefinitionIgnoredInTransactions

Added in API level 1
boolean dataDefinitionIgnoredInTransactions ()

Retrieves whether this database ignores a data definition statement within a transaction.

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

deletesAreDetected

Added in API level 1
boolean deletesAreDetected (int type)

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

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

doesMaxRowSizeIncludeBlobs

Added in API level 1
boolean doesMaxRowSizeIncludeBlobs ()

Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

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

getAttributes

Added in API level 1
ResultSet getAttributes (String catalog, 
                String schemaPattern, 
                String typeNamePattern, 
                String attributeNamePattern)

Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.

Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by TYPE_CAT, TYPE_SCHEM, TYPE_NAME and ORDINAL_POSITION. This description does not contain inherited attributes.

The ResultSet object that is returned has the following columns:

  1. TYPE_CAT String => type catalog (may be null)
  2. TYPE_SCHEM String => type schema (may be null)
  3. TYPE_NAME String => type name
  4. ATTR_NAME String => attribute name
  5. DATA_TYPE int => attribute type SQL type from java.sql.Types
  6. ATTR_TYPE_NAME String => Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type.
  7. ATTR_SIZE int => column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision.
  8. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  9. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  10. NULLABLE int => whether NULL is allowed
    • attributeNoNulls - might not allow NULL values
    • attributeNullable - definitely allows NULL values
    • attributeNullableUnknown - nullability unknown
  11. REMARKS String => comment describing column (may be null)
  12. ATTR_DEF String => default value (may be null)
  13. SQL_DATA_TYPE int => unused
  14. SQL_DATETIME_SUB int => unused
  15. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  16. ORDINAL_POSITION int => index of the attribute in the UDT (starting at 1)
  17. IS_NULLABLE String => ISO rules are used to determine the nullability for a attribute.
    • YES --- if the attribute can include NULLs
    • NO --- if the attribute cannot include NULLs
    • empty string --- if the nullability for the attribute is unknown
  18. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  19. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  20. SCOPE_TABLE String => table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  21. SOURCE_DATA_TYPE short => source type of a distinct type or user-generated Ref type,SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF)

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

See also:

getBestRowIdentifier

Added in API level 1
ResultSet getBestRowIdentifier (String catalog, 
                String schema, 
                String table, 
                int scope, 
                boolean nullable)

Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.

Each column description has the following columns:

  1. SCOPE short => actual scope of result
    • bestRowTemporary - very temporary, while using row
    • bestRowTransaction - valid for remainder of current transaction
    • bestRowSession - valid for remainder of current session
  2. COLUMN_NAME String => column name
  3. DATA_TYPE int => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => not used
  7. DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • bestRowUnknown - may or may not be pseudo column
    • bestRowNotPseudo - is NOT a pseudo column
    • bestRowPseudo - is a pseudo column

The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

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

getCatalogSeparator

Added in API level 1
String getCatalogSeparator ()

Retrieves the String that this database uses as the separator between a catalog and table name.

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

getCatalogTerm

Added in API level 1
String getCatalogTerm ()

Retrieves the database vendor's preferred term for "catalog".

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

getCatalogs

Added in API level 1
ResultSet getCatalogs ()

Retrieves the catalog names available in this database. The results are ordered by catalog name.

The catalog column is:

  1. TABLE_CAT String => catalog name

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

getClientInfoProperties

Added in API level 9
ResultSet getClientInfoProperties ()

Retrieves a list of the client info properties that the driver supports. The result set contains the following columns

  1. NAME String=> The name of the client info property
  2. MAX_LEN int=> The maximum length of the value for the property
  3. DEFAULT_VALUE String=> The default value of the property
  4. DESCRIPTION String=> A description of the property. This will typically contain information as to where this property is stored in the database.

The ResultSet is sorted by the NAME column

Returns
ResultSet A ResultSet object; each row is a supported client info property

Throws
SQLException if a database access error occurs

getColumnPrivileges

Added in API level 1
ResultSet getColumnPrivileges (String catalog, 
                String schema, 
                String table, 
                String columnNamePattern)

Retrieves a description of the access rights for a table's columns.

Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.

Each privilige description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. GRANTOR String => grantor of access (may be null)
  6. GRANTEE String => grantee of access
  7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

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

See also:

getColumns

Added in API level 1
ResultSet getColumns (String catalog, 
                String schemaPattern, 
                String tableNamePattern, 
                String columnNamePattern)

Retrieves a description of table columns available in the specified catalog.

Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_CAT,TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION.

Each column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. DATA_TYPE int => SQL type from java.sql.Types
  6. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  7. COLUMN_SIZE int => column size.
  8. BUFFER_LENGTH is not used.
  9. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  11. NULLABLE int => is NULL allowed.
    • columnNoNulls - might not allow NULL values
    • columnNullable - definitely allows NULL values
    • columnNullableUnknown - nullability unknown
  12. REMARKS String => comment describing column (may be null)
  13. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
  14. SQL_DATA_TYPE int => unused
  15. SQL_DATETIME_SUB int => unused
  16. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  17. ORDINAL_POSITION int => index of column in table (starting at 1)
  18. IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
    • YES --- if the column can include NULLs
    • NO --- if the column cannot include NULLs
    • empty string --- if the nullability for the column is unknown
  19. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  20. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  21. SCOPE_TABLE String => table name that this the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  22. SOURCE_DATA_TYPE short => source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF)
  23. IS_AUTOINCREMENT String => Indicates whether this column is auto incremented
    • YES --- if the column is auto incremented
    • NO --- if the column is not auto incremented
    • empty string --- if it cannot be determined whether the column is auto incremented
  24. IS_GENERATEDCOLUMN String => Indicates whether this is a generated column
    • YES --- if this a generated column
    • NO --- if this not a generated column
    • empty string --- if it cannot be determined whether this is a generated column

The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

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

See also:

getConnection

Added in API level 1
Connection getConnection ()

Retrieves the connection that produced this metadata object.

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

getCrossReference

Added in API level 1
ResultSet getCrossReference (String parentCatalog, 
                String parentSchema, 
                String parentTable, 
                String foreignCatalog, 
                String foreignSchema, 
                String foreignTable)

Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table). The number of columns returned from the parent table must match the number of columns that make up the foreign key. They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT String => parent key table catalog (may be null)
  2. PKTABLE_SCHEM String => parent key table schema (may be null)
  3. PKTABLE_NAME String => parent key table name
  4. PKCOLUMN_NAME String => parent key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be 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 within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
  10. UPDATE_RULE short => What happens to foreign key when parent key is updated:
    • importedNoAction - do not allow update of parent key if it has been imported
    • importedKeyCascade - change imported key to agree with parent key update
    • importedKeySetNull - change imported key to NULL if its parent key has been updated
    • importedKeySetDefault - change imported key to default values if its parent key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when parent key is deleted.
    • importedKeyNoAction - do not allow delete of parent key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its parent key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => parent key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Parameters
parentCatalog String: a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
parentSchema String: a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria
parentTable String: the name of the table that exports the key; must match the table name as it is stored in the database
foreignCatalog String: a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
foreignSchema String: a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria
foreignTable String: the name of the table that imports the key; must match the table name as it is stored in the database
Returns
ResultSet ResultSet - each row is a foreign key column description
Throws
SQLException if a database access error occurs

See also:

getDatabaseMajorVersion

Added in API level 1
int getDatabaseMajorVersion ()

Retrieves the major version number of the underlying database.

Returns
int the underlying database's major version
Throws
SQLException if a database access error occurs

getDatabaseMinorVersion

Added in API level 1
int getDatabaseMinorVersion ()

Retrieves the minor version number of the underlying database.

Returns
int underlying database's minor version
Throws
SQLException if a database access error occurs

getDatabaseProductName

Added in API level 1
String getDatabaseProductName ()

Retrieves the name of this database product.

Returns
String database product name
Throws
SQLException if a database access error occurs

getDatabaseProductVersion

Added in API level 1
String getDatabaseProductVersion ()

Retrieves the version number of this database product.

Returns
String database version number
Throws
SQLException if a database access error occurs

getDefaultTransactionIsolation

Added in API level 1
int getDefaultTransactionIsolation ()

Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection.

Returns
int the default isolation level
Throws
SQLException if a database access error occurs

See also:

getDriverMajorVersion

Added in API level 1
int getDriverMajorVersion ()

Retrieves this JDBC driver's major version number.

Returns
int JDBC driver major version

getDriverMinorVersion

Added in API level 1
int getDriverMinorVersion ()

Retrieves this JDBC driver's minor version number.

Returns
int JDBC driver minor version number

getDriverName

Added in API level 1
String getDriverName ()

Retrieves the name of this JDBC driver.

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

getDriverVersion

Added in API level 1
String getDriverVersion ()

Retrieves the version number of this JDBC driver as a String.

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

getExportedKeys

Added in API level 1
ResultSet getExportedKeys (String catalog, 
                String schema, 
                String table)

Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be 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 (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be 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 within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

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

See also:

getExtraNameCharacters

Added in API level 1
String getExtraNameCharacters ()

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

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

getFunctionColumns

Added in API level 9
ResultSet getFunctionColumns (String catalog, 
                String schemaPattern, 
                String functionNamePattern, 
                String columnNamePattern)

Retrieves a description of the given catalog's system or user function parameters and return type.

Only descriptions matching the schema, function and parameter name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

Each row in the ResultSet is a parameter description, column description or return type description with the following fields:

  1. FUNCTION_CAT String => function catalog (may be null)
  2. FUNCTION_SCHEM String => function schema (may be null)
  3. FUNCTION_NAME String => function name. This is the name used to invoke the function
  4. COLUMN_NAME String => column/parameter name
  5. COLUMN_TYPE Short => kind of column/parameter:
    • functionColumnUnknown - nobody knows
    • functionColumnIn - IN parameter
    • functionColumnInOut - INOUT parameter
    • functionColumnOut - OUT parameter
    • functionColumnReturn - function return value
    • functionColumnResult - Indicates that the parameter or column is a column in the ResultSet
  6. DATA_TYPE int => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL.
    • functionNoNulls - does not allow NULL values
    • functionNullable - allows NULL values
    • functionNullableUnknown - nullability unknown
  13. REMARKS String => comment describing column/parameter
  14. CHAR_OCTET_LENGTH int => the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL
  15. ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1.
  16. IS_NULLABLE String => ISO rules are used to determine the nullability for a parameter or column.
    • YES --- if the parameter or column can include NULLs
    • NO --- if the parameter or column cannot include NULLs
    • empty string --- if the nullability for the parameter or column is unknown
  17. SPECIFIC_NAME String => the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then the FUNCTION_NAME for example with overload functions

The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

Parameters
catalog String: a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern String: a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
functionNamePattern String: a procedure name pattern; must match the function name as it is stored in the database
columnNamePattern String: a parameter name pattern; must match the parameter or column name as it is stored in the database
Returns
ResultSet ResultSet - each row describes a user function parameter, column or return type
Throws
SQLException if a database access error occurs

See also:

getFunctions

Added in API level 9
ResultSet getFunctions (String catalog, 
                String schemaPattern, 
                String functionNamePattern)

Retrieves a description of the system and user functions available in the given catalog.

Only system and user function descriptions matching the schema and function name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME.

Each function description has the the following columns:

  1. FUNCTION_CAT String => function catalog (may be null)
  2. FUNCTION_SCHEM String => function schema (may be null)
  3. FUNCTION_NAME String => function name. This is the name used to invoke the function
  4. REMARKS String => explanatory comment on the function
  5. FUNCTION_TYPE short => kind of function:
    • functionResultUnknown - Cannot determine if a return value or table will be returned
    • functionNoTable- Does not return a table
    • functionReturnsTable - Returns a table
  6. SPECIFIC_NAME String => the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then the FUNCTION_NAME for example with overload functions

A user may not have permission to execute any of the functions that are returned by getFunctions

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

See also:

getIdentifierQuoteString

Added in API level 1
String getIdentifierQuoteString ()

Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.

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

getImportedKeys

Added in API level 1
ResultSet getImportedKeys (String catalog, 
                String schema, 
                String table)

Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.

Each primary key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog being imported (may be null)
  2. PKTABLE_SCHEM String => primary key table schema being imported (may be 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 (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null)
  7. FKTABLE_NAME String => foreign key table name
  8. FKCOLUMN_NAME String => foreign key column name
  9. KEY_SEQ short => sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
  10. UPDATE_RULE short => What happens to a foreign key when the primary key is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

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

See also:

getIndexInfo

Added in API level 1
ResultSet getIndexInfo (String catalog, 
                String schema, 
                String table, 
                boolean unique, 
                boolean approximate)

Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

Each index column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. NON_UNIQUE boolean => Can index values be non-unique. false when TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
  6. INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
  7. TYPE short => index type:
    • tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
    • tableIndexClustered - this is a clustered index
    • tableIndexHashed - this is a hashed index
    • tableIndexOther - this is some other style of index
  8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
  9. COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
  10. ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
  11. CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
  12. PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
  13. FILTER_CONDITION String => Filter condition, if any. (may be null)

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

getJDBCMajorVersion

Added in API level 1
int getJDBCMajorVersion ()

Retrieves the major JDBC version number for this driver.

Returns
int JDBC version major number
Throws
SQLException if a database access error occurs

getJDBCMinorVersion

Added in API level 1
int getJDBCMinorVersion ()

Retrieves the minor JDBC version number for this driver.

Returns
int JDBC version minor number
Throws
SQLException if a database access error occurs

getMaxBinaryLiteralLength

Added in API level 1
int getMaxBinaryLiteralLength ()

Retrieves the maximum number of hex characters this database allows in an inline binary literal.

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

getMaxCatalogNameLength

Added in API level 1
int getMaxCatalogNameLength ()

Retrieves the maximum number of characters that this database allows in a catalog name.

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

getMaxCharLiteralLength

Added in API level 1
int getMaxCharLiteralLength ()

Retrieves the maximum number of characters this database allows for a character literal.

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

getMaxColumnNameLength

Added in API level 1
int getMaxColumnNameLength ()

Retrieves the maximum number of characters this database allows for a column name.

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

getMaxColumnsInGroupBy

Added in API level 1
int getMaxColumnsInGroupBy ()

Retrieves the maximum number of columns this database allows in a GROUP BY clause.

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

getMaxColumnsInIndex

Added in API level 1
int getMaxColumnsInIndex ()

Retrieves the maximum number of columns this database allows in an index.

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

getMaxColumnsInOrderBy

Added in API level 1
int getMaxColumnsInOrderBy ()

Retrieves the maximum number of columns this database allows in an ORDER BY clause.

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

getMaxColumnsInSelect

Added in API level 1
int getMaxColumnsInSelect ()

Retrieves the maximum number of columns this database allows in a SELECT list.

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

getMaxColumnsInTable

Added in API level 1
int getMaxColumnsInTable ()

Retrieves the maximum number of columns this database allows in a table.

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

getMaxConnections

Added in API level 1
int getMaxConnections ()

Retrieves the maximum number of concurrent connections to this database that are possible.

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

getMaxCursorNameLength

Added in API level 1
int getMaxCursorNameLength ()

Retrieves the maximum number of characters that this database allows in a cursor name.

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

getMaxIndexLength

Added in API level 1
int getMaxIndexLength ()

Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

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

getMaxProcedureNameLength

Added in API level 1
int getMaxProcedureNameLength ()

Retrieves the maximum number of characters that this database allows in a procedure name.

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

getMaxRowSize

Added in API level 1
int getMaxRowSize ()

Retrieves the maximum number of bytes this database allows in a single row.

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

getMaxSchemaNameLength

Added in API level 1
int getMaxSchemaNameLength ()

Retrieves the maximum number of characters that this database allows in a schema name.

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

getMaxStatementLength

Added in API level 1
int getMaxStatementLength ()

Retrieves the maximum number of characters this database allows in an SQL statement.

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

getMaxStatements

Added in API level 1
int getMaxStatements ()

Retrieves the maximum number of active statements to this database that can be open at the same time.

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

getMaxTableNameLength

Added in API level 1
int getMaxTableNameLength ()

Retrieves the maximum number of characters this database allows in a table name.

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

getMaxTablesInSelect

Added in API level 1
int getMaxTablesInSelect ()

Retrieves the maximum number of tables this database allows in a SELECT statement.

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

getMaxUserNameLength

Added in API level 1
int getMaxUserNameLength ()

Retrieves the maximum number of characters this database allows in a user name.

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

getNumericFunctions

Added in API level 1
String getNumericFunctions ()

Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.

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

getPrimaryKeys

Added in API level 1
ResultSet getPrimaryKeys (String catalog, 
                String schema, 
                String table)

Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.

Each primary key column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. KEY_SEQ short => sequence number within primary key( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key).
  6. PK_NAME String => primary key name (may be null)

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

getProcedureColumns

Added in API level 1
ResultSet getProcedureColumns (String catalog, 
                String schemaPattern, 
                String procedureNamePattern, 
                String columnNamePattern)

Retrieves a description of the given catalog's stored procedure parameter and result columns.

Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

Each row in the ResultSet is a parameter description or column description with the following fields:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. COLUMN_NAME String => column/parameter name
  5. COLUMN_TYPE Short => kind of column/parameter:
    • procedureColumnUnknown - nobody knows
    • procedureColumnIn - IN parameter
    • procedureColumnInOut - INOUT parameter
    • procedureColumnOut - OUT parameter
    • procedureColumnReturn - procedure return value
    • procedureColumnResult - result column in ResultSet
  6. DATA_TYPE int => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL.
    • procedureNoNulls - does not allow NULL values
    • procedureNullable - allows NULL values
    • procedureNullableUnknown - nullability unknown
  13. REMARKS String => comment describing parameter/column
  14. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
    • The string NULL (not enclosed in quotes) - if NULL was specified as the default value
    • TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation
    • NULL - if a default value was not specified
  15. SQL_DATA_TYPE int => reserved for future use
  16. SQL_DATETIME_SUB int => reserved for future use
  17. CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL
  18. ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 is returned if this row describes the procedure's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. If there are multiple result sets, the column ordinal positions are implementation defined.
  19. IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
    • YES --- if the column can include NULLs
    • NO --- if the column cannot include NULLs
    • empty string --- if the nullability for the column is unknown
  20. SPECIFIC_NAME String => the name which uniquely identifies this procedure within its schema.

Note: Some databases may not return the column descriptions for a procedure.

The PRECISION column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

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

See also:

getProcedureTerm

Added in API level 1
String getProcedureTerm ()

Retrieves the database vendor's preferred term for "procedure".

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

getProcedures

Added in API level 1
ResultSet getProcedures (String catalog, 
                String schemaPattern, 
                String procedureNamePattern)

Retrieves a description of the stored procedures available in the given catalog.

Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_ NAME.

Each procedure description has the the following columns:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. reserved for future use
  5. reserved for future use
  6. reserved for future use
  7. REMARKS String => explanatory comment on the procedure
  8. PROCEDURE_TYPE short => kind of procedure:
    • procedureResultUnknown - Cannot determine if a return value will be returned
    • procedureNoResult - Does not return a return value
    • procedureReturnsResult - Returns a return value
  9. SPECIFIC_NAME String => The name which uniquely identifies this procedure within its schema.

A user may not have permissions to execute any of the procedures that are returned by getProcedures

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

See also:

getResultSetHoldability

Added in API level 1
int getResultSetHoldability ()

Retrieves this database's default holdability for ResultSet objects.

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

getRowIdLifetime

Added in API level 9
RowIdLifetime getRowIdLifetime ()

Indicates whether or not this data source supports the SQL ROWID type, and if so the lifetime for which a RowId object remains valid.

The returned int values have the following relationship:

     ROWID_UNSUPPORTED < ROWID_VALID_OTHER < ROWID_VALID_TRANSACTION
         < ROWID_VALID_SESSION < ROWID_VALID_FOREVER
 
so conditional logic such as
     if (metadata.getRowIdLifetime() > DatabaseMetaData.ROWID_VALID_TRANSACTION)
 
can be used. Valid Forever means valid across all Sessions, and valid for a Session means valid across all its contained Transactions.

Returns
RowIdLifetime the status indicating the lifetime of a RowId
Throws
SQLException if a database access error occurs

getSQLKeywords

Added in API level 1
String getSQLKeywords ()

Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.

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

getSQLStateType

Added in API level 1
int getSQLStateType ()

Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.

Returns
int the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL
Throws
SQLException if a database access error occurs

getSchemaTerm

Added in API level 1
String getSchemaTerm ()

Retrieves the database vendor's preferred term for "schema".

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

getSchemas

Added in API level 9
ResultSet getSchemas (String catalog, 
                String schemaPattern)

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

The schema columns are:

  1. TABLE_SCHEM String => schema name
  2. TABLE_CATALOG String => catalog name (may be null)

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

See also:

getSchemas

Added in API level 1
ResultSet getSchemas ()

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

The schema columns are:

  1. TABLE_SCHEM String => schema name
  2. TABLE_CATALOG String => catalog name (may be null)

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

getSearchStringEscape

Added in API level 1
String getSearchStringEscape ()

Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).

The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.

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

getStringFunctions

Added in API level 1
String getStringFunctions ()

Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.

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

getSuperTables

Added in API level 1
ResultSet getSuperTables (String catalog, 
                String schemaPattern, 
                String tableNamePattern)

Retrieves a description of the table hierarchies defined in a particular schema in this database.

Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.

Each type description has the following columns:

  1. TABLE_CAT String => the type's catalog (may be null)
  2. TABLE_SCHEM String => type's schema (may be null)
  3. TABLE_NAME String => type name
  4. SUPERTABLE_NAME String => the direct super type's name

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

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

See also:

getSuperTypes

Added in API level 1
ResultSet getSuperTypes (String catalog, 
                String schemaPattern, 
                String typeNamePattern)

Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.

Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.

If a UDT does not have a direct super type, it is not listed here. A row of the ResultSet object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:

  1. TYPE_CAT String => the UDT's catalog (may be null)
  2. TYPE_SCHEM String => UDT's schema (may be null)
  3. TYPE_NAME String => type name of the UDT
  4. SUPERTYPE_CAT String => the direct super type's catalog (may be null)
  5. SUPERTYPE_SCHEM String => the direct super type's schema (may be null)
  6. SUPERTYPE_NAME String => the direct super type's name

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

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

See also:

getSystemFunctions

Added in API level 1
String getSystemFunctions ()

Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.

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

getTablePrivileges

Added in API level 1
ResultSet getTablePrivileges (String catalog, 
                String schemaPattern, 
                String tableNamePattern)

Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)

Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.

Each privilige description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. GRANTOR String => grantor of access (may be null)
  5. GRANTEE String => grantee of access
  6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

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

See also:

getTableTypes

Added in API level 1
ResultSet getTableTypes ()

Retrieves the table types available in this database. The results are ordered by table type.

The table type is:

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

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

getTables

Added in API level 1
ResultSet getTables (String catalog, 
                String schemaPattern, 
                String tableNamePattern, 
                String[] types)

Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_CAT, TABLE_SCHEM and TABLE_NAME.

Each table description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
  5. REMARKS String => explanatory comment on the table
  6. TYPE_CAT String => the types catalog (may be null)
  7. TYPE_SCHEM String => the types schema (may be null)
  8. TYPE_NAME String => type name (may be null)
  9. SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null)
  10. REF_GENERATION String => specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be null)

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

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

See also:

getTimeDateFunctions

Added in API level 1
String getTimeDateFunctions ()

Retrieves a comma-separated list of the time and date functions available with this database.

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

getTypeInfo

Added in API level 1
ResultSet getTypeInfo ()

Retrieves a description of all the data types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.

If the database supports SQL distinct types, then getTypeInfo() will return a single row with a TYPE_NAME of DISTINCT and a DATA_TYPE of Types.DISTINCT. If the database supports SQL structured types, then getTypeInfo() will return a single row with a TYPE_NAME of STRUCT and a DATA_TYPE of Types.STRUCT.

If SQL distinct or structured types are supported, then information on the individual types may be obtained from the getUDTs() method.

Each type description has the following columns:

  1. TYPE_NAME String => Type name
  2. DATA_TYPE int => SQL data type from java.sql.Types
  3. PRECISION int => maximum precision
  4. LITERAL_PREFIX String => prefix used to quote a literal (may be null)
  5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
  6. CREATE_PARAMS String => parameters used in creating the type (may be null)
  7. NULLABLE short => can you use NULL for this type.
    • typeNoNulls - does not allow NULL values
    • typeNullable - allows NULL values
    • typeNullableUnknown - nullability unknown
  8. CASE_SENSITIVE boolean=> is it case sensitive.
  9. SEARCHABLE short => can you use "WHERE" based on this type:
    • typePredNone - No support
    • typePredChar - Only supported with WHERE .. LIKE
    • typePredBasic - Supported except for WHERE .. LIKE
    • typeSearchable - Supported for all WHERE ..
  10. UNSIGNED_ATTRIBUTE boolean => is it unsigned.
  11. FIXED_PREC_SCALE boolean => can it be a money value.
  12. AUTO_INCREMENT boolean => can it be used for an auto-increment value.
  13. LOCAL_TYPE_NAME String => localized version of type name (may be null)
  14. MINIMUM_SCALE short => minimum scale supported
  15. MAXIMUM_SCALE short => maximum scale supported
  16. SQL_DATA_TYPE int => unused
  17. SQL_DATETIME_SUB int => unused
  18. NUM_PREC_RADIX int => usually 2 or 10

The PRECISION column represents the maximum column size that the server supports for the given datatype. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

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

getUDTs

Added in API level 1
ResultSet getUDTs (String catalog, 
                String schemaPattern, 
                String typeNamePattern, 
                int[] types)

Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_CAT, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.

Each type description has the following columns:

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

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

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

See also:

getURL

Added in API level 1
String getURL ()

Retrieves the URL for this DBMS.

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

getUserName

Added in API level 1
String getUserName ()

Retrieves the user name as known to this database.

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

getVersionColumns

Added in API level 1
ResultSet getVersionColumns (String catalog, 
                String schema, 
                String table)

Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.

Each column description has the following columns:

  1. SCOPE short => is not used
  2. COLUMN_NAME String => column name
  3. DATA_TYPE int => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source-dependent type name
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => length of column value in bytes
  7. DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. PSEUDO_COLUMN short => whether this is pseudo column like an Oracle ROWID
    • versionColumnUnknown - may or may not be pseudo column
    • versionColumnNotPseudo - is NOT a pseudo column
    • versionColumnPseudo - is a pseudo column

The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

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

insertsAreDetected

Added in API level 1
boolean insertsAreDetected (int type)

Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.

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

isCatalogAtStart

Added in API level 1
boolean isCatalogAtStart ()

Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.

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

isReadOnly

Added in API level 1
boolean isReadOnly ()

Retrieves whether this database is in read-only mode.

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

locatorsUpdateCopy

Added in API level 1
boolean locatorsUpdateCopy ()

Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

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

nullPlusNonNullIsNull

Added in API level 1
boolean nullPlusNonNullIsNull ()

Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.

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

nullsAreSortedAtEnd

Added in API level 1
boolean nullsAreSortedAtEnd ()

Retrieves whether NULL values are sorted at the end regardless of sort order.

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

nullsAreSortedAtStart

Added in API level 1
boolean nullsAreSortedAtStart ()

Retrieves whether NULL values are sorted at the start regardless of sort order.

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

nullsAreSortedHigh

Added in API level 1
boolean nullsAreSortedHigh ()

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

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

nullsAreSortedLow

Added in API level 1
boolean nullsAreSortedLow ()

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

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

othersDeletesAreVisible

Added in API level 1
boolean othersDeletesAreVisible (int type)

Retrieves whether deletes made by others are visible.

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

othersInsertsAreVisible

Added in API level 1
boolean othersInsertsAreVisible (int type)

Retrieves whether inserts made by others are visible.

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

othersUpdatesAreVisible

Added in API level 1
boolean othersUpdatesAreVisible (int type)

Retrieves whether updates made by others are visible.

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

ownDeletesAreVisible

Added in API level 1
boolean ownDeletesAreVisible (int type)

Retrieves whether a result set's own deletes are visible.

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

ownInsertsAreVisible

Added in API level 1
boolean ownInsertsAreVisible (int type)

Retrieves whether a result set's own inserts are visible.

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

ownUpdatesAreVisible

Added in API level 1
boolean ownUpdatesAreVisible (int type)

Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

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

storesLowerCaseIdentifiers

Added in API level 1
boolean storesLowerCaseIdentifiers ()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.

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

storesLowerCaseQuotedIdentifiers

Added in API level 1
boolean storesLowerCaseQuotedIdentifiers ()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

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

storesMixedCaseIdentifiers

Added in API level 1
boolean storesMixedCaseIdentifiers ()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

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

storesMixedCaseQuotedIdentifiers

Added in API level 1
boolean storesMixedCaseQuotedIdentifiers ()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.

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

storesUpperCaseIdentifiers

Added in API level 1
boolean storesUpperCaseIdentifiers ()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

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

storesUpperCaseQuotedIdentifiers

Added in API level 1
boolean storesUpperCaseQuotedIdentifiers ()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

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

supportsANSI92EntryLevelSQL

Added in API level 1
boolean supportsANSI92EntryLevelSQL ()

Retrieves whether this database supports the ANSI92 entry level SQL grammar.

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

supportsANSI92FullSQL

Added in API level 1
boolean supportsANSI92FullSQL ()

Retrieves whether this database supports the ANSI92 full SQL grammar supported.

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

supportsANSI92IntermediateSQL

Added in API level 1
boolean supportsANSI92IntermediateSQL ()

Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.

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

supportsAlterTableWithAddColumn

Added in API level 1
boolean supportsAlterTableWithAddColumn ()

Retrieves whether this database supports ALTER TABLE with add column.

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

supportsAlterTableWithDropColumn

Added in API level 1
boolean supportsAlterTableWithDropColumn ()

Retrieves whether this database supports ALTER TABLE with drop column.

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

supportsBatchUpdates

Added in API level 1
boolean supportsBatchUpdates ()

Retrieves whether this database supports batch updates.

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

supportsCatalogsInDataManipulation

Added in API level 1
boolean supportsCatalogsInDataManipulation ()

Retrieves whether a catalog name can be used in a data manipulation statement.

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

supportsCatalogsInIndexDefinitions

Added in API level 1
boolean supportsCatalogsInIndexDefinitions ()

Retrieves whether a catalog name can be used in an index definition statement.

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

supportsCatalogsInPrivilegeDefinitions

Added in API level 1
boolean supportsCatalogsInPrivilegeDefinitions ()

Retrieves whether a catalog name can be used in a privilege definition statement.

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

supportsCatalogsInProcedureCalls

Added in API level 1
boolean supportsCatalogsInProcedureCalls ()

Retrieves whether a catalog name can be used in a procedure call statement.

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

supportsCatalogsInTableDefinitions

Added in API level 1
boolean supportsCatalogsInTableDefinitions ()

Retrieves whether a catalog name can be used in a table definition statement.

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

supportsColumnAliasing

Added in API level 1
boolean supportsColumnAliasing ()

Retrieves whether this database supports column aliasing.

If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.

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

supportsConvert

Added in API level 1
boolean supportsConvert (int fromType, 
                int toType)

Retrieves whether this database supports the JDBC scalar function CONVERT for conversions between the JDBC types fromType and toType. The JDBC types are the generic SQL data types defined in java.sql.Types.

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

See also:

supportsConvert

Added in API level 1
boolean supportsConvert ()

Retrieves whether this database supports the JDBC scalar function CONVERT for the conversion of one JDBC type to another. The JDBC types are the generic SQL data types defined in java.sql.Types.

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

supportsCoreSQLGrammar

Added in API level 1
boolean supportsCoreSQLGrammar ()

Retrieves whether this database supports the ODBC Core SQL grammar.

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

supportsCorrelatedSubqueries

Added in API level 1
boolean supportsCorrelatedSubqueries ()

Retrieves whether this database supports correlated subqueries.

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

supportsDataDefinitionAndDataManipulationTransactions

Added in API level 1
boolean supportsDataDefinitionAndDataManipulationTransactions ()

Retrieves whether this database supports both data definition and data manipulation statements within a transaction.

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

supportsDataManipulationTransactionsOnly

Added in API level 1
boolean supportsDataManipulationTransactionsOnly ()

Retrieves whether this database supports only data manipulation statements within a transaction.

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

supportsDifferentTableCorrelationNames

Added in API level 1
boolean supportsDifferentTableCorrelationNames ()

Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

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

supportsExpressionsInOrderBy

Added in API level 1
boolean supportsExpressionsInOrderBy ()

Retrieves whether this database supports expressions in ORDER BY lists.

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

supportsExtendedSQLGrammar

Added in API level 1
boolean supportsExtendedSQLGrammar ()

Retrieves whether this database supports the ODBC Extended SQL grammar.

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

supportsFullOuterJoins

Added in API level 1
boolean supportsFullOuterJoins ()

Retrieves whether this database supports full nested outer joins.

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

supportsGetGeneratedKeys

Added in API level 1
boolean supportsGetGeneratedKeys ()

Retrieves whether auto-generated keys can be retrieved after a statement has been executed

Returns
boolean true if auto-generated keys can be retrieved after a statement has executed; false otherwise

If true is returned, the JDBC driver must support the returning of auto-generated keys for at least SQL INSERT statements

Throws
SQLException if a database access error occurs

supportsGroupBy

Added in API level 1
boolean supportsGroupBy ()

Retrieves whether this database supports some form of GROUP BY clause.

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

supportsGroupByBeyondSelect

Added in API level 1
boolean supportsGroupByBeyondSelect ()

Retrieves whether this database supports using columns not included in the SELECT statement in a GROUP BY clause provided that all of the columns in the SELECT statement are included in the GROUP BY clause.

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

supportsGroupByUnrelated

Added in API level 1
boolean supportsGroupByUnrelated ()

Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.

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

supportsIntegrityEnhancementFacility

Added in API level 1
boolean supportsIntegrityEnhancementFacility ()

Retrieves whether this database supports the SQL Integrity Enhancement Facility.

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

supportsLikeEscapeClause

Added in API level 1
boolean supportsLikeEscapeClause ()

Retrieves whether this database supports specifying a LIKE escape clause.

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

supportsLimitedOuterJoins

Added in API level 1
boolean supportsLimitedOuterJoins ()

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

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

supportsMinimumSQLGrammar

Added in API level 1
boolean supportsMinimumSQLGrammar ()

Retrieves whether this database supports the ODBC Minimum SQL grammar.

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

supportsMixedCaseIdentifiers

Added in API level 1
boolean supportsMixedCaseIdentifiers ()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

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

supportsMixedCaseQuotedIdentifiers

Added in API level 1
boolean supportsMixedCaseQuotedIdentifiers ()

Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

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

supportsMultipleOpenResults

Added in API level 1
boolean supportsMultipleOpenResults ()

Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.

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

supportsMultipleResultSets

Added in API level 1
boolean supportsMultipleResultSets ()

Retrieves whether this database supports getting multiple ResultSet objects from a single call to the method execute.

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

supportsMultipleTransactions

Added in API level 1
boolean supportsMultipleTransactions ()

Retrieves whether this database allows having multiple transactions open at once (on different connections).

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

supportsNamedParameters

Added in API level 1
boolean supportsNamedParameters ()

Retrieves whether this database supports named parameters to callable statements.

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

supportsNonNullableColumns

Added in API level 1
boolean supportsNonNullableColumns ()

Retrieves whether columns in this database may be defined as non-nullable.

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

supportsOpenCursorsAcrossCommit

Added in API level 1
boolean supportsOpenCursorsAcrossCommit ()

Retrieves whether this database supports keeping cursors open across commits.

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

supportsOpenCursorsAcrossRollback

Added in API level 1
boolean supportsOpenCursorsAcrossRollback ()

Retrieves whether this database supports keeping cursors open across rollbacks.

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

supportsOpenStatementsAcrossCommit

Added in API level 1
boolean supportsOpenStatementsAcrossCommit ()

Retrieves whether this database supports keeping statements open across commits.

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

supportsOpenStatementsAcrossRollback

Added in API level 1
boolean supportsOpenStatementsAcrossRollback ()

Retrieves whether this database supports keeping statements open across rollbacks.

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

supportsOrderByUnrelated

Added in API level 1
boolean supportsOrderByUnrelated ()

Retrieves whether this database supports using a column that is not in the SELECT statement in an ORDER BY clause.

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

supportsOuterJoins

Added in API level 1
boolean supportsOuterJoins ()

Retrieves whether this database supports some form of outer join.

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

supportsPositionedDelete

Added in API level 1
boolean supportsPositionedDelete ()

Retrieves whether this database supports positioned DELETE statements.

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

supportsPositionedUpdate

Added in API level 1
boolean supportsPositionedUpdate ()

Retrieves whether this database supports positioned UPDATE statements.

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

supportsResultSetConcurrency

Added in API level 1
boolean supportsResultSetConcurrency (int type, 
                int concurrency)

Retrieves whether this database supports the given concurrency type in combination with the given result set type.

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

See also:

supportsResultSetHoldability

Added in API level 1
boolean supportsResultSetHoldability (int holdability)

Retrieves whether this database supports the given result set holdability.

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

See also:

supportsResultSetType

Added in API level 1
boolean supportsResultSetType (int type)

Retrieves whether this database supports the given result set type.

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

See also:

supportsSavepoints

Added in API level 1
boolean supportsSavepoints ()

Retrieves whether this database supports savepoints.

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

supportsSchemasInDataManipulation

Added in API level 1
boolean supportsSchemasInDataManipulation ()

Retrieves whether a schema name can be used in a data manipulation statement.

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

supportsSchemasInIndexDefinitions

Added in API level 1
boolean supportsSchemasInIndexDefinitions ()

Retrieves whether a schema name can be used in an index definition statement.

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

supportsSchemasInPrivilegeDefinitions

Added in API level 1
boolean supportsSchemasInPrivilegeDefinitions ()

Retrieves whether a schema name can be used in a privilege definition statement.

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

supportsSchemasInProcedureCalls

Added in API level 1
boolean supportsSchemasInProcedureCalls ()

Retrieves whether a schema name can be used in a procedure call statement.

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

supportsSchemasInTableDefinitions

Added in API level 1
boolean supportsSchemasInTableDefinitions ()

Retrieves whether a schema name can be used in a table definition statement.

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

supportsSelectForUpdate

Added in API level 1
boolean supportsSelectForUpdate ()

Retrieves whether this database supports SELECT FOR UPDATE statements.

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

supportsStatementPooling

Added in API level 1
boolean supportsStatementPooling ()

Retrieves whether this database supports statement pooling.

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

supportsStoredFunctionsUsingCallSyntax

Added in API level 9
boolean supportsStoredFunctionsUsingCallSyntax ()

Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.

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

supportsStoredProcedures

Added in API level 1
boolean supportsStoredProcedures ()

Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.

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

supportsSubqueriesInComparisons

Added in API level 1
boolean supportsSubqueriesInComparisons ()

Retrieves whether this database supports subqueries in comparison expressions.

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

supportsSubqueriesInExists

Added in API level 1
boolean supportsSubqueriesInExists ()

Retrieves whether this database supports subqueries in EXISTS expressions.

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

supportsSubqueriesInIns

Added in API level 1
boolean supportsSubqueriesInIns ()

Retrieves whether this database supports subqueries in IN expressions.

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

supportsSubqueriesInQuantifieds

Added in API level 1
boolean supportsSubqueriesInQuantifieds ()

Retrieves whether this database supports subqueries in quantified expressions.

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

supportsTableCorrelationNames

Added in API level 1
boolean supportsTableCorrelationNames ()

Retrieves whether this database supports table correlation names.

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

supportsTransactionIsolationLevel

Added in API level 1
boolean supportsTransactionIsolationLevel (int level)

Retrieves whether this database supports the given transaction isolation level.

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

See also:

supportsTransactions

Added in API level 1
boolean supportsTransactions ()

Retrieves whether this database supports transactions. If not, invoking the method commit is a noop, and the isolation level is TRANSACTION_NONE.

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

supportsUnion

Added in API level 1
boolean supportsUnion ()

Retrieves whether this database supports SQL UNION.

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

supportsUnionAll

Added in API level 1
boolean supportsUnionAll ()

Retrieves whether this database supports SQL UNION ALL.

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

updatesAreDetected

Added in API level 1
boolean updatesAreDetected (int type)

Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated.

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

usesLocalFilePerTable

Added in API level 1
boolean usesLocalFilePerTable ()

Retrieves whether this database uses a file for each table.

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

usesLocalFiles

Added in API level 1
boolean usesLocalFiles ()

Retrieves whether this database stores tables in a local file.

Returns
boolean true if so; false otherwise
Throws
SQLException if a database access error occurs
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.