Home » openjdk-7 » java » sql » [javadoc | source]

java.sql
public interface: DatabaseMetaData [javadoc | source]

All Implemented Interfaces:
    Wrapper

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 JDBC^TM technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.

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

Some DatabaseMetaData methods return lists of information in the form of ResultSet objects. Regular ResultSet methods, such as getString and getInt, can be used to retrieve the data from these ResultSet objects. If a given form of metadata is not available, 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.

Field Summary
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.
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.
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.
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.
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.
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.
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.
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.
int	procedureColumnResult	Indicates that the column stores results. A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
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.
int	procedureNullable	Indicates that NULL values are allowed. A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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. since: 1.4 -
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. since: 1.6 -
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. since: 1.4 -
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.
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. since: 1.6 -
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. since: 1.6 -
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. since: 1.6 -
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. since: 1.6 -
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. since: 1.6 -
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. since: 1.6 -
int	functionNullable	Indicates that NULL values are allowed. A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns. since: 1.6 -
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. since: 1.6 -
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. since: 1.6 -
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. since: 1.6 -
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. since: 1.6 -

Method from java.sql.DatabaseMetaData Summary:

allProceduresAreCallable,   allTablesAreSelectable,   autoCommitFailureClosesAllResultSets,   dataDefinitionCausesTransactionCommit,   dataDefinitionIgnoredInTransactions,   deletesAreDetected,   doesMaxRowSizeIncludeBlobs,   getAttributes,   getBestRowIdentifier,   getCatalogSeparator,   getCatalogTerm,   getCatalogs,   getClientInfoProperties,   getColumnPrivileges,   getColumns,   getConnection,   getCrossReference,   getDatabaseMajorVersion,   getDatabaseMinorVersion,   getDatabaseProductName,   getDatabaseProductVersion,   getDefaultTransactionIsolation,   getDriverMajorVersion,   getDriverMinorVersion,   getDriverName,   getDriverVersion,   getExportedKeys,   getExtraNameCharacters,   getFunctionColumns,   getFunctions,   getIdentifierQuoteString,   getImportedKeys,   getIndexInfo,   getJDBCMajorVersion,   getJDBCMinorVersion,   getMaxBinaryLiteralLength,   getMaxCatalogNameLength,   getMaxCharLiteralLength,   getMaxColumnNameLength,   getMaxColumnsInGroupBy,   getMaxColumnsInIndex,   getMaxColumnsInOrderBy,   getMaxColumnsInSelect,   getMaxColumnsInTable,   getMaxConnections,   getMaxCursorNameLength,   getMaxIndexLength,   getMaxProcedureNameLength,   getMaxRowSize,   getMaxSchemaNameLength,   getMaxStatementLength,   getMaxStatements,   getMaxTableNameLength,   getMaxTablesInSelect,   getMaxUserNameLength,   getNumericFunctions,   getPrimaryKeys,   getProcedureColumns,   getProcedureTerm,   getProcedures,   getResultSetHoldability,   getRowIdLifetime,   getSQLKeywords,   getSQLStateType,   getSchemaTerm,   getSchemas,   getSchemas,   getSearchStringEscape,   getStringFunctions,   getSuperTables,   getSuperTypes,   getSystemFunctions,   getTablePrivileges,   getTableTypes,   getTables,   getTimeDateFunctions,   getTypeInfo,   getUDTs,   getURL,   getUserName,   getVersionColumns,   insertsAreDetected,   isCatalogAtStart,   isReadOnly,   locatorsUpdateCopy,   nullPlusNonNullIsNull,   nullsAreSortedAtEnd,   nullsAreSortedAtStart,   nullsAreSortedHigh,   nullsAreSortedLow,   othersDeletesAreVisible,   othersInsertsAreVisible,   othersUpdatesAreVisible,   ownDeletesAreVisible,   ownInsertsAreVisible,   ownUpdatesAreVisible,   storesLowerCaseIdentifiers,   storesLowerCaseQuotedIdentifiers,   storesMixedCaseIdentifiers,   storesMixedCaseQuotedIdentifiers,   storesUpperCaseIdentifiers,   storesUpperCaseQuotedIdentifiers,   supportsANSI92EntryLevelSQL,   supportsANSI92FullSQL,   supportsANSI92IntermediateSQL,   supportsAlterTableWithAddColumn,   supportsAlterTableWithDropColumn,   supportsBatchUpdates,   supportsCatalogsInDataManipulation,   supportsCatalogsInIndexDefinitions,   supportsCatalogsInPrivilegeDefinitions,   supportsCatalogsInProcedureCalls,   supportsCatalogsInTableDefinitions,   supportsColumnAliasing,   supportsConvert,   supportsConvert,   supportsCoreSQLGrammar,   supportsCorrelatedSubqueries,   supportsDataDefinitionAndDataManipulationTransactions,   supportsDataManipulationTransactionsOnly,   supportsDifferentTableCorrelationNames,   supportsExpressionsInOrderBy,   supportsExtendedSQLGrammar,   supportsFullOuterJoins,   supportsGetGeneratedKeys,   supportsGroupBy,   supportsGroupByBeyondSelect,   supportsGroupByUnrelated,   supportsIntegrityEnhancementFacility,   supportsLikeEscapeClause,   supportsLimitedOuterJoins,   supportsMinimumSQLGrammar,   supportsMixedCaseIdentifiers,   supportsMixedCaseQuotedIdentifiers,   supportsMultipleOpenResults,   supportsMultipleResultSets,   supportsMultipleTransactions,   supportsNamedParameters,   supportsNonNullableColumns,   supportsOpenCursorsAcrossCommit,   supportsOpenCursorsAcrossRollback,   supportsOpenStatementsAcrossCommit,   supportsOpenStatementsAcrossRollback,   supportsOrderByUnrelated,   supportsOuterJoins,   supportsPositionedDelete,   supportsPositionedUpdate,   supportsResultSetConcurrency,   supportsResultSetHoldability,   supportsResultSetType,   supportsSavepoints,   supportsSchemasInDataManipulation,   supportsSchemasInIndexDefinitions,   supportsSchemasInPrivilegeDefinitions,   supportsSchemasInProcedureCalls,   supportsSchemasInTableDefinitions,   supportsSelectForUpdate,   supportsStatementPooling,   supportsStoredFunctionsUsingCallSyntax,   supportsStoredProcedures,   supportsSubqueriesInComparisons,   supportsSubqueriesInExists,   supportsSubqueriesInIns,   supportsSubqueriesInQuantifieds,   supportsTableCorrelationNames,   supportsTransactionIsolationLevel,   supportsTransactions,   supportsUnion,   supportsUnionAll,   updatesAreDetected,   usesLocalFilePerTable,   usesLocalFiles

