Interface DatabaseMetaData
- All Superinterfaces:
Wrapper
- All Known Implementing Classes:
JDBCDatabaseMetaData
public interface DatabaseMetaData extends Wrapper
This interface is implemented by JDBC driver vendors in order to provide information about the underlying database capabilities in association with the JDBC driver.
Some of the methods in this interface take string parameters which are
patterns. Within these string patterns, '%' and '_'
characters have special meanings. '%' means
"match any substring of 0 or more characters". '_' means
"match any character". Only metadata entries that match the pattern are
returned. If such a search pattern string is set to null, that
argument's criteria are dropped from the search.
-
Field Summary
Fields Modifier and Type Field Description static shortattributeNoNullsStates that it may not be permitted to storeNULLvalues.static shortattributeNullableStates thatNULLvalues are definitely permitted.static shortattributeNullableUnknownStates that whetherNULLvalues are permitted is unknown.static intbestRowNotPseudoStates the best row identifier is NOT a pseudo column.static intbestRowPseudoStates that the best row identifier is a pseudo column.static intbestRowSessionStates that the remainder of the current session is used as the scope for the best row identifier.static intbestRowTemporaryStates that best row identifier scope lasts only while the row is being used.static intbestRowTransactionStates that the remainder of the current transaction is used as the scope for the best row identifier.static intbestRowUnknownStates that the best row identifier may or may not be a pseudo column.static intcolumnNoNullsStates that the column must not allowNULLvalues.static intcolumnNullableStates that the column definitely allowsNULLvalues.static intcolumnNullableUnknownStates that it is unknown whether the columns may be nulled.static intfunctionColumnInStates that the parameter or column is an IN parameterstatic intfunctionColumnInOutStates that the parameter or column is an INOUT parameterstatic intfunctionColumnOutStates that the parameter or column is an OUT parameterstatic intfunctionColumnResultStates that the parameter or column is a column in a result setstatic intfunctionColumnUnknownStates that the parameter of function is unknownstatic intfunctionNoNullsStates that NULL values are not allowedstatic intfunctionNoTableStates that the function does not return a tablestatic intfunctionNullableStates that NULL values are allowedstatic intfunctionNullableUnknownStates that whether NULL values are allowed is unknownstatic intfunctionResultUnknownStates that it is not known whether the function returns a result or a tablestatic intfunctionReturnStates that the parameter or column is a return valuestatic intfunctionReturnsTableStates that the function returns a table.static intimportedKeyCascadeFor the columnUPDATE_RULE, states that when the primary key is updated, the foreign key (imported key) is changed accordingly.static intimportedKeyInitiallyDeferredStates that the evaluation of foreign key constraints is deferred (delayed until commit).static intimportedKeyInitiallyImmediateStates that the evaluation of foreign key constraint isIMMEDIATE.static intimportedKeyNoActionFor the columnsUPDATE_RULEandDELETE_RULE, states that if the primary key has been imported, it cannot be updated or deleted.static intimportedKeyNotDeferrableStates that the evaluation of foreign key constraint must not beDEFERRED.static intimportedKeyRestrictStates that a primary key must not be updated when imported as a foreign key by some other table.static intimportedKeySetDefaultStates that when the primary key is modified (updated or deleted) the foreign (imported) key is changed to its default value.static intimportedKeySetNullStates that when the primary key is modified (updated or deleted) the foreign (imported) key is changed toNULL.static intprocedureColumnInStates that the column storesINtype parameters.static intprocedureColumnInOutStates that this column storesINOUTtype parameters.static intprocedureColumnOutStates that this column storesOUTtype parameters.static intprocedureColumnResultStates that the column stores results.static intprocedureColumnReturnStates that the column stores return values.static intprocedureColumnUnknownStates that type of the column is unknown.static intprocedureNoNullsStates thatNULLvalues are not permitted.static intprocedureNoResultStates that the procedure does not return a result.static intprocedureNullableStates thatNULLvalues are permitted.static intprocedureNullableUnknownStates that it is unknown whetherNULLvalues are permitted.static intprocedureResultUnknownStates that it is unknown whether or not the procedure returns a result.static intprocedureReturnsResultStates that the procedure returns a result.static intsqlStateSQLStates that the method DatabaseMetaData.getSQLStateType may returns an SQLSTATE value or not.static intsqlStateSQL99States that the value is an SQL99SQLSTATEvalue.static intsqlStateXOpenStates that the value is an SQLCLI SQLSTATEvalue as defined by the X/Open standard.static shorttableIndexClusteredStates that this table index is a clustered index.static shorttableIndexHashedStates that this table index is a hashed index.static shorttableIndexOtherStates this table's index is neither a clustered index, not a hashed index, and not a table statistics index; i.e.static shorttableIndexStatisticStates this column has the table's statistics, and that it is returned in conjunction with the table's index description.static inttypeNoNullsStates that aNULLvalue is NOT permitted for this data type.static inttypeNullableStates that aNULLvalue is permitted for this data type.static inttypeNullableUnknownStates that it is unknown if aNULLvalue is permitted for this data type.static inttypePredBasicStates that this column shall not be used forWHEREstatements with aLIKEclause.static inttypePredCharStates that this column can only be used in aWHERE...LIKEstatement.static inttypePredNoneStates that this column does not support searches.static inttypeSearchableStates that the column is searchable.static intversionColumnNotPseudoStates that the version column is known to be not a pseudo column.static intversionColumnPseudoStates that this version column is known to be a pseudo column.static intversionColumnUnknownStates that the version column may be a pseudo column or not. -
Method Summary
Modifier and Type Method Description booleanallProceduresAreCallable()Returns whether all procedures returned bygetProcedures(java.lang.String, java.lang.String, java.lang.String)can be called by the current user.booleanallTablesAreSelectable()Returns whether all the tables returned bygetTablescan be used by the current user in aSELECTstatement.booleanautoCommitFailureClosesAllResultSets()Determine if a SQLException while autoCommit is true indicates that all open ResultSets are closed, even ones that are holdablebooleandataDefinitionCausesTransactionCommit()Returns whether a data definition statement in a transaction forces acommitof the transaction.booleandataDefinitionIgnoredInTransactions()Returns whether the database ignores data definition statements within a transaction.booleandeletesAreDetected(int type)Returns whether a visible row delete can be detected by callingResultSet.rowDeleted().booleandoesMaxRowSizeIncludeBlobs()Returns whether the return value ofgetMaxRowSizeincludes the SQL data typesLONGVARCHARandLONGVARBINARY.ResultSetgetAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)Returns aResultSetdescribing a subset of the attributes of a specified SQL User Defined Type (UDT) for a specified schema and catalog.ResultSetgetBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)Returns a list of a table's optimal set of columns that uniquely identify the rows.ResultSetgetCatalogs()Returns the set of catalog names available in this database.StringgetCatalogSeparator()Returns the separator that this database uses between a catalog name and table name.StringgetCatalogTerm()Returns the term that the database vendor prefers term for "catalog".ResultSetgetClientInfoProperties()Returns a list of the client info properties of the driver.ResultSetgetColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)Returns a description of access rights for a table's columns.ResultSetgetColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)Returns a description of table columns available in a specified catalog.ConnectiongetConnection()Returns the database connection that created this metadata.ResultSetgetCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)Returns a list of foreign key columns in a given foreign key table that reference the primary key columns of a supplied primary key table.intgetDatabaseMajorVersion()Returns the major version number of the database software.intgetDatabaseMinorVersion()Returns the minor version number of the database software.StringgetDatabaseProductName()Returns the name of the database software.StringgetDatabaseProductVersion()Returns the version number of this database software.intgetDefaultTransactionIsolation()Returns the default transaction isolation level for this database.intgetDriverMajorVersion()Returns the JDBC driver's major version number.intgetDriverMinorVersion()Returns the JDBC driver's minor version number.StringgetDriverName()Returns the name of this JDBC driver.StringgetDriverVersion()Returns the version number of this JDBC driver.ResultSetgetExportedKeys(String catalog, String schema, String table)Returns a list of the foreign key columns that reference the primary key columns of a specified table (the foreign keys exported by a table).StringgetExtraNameCharacters()Returns a string of characters that may be used in unquoted identifier names.ResultSetgetFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern)Returns a description according to the given catalog's system or user function parameters and return type.ResultSetgetFunctions(String catalog, String schemaPattern, String functionNamePattern)Returns a description of the system and user functions available according to the given catalog.StringgetIdentifierQuoteString()Returns the string used to quote SQL identifiers.ResultSetgetImportedKeys(String catalog, String schema, String table)Returns a list columns in a table that are both primary keys and referenced by the table's foreign key columns (that is, the primary keys imported by a table).ResultSetgetIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)Returns a list of indices and statistics for a specified table.intgetJDBCMajorVersion()Returns this driver's major JDBC version number.intgetJDBCMinorVersion()Returns the minor JDBC version number for this driver.intgetMaxBinaryLiteralLength()Get the maximum number of hex characters in an in-line binary literal for this database.intgetMaxCatalogNameLength()Returns the maximum size of a catalog name in this database.intgetMaxCharLiteralLength()Returns the maximum size for a character literal in this database.intgetMaxColumnNameLength()Returns the maximum size for a Column name for this database.intgetMaxColumnsInGroupBy()Get the maximum number of columns in aGROUP BYclause for this database.intgetMaxColumnsInIndex()Returns the maximum number of columns in an Index for this database.intgetMaxColumnsInOrderBy()Returns the maximum number of columns in anORDER BYclause for this database.intgetMaxColumnsInSelect()Returns the maximum number of columns in aSELECTlist for this database.intgetMaxColumnsInTable()Returns the maximum number of columns in a table for this database.intgetMaxConnections()Returns the database's maximum number of concurrent connections.intgetMaxCursorNameLength()Returns the maximum length of a cursor name for this database.intgetMaxIndexLength()Returns the maximum length in bytes for an Index for this database.intgetMaxProcedureNameLength()Returns the maximum number of characters for a procedure name in this database.intgetMaxRowSize()Returns the maximum number of bytes within a single row for this database.intgetMaxSchemaNameLength()Returns the maximum number of characters in a schema name for this database.intgetMaxStatementLength()Returns the maximum number of characters in an SQL statement for this database.intgetMaxStatements()Get the maximum number of simultaneously open active statements for this database.intgetMaxTableNameLength()Returns the maximum size for a table name in the database.intgetMaxTablesInSelect()Returns the maximum number of tables permitted in aSELECTstatement for the database.intgetMaxUserNameLength()Returns the maximum number of characters in a user name for the database.StringgetNumericFunctions()Returns a list of the math functions available with this database.ResultSetgetPrimaryKeys(String catalog, String schema, String table)Returns a list of the primary key columns of a specified table.ResultSetgetProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)Returns a list of parameter and result columns for the stored procedures belonging to a specified catalog.ResultSetgetProcedures(String catalog, String schemaPattern, String procedureNamePattern)Returns a list of the stored procedures available in a specified catalog.StringgetProcedureTerm()Returns the database vendor's preferred name for "procedure".intgetResultSetHoldability()Returns the result set's default holdability.RowIdLifetimegetRowIdLifetime()Returns the lifetime for which a RowId object remains valid if this data source supports the SQL ROWID typeResultSetgetSchemas()Returns a list of the schema names in the database.ResultSetgetSchemas(String catalog, String schemaPattern)Returns the schema names ordered by TABLE_CATALOG and TABLE_SCHEMA.StringgetSchemaTerm()Returns the database vendor's preferred term for "schema".StringgetSearchStringEscape()Returns the string that is used to escape wildcard characters.StringgetSQLKeywords()Returns a list of all the SQL keywords that are NOT also SQL92 keywords for the database.intgetSQLStateType()States the type ofSQLStatevalue returned bySQLException.getSQLState.StringgetStringFunctions()Returns a list of string functions available with the database.ResultSetgetSuperTables(String catalog, String schemaPattern, String tableNamePattern)Returns a listing of the hierarchies of tables in a specified schema in the database.ResultSetgetSuperTypes(String catalog, String schemaPattern, String typeNamePattern)Returns the User Defined Type (UDT) hierarchies for a given schema.StringgetSystemFunctions()Returns a list of system functions available with the database.ResultSetgetTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)Returns a description of access rights for each table present in a catalog.ResultSetgetTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)Returns a description of the tables in a specified catalog.ResultSetgetTableTypes()Returns a list of table types supported by the database.StringgetTimeDateFunctions()Returns a list of time and date functions available for the database.ResultSetgetTypeInfo()Get a list of the standard SQL types supported by this database.ResultSetgetUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)Returns a description of the User Defined Types (UDTs) defined in a given schema, which includes the typesDISTINCT,STRUCTandJAVA_OBJECT.StringgetURL()Returns the URL for this database.StringgetUserName()Determine the user name as known by the database.ResultSetgetVersionColumns(String catalog, String schema, String table)Returns which of a table's columns are automatically updated when any value in a row is updated.booleaninsertsAreDetected(int type)Determines whether a visible row insert can be detected by callingResultSet.rowInserted.booleanisCatalogAtStart()Determine whether a fully qualified table name is prefixed or suffixed to a fully qualified table name.booleanisReadOnly()Determines whether the database is in read-only mode.booleanlocatorsUpdateCopy()Determines whether updates are made to a copy of, or directly on, Large Objects (LOBs).booleannullPlusNonNullIsNull()Determines whether the database handles concatenations betweenNULLand non-NULLvalues by producing aNULLoutput.booleannullsAreSortedAtEnd()Determines whetherNULLvalues are always sorted to the end of sorted results regardless of requested sort order.booleannullsAreSortedAtStart()Determines whetherNULLvalues are always sorted at the start of the sorted list, irrespective of the sort order.booleannullsAreSortedHigh()Determines whetherNULLvalues are sorted high - i.e.booleannullsAreSortedLow()Determines whetherNULLvalues are sorted low - i.e.booleanothersDeletesAreVisible(int type)Determines whether deletes made by others are visible, for a specifiedResultSettype.booleanothersInsertsAreVisible(int type)Determines whether inserts made by others are visible, for a specifiedResultSettype.booleanothersUpdatesAreVisible(int type)Determines whether updates made by others are visible, for a specifiedResultSettype.booleanownDeletesAreVisible(int type)Determines whether aResultSetcan see its own deletes, for a specifiedResultSettype.booleanownInsertsAreVisible(int type)Determines whether aResultSetcan see its own inserts, for a specifiedResultSettype.booleanownUpdatesAreVisible(int type)Determines whether aResultSetcan see its own updates, for a specifiedResultSettype.booleanstoresLowerCaseIdentifiers()Determines whether the database treats SQL identifiers that are in mixed case (and unquoted) as case insensitive.booleanstoresLowerCaseQuotedIdentifiers()Determines whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in lower case.booleanstoresMixedCaseIdentifiers()Determines whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.booleanstoresMixedCaseQuotedIdentifiers()Determines whether the database considers identifiers as case insensitive if they are mixed case quoted SQL.booleanstoresUpperCaseIdentifiers()Determines whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.booleanstoresUpperCaseQuotedIdentifiers()Determines whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in upper case.booleansupportsAlterTableWithAddColumn()Determines whether the database supportsALTER TABLEoperation withADD COLUMN.booleansupportsAlterTableWithDropColumn()Determines whether the database supportsALTER TABLEoperation withDROP COLUMN.booleansupportsANSI92EntryLevelSQL()Determines whether the database supports the ANSI92 entry level SQL grammar.booleansupportsANSI92FullSQL()Determines whether the database supports the ANSI92 full SQL grammar.booleansupportsANSI92IntermediateSQL()Determines whether the database supports the ANSI92 intermediate SQL Grammar.booleansupportsBatchUpdates()Determines whether the database supports batch updates.booleansupportsCatalogsInDataManipulation()Determines whether catalog names may be used in data manipulation statements.booleansupportsCatalogsInIndexDefinitions()Determines whether catalog names can be used in index definition statements.booleansupportsCatalogsInPrivilegeDefinitions()Determines whether catalog names can be used in privilege definition statements.booleansupportsCatalogsInProcedureCalls()Determines whether catalog names can be used in procedure call statements.booleansupportsCatalogsInTableDefinitions()Determines whether catalog names may be used in table definition statements.booleansupportsColumnAliasing()Determines whether the database supports column aliasing.booleansupportsConvert()Determines whether the database supports theCONVERToperation between SQL types.booleansupportsConvert(int fromType, int toType)Determines whether the database supportsCONVERToperation for two supplied SQL types.booleansupportsCoreSQLGrammar()Determines whether the database supports the Core SQL Grammar for ODBC.booleansupportsCorrelatedSubqueries()Determines whether the database supports correlated sub-queries.booleansupportsDataDefinitionAndDataManipulationTransactions()Determines whether the database allows both data definition and data manipulation statements inside a transaction.booleansupportsDataManipulationTransactionsOnly()Determines whether the database only allows data manipulation statements inside a transaction.booleansupportsDifferentTableCorrelationNames()Determines whether table correlation names are required to be different from the names of the tables, when they are supported.booleansupportsExpressionsInOrderBy()Determines whether expressions inORDER BYlists are supported.booleansupportsExtendedSQLGrammar()Determines whether the Extended SQL Grammar for ODBC is supported.booleansupportsFullOuterJoins()Determines whether the database supports full nested outer joins.booleansupportsGetGeneratedKeys()Determines whether auto generated keys can be returned when a statement executes.booleansupportsGroupBy()Determines whether the database supportsGROUP BYclauses.booleansupportsGroupByBeyondSelect()Determines whether the database supports using a column name in aGROUP BYclause not included in theSELECTstatement as long as all of the columns in theSELECTstatement are used in theGROUP BYclause.booleansupportsGroupByUnrelated()Determines whether the database supports using a column name in aGROUP BYclause that is not in theSELECTstatement.booleansupportsIntegrityEnhancementFacility()Determines whether the database supports SQL Integrity Enhancement Facility.booleansupportsLikeEscapeClause()Determines whether the database supports aLIKEescape clause.booleansupportsLimitedOuterJoins()Determines whether the database provides limited support for outer join operations.booleansupportsMinimumSQLGrammar()Determines whether the database supports Minimum SQL Grammar for ODBC.booleansupportsMixedCaseIdentifiers()Determines whether the database treats mixed case unquoted SQL identifiers as case sensitive storing them in mixed case.booleansupportsMixedCaseQuotedIdentifiers()Determines whether the database considers mixed case quoted SQL identifiers as case sensitive, storing them in mixed case.booleansupportsMultipleOpenResults()Determines whether it is possible for a singleCallableStatementto return multipleResultSets simultaneously.booleansupportsMultipleResultSets()Determines whether retrieving multipleResultSets from a single call to theexecutemethod is supported.booleansupportsMultipleTransactions()Determines whether multiple simultaneous transactions on different connections are supported.booleansupportsNamedParameters()Determines whether callable statements with named parameters is supported.booleansupportsNonNullableColumns()Determines whether columns in the database can be defined as non-nullable.booleansupportsOpenCursorsAcrossCommit()Determines whether keeping cursors open across commit operations is supported.booleansupportsOpenCursorsAcrossRollback()Determines whether the database can keep cursors open across rollback operations.booleansupportsOpenStatementsAcrossCommit()Determines whether keeping statements open across commit operations is supported.booleansupportsOpenStatementsAcrossRollback()Determines whether keeping statements open across rollback operations is supported.booleansupportsOrderByUnrelated()Determines whether using a column in anORDER BYclause that is not in theSELECTstatement is supported.booleansupportsOuterJoins()Determines whether outer join operations are supported.booleansupportsPositionedDelete()Determines whether positionedDELETEstatements are supported.booleansupportsPositionedUpdate()Determines whether positionedUPDATEstatements are supported.booleansupportsResultSetConcurrency(int type, int concurrency)Determines whether there is support for a given concurrency style for the givenResultSet.booleansupportsResultSetHoldability(int holdability)Determines whether the suppliedResultSetholdability mode is supported.booleansupportsResultSetType(int type)Determines whether the suppliedResultSettype is supported.booleansupportsSavepoints()Determines whether savepoints for transactions are supported.booleansupportsSchemasInDataManipulation()Determines whether a schema name may be used in a data manipulation statement.booleansupportsSchemasInIndexDefinitions()Determines whether a schema name may be used in an index definition statement.booleansupportsSchemasInPrivilegeDefinitions()Determines whether a database schema name can be used in a privilege definition statement.booleansupportsSchemasInProcedureCalls()Determines whether a procedure call statement may be contain in a schema name.booleansupportsSchemasInTableDefinitions()Determines whether a schema name can be used in a table definition statement.booleansupportsSelectForUpdate()Determines whether theSELECT FOR UPDATEstatement is supported.booleansupportsStatementPooling()Determines whether statement pooling is supported.booleansupportsStoredFunctionsUsingCallSyntax()Determine if this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.booleansupportsStoredProcedures()Determines whether stored procedure calls using the stored procedure escape syntax is supported.booleansupportsSubqueriesInComparisons()Determines whether subqueries in comparison expressions are supported.booleansupportsSubqueriesInExists()Determines whether subqueries inEXISTSexpressions are supported.booleansupportsSubqueriesInIns()Determines whether subqueries inINstatements are supported.booleansupportsSubqueriesInQuantifieds()Determines whether subqueries in quantified expressions are supported.booleansupportsTableCorrelationNames()Determines whether the database has table correlation names support.booleansupportsTransactionIsolationLevel(int level)Determines whether a specified transaction isolation level is supported.booleansupportsTransactions()Determines whether transactions are supported.booleansupportsUnion()Determines whether theSQL UNIONoperation is supported.booleansupportsUnionAll()Determines whether theSQL UNION ALLoperation is supported.booleanupdatesAreDetected(int type)Determines whether the methodResultSet.rowUpdatedcan detect a visible row update for the specifiedResultSettype.booleanusesLocalFilePerTable()Determines whether this database uses a file for each table.booleanusesLocalFiles()Determines whether this database uses a local file to store tables.Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
Field Details
-
attributeNoNulls
static final short attributeNoNullsStates that it may not be permitted to storeNULLvalues.- See Also:
- Constant Field Values
-
attributeNullable
static final short attributeNullableStates thatNULLvalues are definitely permitted.- See Also:
- Constant Field Values
-
attributeNullableUnknown
static final short attributeNullableUnknownStates that whetherNULLvalues are permitted is unknown.- See Also:
- Constant Field Values
-
bestRowNotPseudo
static final int bestRowNotPseudoStates the best row identifier is NOT a pseudo column.- See Also:
- Constant Field Values
-
bestRowPseudo
static final int bestRowPseudoStates that the best row identifier is a pseudo column.- See Also:
- Constant Field Values
-
bestRowSession
static final int bestRowSessionStates that the remainder of the current session is used as the scope for the best row identifier.- See Also:
- Constant Field Values
-
bestRowTemporary
static final int bestRowTemporaryStates that best row identifier scope lasts only while the row is being used.- See Also:
- Constant Field Values
-
bestRowTransaction
static final int bestRowTransactionStates that the remainder of the current transaction is used as the scope for the best row identifier.- See Also:
- Constant Field Values
-
bestRowUnknown
static final int bestRowUnknownStates that the best row identifier may or may not be a pseudo column.- See Also:
- Constant Field Values
-
columnNoNulls
static final int columnNoNullsStates that the column must not allowNULLvalues.- See Also:
- Constant Field Values
-
columnNullable
static final int columnNullableStates that the column definitely allowsNULLvalues.- See Also:
- Constant Field Values
-
columnNullableUnknown
static final int columnNullableUnknownStates that it is unknown whether the columns may be nulled.- See Also:
- Constant Field Values
-
importedKeyCascade
static final int importedKeyCascadeFor the columnUPDATE_RULE, states that when the primary key is updated, the foreign key (imported key) is changed accordingly.- See Also:
- Constant Field Values
-
importedKeyInitiallyDeferred
static final int importedKeyInitiallyDeferredStates that the evaluation of foreign key constraints is deferred (delayed until commit).- See Also:
- Constant Field Values
-
importedKeyInitiallyImmediate
static final int importedKeyInitiallyImmediateStates that the evaluation of foreign key constraint isIMMEDIATE.- See Also:
- Constant Field Values
-
importedKeyNoAction
static final int importedKeyNoActionFor the columnsUPDATE_RULEandDELETE_RULE, states that if the primary key has been imported, it cannot be updated or deleted.- See Also:
- Constant Field Values
-
importedKeyNotDeferrable
static final int importedKeyNotDeferrableStates that the evaluation of foreign key constraint must not beDEFERRED.- See Also:
- Constant Field Values
-
importedKeyRestrict
static final int importedKeyRestrictStates that a primary key must not be updated when imported as a foreign key by some other table. Used for the columnUPDATE_RULE.- See Also:
- Constant Field Values
-
importedKeySetDefault
static final int importedKeySetDefaultStates that when the primary key is modified (updated or deleted) the foreign (imported) key is changed to its default value. Applies to theUPDATE_RULEandDELETE_RULEcolumns.- See Also:
- Constant Field Values
-
importedKeySetNull
static final int importedKeySetNullStates that when the primary key is modified (updated or deleted) the foreign (imported) key is changed toNULL. Applies to theUPDATE_RULEandDELETE_RULEcolumns.- See Also:
- Constant Field Values
-
procedureColumnIn
static final int procedureColumnInStates that the column storesINtype parameters.- See Also:
- Constant Field Values
-
procedureColumnInOut
static final int procedureColumnInOutStates that this column storesINOUTtype parameters.- See Also:
- Constant Field Values
-
procedureColumnOut
static final int procedureColumnOutStates that this column storesOUTtype parameters.- See Also:
- Constant Field Values
-
procedureColumnResult
static final int procedureColumnResultStates that the column stores results.- See Also:
- Constant Field Values
-
procedureColumnReturn
static final int procedureColumnReturnStates that the column stores return values.- See Also:
- Constant Field Values
-
procedureColumnUnknown
static final int procedureColumnUnknownStates that type of the column is unknown.- See Also:
- Constant Field Values
-
procedureNoNulls
static final int procedureNoNullsStates thatNULLvalues are not permitted.- See Also:
- Constant Field Values
-
procedureNoResult
static final int procedureNoResultStates that the procedure does not return a result.- See Also:
- Constant Field Values
-
procedureNullable
static final int procedureNullableStates thatNULLvalues are permitted.- See Also:
- Constant Field Values
-
procedureNullableUnknown
static final int procedureNullableUnknownStates that it is unknown whetherNULLvalues are permitted.- See Also:
- Constant Field Values
-
procedureResultUnknown
static final int procedureResultUnknownStates that it is unknown whether or not the procedure returns a result.- See Also:
- Constant Field Values
-
procedureReturnsResult
static final int procedureReturnsResultStates that the procedure returns a result.- See Also:
- Constant Field Values
-
sqlStateSQL99
static final int sqlStateSQL99States that the value is an SQL99SQLSTATEvalue.- See Also:
- Constant Field Values
-
sqlStateXOpen
static final int sqlStateXOpenStates that the value is an SQLCLI SQLSTATEvalue as defined by the X/Open standard.- See Also:
- Constant Field Values
-
tableIndexClustered
static final short tableIndexClusteredStates that this table index is a clustered index.- See Also:
- Constant Field Values
-
tableIndexHashed
static final short tableIndexHashedStates that this table index is a hashed index.- See Also:
- Constant Field Values
-
tableIndexOther
static final short tableIndexOtherStates this table's index is neither a clustered index, not a hashed index, and not a table statistics index; i.e. it is something else.- See Also:
- Constant Field Values
-
tableIndexStatistic
static final short tableIndexStatisticStates this column has the table's statistics, and that it is returned in conjunction with the table's index description.- See Also:
- Constant Field Values
-
typeNoNulls
static final int typeNoNullsStates that aNULLvalue is NOT permitted for this data type.- See Also:
- Constant Field Values
-
typeNullable
static final int typeNullableStates that aNULLvalue is permitted for this data type.- See Also:
- Constant Field Values
-
typeNullableUnknown
static final int typeNullableUnknownStates that it is unknown if aNULLvalue is permitted for this data type.- See Also:
- Constant Field Values
-
typePredBasic
static final int typePredBasicStates that this column shall not be used forWHEREstatements with aLIKEclause.- See Also:
- Constant Field Values
-
typePredChar
static final int typePredCharStates that this column can only be used in aWHERE...LIKEstatement.- See Also:
- Constant Field Values
-
typePredNone
static final int typePredNoneStates that this column does not support searches.- See Also:
- Constant Field Values
-
typeSearchable
static final int typeSearchableStates that the column is searchable.- See Also:
- Constant Field Values
-
versionColumnNotPseudo
static final int versionColumnNotPseudoStates that the version column is known to be not a pseudo column.- See Also:
- Constant Field Values
-
versionColumnPseudo
static final int versionColumnPseudoStates that this version column is known to be a pseudo column.- See Also:
- Constant Field Values
-
versionColumnUnknown
static final int versionColumnUnknownStates that the version column may be a pseudo column or not.- See Also:
- Constant Field Values
-
sqlStateSQL
static final int sqlStateSQLStates that the method DatabaseMetaData.getSQLStateType may returns an SQLSTATE value or not.- See Also:
- Constant Field Values
-
functionColumnIn
static final int functionColumnInStates that the parameter or column is an IN parameter- See Also:
- Constant Field Values
-
functionColumnInOut
static final int functionColumnInOutStates that the parameter or column is an INOUT parameter- See Also:
- Constant Field Values
-
functionColumnOut
static final int functionColumnOutStates that the parameter or column is an OUT parameter- See Also:
- Constant Field Values
-
functionReturn
static final int functionReturnStates that the parameter or column is a return value- See Also:
- Constant Field Values
-
functionColumnUnknown
static final int functionColumnUnknownStates that the parameter of function is unknown- See Also:
- Constant Field Values
-
functionColumnResult
static final int functionColumnResultStates that the parameter or column is a column in a result set- See Also:
- Constant Field Values
-
functionNoNulls
static final int functionNoNullsStates that NULL values are not allowed- See Also:
- Constant Field Values
-
functionNullable
static final int functionNullableStates that NULL values are allowed- See Also:
- Constant Field Values
-
functionNullableUnknown
static final int functionNullableUnknownStates that whether NULL values are allowed is unknown- See Also:
- Constant Field Values
-
functionResultUnknown
static final int functionResultUnknownStates that it is not known whether the function returns a result or a table- See Also:
- Constant Field Values
-
functionNoTable
static final int functionNoTableStates that the function does not return a table- See Also:
- Constant Field Values
-
functionReturnsTable
static final int functionReturnsTableStates that the function returns a table.- See Also:
- Constant Field Values
-
-
Method Details
-
allProceduresAreCallable
Returns whether all procedures returned bygetProcedures(java.lang.String, java.lang.String, java.lang.String)can be called by the current user.- Returns:
trueif all procedures can be called by the current user,falseotherwise.- Throws:
SQLException- if there is a database error.
-
allTablesAreSelectable
Returns whether all the tables returned bygetTablescan be used by the current user in aSELECTstatement.- Returns:
trueif all the tables can be used,falseotherwise.- Throws:
SQLException- if there is a database error.
-
dataDefinitionCausesTransactionCommit
Returns whether a data definition statement in a transaction forces acommitof the transaction.- Returns:
trueif the statement forces a commit,falseotherwise.- Throws:
SQLException- if there is a database error.
-
dataDefinitionIgnoredInTransactions
Returns whether the database ignores data definition statements within a transaction.- Returns:
trueif the database ignores a data definition statement,falseotherwise.- Throws:
SQLException- if there is a database error.
-
deletesAreDetected
Returns whether a visible row delete can be detected by callingResultSet.rowDeleted().- Parameters:
type- the type of theResultSetinvolved:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
trueif the visible row delete can be detected,falseotherwise.- Throws:
SQLException- if there is a database error.
-
doesMaxRowSizeIncludeBlobs
Returns whether the return value ofgetMaxRowSizeincludes the SQL data typesLONGVARCHARandLONGVARBINARY.- Returns:
trueif the return value includesLONGVARBINARYandLONGVARCHAR, otherwisefalse.- Throws:
SQLException- if there is a database error.
-
getAttributes
ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLExceptionReturns aResultSetdescribing a subset of the attributes of a specified SQL User Defined Type (UDT) for a specified schema and catalog. The subset is determined by restricting to those attributes whose name matches theattributeNamePatternand whose type name matches thetypeNamePattern. Each row of theResultSetdescribes one attribute, and the rows are ordered by the columnsTYPE_SCHEM,TYPE_NAMEandORDINAL_POSITION. Inherited attributes are not included.The columns of the returned
ResultSetobject have the following names and meanings:TYPE_CAT- String - the type catalog name (possiblynull)TYPE_SCHEM- String - the type schema name (possiblynull)TYPE_NAME- String - the type nameATTR_NAME- String - the attribute nameDATA_TYPE- int - the attribute type as defined injava.sql.TypesATTR_TYPE_NAME- String - the attribute type name. This depends on the data source. For aUDTthe name is fully qualified. For aREFit is both fully qualified and represents the target type of the reference.ATTR_SIZE- int - the column size. When referring to char and date types this value is the maximum number of characters. When referring to numeric types is is the precision.DECIMAL_DIGITS- int - how many fractional digits are supportedNUM_PREC_RADIX- int - numeric values radixNULLABLE- int - whetherNULLis permitted:- DatabaseMetaData.attributeNoNulls -
NULLvalues not permitted - DatabaseMetaData.attributeNullable -
NULLvalues definitely permitted - DatabaseMetaData.attributeNullableUnknown - unknown
- DatabaseMetaData.attributeNoNulls -
REMARKS- String - a comment describing the attribute (possiblynull)- ATTR_DEF - String - Default value for the attribute (possibly
null) SQL_DATA_TYPE- int - not used- SQL_DATETIME_SUB - int - not used
- CHAR_OCTET_LENGTH - int - for
CHARtypes, the max number of bytes in the column - ORDINAL_POSITION - int - The index of the column in the table (where the count starts from 1, not 0)
- IS_NULLABLE - String -
"NO"= the column does not allowNULLs,"YES"= the column allowsNULLs, "" = status unknown SCOPE_CATALOG- String - if theDATA_TYPEisREF, this gives the catalog of the table corresponding to the attribute's scope. NULL if theDATA_TYPEis not REF.SCOPE_SCHEMA- String - if theDATA_TYPEisREF, this gives the schema of the table corresponding to the attribute's scope. NULL if theDATA_TYPEis not REF.SCOPE_TABLE- String - if theDATA_TYPEisREF, this gives the name of the table corresponding to the attribute's scope. NULL if theDATA_TYPEis not REF.SOURCE_DATA_TYPE- String - The source type for a user generated REF type or for a Distinct type. (NULLifDATA_TYPEis not DISTINCT or a user generated REF)
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search by a schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.typeNamePattern- a type name. This pattern must match the type name stored in the database.attributeNamePattern- an Attribute name. This pattern must match the attribute name as stored in the database.- Returns:
- a
ResultSet, where each row is an attribute description. - Throws:
SQLException- if there is a database error.
-
getBestRowIdentifier
ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLExceptionReturns a list of a table's optimal set of columns that uniquely identify the rows. The results are ordered bySCOPE(see below).The results are returned as a table, with one entry for each column, as follows:
SCOPE- short - theSCOPEof the result, as follows:DatabaseMetaData.bestRowTemporary- the result is very temporary, only valid while on the current rowDatabaseMetaData.bestRowTransaction- the result is good for remainder of current transactionDatabaseMetaData.bestRowSession- the result is good for remainder of database session
COLUMN_NAME- String - the column nameDATA_TYPE- int - the Type of the data, as defined injava.sql.TypesTYPE_NAME- String - the Name of the type - database dependent. For UDT types the name is fully qualifiedCOLUMN_SIZE- int - the precision of the data in the columnBUFFER_LENGTH- int - not usedDECIMAL_DIGITS- short - number of fractional digitsPSEUDO_COLUMN- short - whether this is a pseudo column (e.g. an OracleROWID):DatabaseMetaData.bestRowUnknown- it is not known whether this is a pseudo columnDatabaseMetaData.bestRowNotPseudo- the column is not pseudoDatabaseMetaData.bestRowPseudo- the column is a pseudo column
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schema- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.table- the table name. This must match the name of the table as declared in the database.scope- theSCOPEof interest, values as defined above.nullable-true= include columns that are nullable,false= do not include nullable columns.- Returns:
- a
ResultSetwhere each row is a description of a column and the complete set of rows is the optimal set for this table. - Throws:
SQLException- if there is a database error.
-
getCatalogs
Returns the set of catalog names available in this database. The set is returned ordered by catalog name.- Returns:
- a
ResultSetcontaining the catalog names, with each row containing one catalog name (as aString) in the single column namedTABLE_CAT. - Throws:
SQLException- if there is a database error.
-
getCatalogSeparator
Returns the separator that this database uses between a catalog name and table name.- Returns:
- a String containing the separator.
- Throws:
SQLException- if there is a database error.
-
getCatalogTerm
Returns the term that the database vendor prefers term for "catalog".- Returns:
- a String with the vendor's term for "catalog".
- Throws:
SQLException- if there is a database error.
-
getColumnPrivileges
ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLExceptionReturns a description of access rights for a table's columns. Only access rights matching the criteria for the column name are returned.The description is returned as a
ResultSetwith rows of data for each access right, with columns as follows:TABLE_CAT- String - the catalog name (possiblynull)TABLE_SCHEM- String - the schema name (possiblynull)TABLE_NAME- String - the table nameCOLUMN_NAME- String - the Column nameGRANTOR- String - the grantor of access (possiblynull)PRIVILEGE- String - Access right - one of SELECT, INSERT, UPDATE, REFERENCES,...IS_GRANTABLE- String -"YES"implies that the receiver can grant access to others,"NO"if the receiver cannot grant access to others,nullif unknown.
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schema- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.table- the table name. This must match the name of the table as declared in the database.columnNamePattern- the column name. This must match the name of a column in the table in the database.- Returns:
- a
ResultSetcontaining the access rights, one row for each privilege description. - Throws:
SQLException- if there is a database error.
-
getColumns
ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLExceptionReturns a description of table columns available in a specified catalog. Only descriptions meeting the specified catalog, schema, table, and column names are returned.The descriptions are returned as a
ResultSetconforming to the following data layout, with one row per table column:TABLE_CAT- String - the catalog name (possiblynull)TABLE_SCHEM- String - the schema name (possiblynull)TABLE_NAME- String - the table nameCOLUMN_NAME- String - the column nameDATA_TYPE- int - the SQL type as specified injava.sql.TypesTYPE_NAME- String - the name of the data type, (database-dependent, UDT names are fully qualified)COLUMN_SIZE- int - the column size (the precision for numeric types, max characters forcharanddatetypes)BUFFER_LENGTH- int - Not usedDECIMAL_DIGITS- int - maximum number of fractional digitsNUM_PREC_RADIX- int - the radix for numerical typesNULLABLE- int - whether the column allowsnulls:- DatabaseMetaData.columnNoNulls = may not allow
NULLs - DatabaseMetaData.columnNullable = does allow
NULLs - DatabaseMetaData.columnNullableUnknown = unknown
NULLstatus
- DatabaseMetaData.columnNoNulls = may not allow
REMARKS- String - A description of the column (possiblynull)COLUMN_DEF- String - Default value for the column (possiblynull)SQL_DATA_TYPE- int - not usedSQL_DATETIME_SUB- int - not usedCHAR_OCTET_LENGTH- int - maximum number of bytes in thechartype columnsORDINAL_POSITION- int - the column index in the table (1 based)IS_NULLABLE- String -"NO"= column does not allow NULLs,"YES"= column allows NULLs, "" =NULLstatus unknownSCOPE_CATALOG- String - if theDATA_TYPEisREF, this gives the catalog of the table corresponding to the attribute's scope. NULL if theDATA_TYPEis not REF.SCOPE_SCHEMA- String - if theDATA_TYPEisREF, this gives the schema of the table corresponding to the attribute's scope. NULL if theDATA_TYPEis not REF.SCOPE_TABLE- String - if theDATA_TYPEisREF, this gives the name of the table corresponding to the attribute's scope. NULL if theDATA_TYPEis not REF.SOURCE_DATA_TYPE- String - The source type for a user generated REF type or for a Distinct type. (NULLifDATA_TYPEis not DISTINCT or a user generated REF)
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.tableNamePattern- the table name. This must match the name of the table as declared in the database.columnNamePattern- the column name. This must match the name of a column in the table in the database.- Returns:
- the descriptions as a
ResultSetwith rows in the form defined above. - Throws:
SQLException- if there is a database error.
-
getConnection
Returns the database connection that created this metadata.- Returns:
- the connection to the database.
- Throws:
SQLException- if there is a database error.
-
getCrossReference
ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLExceptionReturns a list of foreign key columns in a given foreign key table that reference the primary key columns of a supplied primary key table. This describes how one table imports the key of another table. It would be expected to return a single foreign key - primary key pair in most cases.The descriptions are returned as a
ResultSetwith one row for each foreign key, with the following layout:PKTABLE_CAT- String - from the primary key table : Catalog (possiblynull)PKTABLE_SCHEM- String - from the primary key table : Schema (possiblynull)PKTABLE_NAME- String - from the primary key table : namePKCOLUMN_NAME- String - from the primary key column : nameFKTABLE_CAT- String - from the foreign key table : the catalog name being exported (possiblynull)FKTABLE_SCHEM- String - from the foreign key table : the schema name being exported (possiblynull)FKTABLE_NAME- String - from the foreign key table : the name being exportedFKCOLUMN_NAME- String - from the foreign key column : the name being exportedKEY_SEQ- short - the sequence number (in the foreign key)UPDATE_RULE- short - a value giving the rule for how to treat the corresponding foreign key when a primary key is updated:DatabaseMetaData.importedKeyNoAction- don't allow the primary key to be updated if it is imported as a foreign keyDatabaseMetaData.importedKeyCascade- change the imported key to match the updated primary keyDatabaseMetaData.importedKeySetNull- set the imported key tonullDatabaseMetaData.importedKeySetDefault- set the imported key to its default valueDatabaseMetaData.importedKeyRestrict- same asimportedKeyNoAction
DELETE_RULE- short - a value giving the rule for how to treat the foreign key when the corresponding primary key is deleted:DatabaseMetaData.importedKeyNoAction- don't allow the primary key to be deleted if it is imported as a foreign keyDatabaseMetaData.importedKeyCascade- delete those rows that import a deleted keyDatabaseMetaData.importedKeySetNull- set the imported key tonullDatabaseMetaData.importedKeySetDefault- set the imported key to its default valueDatabaseMetaData.importedKeyRestrict- same as importedKeyNoAction
FK_NAME- String - the foreign key name (possiblynull)PK_NAME- String - the primary key name (possiblynull)DEFERRABILITY- short - whether foreign key constraints can be deferred until commit (see the SQL92 specification for definitions):DatabaseMetaData.importedKeyInitiallyDeferredDatabaseMetaData.importedKeyInitiallyImmediateDatabaseMetaData.importedKeyNotDeferrable
- Parameters:
primaryCatalog- a catalog name for the primary key table.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.primarySchema- a schema name for the primary key table.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.primaryTable- the name of the table which exports the key. It must match the name of the table in the database.foreignCatalog- a catalog name for the foreign key table.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.foreignSchema- a schema name for the foreign key table.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.foreignTable- the name of the table importing the key. It must match the name of the table in the database.- Returns:
- a
ResultSetcontaining rows with the descriptions of the foreign keys laid out according to the format defined above. - Throws:
SQLException- if there is a database error.
-
getDatabaseMajorVersion
Returns the major version number of the database software.- Returns:
- the major version number of the database software.
- Throws:
SQLException- a database error occurred.
-
getDatabaseMinorVersion
Returns the minor version number of the database software.- Returns:
- the minor version number of the database software.
- Throws:
SQLException- a database error occurred.
-
getDatabaseProductName
Returns the name of the database software.- Returns:
- a
Stringwith the name of the database software. - Throws:
SQLException- a database error occurred.
-
getDatabaseProductVersion
Returns the version number of this database software.- Returns:
- a
Stringwith the version number of the database software. - Throws:
SQLException- a database error occurred.
-
getDefaultTransactionIsolation
Returns the default transaction isolation level for this database.- Returns:
- the default transaction isolation level. One of the following values:
TRANSACTION_NONETRANSACTION_READ_COMMITTEDTRANSACTION_READ_UNCOMMITTEDTRANSACTION_REPEATABLE_READTRANSACTION_SERIALIZABLE
- Throws:
SQLException- a database error occurred.
-
getDriverMajorVersion
int getDriverMajorVersion()Returns the JDBC driver's major version number.- Returns:
- the driver's major version number.
-
getDriverMinorVersion
int getDriverMinorVersion()Returns the JDBC driver's minor version number.- Returns:
- the driver's minor version number.
-
getDriverName
Returns the name of this JDBC driver.- Returns:
- a
Stringcontaining the name of the JDBC driver - Throws:
SQLException- a database error occurred.
-
getDriverVersion
Returns the version number of this JDBC driver.- Returns:
- a
Stringcontaining the complete version number of the JDBC driver. - Throws:
SQLException- a database error occurred.
-
getExportedKeys
Returns a list of the foreign key columns that reference the primary key columns of a specified table (the foreign keys exported by a table).The list is returned as a
ResultSetwith a row for each of the foreign key columns, ordered byFKTABLE_CAT,FKTABLE_SCHEM,FKTABLE_NAME, andKEY_SEQ, with the format for each row being:PKTABLE_CAT- String - from the primary key table : the catalog (possiblynull)PKTABLE_SCHEM- String - from the primary key table : the schema (possiblynull)PKTABLE_NAME- String - from the primary key table : the namePKCOLUMN_NAME- String - from the primary key column : the nameFKTABLE_CAT- String - from the foreign key table : the catalog name being exported (possiblynull)FKTABLE_SCHEM- String - from the foreign key table : the schema name being exported (possiblynull)FKTABLE_NAME- String - from the foreign key table : the name being exportedFKCOLUMN_NAME- String - from the foreign key column : the name being exportedKEY_SEQ- short - the sequence number (in the foreign key)UPDATE_RULE- short - a value giving the rule for how to treat the foreign key when the corresponding primary key is updated:DatabaseMetaData.importedKeyNoAction- don't allow the primary key to be updated if it is imported as a foreign keyDatabaseMetaData.importedKeyCascade- change the imported key to match the primary key updateDatabaseMetaData.importedKeySetNull- set the imported key tonullDatabaseMetaData.importedKeySetDefault- set the imported key to its default valueDatabaseMetaData.importedKeyRestrict- same as importedKeyNoAction
DELETE_RULE- short - how to treat the foreign key when the corresponding primary key is deleted:DatabaseMetaData.importedKeyNoAction- don't allow the primary key to be deleted if it is imported as a foreign keyDatabaseMetaData.importedKeyCascade- the deletion should also delete rows that import a deleted keyDatabaseMetaData.importedKeySetNull- the deletion sets the imported key tonullDatabaseMetaData.importedKeySetDefault- the deletion sets the imported key to its default valueDatabaseMetaData.importedKeyRestrict- same as importedKeyNoAction
FK_NAME- String - the foreign key name (possiblynull)PK_NAME- String - the primary key name (possiblynull)DEFERRABILITY- short - defines whether the foreign key constraints can be deferred until commit (see the SQL92 specification for definitions):DatabaseMetaData.importedKeyInitiallyDeferredDatabaseMetaData.importedKeyInitiallyImmediateDatabaseMetaData.importedKeyNotDeferrable
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schema- a schema name.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.table- a table name, which must match the name of a table in the database- Returns:
- a
ResultSetcontaining a row for each of the foreign key columns, as defined above - Throws:
SQLException- a database error occurred
-
getExtraNameCharacters
Returns a string of characters that may be used in unquoted identifier names. The charactersa-z,A-Z,0-9and_are always permitted.- Returns:
- a String containing all the additional permitted characters.
- Throws:
SQLException- a database error occurred.
-
getIdentifierQuoteString
Returns the string used to quote SQL identifiers. Returns " " (space) if identifier quoting not supported.- Returns:
- the String used to quote SQL identifiers.
- Throws:
SQLException- a database error occurred.
-
getImportedKeys
Returns a list columns in a table that are both primary keys and referenced by the table's foreign key columns (that is, the primary keys imported by a table).The list returned is a
ResultSetwith a row entry for each primary key column, ordered byPKTABLE_CAT,PKTABLE_SCHEM,PKTABLE_NAME, andKEY_SEQ, with the following format:PKTABLE_CAT- String - primary key catalog name being imported (possiblynull)PKTABLE_SCHEM- String - primary key schema name being imported (possiblynull)PKTABLE_NAME- String - primary key table name being importedPKCOLUMN_NAME- String - primary key column name being importedFKTABLE_CAT- String - foreign key table catalog name (possiblynull)FKTABLE_SCHEM- String - foreign key table schema name (possiblynull)FKTABLE_NAME- String - foreign key table nameFKCOLUMN_NAME- String - foreign key column nameKEY_SEQ- short - sequence number (in the foreign key)UPDATE_RULE- short - how to treat the foreign key when the corresponding primary key is updated:DatabaseMetaData.importedKeyNoAction- don't allow any update of the primary key if it is imported as a foreign keyDatabaseMetaData.importedKeyCascade- change imported key to match the primary key updateDatabaseMetaData.importedKeySetNull- set the imported key tonullDatabaseMetaData.importedKeySetDefault- set the imported key to its default valueDatabaseMetaData.importedKeyRestrict- same as importedKeyNoAction
DELETE_RULE- short - how to treat the foreign key when the corresponding primary key is deleted:DatabaseMetaData.importedKeyNoAction- don't allow the primary key to be deleted if it is imported as a foreign keyDatabaseMetaData.importedKeyCascade- delete those rows that import a deleted keyDatabaseMetaData.importedKeySetNull- set the imported key tonullDatabaseMetaData.importedKeySetDefault- set the imported key to its default valueDatabaseMetaData.importedKeyRestrict- same asimportedKeyNoAction
FK_NAME- String - foreign key name (possiblynull)PK_NAME- String - primary key name (possiblynull)DEFERRABILITY- short - defines whether foreign key constraints can be deferred until commit (see SQL92 specification for definitions):DatabaseMetaData.importedKeyInitiallyDeferredDatabaseMetaData.importedKeyInitiallyImmediateDatabaseMetaData.importedKeyNotDeferrable
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schema- a schema name.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.table- a table name, which must match the name of a table in the database.- Returns:
- a
ResultSetcontaining the list of primary key columns as rows in the format defined above. - Throws:
SQLException- a database error occurred.
-
getIndexInfo
ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLExceptionReturns a list of indices and statistics for a specified table.The list is returned as a
ResultSet, with one row for each index or statistic. The list is ordered byNON_UNIQUE,TYPE,INDEX_NAME, andORDINAL_POSITION. Each row has the following format:TABLE_CAT- String - table catalog name (possiblynull)TABLE_SCHEM- String - table schema name (possiblynull)TABLE_NAME- String - The table nameNON_UNIQUE- boolean -truewhen index values can be non-unique. Must befalsewhen the TYPE is tableIndexStatisticINDEX_QUALIFIER- String : index catalog name.nullwhen the TYPE is 'tableIndexStatistic'INDEX_NAME- String : index name.nullwhen TYPE is 'tableIndexStatistic'TYPE- short - the index type. One of:DatabaseMetaData.tableIndexStatistic- table statistics returned with Index descriptionsDatabaseMetaData.tableIndexClustered- a clustered IndexDatabaseMetaData.tableIndexHashed- a hashed IndexDatabaseMetaData.tableIndexOther- other style of Index
ORDINAL_POSITION- short - column sequence within Index. 0 when TYPE is tableIndexStatisticCOLUMN_NAME- String - the column name.nullwhen TYPE is tableIndexStatisticASC_OR_DESC- String - column sort sequence.nullif sequencing not supported or TYPE is tableIndexStatistic; otherwise "A" means sort ascending and "D" means sort descending.CARDINALITY- int - Number of unique values in the Index. If TYPE is tableIndexStatistic, this is number of rows in the table.PAGES- int - Number of pages for current Index. If TYPE is tableIndexStatistic, this is number of pages used for the table.FILTER_CONDITION- String - Filter condition. (possibly null)
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schema- a schema name.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.table- a table name, which must match the name of a table in the database.unique-truemeans only return indices for unique values,falseimplies that they can be returned even if not unique.approximate-trueimplies that the list can contain approximate or "out of data" values,falseimplies that all values must be precisely accurate- Returns:
- a
ResultSetcontaining the list of indices and statistics for the table, in the format defined above. - Throws:
SQLException- a database error occurred.
-
getJDBCMajorVersion
Returns this driver's major JDBC version number.- Returns:
- the major JDBC version number.
- Throws:
SQLException- a database error occurred.
-
getJDBCMinorVersion
Returns the minor JDBC version number for this driver.- Returns:
- the Minor JDBC Version Number.
- Throws:
SQLException- a database error occurred.
-
getMaxBinaryLiteralLength
Get the maximum number of hex characters in an in-line binary literal for this database.- Returns:
- the maximum number of hex characters in an in-line binary literal. If the number is unlimited then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxCatalogNameLength
Returns the maximum size of a catalog name in this database.- Returns:
- the maximum size in characters for a catalog name. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxCharLiteralLength
Returns the maximum size for a character literal in this database.- Returns:
- the maximum size in characters for a character literal. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxColumnNameLength
Returns the maximum size for a Column name for this database.- Returns:
- the maximum number of characters for a Column name. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxColumnsInGroupBy
Get the maximum number of columns in aGROUP BYclause for this database.- Returns:
- the maximum number of columns in a
GROUP BYclause. If the limit is unknown, or the value is unlimited, then the result is zero. - Throws:
SQLException- a database error occurred.
-
getMaxColumnsInIndex
Returns the maximum number of columns in an Index for this database.- Returns:
- the maximum number of columns in an Index. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxColumnsInOrderBy
Returns the maximum number of columns in anORDER BYclause for this database.- Returns:
- the maximum number of columns in an
ORDER BYclause. If the limit is unknown, or the value is unlimited, then the result is zero. - Throws:
SQLException- a database error occurred.
-
getMaxColumnsInSelect
Returns the maximum number of columns in aSELECTlist for this database.- Returns:
- the maximum number of columns in a
SELECTlist. If the limit is unknown, or the value is unlimited, then the result is zero. - Throws:
SQLException- a database error occurred.
-
getMaxColumnsInTable
Returns the maximum number of columns in a table for this database.- Returns:
- the maximum number of columns in a table. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxConnections
Returns the database's maximum number of concurrent connections.- Returns:
- the maximum number of connections. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxCursorNameLength
Returns the maximum length of a cursor name for this database.- Returns:
- the maximum number of characters in a cursor name. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxIndexLength
Returns the maximum length in bytes for an Index for this database. This covers all the parts of a composite index.- Returns:
- the maximum length in bytes for an Index. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxProcedureNameLength
Returns the maximum number of characters for a procedure name in this database.- Returns:
- the maximum number of character for a procedure name. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxRowSize
Returns the maximum number of bytes within a single row for this database.- Returns:
- the maximum number of bytes for a single row. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxSchemaNameLength
Returns the maximum number of characters in a schema name for this database.- Returns:
- the maximum number of characters in a schema name. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxStatementLength
Returns the maximum number of characters in an SQL statement for this database.- Returns:
- the maximum number of characters in an SQL statement. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxStatements
Get the maximum number of simultaneously open active statements for this database.- Returns:
- the maximum number of open active statements. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxTableNameLength
Returns the maximum size for a table name in the database.- Returns:
- the maximum size in characters for a table name. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getMaxTablesInSelect
Returns the maximum number of tables permitted in aSELECTstatement for the database.- Returns:
- the maximum number of tables permitted in a
SELECTstatement. If the limit is unknown, or the value is unlimited, then the result is zero. - Throws:
SQLException- a database error occurred.
-
getMaxUserNameLength
Returns the maximum number of characters in a user name for the database.- Returns:
- the maximum number of characters in a user name. If the limit is unknown, or the value is unlimited, then the result is zero.
- Throws:
SQLException- a database error occurred.
-
getNumericFunctions
Returns a list of the math functions available with this database. These are used in the JDBC function escape clause and are the Open Group CLI math function names.- Returns:
- a String which contains the list of math functions as a comma separated list.
- Throws:
SQLException- a database error occurred.
-
getPrimaryKeys
Returns a list of the primary key columns of a specified table.The list is returned as a
ResultSetwith one row for each primary key column, ordered byCOLUMN_NAME, with each row having the structure as follows:TABLE_CAT- String - table catalog name (possibly null)TABLE_SCHEM- String - table schema name (possibly null)TABLE_NAME- String - The table nameCOLUMN_NAME- String - The column nameKEY_SEQ- short - the sequence number for this column in the primary keyPK_NAME- String - the primary key name (possibly null)
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with the empty string used to retrieve those without a catalog name.schema- a schema name.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with the empty string used to retrieve those without a schema name.table- the name of a table, which must match the name of a table in the database.- Returns:
- a
ResultSetcontaining the list of keys in the format defined above. - Throws:
SQLException- a database error occurred.
-
getProcedureColumns
ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLExceptionReturns a list of parameter and result columns for the stored procedures belonging to a specified catalog.The list is returned as a
ResultSetwith one row for each parameter or result column. The data is ordered byPROCEDURE_SCHEMandPROCEDURE_NAME, while for each procedure, the return value (if any) is first, followed by the parameters in the order they appear in the stored procedure call, followed byResultSetcolumns in column number order. Each row has the following structure:PROCEDURE_CAT- String - the procedure catalog namePROCEDURE_SCHEM- String - the procedure schema name (possibly null)PROCEDURE_NAME- String - the procedure nameCOLUMN_NAME- String - the name of the columnCOLUMN_TYPE- short - the kind of column or parameter, as follows:DatabaseMetaData.procedureColumnUnknown- type unknownDatabaseMetaData.procedureColumnIn- anINparameterDatabaseMetaData.procedureColumnInOut- anINOUTparameterDatabaseMetaData.procedureColumnOut- anOUTparameterDatabaseMetaData.procedureColumnReturn- a return valueDatabaseMetaData.procedureReturnsResult- a result column in a result set
DATA_TYPE- int - the SQL type of the data, as injava.sql.TypesTYPE_NAME- String - the SQL type name, for a UDT it is fully qualifiedPRECISION- int - the precisionLENGTH- int - the length of the data in bytesSCALE- short - the scale for numeric typesRADIX- short - the Radix for numeric data (typically 2 or 10)NULLABLE- short - can the data containnull:DatabaseMetaData.procedureNoNulls-NULLs not permittedDatabaseMetaData.procedureNullable-NULLs are permittedDatabaseMetaData.procedureNullableUnknown-NULLstatus unknown
REMARKS- String - an explanatory comment about the data item
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.procedureNamePattern- a pattern that must match the name of the procedure stored in the database.columnNamePattern- a column name pattern. The name must match the column name stored in the database.- Returns:
- a
ResultSetwith the list of parameter and result columns in the format defined above. - Throws:
SQLException- a database error occurred.
-
getProcedures
ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLExceptionReturns a list of the stored procedures available in a specified catalog.The list is returned as a
ResultSetwith one row for each stored procedure, ordered by PROCEDURE_SCHEM and PROCEDURE_NAME, with the data in each row as follows:PROCEDURE_CAT- String : the procedure catalog namePROCEDURE_SCHEM- String : the procedure schema name (possiblynull)PROCEDURE_NAME- String : the procedure nameReservedReservedReservedREMARKS- String - information about the procedurePROCEDURE_TYPE- short : one of:DatabaseMetaData.procedureResultUnknown- procedure may return a resultDatabaseMetaData.procedureNoResult- procedure does not return a resultDatabaseMetaData.procedureReturnsResult- procedure definitely returns a result
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.procedureNamePattern- a procedure name pattern, which must match the procedure name stored in the database.- Returns:
- a
ResultSetwhere each row is a description of a stored procedure in the format defined above. - Throws:
SQLException- a database error occurred.
-
getProcedureTerm
Returns the database vendor's preferred name for "procedure".- Returns:
- a String with the vendor's preferred name for "procedure".
- Throws:
SQLException- a database error occurred.
-
getResultSetHoldability
Returns the result set's default holdability.- Returns:
- one of
ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT. - Throws:
SQLException- a database error occurred.
-
getSchemas
Returns a list of the schema names in the database. The list is returned as aResultSet, ordered by the schema name, with one row per schema in the following format:TABLE_SCHEM- String - the schema nameTABLE_CATALOG- String - the catalog name (possiblynull)
- Returns:
- a
ResultSetwith one row for each schema in the format defined above. - Throws:
SQLException- a database error occurred.
-
getSchemaTerm
Returns the database vendor's preferred term for "schema".- Returns:
- a String which is the vendor's preferred term for schema.
- Throws:
SQLException- a database error occurred.
-
getSearchStringEscape
Returns the string that is used to escape wildcard characters. This string is used to escape the'_'and'%'wildcard characters in catalog search pattern strings.'_'is used to represent any single character while'%'is used for a sequence of zero or more characters.- Returns:
- a String used to escape the wildcard characters.
- Throws:
SQLException- a database error occurred.
-
getSQLKeywords
Returns a list of all the SQL keywords that are NOT also SQL92 keywords for the database.- Returns:
- a String containing the list of SQL keywords in a comma separated format.
- Throws:
SQLException- a database error occurred.
-
getSQLStateType
States the type ofSQLStatevalue returned bySQLException.getSQLState. This can either be the X/Open (now known as Open Group) SQL CLI form or the SQL99 form.- Returns:
- an integer, which is either
DatabaseMetaData.sqlStateSQL99orDatabaseMetaData.sqlStateXOpen. - Throws:
SQLException- a database error occurred.
-
getStringFunctions
Returns a list of string functions available with the database. These functions are used in JDBC function escape clause and follow the Open Group CLI string function names definition.- Returns:
- a String containing the list of string functions in comma separated format.
- Throws:
SQLException- a database error occurred.
-
getSuperTables
ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLExceptionReturns a listing of the hierarchies of tables in a specified schema in the database.The listing only contains entries for tables that have a super table. Super tables and corresponding subtables must be defined in the same catalog and schema. The list is returned as a
ResultSet, with one row for each table that has a super table, in the following format:TABLE_CAT- String - table catalog name (possiblynull)TABLE_SCHEM- String - Table schema name (possiblynull)TABLE_NAME- String - The table name- SUPER
TABLE_NAME- String - The super table name
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.tableNamePattern- a table name, which should match the table name as stored in the database. it may be a fully qualified name. If it is fully qualified the catalog name and schema name parameters are ignored.- Returns:
- a
ResultSetwith one row for each table which has a super table, in the format defined above. An emptyResultSetis returned if the database does not support table hierarchies. - Throws:
SQLException- a database error occurred.
-
getSuperTypes
ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLExceptionReturns the User Defined Type (UDT) hierarchies for a given schema. Only the immediate parent/child relationship is described. If a UDT does not have a direct supertype, it is not listed.The listing is returned as a
ResultSetwhere there is one row for a specific UDT which describes its supertype, with the data organized in columns as follows:TYPE_CAT- String - the UDT catalog name (possiblynull)TYPE_SCHEM- String - the UDT schema name (possiblynull)TYPE_NAME- String - the UDT type name- SUPER
TYPE_CAT- String - direct supertype's catalog name (possiblynull) - SUPER
TYPE_SCHEM- String - direct supertype's schema name (possiblynull) - SUPER
TYPE_NAME- String - direct supertype's name
- Parameters:
catalog- the catalog name. "" means get the UDTs without a catalog.nullmeans don't use the catalog name to restrict the search.schemaPattern- the Schema pattern name. "" means get the UDT's without a schema.typeNamePattern- the UDT name pattern. This may be a fully qualified name. When a fully qualified name is specified, the catalog name and schema name parameters are ignored.- Returns:
- a
ResultSetin which each row gives information about a particular UDT in the format defined above. An empty ResultSet is returned for a database that does not support type hierarchies. - Throws:
SQLException- a database error occurred.
-
getSystemFunctions
Returns a list of system functions available with the database. These are names used in the JDBC function escape clause and are Open Group CLI function names.- Returns:
- a String containing the list of system functions in a comma separated format.
- Throws:
SQLException- a database error occurred.
-
getTablePrivileges
ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLExceptionReturns a description of access rights for each table present in a catalog. Table privileges can apply to one or more columns in the table - but are not guaranteed to apply to all columns.The privileges are returned as a
ResultSet, with one row for each privilege, ordered byTABLE_SCHEM,TABLE_NAME,PRIVILEGE, and each row has data as defined in the following column definitions:TABLE_CAT- String - table catalog name (possiblynull)TABLE_SCHEM- String - Table schema name (possiblynull)TABLE_NAME- String - The table name- GRANTOR - String - who granted the access
- GRANTEE - String - who received the access grant
- PRIVILEGE - String - the type of access granted - one of SELECT, INSERT, UPDATE, REFERENCES,...
- IS_GRANTABLE - String -
"YES"implies the grantee can grant access to others,"NO"implies guarantee cannot grant access to others,nullmeans this status is unknown
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.tableNamePattern- a Table Name, which should match the table name as stored in the database.- Returns:
- a
ResultSetcontaining a list with one row for each table in the format defined above. - Throws:
SQLException- a database error occurred.
-
getTables
ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLExceptionReturns a description of the tables in a specified catalog.The descriptions are returned as rows in a
ResultSet, one row for each Table. The ResultSet is ordered byTABLE_TYPE,TABLE_SCHEMandTABLE_NAME. Each row in the ResultSet consists of a series of columns as follows:TABLE_CAT- String - table catalog name (possiblynull)TABLE_SCHEM- String - Table schema name (possiblynull)TABLE_NAME- String - The table nameTABLE_TYPE- String - Typical names include "TABLE", "VIEW", "SYSTEM TABLE", "ALIAS", "SYNONYM", "GLOBAL TEMPORARY"REMARKS- String - A comment describing the tableTYPE_CAT- String - the 'Types' catalog(possiblynull)TYPE_SCHEM- String - the 'Types' schema(possiblynull)TYPE_NAME- String - the 'Types' name (possiblynull)SELF_REFERENCING_COL_NAME- String - the name of a designated identifier column in a typed table (possiblynull)- REF_GENERATION - String - one of the following values : "SYSTEM" |
"USER" | "DERIVED" - specifies how values in the
SELF_REFERENCING_COL_NAMEare created (possiblynull)
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.tableNamePattern- a table name, which should match the table name as stored in the database.types- a list of table types to include in the list.nullimplies list all types.- Returns:
- a
ResultSetwith one row per table in the format defined above. - Throws:
SQLException- a database error occurred.
-
getTableTypes
Returns a list of table types supported by the database.The list is returned as a
ResultSetwith one row per table type, ordered by the table type. The information in theResultSetis structured into a single column per row, as follows:TABLE_TYPE- String - the table type. Typical names include"TABLE","VIEW", "SYSTEM TABLE","ALIAS","SYNONYM","GLOBAL TEMPORARY"
- Returns:
- a
ResultSetwith one row per table type in the format defined above. - Throws:
SQLException- a database error occurred.
-
getTimeDateFunctions
Returns a list of time and date functions available for the database.- Returns:
- a string containing a comma separated list of the time and date functions.
- Throws:
SQLException- a database error occurred.
-
getTypeInfo
Get a list of the standard SQL types supported by this database. The list is returned as aResultSet, with one row for each type, ordered by theDATA_TYPEvalue, where the data in each row is structured into the following columns:TYPE_NAME- String : the type nameDATA_TYPE- int : the SQL data type value as defined injava.sql.TypesPRECISION- int - the maximum precision of the typeLITERAL_PREFIX- String : the prefix to be used when quoting a literal value (possiblynull)LITERAL_SUFFIX- String : the suffix to be used when quoting a literal value (possiblynull)CREATE_PARAMS- String : params used when creating the type (possiblynull)NULLABLE- short : shows if the value is nullable:DatabaseMetaData.typeNoNulls:NULLs not permittedDatabaseMetaData.typeNullable:NULLs are permittedDatabaseMetaData.typeNullableUnknown:NULLstatus unknown
CASE_SENSITIVE- boolean : true if the type is case sensitiveSEARCHABLE- short : how this type can be used withWHEREclauses:DatabaseMetaData.typePredNone-WHEREclauses cannot be usedDatabaseMetaData.typePredChar- support forWHERE...LIKEonlyDatabaseMetaData.typePredBasic- support except forWHERE...LIKEDatabaseMetaData.typeSearchable- support for allWHEREclauses
UNSIGNED_ATTRIBUTE- boolean - the type is unsigned or notFIXED_PREC_SCALE- boolean - fixed precision = it can be used as a money valueAUTO_INCREMENT- boolean - can be used as an auto-increment valueLOCAL_TYPE_NAME- String - a localized version of the type name (possiblynull)MINIMUM_SCALE- short - the minimum scale supportedMAXIMUM_SCALE- short - the maximum scale supportedSQL_DATA_TYPE- int - not usedSQL_DATETIME_SUB- int - not usedNUM_PREC_RADIX- int - number radix (typically 2 or 10)
- Returns:
- a
ResultSetwhich is structured as described above. - Throws:
SQLException- a database error occurred.
-
getUDTs
ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLExceptionReturns a description of the User Defined Types (UDTs) defined in a given schema, which includes the typesDISTINCT,STRUCTandJAVA_OBJECT.The types matching the supplied the specified catalog, schema, type name and type are returned as rows in a
ResultSetwith columns of information as follows:TABLE_CAT- String - catalog name (possiblynull)TABLE_SCHEM- String - schema name (possiblynull)TABLE_NAME- String - The table nameCLASS_NAME- String - The Java class nameDATA_TYPE- int - The SQL type as specified injava.sql.Types. One of DISTINCT, STRUCT, and JAVA_OBJECTREMARKS- String - A comment which describes the typeBASE_TYPE- short - A type code. For a DISTINCT type, the source type. For a structured type this is the type that implements the user generated reference type of theSELF_REFERENCING_COLUMN. This is defined injava.sql.Types, and will benullif theDATA_TYPEdoes not match these criteria.
If the driver does not support UDTs, the
ResultSetis empty.- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schemaPattern- a schema name pattern.nullis used to imply no narrowing of the search using schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.typeNamePattern- a type name pattern, which should match a type name as stored in the database. It may be fully qualified.types- a list of the UDT types to include in the list - one ofDISTINCT,STRUCTorJAVA_OBJECT.- Returns:
- a
ResultSetin the format described above. - Throws:
SQLException- a database error occurred.
-
getURL
Returns the URL for this database.- Returns:
- the URL for the database.
nullif it cannot be generated. - Throws:
SQLException- a database error occurred.
-
getUserName
Determine the user name as known by the database.- Returns:
- the user name.
- Throws:
SQLException- a database error occurred.
-
getVersionColumns
Returns which of a table's columns are automatically updated when any value in a row is updated.The result is laid-out in the following columns:
SCOPE- short - not usedCOLUMN_NAME- String - Column nameDATA_TYPE- int - The SQL data type, as defined injava.sql.TypesTYPE_NAME- String - The SQL type name, data source dependentCOLUMN_SIZE- int - Precision for numeric typesBUFFER_LENGTH- int - Length of a column value in bytesDECIMAL_DIGITS- short - Number of digits after the decimal pointPSEUDO_COLUMN- short - If this is a pseudo-column (for example, an OracleROWID):DatabaseMetaData.bestRowUnknown- don't know whether this is a pseudo columnDatabaseMetaData.bestRowNotPseudo- column is not pseudoDatabaseMetaData.bestRowPseudo- column is a pseudo column
- Parameters:
catalog- a catalog name.nullis used to imply no narrowing of the search using catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.schema- a schema name pattern.nullis used to imply no narrowing of the search using schema names. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.table- a table name. It must match the name of a table in the database.- Returns:
- a
ResultSetcontaining the descriptions, one row for each column, in the format defined above. - Throws:
SQLException- a database error occurred.
-
insertsAreDetected
Determines whether a visible row insert can be detected by callingResultSet.rowInserted.- Parameters:
type- theResultSettype. This may be one ofResultSet.TYPE_SCROLL_SENSITIVEorResultSet.TYPE_SCROLL_INSENSITIVEorResultSet.TYPE_FORWARD_ONLY,- Returns:
trueifResultSet.rowInserteddetects a visible row insert otherwisefalse.- Throws:
SQLException- a database error occurred.- See Also:
ResultSet.rowInserted()
-
isCatalogAtStart
Determine whether a fully qualified table name is prefixed or suffixed to a fully qualified table name.- Returns:
trueif the catalog appears at the start of a fully qualified table name,falseotherwise.- Throws:
SQLException- a database error occurred.
-
isReadOnly
Determines whether the database is in read-only mode.- Returns:
trueif the database is in read-only mode,falseotherwise.- Throws:
SQLException- a database error occurred.
-
locatorsUpdateCopy
Determines whether updates are made to a copy of, or directly on, Large Objects (LOBs).- Returns:
trueif updates are made to a copy of the Large Object,falseotherwise.- Throws:
SQLException- a database error occurred.
-
nullPlusNonNullIsNull
Determines whether the database handles concatenations betweenNULLand non-NULLvalues by producing aNULLoutput.- Returns:
trueifNULLto non-NULLconcatenations produce aNULLresult,falseotherwise.- Throws:
SQLException- a database error occurred.
-
nullsAreSortedAtEnd
Determines whetherNULLvalues are always sorted to the end of sorted results regardless of requested sort order. This means that they will appear at the end of sorted lists whatever other non-NULLvalues may be present.- Returns:
trueifNULLvalues are sorted at the end,falseotherwise.- Throws:
SQLException- a database error occurred.
-
nullsAreSortedAtStart
Determines whetherNULLvalues are always sorted at the start of the sorted list, irrespective of the sort order. This means that they appear at the start of sorted lists, whatever other values may be present.- Returns:
trueifNULLvalues are sorted at the start,falseotherwise.- Throws:
SQLException- a database error occurred.
-
nullsAreSortedHigh
Determines whetherNULLvalues are sorted high - i.e. they are sorted as if they are higher than any other values.- Returns:
trueifNULLvalues are sorted high,falseotherwise.- Throws:
SQLException- a database error occurred.
-
nullsAreSortedLow
Determines whetherNULLvalues are sorted low - i.e. they are sorted as if they are lower than any other values.- Returns:
trueifNULLvalues are sorted low,falseotherwise.- Throws:
SQLException- a database error occurred.
-
othersDeletesAreVisible
Determines whether deletes made by others are visible, for a specifiedResultSettype.- Parameters:
type- the type of theResultSet. It may be eitherResultSet.TYPE_FORWARD_ONLYorResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE)- Returns:
trueif others' deletes are visible,falseotherwise.- Throws:
SQLException- a database error occurred.
-
othersInsertsAreVisible
Determines whether inserts made by others are visible, for a specifiedResultSettype.- Parameters:
type- the type of theResultSet. May beResultSet.TYPE_FORWARD_ONLY, orResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
trueif others' inserts are visible, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
othersUpdatesAreVisible
Determines whether updates made by others are visible, for a specifiedResultSettype.- Parameters:
type- the type of theResultSet. May beResultSet.TYPE_FORWARD_ONLY, orResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
trueif others' inserts are visible, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
ownDeletesAreVisible
Determines whether aResultSetcan see its own deletes, for a specifiedResultSettype.- Parameters:
type- the type of theResultSet:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
trueif the deletes are seen by theResultSetitself, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
ownInsertsAreVisible
Determines whether aResultSetcan see its own inserts, for a specifiedResultSettype.- Parameters:
type- the type of theResultSet:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
trueif the inserts are seen by theResultSetitself, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
ownUpdatesAreVisible
Determines whether aResultSetcan see its own updates, for a specifiedResultSettype.- Parameters:
type- the type of theResultSet:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
trueif the updates are seen by theResultSetitself, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
storesLowerCaseIdentifiers
Determines whether the database treats SQL identifiers that are in mixed case (and unquoted) as case insensitive. Iftruethen the database stores them in lower case.- Returns:
trueif unquoted SQL identifiers are stored in lower case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
storesLowerCaseQuotedIdentifiers
Determines whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in lower case.- Returns:
trueif quoted SQL identifiers are stored in lower case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
storesMixedCaseIdentifiers
Determines whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.- Returns:
trueif unquoted SQL identifiers as stored in mixed case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
storesMixedCaseQuotedIdentifiers
Determines whether the database considers identifiers as case insensitive if they are mixed case quoted SQL. The database stores them in mixed case.- Returns:
trueif quoted SQL identifiers are stored in mixed case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
storesUpperCaseIdentifiers
Determines whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.- Returns:
trueif unquoted SQL identifiers are stored in upper case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
storesUpperCaseQuotedIdentifiers
Determines whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in upper case.- Returns:
trueif quoted SQL identifiers are stored in upper case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsAlterTableWithAddColumn
Determines whether the database supportsALTER TABLEoperation withADD COLUMN.- Returns:
trueifALTER TABLEwithADD COLUMNis supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsAlterTableWithDropColumn
Determines whether the database supportsALTER TABLEoperation withDROP COLUMN.- Returns:
trueifALTER TABLEwithDROP COLUMNis supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsANSI92EntryLevelSQL
Determines whether the database supports the ANSI92 entry level SQL grammar.- Returns:
trueif the ANSI92 entry level SQL grammar is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsANSI92FullSQL
Determines whether the database supports the ANSI92 full SQL grammar.- Returns:
trueif the ANSI92 full SQL grammar is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsANSI92IntermediateSQL
Determines whether the database supports the ANSI92 intermediate SQL Grammar.- Returns:
trueif the ANSI92 intermediate SQL grammar is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsBatchUpdates
Determines whether the database supports batch updates.- Returns:
trueif batch updates are supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsCatalogsInDataManipulation
Determines whether catalog names may be used in data manipulation statements.- Returns:
trueif catalog names can be used in data manipulation statements,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsCatalogsInIndexDefinitions
Determines whether catalog names can be used in index definition statements.- Returns:
trueif catalog names can be used in index definition statements,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsCatalogsInPrivilegeDefinitions
Determines whether catalog names can be used in privilege definition statements.- Returns:
trueif catalog names can be used in privilege definition statements,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsCatalogsInProcedureCalls
Determines whether catalog names can be used in procedure call statements.- Returns:
trueif catalog names can be used in procedure call statements.- Throws:
SQLException- a database error occurred.
-
supportsCatalogsInTableDefinitions
Determines whether catalog names may be used in table definition statements.- Returns:
trueif catalog names can be used in definition statements,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsColumnAliasing
Determines whether the database supports column aliasing.If aliasing is supported, then the SQL AS clause is used to provide names for computed columns and provide alias names for columns.
- Returns:
trueif column aliasing is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsConvert
Determines whether the database supports theCONVERToperation between SQL types.- Returns:
trueif theCONVERToperation is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsConvert
Determines whether the database supportsCONVERToperation for two supplied SQL types.- Parameters:
fromType- the Type to convert from, as defined byjava.sql.TypestoType- the Type to convert to, as defined byjava.sql.Types- Returns:
trueif theCONVERToperation is supported for these types,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsCoreSQLGrammar
Determines whether the database supports the Core SQL Grammar for ODBC.- Returns:
trueif the Core SQL Grammar is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsDataDefinitionAndDataManipulationTransactions
Determines whether the database allows both data definition and data manipulation statements inside a transaction.- Returns:
trueif both types of statement are permitted,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsDataManipulationTransactionsOnly
Determines whether the database only allows data manipulation statements inside a transaction.- Returns:
trueif data manipulation statements are permitted only within a transaction,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsDifferentTableCorrelationNames
Determines whether table correlation names are required to be different from the names of the tables, when they are supported.- Returns:
trueif correlation names must be different from table names,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsExpressionsInOrderBy
Determines whether expressions inORDER BYlists are supported.- Returns:
trueif expressions inORDER BYlists are supported.- Throws:
SQLException- a database error occurred.
-
supportsExtendedSQLGrammar
Determines whether the Extended SQL Grammar for ODBC is supported.- Returns:
trueif the Extended SQL Grammar is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsFullOuterJoins
Determines whether the database supports full nested outer joins.- Returns:
trueif full nested outer joins are supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsGetGeneratedKeys
Determines whether auto generated keys can be returned when a statement executes.- Returns:
trueif auto generated keys can be returned,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsGroupBy
Determines whether the database supportsGROUP BYclauses.- Returns:
trueif theGROUP BYclause is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsGroupByBeyondSelect
Determines whether the database supports using a column name in aGROUP BYclause not included in theSELECTstatement as long as all of the columns in theSELECTstatement are used in theGROUP BYclause.- Returns:
trueifGROUP BYclauses can use column names in this way,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsIntegrityEnhancementFacility
Determines whether the database supports SQL Integrity Enhancement Facility.- Returns:
trueif the Integrity Enhancement Facility is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsLikeEscapeClause
Determines whether the database supports aLIKEescape clause.- Returns:
trueif LIKE escape clause is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsLimitedOuterJoins
Determines whether the database provides limited support for outer join operations.- Returns:
trueif there is limited support for outer join operations,falseotherwise. This will betrueifsupportsFullOuterJoinsreturnstrue.- Throws:
SQLException- a database error occurred.
-
supportsMinimumSQLGrammar
Determines whether the database supports Minimum SQL Grammar for ODBC.- Returns:
trueif the Minimum SQL Grammar is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsMixedCaseIdentifiers
Determines whether the database treats mixed case unquoted SQL identifiers as case sensitive storing them in mixed case.- Returns:
trueif unquoted SQL identifiers are stored in mixed case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsMixedCaseQuotedIdentifiers
Determines whether the database considers mixed case quoted SQL identifiers as case sensitive, storing them in mixed case.- Returns:
trueif quoted SQL identifiers are stored in mixed case,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsMultipleOpenResults
Determines whether it is possible for a singleCallableStatementto return multipleResultSets simultaneously.- Returns:
trueif a singleCallableStatementcan return multipleResultSets simultaneously,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsMultipleResultSets
Determines whether retrieving multipleResultSets from a single call to theexecutemethod is supported.- Returns:
trueif multipleResultSets can be retrieved,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsMultipleTransactions
Determines whether multiple simultaneous transactions on different connections are supported.- Returns:
trueif multiple open transactions are supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsNamedParameters
Determines whether callable statements with named parameters is supported.- Returns:
trueif named parameters can be used with callable statements,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsNonNullableColumns
Determines whether columns in the database can be defined as non-nullable.- Returns:
trueif columns can be defined non-nullable,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsOpenCursorsAcrossCommit
Determines whether keeping cursors open across commit operations is supported.- Returns:
trueif cursors can be kept open across commit operations,falseif they might get closed.- Throws:
SQLException- a database error occurred.
-
supportsOpenCursorsAcrossRollback
Determines whether the database can keep cursors open across rollback operations.- Returns:
trueif cursors can be kept open across rollback operations,falseif they might get closed.- Throws:
SQLException- a database error occurred.
-
supportsOpenStatementsAcrossCommit
Determines whether keeping statements open across commit operations is supported.- Returns:
trueif statements can be kept open,falseif they might not.- Throws:
SQLException- a database error occurred.
-
supportsOpenStatementsAcrossRollback
Determines whether keeping statements open across rollback operations is supported.- Returns:
trueif statements can be kept open,falseif they might not.- Throws:
SQLException- a database error occurred.
-
supportsOuterJoins
Determines whether outer join operations are supported.- Returns:
trueif outer join operations are supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsPositionedDelete
Determines whether positionedDELETEstatements are supported.- Returns:
trueif the database supports positionedDELETEstatements.- Throws:
SQLException- a database error occurred.
-
supportsPositionedUpdate
Determines whether positionedUPDATEstatements are supported.- Returns:
trueif the database supports positionedUPDATEstatements,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsResultSetConcurrency
Determines whether there is support for a given concurrency style for the givenResultSet.- Parameters:
type- theResultSettype, as defined injava.sql.ResultSet:ResultSet.TYPE_FORWARD_ONLYResultSet.TYPE_SCROLL_INSENSITIVEResultSet.TYPE_SCROLL_SENSITIVE
concurrency- a concurrency type, which may be one ofResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE.- Returns:
trueif that concurrency andResultSettype pairing is supported otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsResultSetHoldability
Determines whether the suppliedResultSetholdability mode is supported.- Parameters:
holdability- as specified injava.sql.ResultSet:ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
trueif the given ResultSet holdability is supported and if it isn't thenfalse.- Throws:
SQLException- a database error occurred.
-
supportsResultSetType
Determines whether the suppliedResultSettype is supported.- Parameters:
type- theResultSettype as defined injava.sql.ResultSet:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
trueif theResultSettype is supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsSavepoints
Determines whether savepoints for transactions are supported.- Returns:
trueif savepoints are supported,falseotherwise.- Throws:
SQLException- a database error occurred.
-
supportsSchemasInDataManipulation
Determines whether a schema name may be used in a data manipulation statement.- Returns:
trueif a schema name can be used in a data manipulation, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsSchemasInIndexDefinitions
Determines whether a schema name may be used in an index definition statement.- Returns:
trueif a schema name can be used in an index definition, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsSchemasInPrivilegeDefinitions
Determines whether a database schema name can be used in a privilege definition statement.- Returns:
trueif a database schema name may be used in a privilege definition, otherwisefalse- Throws:
SQLException- a database error occurred.
-
supportsSchemasInProcedureCalls
Determines whether a procedure call statement may be contain in a schema name.- Returns:
trueif a schema name can be used in a procedure call, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsSchemasInTableDefinitions
Determines whether a schema name can be used in a table definition statement.- Returns:
trueif a schema name can be used in a table definition, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsSelectForUpdate
Determines whether theSELECT FOR UPDATEstatement is supported.- Returns:
trueifSELECT FOR UPDATEstatements are supported, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsStatementPooling
Determines whether statement pooling is supported.- Returns:
trueof the database does support statement pooling, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsStoredProcedures
Determines whether stored procedure calls using the stored procedure escape syntax is supported.- Returns:
trueif stored procedure calls using the stored procedure escape syntax are supported, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsSubqueriesInComparisons
Determines whether subqueries in comparison expressions are supported.- Returns:
trueif subqueries are supported in comparison expressions.- Throws:
SQLException- a database error occurred.
-
supportsSubqueriesInExists
Determines whether subqueries inEXISTSexpressions are supported.- Returns:
trueif subqueries are supported inEXISTSexpressions, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsSubqueriesInIns
Determines whether subqueries inINstatements are supported.- Returns:
trueif subqueries are supported inINstatements, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsSubqueriesInQuantifieds
Determines whether subqueries in quantified expressions are supported.- Returns:
trueif subqueries are supported, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsTableCorrelationNames
Determines whether the database has table correlation names support.- Returns:
trueif table correlation names are supported, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsTransactionIsolationLevel
Determines whether a specified transaction isolation level is supported.- Parameters:
level- the transaction isolation level, as specified injava.sql.Connection:TRANSACTION_NONE,TRANSACTION_READ_COMMITTED,TRANSACTION_READ_UNCOMMITTED,TRANSACTION_REPEATABLE_READ,TRANSACTION_SERIALIZABLE- Returns:
trueif the specific isolation level is supported, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsTransactions
Determines whether transactions are supported.If transactions are not supported, then the
commitmethod does nothing and the transaction isolation level is alwaysTRANSACTION_NONE.- Returns:
trueif transactions are supported, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsUnion
Determines whether theSQL UNIONoperation is supported.- Returns:
trueof the database does supportUNION, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
supportsUnionAll
Determines whether theSQL UNION ALLoperation is supported.- Returns:
trueif the database does supportUNION ALL, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
updatesAreDetected
Determines whether the methodResultSet.rowUpdatedcan detect a visible row update for the specifiedResultSettype.- Parameters:
type-ResultSettype:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Returns:
truedetecting changes is possible, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
usesLocalFilePerTable
Determines whether this database uses a file for each table.- Returns:
trueif the database uses one file for each table, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
usesLocalFiles
Determines whether this database uses a local file to store tables.- Returns:
trueif the database stores tables in a local file, otherwisefalse.- Throws:
SQLException- a database error occurred.
-
autoCommitFailureClosesAllResultSets
Determine if a SQLException while autoCommit is true indicates that all open ResultSets are closed, even ones that are holdable- Returns:
- true if all open ResultSets are closed
- Throws:
SQLException- if any error occurs
-
getClientInfoProperties
Returns a list of the client info properties of the driver.- Returns:
- a list of the client info
- Throws:
SQLException- if any error occurs
-
getFunctionColumns
ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLExceptionReturns a description according to the given catalog's system or user function parameters and return type.- Parameters:
catalog- the given catalongschemaPattern- the schema patternfunctionNamePattern- the function name patterncolumnNamePattern- the column name pattern- Returns:
- a description of user functions
- Throws:
SQLException- if any error occurs
-
getFunctions
ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLExceptionReturns a description of the system and user functions available according to the given catalog.- Parameters:
catalog- the given catalogschemaPattern- the schema patternfunctionNamePattern- the function name pattern- Returns:
- user functions
- Throws:
SQLException- if any error occurs
-
getRowIdLifetime
Returns the lifetime for which a RowId object remains valid if this data source supports the SQL ROWID type- Returns:
- the time of a RowId object that remains valid.
- Throws:
SQLException- if any error occurs
-
getSchemas
Returns the schema names ordered by TABLE_CATALOG and TABLE_SCHEMA.- Parameters:
catalog- the catalogschemaPattern- the schema pattern- Returns:
- the schema names
- Throws:
SQLException- if any error occurs
-
supportsStoredFunctionsUsingCallSyntax
Determine if this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.- Returns:
- true if this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.
- Throws:
SQLException- if any error occurs
-