Method from java.sql.DatabaseMetaData Detail:
public boolean allProceduresAreCallable() throws SQLException Retrieves whether the current user can call all the procedures returned by the method getProcedures.
public boolean allTablesAreSelectable() throws SQLException Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.
public boolean autoCommitFailureClosesAllResultSets() throws SQLException 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.
public boolean dataDefinitionCausesTransactionCommit() throws SQLException Retrieves whether a data definition statement within a transaction forces the transaction to commit.
public boolean dataDefinitionIgnoredInTransactions() throws SQLException Retrieves whether this database ignores a data definition statement within a transaction.
public boolean deletesAreDetected(int type) throws SQLException Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted. If the method deletesAreDetected returns false, it means that deleted rows are removed from the result set.
public boolean doesMaxRowSizeIncludeBlobs() throws SQLException Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.
public ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog. Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by TYPE_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: TYPE_CAT String => type catalog (may be null) TYPE_SCHEM String => type schema (may be null) TYPE_NAME String => type name ATTR_NAME String => attribute name DATA_TYPE int => attribute type SQL type from java.sql.Types ATTR_TYPE_NAME String => Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type. ATTR_SIZE int => column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. NUM_PREC_RADIX int => Radix (typically either 10 or 2) NULLABLE int => whether NULL is allowed attributeNoNulls - might not allow NULL values attributeNullable - definitely allows NULL values attributeNullableUnknown - nullability unknown REMARKS String => comment describing column (may be null) ATTR_DEF String => default value (may be null) SQL_DATA_TYPE int => unused SQL_DATETIME_SUB int => unused CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column ORDINAL_POSITION int => index of the attribute in the UDT (starting at 1) 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 SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) SCOPE_TABLE String => table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF) SOURCE_DATA_TYPE short => source type of a distinct type or user-generated Ref type,SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF)
public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE. Each column description has the following columns: SCOPE short => actual scope of result bestRowTemporary - very temporary, while using row bestRowTransaction - valid for remainder of current transaction bestRowSession - valid for remainder of current session COLUMN_NAME String => column name DATA_TYPE int => SQL data type from java.sql.Types TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified COLUMN_SIZE int => precision BUFFER_LENGTH int => not used DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. 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.
public String getCatalogSeparator() throws SQLException Retrieves the String that this database uses as the separator between a catalog and table name.
public String getCatalogTerm() throws SQLException Retrieves the database vendor's preferred term for "catalog".
public ResultSet getCatalogs() throws SQLException Retrieves the catalog names available in this database. The results are ordered by catalog name. The catalog column is: TABLE_CAT String => catalog name
public ResultSet getClientInfoProperties() throws SQLException Retrieves a list of the client info properties that the driver supports. The result set contains the following columns NAME String=> The name of the client info property MAX_LEN int=> The maximum length of the value for the property DEFAULT_VALUE String=> The default value of the property DESCRIPTION String=> A description of the property. This will typically contain information as to where this property is stored in the database. The ResultSet is sorted by the NAME column
public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException Retrieves a description of the access rights for a table's columns. Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE. Each privilige description has the following columns: TABLE_CAT String => table catalog (may be null) TABLE_SCHEM String => table schema (may be null) TABLE_NAME String => table name COLUMN_NAME String => column name GRANTOR String => grantor of access (may be null) GRANTEE String => grantee of access PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...) IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Retrieves a description of table columns available in the specified catalog. Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_CAT,TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION. Each column description has the following columns: TABLE_CAT String => table catalog (may be null) TABLE_SCHEM String => table schema (may be null) TABLE_NAME String => table name COLUMN_NAME String => column name DATA_TYPE int => SQL type from java.sql.Types TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified COLUMN_SIZE int => column size. BUFFER_LENGTH is not used. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. NUM_PREC_RADIX int => Radix (typically either 10 or 2) NULLABLE int => is NULL allowed. columnNoNulls - might not allow NULL values columnNullable - definitely allows NULL values columnNullableUnknown - nullability unknown REMARKS String => comment describing column (may be null) COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null) SQL_DATA_TYPE int => unused SQL_DATETIME_SUB int => unused CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column ORDINAL_POSITION int => index of column in table (starting at 1) IS_NULLABLE String => ISO rules are used to determine the nullability for a column. YES --- if the parameter can include NULLs NO --- if the parameter cannot include NULLs empty string --- if the nullability for the parameter is unknown SCOPE_CATLOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF) SCOPE_TABLE String => table name that this the scope of a reference attribure (null if the DATA_TYPE isn't REF) SOURCE_DATA_TYPE short => source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF) 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 parameter is unknown The COLUMN_SIZE column 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.
public Connection getConnection() throws SQLException Retrieves the connection that produced this metadata object.
public ResultSet getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key 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: PKTABLE_CAT String => parent key table catalog (may be null) PKTABLE_SCHEM String => parent key table schema (may be null) PKTABLE_NAME String => parent key table name PKCOLUMN_NAME String => parent key column name FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null) FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null) FKTABLE_NAME String => foreign key table name being exported FKCOLUMN_NAME String => foreign key column name being exported KEY_SEQ short => sequence number within foreign key( 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). 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) 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 FK_NAME String => foreign key name (may be null) PK_NAME String => parent key name (may be null) DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit importedKeyInitiallyDeferred - see SQL92 for definition importedKeyInitiallyImmediate - see SQL92 for definition importedKeyNotDeferrable - see SQL92 for definition
public int getDatabaseMajorVersion() throws SQLException Retrieves the major version number of the underlying database.
public int getDatabaseMinorVersion() throws SQLException Retrieves the minor version number of the underlying database.
public String getDatabaseProductName() throws SQLException Retrieves the name of this database product.
public String getDatabaseProductVersion() throws SQLException Retrieves the version number of this database product.
public int getDefaultTransactionIsolation() throws SQLException Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection.
public int getDriverMajorVersion() Retrieves this JDBC driver's major version number.
public int getDriverMinorVersion() Retrieves this JDBC driver's minor version number.
public String getDriverName() throws SQLException Retrieves the name of this JDBC driver.
public String getDriverVersion() throws SQLException Retrieves the version number of this JDBC driver as a String.
public ResultSet getExportedKeys(String catalog, String schema, String table) throws SQLException Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. Each foreign key column description has the following columns: PKTABLE_CAT String => primary key table catalog (may be null) PKTABLE_SCHEM String => primary key table schema (may be null) PKTABLE_NAME String => primary key table name PKCOLUMN_NAME String => primary key column name FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null) FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null) FKTABLE_NAME String => foreign key table name being exported FKCOLUMN_NAME String => foreign key column name being exported KEY_SEQ short => sequence number within foreign key( 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). UPDATE_RULE short => What happens to foreign key when primary is updated: importedNoAction - do not allow update of primary key if it has been imported importedKeyCascade - change imported key to agree with primary key update importedKeySetNull - change imported key to NULL if its primary key has been updated importedKeySetDefault - change imported key to default values if its primary key has been updated importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility) DELETE_RULE short => What happens to the foreign key when primary is deleted. importedKeyNoAction - do not allow delete of primary key if it has been imported importedKeyCascade - delete rows that import a deleted key importedKeySetNull - change imported key to NULL if its primary key has been deleted importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility) importedKeySetDefault - change imported key to default if its primary key has been deleted FK_NAME String => foreign key name (may be null) PK_NAME String => primary key name (may be null) DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit importedKeyInitiallyDeferred - see SQL92 for definition importedKeyInitiallyImmediate - see SQL92 for definition importedKeyNotDeferrable - see SQL92 for definition
public String getExtraNameCharacters() throws SQLException Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
public ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException 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: FUNCTION_CAT String => function catalog (may be null) FUNCTION_SCHEM String => function schema (may be null) FUNCTION_NAME String => function name. This is the name used to invoke the function COLUMN_NAME String => column/parameter name 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 DATA_TYPE int => SQL type from java.sql.Types TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified PRECISION int => precision LENGTH int => length in bytes of data SCALE short => scale - null is returned for data types where SCALE is not applicable. RADIX short => radix NULLABLE short => can it contain NULL. functionNoNulls - does not allow NULL values functionNullable - allows NULL values functionNullableUnknown - nullability unknown REMARKS String => comment describing column/parameter 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 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. 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 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.
public ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException 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: FUNCTION_CAT String => function catalog (may be null) FUNCTION_SCHEM String => function schema (may be null) FUNCTION_NAME String => function name. This is the name used to invoke the function REMARKS String => explanatory comment on the function 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 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
public String getIdentifierQuoteString() throws SQLException Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.
public ResultSet getImportedKeys(String catalog, String schema, String table) throws SQLException 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: PKTABLE_CAT String => primary key table catalog being imported (may be null) PKTABLE_SCHEM String => primary key table schema being imported (may be null) PKTABLE_NAME String => primary key table name being imported PKCOLUMN_NAME String => primary key column name being imported FKTABLE_CAT String => foreign key table catalog (may be null) FKTABLE_SCHEM String => foreign key table schema (may be null) FKTABLE_NAME String => foreign key table name FKCOLUMN_NAME String => foreign key column name KEY_SEQ short => sequence number within a foreign key( 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). UPDATE_RULE short => What happens to a foreign key when the primary key is updated: importedNoAction - do not allow update of primary key if it has been imported importedKeyCascade - change imported key to agree with primary key update importedKeySetNull - change imported key to NULL if its primary key has been updated importedKeySetDefault - change imported key to default values if its primary key has been updated importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility) DELETE_RULE short => What happens to the foreign key when primary is deleted. importedKeyNoAction - do not allow delete of primary key if it has been imported importedKeyCascade - delete rows that import a deleted key importedKeySetNull - change imported key to NULL if its primary key has been deleted importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility) importedKeySetDefault - change imported key to default if its primary key has been deleted FK_NAME String => foreign key name (may be null) PK_NAME String => primary key name (may be null) DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit importedKeyInitiallyDeferred - see SQL92 for definition importedKeyInitiallyImmediate - see SQL92 for definition importedKeyNotDeferrable - see SQL92 for definition
public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION. Each index column description has the following columns: TABLE_CAT String => table catalog (may be null) TABLE_SCHEM String => table schema (may be null) TABLE_NAME String => table name NON_UNIQUE boolean => Can index values be non-unique. false when TYPE is tableIndexStatistic INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic INDEX_NAME String => index name; null when TYPE is tableIndexStatistic TYPE short => index type: tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions tableIndexClustered - this is a clustered index tableIndexHashed - this is a hashed index tableIndexOther - this is some other style of index ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index. PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index. FILTER_CONDITION String => Filter condition, if any. (may be null)
public int getJDBCMajorVersion() throws SQLException Retrieves the major JDBC version number for this driver.
public int getJDBCMinorVersion() throws SQLException Retrieves the minor JDBC version number for this driver.
public int getMaxBinaryLiteralLength() throws SQLException Retrieves the maximum number of hex characters this database allows in an inline binary literal.
public int getMaxCatalogNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a catalog name.
public int getMaxCharLiteralLength() throws SQLException Retrieves the maximum number of characters this database allows for a character literal.
public int getMaxColumnNameLength() throws SQLException Retrieves the maximum number of characters this database allows for a column name.
public int getMaxColumnsInGroupBy() throws SQLException Retrieves the maximum number of columns this database allows in a GROUP BY clause.
public int getMaxColumnsInIndex() throws SQLException Retrieves the maximum number of columns this database allows in an index.
public int getMaxColumnsInOrderBy() throws SQLException Retrieves the maximum number of columns this database allows in an ORDER BY clause.
public int getMaxColumnsInSelect() throws SQLException Retrieves the maximum number of columns this database allows in a SELECT list.
public int getMaxColumnsInTable() throws SQLException Retrieves the maximum number of columns this database allows in a table.
public int getMaxConnections() throws SQLException Retrieves the maximum number of concurrent connections to this database that are possible.
public int getMaxCursorNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a cursor name.
public int getMaxIndexLength() throws SQLException Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.
public int getMaxProcedureNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a procedure name.
public int getMaxRowSize() throws SQLException Retrieves the maximum number of bytes this database allows in a single row.
public int getMaxSchemaNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a schema name.
public int getMaxStatementLength() throws SQLException Retrieves the maximum number of characters this database allows in an SQL statement.
public int getMaxStatements() throws SQLException Retrieves the maximum number of active statements to this database that can be open at the same time.
public int getMaxTableNameLength() throws SQLException Retrieves the maximum number of characters this database allows in a table name.
public int getMaxTablesInSelect() throws SQLException Retrieves the maximum number of tables this database allows in a SELECT statement.
public int getMaxUserNameLength() throws SQLException Retrieves the maximum number of characters this database allows in a user name.
public String getNumericFunctions() throws SQLException Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.
public ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME. Each primary key column description has the following columns: TABLE_CAT String => table catalog (may be null) TABLE_SCHEM String => table schema (may be null) TABLE_NAME String => table name COLUMN_NAME String => column name KEY_SEQ short => sequence number within primary key( 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). PK_NAME String => primary key name (may be null)
public ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException Retrieves a description of the given catalog's stored procedure parameter and result columns. Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_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: PROCEDURE_CAT String => procedure catalog (may be null) PROCEDURE_SCHEM String => procedure schema (may be null) PROCEDURE_NAME String => procedure name COLUMN_NAME String => column/parameter name COLUMN_TYPE Short => kind of column/parameter: procedureColumnUnknown - nobody knows procedureColumnIn - IN parameter procedureColumnInOut - INOUT parameter procedureColumnOut - OUT parameter procedureColumnReturn - procedure return value procedureColumnResult - result column in ResultSet DATA_TYPE int => SQL type from java.sql.Types TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified PRECISION int => precision LENGTH int => length in bytes of data SCALE short => scale - null is returned for data types where SCALE is not applicable. RADIX short => radix NULLABLE short => can it contain NULL. procedureNoNulls - does not allow NULL values procedureNullable - allows NULL values procedureNullableUnknown - nullability unknown REMARKS String => comment describing parameter/column 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 SQL_DATA_TYPE int => reserved for future use SQL_DATETIME_SUB int => reserved for future use CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL 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. IS_NULLABLE String => ISO rules are used to determine the nullability for a column. YES --- if the parameter can include NULLs NO --- if the parameter cannot include NULLs empty string --- if the nullability for the parameter is unknown 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.
public String getProcedureTerm() throws SQLException Retrieves the database vendor's preferred term for "procedure".
public ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException Retrieves a description of the stored procedures available in the given catalog. Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_ NAME. Each procedure description has the the following columns: PROCEDURE_CAT String => procedure catalog (may be null) PROCEDURE_SCHEM String => procedure schema (may be null) PROCEDURE_NAME String => procedure name reserved for future use reserved for future use reserved for future use REMARKS String => explanatory comment on the procedure PROCEDURE_TYPE short => kind of procedure: procedureResultUnknown - Cannot determine if a return value will be returned procedureNoResult - Does not return a return value procedureReturnsResult - Returns a return value 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
public int getResultSetHoldability() throws SQLException Retrieves this database's default holdability for ResultSet objects.
public RowIdLifetime getRowIdLifetime() throws SQLException 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.
public String getSQLKeywords() throws SQLException Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.
public int getSQLStateType() throws SQLException Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.
public String getSchemaTerm() throws SQLException Retrieves the database vendor's preferred term for "schema".
public ResultSet getSchemas() throws SQLException Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM. The schema columns are: TABLE_SCHEM String => schema name TABLE_CATALOG String => catalog name (may be null)
public ResultSet getSchemas(String catalog, String schemaPattern) throws SQLException Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM. The schema columns are: TABLE_SCHEM String => schema name TABLE_CATALOG String => catalog name (may be null)
public String getSearchStringEscape() throws SQLException Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters). The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.
public String getStringFunctions() throws SQLException Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.
public ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLException Retrieves a description of the table hierarchies defined in a particular schema in this database. Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable. Each type description has the following columns: TABLE_CAT String => the type's catalog (may be null) TABLE_SCHEM String => type's schema (may be null) TABLE_NAME String => type name SUPERTABLE_NAME String => the direct super type's name Note: If the driver does not support type hierarchies, an empty result set is returned.
public ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled. Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored. If a UDT does not have a direct super type, it is not listed here. A row of the ResultSet object returned by this method describes the designated UDT and a direct supertype. A row has the following columns: TYPE_CAT String => the UDT's catalog (may be null) TYPE_SCHEM String => UDT's schema (may be null) TYPE_NAME String => type name of the UDT SUPERTYPE_CAT String => the direct super type's catalog (may be null) SUPERTYPE_SCHEM String => the direct super type's schema (may be null) SUPERTYPE_NAME String => the direct super type's name Note: If the driver does not support type hierarchies, an empty result set is returned.
public String getSystemFunctions() throws SQLException Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.
public ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.) Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME, and PRIVILEGE. Each privilige description has the following columns: TABLE_CAT String => table catalog (may be null) TABLE_SCHEM String => table schema (may be null) TABLE_NAME String => table name GRANTOR String => grantor of access (may be null) GRANTEE String => grantee of access PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...) IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
public ResultSet getTableTypes() throws SQLException Retrieves the table types available in this database. The results are ordered by table type. The table type is: TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_CAT, TABLE_SCHEM and TABLE_NAME. Each table description has the following columns: TABLE_CAT String => table catalog (may be null) TABLE_SCHEM String => table schema (may be null) TABLE_NAME String => table name TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". REMARKS String => explanatory comment on the table TYPE_CAT String => the types catalog (may be null) TYPE_SCHEM String => the types schema (may be null) TYPE_NAME String => type name (may be null) SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null) REF_GENERATION String => specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be null) Note: Some databases may not return information for all tables.
public String getTimeDateFunctions() throws SQLException Retrieves a comma-separated list of the time and date functions available with this database.
public ResultSet getTypeInfo() throws SQLException 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: TYPE_NAME String => Type name DATA_TYPE int => SQL data type from java.sql.Types PRECISION int => maximum precision LITERAL_PREFIX String => prefix used to quote a literal (may be null) LITERAL_SUFFIX String => suffix used to quote a literal (may be null) CREATE_PARAMS String => parameters used in creating the type (may be null) NULLABLE short => can you use NULL for this type. typeNoNulls - does not allow NULL values typeNullable - allows NULL values typeNullableUnknown - nullability unknown CASE_SENSITIVE boolean=> is it case sensitive. SEARCHABLE short => can you use "WHERE" based on this type: typePredNone - No support typePredChar - Only supported with WHERE .. LIKE typePredBasic - Supported except for WHERE .. LIKE typeSearchable - Supported for all WHERE .. UNSIGNED_ATTRIBUTE boolean => is it unsigned. FIXED_PREC_SCALE boolean => can it be a money value. AUTO_INCREMENT boolean => can it be used for an auto-increment value. LOCAL_TYPE_NAME String => localized version of type name (may be null) MINIMUM_SCALE short => minimum scale supported MAXIMUM_SCALE short => maximum scale supported SQL_DATA_TYPE int => unused SQL_DATETIME_SUB int => unused NUM_PREC_RADIX int => usually 2 or 10 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.
public ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT. Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_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: TYPE_CAT String => the type's catalog (may be null) TYPE_SCHEM String => type's schema (may be null) TYPE_NAME String => type name CLASS_NAME String => Java class name DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT REMARKS String => explanatory comment on the type BASE_TYPE short => type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in java.sql.Types (null if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED) Note: If the driver does not support UDTs, an empty result set is returned.
public String getURL() throws SQLException Retrieves the URL for this DBMS.
public String getUserName() throws SQLException Retrieves the user name as known to this database.
public ResultSet getVersionColumns(String catalog, String schema, String table) throws SQLException Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered. Each column description has the following columns: SCOPE short => is not used COLUMN_NAME String => column name DATA_TYPE int => SQL data type from java.sql.Types TYPE_NAME String => Data source-dependent type name COLUMN_SIZE int => precision BUFFER_LENGTH int => length of column value in bytes DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. 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.
public boolean insertsAreDetected(int type) throws SQLException Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.
public boolean isCatalogAtStart() throws SQLException Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.
public boolean isReadOnly() throws SQLException Retrieves whether this database is in read-only mode.
public boolean locatorsUpdateCopy() throws SQLException Indicates whether updates made to a LOB are made on a copy or directly to the LOB.
public boolean nullPlusNonNullIsNull() throws SQLException Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.
public boolean nullsAreSortedAtEnd() throws SQLException Retrieves whether NULL values are sorted at the end regardless of sort order.
public boolean nullsAreSortedAtStart() throws SQLException Retrieves whether NULL values are sorted at the start regardless of sort order.
public boolean nullsAreSortedHigh() throws SQLException Retrieves whether NULL values are sorted high. Sorted high means that NULL values sort higher than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the end. By contrast, the method nullsAreSortedAtEnd indicates whether NULL values are sorted at the end regardless of sort order.
public boolean nullsAreSortedLow() throws SQLException Retrieves whether NULL values are sorted low. Sorted low means that NULL values sort lower than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the beginning. By contrast, the method nullsAreSortedAtStart indicates whether NULL values are sorted at the beginning regardless of sort order.
public boolean othersDeletesAreVisible(int type) throws SQLException Retrieves whether deletes made by others are visible.
public boolean othersInsertsAreVisible(int type) throws SQLException Retrieves whether inserts made by others are visible.
public boolean othersUpdatesAreVisible(int type) throws SQLException Retrieves whether updates made by others are visible.
public boolean ownDeletesAreVisible(int type) throws SQLException Retrieves whether a result set's own deletes are visible.
public boolean ownInsertsAreVisible(int type) throws SQLException Retrieves whether a result set's own inserts are visible.
public boolean ownUpdatesAreVisible(int type) throws SQLException Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.
public boolean storesLowerCaseIdentifiers() throws SQLException Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.
public boolean storesLowerCaseQuotedIdentifiers() throws SQLException Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.
public boolean storesMixedCaseIdentifiers() throws SQLException Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.
public boolean storesMixedCaseQuotedIdentifiers() throws SQLException Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.
public boolean storesUpperCaseIdentifiers() throws SQLException Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.
public boolean storesUpperCaseQuotedIdentifiers() throws SQLException Retrieves whether this d