Package totalcross.sql
Interface DatabaseMetaData
-
public interface DatabaseMetaData
-
-
Field Summary
Fields Modifier and Type Field Description static shortattributeNoNullsA NULL value is not allowed for this attribute.static shortattributeNullableA NULL value is allowed for this attribute.static shortattributeNullableUnknownIt is unknown whether or not NULL values are allowed for this attribute.static intbestRowNotPseudoThe best row identifier is not a pseudo-column.static intbestRowPseudoThe best row identifier is a pseudo-column.static intbestRowSessionThe best row identifier is valid to the end of the session.static intbestRowTemporaryThe best row's scope is only guaranteed to be valid so long as the row is actually being used.static intbestRowTransactionThe best row identifier is valid to the end of the transaction.static intbestRowUnknownThe best row may or may not be a pseudo-column.static intcolumnNoNullsThe column does not allow NULLstatic intcolumnNullableThe column does allow NULLstatic intcolumnNullableUnknownIt is unknown whether or not the column allows NULLstatic intimportedKeyCascadeForeign key changes are cascaded in updates or deletes.static intimportedKeyInitiallyDeferredWish I knew what this meant.static intimportedKeyInitiallyImmediateWish I knew what this meant.static intimportedKeyNoActionIf the primary key is a foreign key, it cannot be udpated or deleted.static intimportedKeyNotDeferrableWish I knew what this meant.static intimportedKeyRestrictColumn may not be updated or deleted in use as a foreign key.static intimportedKeySetDefaultIf the primary key is updated or deleted, the foreign key is set to a default value.static intimportedKeySetNullWhen primary key is updated or deleted, the foreign key is set to NULL.static intprocedureColumnInstatic intprocedureColumnInOutstatic intprocedureColumnOutstatic intprocedureColumnResultstatic intprocedureColumnReturnstatic intprocedureColumnUnknownstatic intprocedureNoNullsstatic intprocedureNoResultstatic intprocedureNullablestatic intprocedureNullableUnknownstatic intprocedureResultUnknownstatic intprocedureReturnsResultstatic intsqlStateSQL99static intsqlStateXOpenstatic shorttableIndexClusteredThis table index is clustered.static shorttableIndexHashedThis table index is hashed.static shorttableIndexOtherThis table index is of another type.static shorttableIndexStatisticThis column contains table statistics.static inttypeNoNullsA NULL value is not allowed for this data type.static inttypeNullableA NULL value is allowed for this data type.static inttypeNullableUnknownIt is unknown whether or not NULL values are allowed for this data type.static inttypePredBasicAll WHERE clauses except "WHERE..LIKE" style are allowed on this data type.static inttypePredCharOnly "WHERE..LIKE" style WHERE clauses are allowed on this data type.static inttypePredNoneWhere clauses are not supported for this type.static inttypeSearchableAny type of WHERE clause is allowed for this data type.static intversionColumnNotPseudoThe version column is not a pseudo-columnstatic intversionColumnPseudoThe version column is a pseudo-columnstatic intversionColumnUnknownIt is unknown whether or not the version column is a pseudo-column.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanallProceduresAreCallable()This method tests whether or not all the procedures returned by thegetProceduresmethod can be called by this user.booleanallTablesAreSelectable()This method tests whether or not all the table returned by thegetTablesmethod can be selected by this user.booleandataDefinitionCausesTransactionCommit()This method tests whether or not a DDL statement will cause the current transaction to be automatically committed.booleandataDefinitionIgnoredInTransactions()This method tests whether or not DDL statements are ignored in transactions.booleandeletesAreDetected(int type)This method tests whether or not the specified result set type can detect a visible delete by calling therowUpdatedmethod.booleandoesMaxRowSizeIncludeBlobs()This method tests whether or not the maximum row size includes BLOB'sResultSetgetAttributes(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typePattern, java.lang.String attributePattern)ResultSetgetBestRowIdentifier(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, int scope, boolean nullable)This method returns the best set of columns for uniquely identifying a row.ResultSetgetCatalogs()This method returns the list of database catalogs as aResultSetwith one column - TABLE_CAT - that is the name of the catalog.java.lang.StringgetCatalogSeparator()This method returns the separator between the catalog name and the table name.java.lang.StringgetCatalogTerm()This method returns the vendor's term for "catalog".ResultSetgetColumnPrivileges(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, java.lang.String columnPattern)This method returns the access rights that have been granted to the requested columns.ResultSetgetColumns(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern, java.lang.String columnPattern)This method returns a list of the tables columns for the requested tables.ConnectiongetConnection()This method returns theConnectionobject that was used to generate the metadata in this object.ResultSetgetCrossReference(java.lang.String primaryCatalog, java.lang.String primarySchema, java.lang.String primaryTableName, java.lang.String foreignCatalog, java.lang.String foreignSchema, java.lang.String foreignTableName)This method returns a description of how one table imports another table's primary key as a foreign key.intgetDatabaseMajorVersion()This method returns the major version number of the database.intgetDatabaseMinorVersion()This method returns the minor version number of the database.java.lang.StringgetDatabaseProductName()This method returns the name of the database product.java.lang.StringgetDatabaseProductVersion()This method returns the version of the database product.intgetDefaultTransactionIsolation()This method returns the default transaction isolation level of the database.intgetDriverMajorVersion()This method returns the major version number of the JDBC driver.intgetDriverMinorVersion()This method returns the minor version number of the JDBC driver.java.lang.StringgetDriverName()This method returns the name of the JDBC driver.java.lang.StringgetDriverVersion()This method returns the version of the JDBC driver.ResultSetgetExportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.String tableName)This method returns a list of the table's which use this table's primary key as a foreign key.java.lang.StringgetExtraNameCharacters()This methods returns non-standard characters that can appear in unquoted identifiers.java.lang.StringgetIdentifierQuoteString()This metohd returns the quote string for SQL identifiers.ResultSetgetImportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.String tableName)This method returns a list of the table's foreign keys.ResultSetgetIndexInfo(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, boolean unique, boolean approximate)This method returns information about a tables indices and statistics.intgetJDBCMajorVersion()This method returns the major version number of the JDBC driver.intgetJDBCMinorVersion()This method returns the minor version number of the JDBC driver.intgetMaxBinaryLiteralLength()This method returns the number of hex characters allowed in an inline binary literal.intgetMaxCatalogNameLength()This method returns the maximum length of a catalog name.intgetMaxCharLiteralLength()This method returns the maximum length of a character literal.intgetMaxColumnNameLength()This method returns the maximum length of a column name.intgetMaxColumnsInGroupBy()This method returns the maximum number of columns in a GROUP BY statement.intgetMaxColumnsInIndex()This method returns the maximum number of columns in an index.intgetMaxColumnsInOrderBy()This method returns the maximum number of columns in an ORDER BY statement.intgetMaxColumnsInSelect()This method returns the maximum number of columns in a SELECT statement.intgetMaxColumnsInTable()This method returns the maximum number of columns in a table.intgetMaxConnections()This method returns the maximum number of connections this client can have to the database.intgetMaxCursorNameLength()This method returns the maximum length of a cursor name.intgetMaxIndexLength()This method returns the maximum length of an index.intgetMaxProcedureNameLength()This method returns the maximum length of a procedure name.intgetMaxRowSize()This method returns the maximum size of a row in bytes.intgetMaxSchemaNameLength()This method returns the maximum length of a schema name.intgetMaxStatementLength()This method includes the maximum length of a SQL statement.intgetMaxStatements()This method returns the maximum number of statements that can be active at any time.intgetMaxTableNameLength()This method returns the maximum length of a table name.intgetMaxTablesInSelect()This method returns the maximum number of tables that may be referenced in a SELECT statement.intgetMaxUserNameLength()This method returns the maximum length of a user name.java.lang.StringgetNumericFunctions()This method returns a comma separated list of math functions.ResultSetgetPrimaryKeys(java.lang.String catalog, java.lang.String schema, java.lang.String tableName)This method returns a list of a table's primary key columns.ResultSetgetProcedureColumns(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedurePattern, java.lang.String columnPattern)This method returns a list of the parameter and result columns for the requested stored procedures.ResultSetgetProcedures(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedurePattern)This method returns a list of all the stored procedures matching the specified pattern in the given schema and catalog.java.lang.StringgetProcedureTerm()This method returns the vendor's term for "procedure".intgetResultSetHoldability()This method returns the default holdability type ofResultSetS retrieved from this database.ResultSetgetSchemas()This method returns the list of database schemas as aResultSet, with one column - TABLE_SCHEM - that is the name of the schema.java.lang.StringgetSchemaTerm()This method returns the vendor's term for "schema".java.lang.StringgetSearchStringEscape()This method returns the string used to escape wildcards in search strings.java.lang.StringgetSQLKeywords()This method returns a comma separated list of all the SQL keywords in the database that are not in SQL92.intgetSQLStateType()java.lang.StringgetStringFunctions()This method returns a comma separated list of string functions.ResultSetgetSuperTables(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern)ResultSetgetSuperTypes(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typePattern)java.lang.StringgetSystemFunctions()This method returns a comma separated list of of system functions.ResultSetgetTablePrivileges(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern)This method returns the access rights that have been granted to the requested tables.ResultSetgetTables(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern, java.lang.String[] types)This method returns a list of the requested table as aResultSetwith the following columns: TABLE_CAT - The catalog the table is in, which may benull. TABLE_SCHEM - The schema the table is in, which may benull. TABLE_NAME - The name of the table. TABLE_TYPE - A string describing the table type.ResultSetgetTableTypes()This method returns the list of database table types as aResultSetwith one column - TABLE_TYPE - that is the name of the table type.java.lang.StringgetTimeDateFunctions()This method returns comma separated list of time/date functions.ResultSetgetTypeInfo()This method returns a list of the SQL types supported by this database.ResultSetgetUDTs(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typePattern, int[] types)This method returns the list of user defined data types in use.java.lang.StringgetURL()This method returns the URL for this database.java.lang.StringgetUserName()This method returns the database username for this connection.ResultSetgetVersionColumns(java.lang.String catalog, java.lang.String schema, java.lang.String tableName)This method returns the set of columns that are automatically updated when the row is update.booleaninsertsAreDetected(int type)This method tests whether or not the specified result set type can detect a visible insert by calling therowUpdatedmethod.booleanisCatalogAtStart()This method tests whether a catalog name appears at the beginning of a fully qualified table name.booleanisReadOnly()This method tests whether or not the database is in read only mode.booleanlocatorsUpdateCopy()booleannullPlusNonNullIsNull()This method tests whether the concatenation of a NULL and non-NULL value results in a NULL.booleannullsAreSortedAtEnd()This method test whether or not NULL's are sorted to the end of the list regardless of ascending or descending sort order.booleannullsAreSortedAtStart()This method tests whether or not NULL's sort as high values.booleannullsAreSortedHigh()This method tests whether or not NULL's sort as high values.booleannullsAreSortedLow()This method tests whether or not NULL's sort as low values.booleanothersDeletesAreVisible(int type)This method tests whether or not the specified result set type sees deletes committed by others.booleanothersInsertsAreVisible(int type)This method tests whether or not the specified result set type sees inserts committed by others.booleanothersUpdatesAreVisible(int type)This method tests whether or not the specified result set type sees updates committed by others.booleanownDeletesAreVisible(int type)This method tests whether or not the specified result set type sees its own deletes.booleanownInsertsAreVisible(int type)This method tests whether or not the specified result set type sees its own inserts.booleanownUpdatesAreVisible(int type)This method tests whether or not the specified result set type sees its own updates.booleanstoresLowerCaseIdentifiers()This method tests whether or not the database treats mixed case identifiers as all lower case.booleanstoresLowerCaseQuotedIdentifiers()This method tests whether or not the database treats mixed case quoted identifiers as all lower case.booleanstoresMixedCaseIdentifiers()This method tests whether or not the database stores mixed case identifers even if it treats them as case insensitive.booleanstoresMixedCaseQuotedIdentifiers()This method tests whether or not the database stores mixed case quoted identifers even if it treats them as case insensitive.booleanstoresUpperCaseIdentifiers()This method tests whether or not the database treats mixed case identifiers as all upper case.booleanstoresUpperCaseQuotedIdentifiers()This method tests whether or not the database treats mixed case quoted identifiers as all upper case.booleansupportsAlterTableWithAddColumn()This method tests whether or not the database supports "ALTER TABLE ADD COLUMN"booleansupportsAlterTableWithDropColumn()This method tests whether or not the database supports "ALTER TABLE DROP COLUMN"booleansupportsANSI92EntryLevelSQL()This method tests whether or not the ANSI92 entry level SQL grammar is supported.booleansupportsANSI92FullSQL()This method tests whether or not the ANSI92 full SQL grammar is supported.booleansupportsANSI92IntermediateSQL()This method tests whether or not the ANSI92 intermediate SQL grammar is supported.booleansupportsBatchUpdates()This method tests whether or not the database supports batch updates.booleansupportsCatalogsInDataManipulation()This method tests whether a catalog name can appear in a data manipulation statement.booleansupportsCatalogsInIndexDefinitions()This method tests whether a catalog name can appear in an index definition.booleansupportsCatalogsInPrivilegeDefinitions()This method tests whether a catalog name can appear in privilege definitions.booleansupportsCatalogsInProcedureCalls()This method tests whether a catalog name can appear in a procedure callbooleansupportsCatalogsInTableDefinitions()This method tests whether a catalog name can appear in a table definition.booleansupportsColumnAliasing()This method tests whether or not column aliasing is supported.booleansupportsConvert()Tests whether or not CONVERT is supported.booleansupportsConvert(int fromType, int toType)This method tests whether or not CONVERT can be performed between the specified types.booleansupportsCoreSQLGrammar()This method tests whether or not the core grammer for ODBC is supported.booleansupportsCorrelatedSubqueries()This method test whether or not correlated subqueries are allowed.booleansupportsDataDefinitionAndDataManipulationTransactions()This method tests whether or not DDL and DML statements allowed within the same transaction.booleansupportsDataManipulationTransactionsOnly()This method tests whether or not only DML statement are allowed inside a transaction.booleansupportsDifferentTableCorrelationNames()This method tests whether correlation names must be different from the name of the table.booleansupportsExpressionsInOrderBy()This method tests whether or not expressions are allowed in an ORDER BY lists.booleansupportsExtendedSQLGrammar()This method tests whether or not the extended grammer for ODBC is supported.booleansupportsFullOuterJoins()This method tests whether or not the database supports full outer joins.booleansupportsGetGeneratedKeys()booleansupportsGroupBy()This method tests whether or not GROUP BY is supported.booleansupportsGroupByBeyondSelect()This method tests whether or not a GROUP BY can add columns not in the select if it includes all the columns in the select.booleansupportsGroupByUnrelated()This method tests whether GROUP BY on a non-selected column is allowed.booleansupportsIntegrityEnhancementFacility()This method tests whether or not the SQL integrity enhancement facility is supported.booleansupportsLikeEscapeClause()This method tests whether or not the escape character is supported in LIKE expressions.booleansupportsLimitedOuterJoins()This method tests whether or not the database supports limited outer joins.booleansupportsMinimumSQLGrammar()This method tests whether or not the minimum grammer for ODBC is supported.booleansupportsMixedCaseIdentifiers()This method tests whether or not the database supports identifiers with mixed case.booleansupportsMixedCaseQuotedIdentifiers()This method tests whether or not the database supports quoted identifiers with mixed case.booleansupportsMultipleOpenResults()This method tests whether the database supports returning multipleResultSetS from aCallableStatementat once.booleansupportsMultipleResultSets()This method tests whether multiple result sets for a single statement are supported.booleansupportsMultipleTransactions()This method test whether or not multiple transactions may be open at once, as long as they are on different connections.booleansupportsNamedParameters()This method tests whether the database supports named parameters.booleansupportsNonNullableColumns()This method tests whether or not columns can be defined as NOT NULL.booleansupportsOpenCursorsAcrossCommit()This method tests whether or not the database supports cursors remaining open across commits.booleansupportsOpenCursorsAcrossRollback()This method tests whether or not the database supports cursors remaining open across rollbacks.booleansupportsOpenStatementsAcrossCommit()This method tests whether or not the database supports statements remaining open across commits.booleansupportsOpenStatementsAcrossRollback()This method tests whether or not the database supports statements remaining open across rollbacks.booleansupportsOrderByUnrelated()This method tests whether or ORDER BY on a non-selected column is allowed.booleansupportsOuterJoins()This method tests whether or not the database supports outer joins.booleansupportsPositionedDelete()This method tests whether or not that database supports positioned deletes.booleansupportsPositionedUpdate()This method tests whether or not that database supports positioned updates.booleansupportsResultSetConcurrency(int type, int concurrency)This method tests whether the specified result set type and result set concurrency type are supported by the database.booleansupportsResultSetHoldability(int holdability)This method tests if the database supports the specified holdability type.booleansupportsResultSetType(int type)This method tests whether or not the datbase supports the specified result type.booleansupportsSavepoints()This method tests whether the databse supports savepoints.booleansupportsSchemasInDataManipulation()This method tests whether a catalog name can appear in a data manipulation statement.booleansupportsSchemasInIndexDefinitions()This method tests whether a catalog name can appear in an index definition.booleansupportsSchemasInPrivilegeDefinitions()This method tests whether a catalog name can appear in privilege definitions.booleansupportsSchemasInProcedureCalls()This method tests whether a catalog name can appear in a procedure callbooleansupportsSchemasInTableDefinitions()This method tests whether a catalog name can appear in a table definition.booleansupportsSelectForUpdate()This method tests whether or not SELECT FOR UPDATE is supported by the database.booleansupportsStatementPooling()booleansupportsStoredProcedures()This method tests whether or not stored procedures are supported on this database.booleansupportsSubqueriesInComparisons()This method tests whether or not subqueries are allowed in comparisons.booleansupportsSubqueriesInExists()This method tests whether or not subqueries are allowed in exists expressions.booleansupportsSubqueriesInIns()This method tests whether subqueries are allowed in IN statements.booleansupportsSubqueriesInQuantifieds()This method tests whether or not subqueries are allowed in quantified expressions.booleansupportsTableCorrelationNames()This method tests whether or not table correlation names are supported.booleansupportsTransactionIsolationLevel(int level)This method tests whether or not the database supports the specified transaction isolation level.booleansupportsTransactions()This method tests whether or not the database supports transactions.booleansupportsUnion()This method tests whether or not the UNION statement is supported.booleansupportsUnionAll()This method tests whether or not the UNION ALL statement is supported.booleanupdatesAreDetected(int type)This method tests whether or not the specified result set type can detect a visible update by calling therowUpdatedmethod.booleanusesLocalFilePerTable()This method tests whether or not the database uses a separate file for each table.booleanusesLocalFiles()This method tests whether or not the database uses local files to store tables.
-
-
-
Field Detail
-
procedureResultUnknown
static final int procedureResultUnknown
- See Also:
- Constant Field Values
-
procedureNoResult
static final int procedureNoResult
- See Also:
- Constant Field Values
-
procedureReturnsResult
static final int procedureReturnsResult
- See Also:
- Constant Field Values
-
procedureColumnUnknown
static final int procedureColumnUnknown
- See Also:
- Constant Field Values
-
procedureColumnIn
static final int procedureColumnIn
- See Also:
- Constant Field Values
-
procedureColumnInOut
static final int procedureColumnInOut
- See Also:
- Constant Field Values
-
procedureColumnOut
static final int procedureColumnOut
- See Also:
- Constant Field Values
-
procedureColumnReturn
static final int procedureColumnReturn
- See Also:
- Constant Field Values
-
procedureColumnResult
static final int procedureColumnResult
- See Also:
- Constant Field Values
-
procedureNoNulls
static final int procedureNoNulls
- See Also:
- Constant Field Values
-
procedureNullable
static final int procedureNullable
- See Also:
- Constant Field Values
-
procedureNullableUnknown
static final int procedureNullableUnknown
- See Also:
- Constant Field Values
-
columnNoNulls
static final int columnNoNulls
The column does not allow NULL- See Also:
- Constant Field Values
-
columnNullable
static final int columnNullable
The column does allow NULL- See Also:
- Constant Field Values
-
columnNullableUnknown
static final int columnNullableUnknown
It is unknown whether or not the column allows NULL- See Also:
- Constant Field Values
-
bestRowTemporary
static final int bestRowTemporary
The best row's scope is only guaranteed to be valid so long as the row is actually being used.- See Also:
- Constant Field Values
-
bestRowTransaction
static final int bestRowTransaction
The best row identifier is valid to the end of the transaction.- See Also:
- Constant Field Values
-
bestRowSession
static final int bestRowSession
The best row identifier is valid to the end of the session.- See Also:
- Constant Field Values
-
bestRowUnknown
static final int bestRowUnknown
The best row may or may not be a pseudo-column.- See Also:
- Constant Field Values
-
bestRowNotPseudo
static final int bestRowNotPseudo
The best row identifier is not a pseudo-column.- See Also:
- Constant Field Values
-
bestRowPseudo
static final int bestRowPseudo
The best row identifier is a pseudo-column.- See Also:
- Constant Field Values
-
versionColumnUnknown
static final int versionColumnUnknown
It is unknown whether or not the version column is a pseudo-column.- See Also:
- Constant Field Values
-
versionColumnNotPseudo
static final int versionColumnNotPseudo
The version column is not a pseudo-column- See Also:
- Constant Field Values
-
versionColumnPseudo
static final int versionColumnPseudo
The version column is a pseudo-column- See Also:
- Constant Field Values
-
importedKeyCascade
static final int importedKeyCascade
Foreign key changes are cascaded in updates or deletes.- See Also:
- Constant Field Values
-
importedKeyRestrict
static final int importedKeyRestrict
Column may not be updated or deleted in use as a foreign key.- See Also:
- Constant Field Values
-
importedKeySetNull
static final int importedKeySetNull
When primary key is updated or deleted, the foreign key is set to NULL.- See Also:
- Constant Field Values
-
importedKeyNoAction
static final int importedKeyNoAction
If the primary key is a foreign key, it cannot be udpated or deleted.- See Also:
- Constant Field Values
-
importedKeySetDefault
static final int importedKeySetDefault
If the primary key is updated or deleted, the foreign key is set to a default value.- See Also:
- Constant Field Values
-
importedKeyInitiallyDeferred
static final int importedKeyInitiallyDeferred
Wish I knew what this meant.- See Also:
- Constant Field Values
-
importedKeyInitiallyImmediate
static final int importedKeyInitiallyImmediate
Wish I knew what this meant.- See Also:
- Constant Field Values
-
importedKeyNotDeferrable
static final int importedKeyNotDeferrable
Wish I knew what this meant.- See Also:
- Constant Field Values
-
typeNoNulls
static final int typeNoNulls
A NULL value is not allowed for this data type.- See Also:
- Constant Field Values
-
typeNullable
static final int typeNullable
A NULL value is allowed for this data type.- See Also:
- Constant Field Values
-
typeNullableUnknown
static final int typeNullableUnknown
It is unknown whether or not NULL values are allowed for this data type.- See Also:
- Constant Field Values
-
typePredNone
static final int typePredNone
Where clauses are not supported for this type.- See Also:
- Constant Field Values
-
typePredChar
static final int typePredChar
Only "WHERE..LIKE" style WHERE clauses are allowed on this data type.- See Also:
- Constant Field Values
-
typePredBasic
static final int typePredBasic
All WHERE clauses except "WHERE..LIKE" style are allowed on this data type.- See Also:
- Constant Field Values
-
typeSearchable
static final int typeSearchable
Any type of WHERE clause is allowed for this data type.- See Also:
- Constant Field Values
-
tableIndexStatistic
static final short tableIndexStatistic
This column contains table statistics.- See Also:
- Constant Field Values
-
tableIndexClustered
static final short tableIndexClustered
This table index is clustered.- See Also:
- Constant Field Values
-
tableIndexHashed
static final short tableIndexHashed
This table index is hashed.- See Also:
- Constant Field Values
-
tableIndexOther
static final short tableIndexOther
This table index is of another type.- See Also:
- Constant Field Values
-
attributeNoNulls
static final short attributeNoNulls
A NULL value is not allowed for this attribute.- See Also:
- Constant Field Values
-
attributeNullable
static final short attributeNullable
A NULL value is allowed for this attribute.- See Also:
- Constant Field Values
-
attributeNullableUnknown
static final short attributeNullableUnknown
It is unknown whether or not NULL values are allowed for this attribute.- See Also:
- Constant Field Values
-
sqlStateXOpen
static final int sqlStateXOpen
- See Also:
- Constant Field Values
-
sqlStateSQL99
static final int sqlStateSQL99
- See Also:
- Constant Field Values
-
-
Method Detail
-
allProceduresAreCallable
boolean allProceduresAreCallable() throws java.sql.SQLExceptionThis method tests whether or not all the procedures returned by thegetProceduresmethod can be called by this user.- Returns:
trueif all the procedures can be called,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
allTablesAreSelectable
boolean allTablesAreSelectable() throws java.sql.SQLExceptionThis method tests whether or not all the table returned by thegetTablesmethod can be selected by this user.- Returns:
trueif all the procedures can be called,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getURL
java.lang.String getURL() throws java.sql.SQLExceptionThis method returns the URL for this database.- Returns:
- The URL string for this database, or
nullif it is not known. - Throws:
java.sql.SQLException- If an error occurs.
-
getUserName
java.lang.String getUserName() throws java.sql.SQLExceptionThis method returns the database username for this connection.- Returns:
- The database username.
- Throws:
java.sql.SQLException- If an error occurs.
-
isReadOnly
boolean isReadOnly() throws java.sql.SQLExceptionThis method tests whether or not the database is in read only mode.- Returns:
trueif the database is in read only mode,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
nullsAreSortedHigh
boolean nullsAreSortedHigh() throws java.sql.SQLExceptionThis method tests whether or not NULL's sort as high values.- Returns:
trueif NULL's sort as high values,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
nullsAreSortedLow
boolean nullsAreSortedLow() throws java.sql.SQLExceptionThis method tests whether or not NULL's sort as low values.- Returns:
trueif NULL's sort as low values,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
nullsAreSortedAtStart
boolean nullsAreSortedAtStart() throws java.sql.SQLExceptionThis method tests whether or not NULL's sort as high values.- Returns:
trueif NULL's sort as high values,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
nullsAreSortedAtEnd
boolean nullsAreSortedAtEnd() throws java.sql.SQLExceptionThis method test whether or not NULL's are sorted to the end of the list regardless of ascending or descending sort order.- Returns:
trueif NULL's always sort to the end,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getDatabaseProductName
java.lang.String getDatabaseProductName() throws java.sql.SQLExceptionThis method returns the name of the database product.- Returns:
- The database product.
- Throws:
java.sql.SQLException- If an error occurs.
-
getDatabaseProductVersion
java.lang.String getDatabaseProductVersion() throws java.sql.SQLExceptionThis method returns the version of the database product.- Returns:
- The version of the database product.
- Throws:
java.sql.SQLException- If an error occurs.
-
getDriverName
java.lang.String getDriverName() throws java.sql.SQLExceptionThis method returns the name of the JDBC driver.- Returns:
- The name of the JDBC driver.
- Throws:
java.sql.SQLException- If an error occurs.
-
getDriverVersion
java.lang.String getDriverVersion() throws java.sql.SQLExceptionThis method returns the version of the JDBC driver.- Returns:
- The version of the JDBC driver.
- Throws:
java.sql.SQLException- If an error occurs.
-
getDriverMajorVersion
int getDriverMajorVersion()
This method returns the major version number of the JDBC driver.- Returns:
- The major version number of the JDBC driver.
-
getDriverMinorVersion
int getDriverMinorVersion()
This method returns the minor version number of the JDBC driver.- Returns:
- The minor version number of the JDBC driver.
-
usesLocalFiles
boolean usesLocalFiles() throws java.sql.SQLExceptionThis method tests whether or not the database uses local files to store tables.- Returns:
trueif the database uses local files,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
usesLocalFilePerTable
boolean usesLocalFilePerTable() throws java.sql.SQLExceptionThis method tests whether or not the database uses a separate file for each table.- Returns:
trueif the database uses a separate file for each tablefalseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsMixedCaseIdentifiers
boolean supportsMixedCaseIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database supports identifiers with mixed case.- Returns:
trueif the database supports mixed case identifiers,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
storesUpperCaseIdentifiers
boolean storesUpperCaseIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database treats mixed case identifiers as all upper case.- Returns:
trueif the database treats all identifiers as upper case,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
storesLowerCaseIdentifiers
boolean storesLowerCaseIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database treats mixed case identifiers as all lower case.- Returns:
trueif the database treats all identifiers as lower case,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
storesMixedCaseIdentifiers
boolean storesMixedCaseIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database stores mixed case identifers even if it treats them as case insensitive.- Returns:
trueif the database stores mixed case identifiers,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsMixedCaseQuotedIdentifiers
boolean supportsMixedCaseQuotedIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database supports quoted identifiers with mixed case.- Returns:
trueif the database supports mixed case quoted identifiers,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
storesUpperCaseQuotedIdentifiers
boolean storesUpperCaseQuotedIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database treats mixed case quoted identifiers as all upper case.- Returns:
trueif the database treats all quoted identifiers as upper case,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
storesLowerCaseQuotedIdentifiers
boolean storesLowerCaseQuotedIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database treats mixed case quoted identifiers as all lower case.- Returns:
trueif the database treats all quoted identifiers as lower case,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
storesMixedCaseQuotedIdentifiers
boolean storesMixedCaseQuotedIdentifiers() throws java.sql.SQLExceptionThis method tests whether or not the database stores mixed case quoted identifers even if it treats them as case insensitive.- Returns:
trueif the database stores mixed case quoted identifiers,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getIdentifierQuoteString
java.lang.String getIdentifierQuoteString() throws java.sql.SQLExceptionThis metohd returns the quote string for SQL identifiers.- Returns:
- The quote string for SQL identifers, or a space if quoting is not supported.
- Throws:
java.sql.SQLException- If an error occurs.
-
getSQLKeywords
java.lang.String getSQLKeywords() throws java.sql.SQLExceptionThis method returns a comma separated list of all the SQL keywords in the database that are not in SQL92.- Returns:
- The list of SQL keywords not in SQL92.
- Throws:
java.sql.SQLException- If an error occurs.
-
getNumericFunctions
java.lang.String getNumericFunctions() throws java.sql.SQLExceptionThis method returns a comma separated list of math functions.- Returns:
- The list of math functions.
- Throws:
java.sql.SQLException- If an error occurs.
-
getStringFunctions
java.lang.String getStringFunctions() throws java.sql.SQLExceptionThis method returns a comma separated list of string functions.- Returns:
- The list of string functions.
- Throws:
java.sql.SQLException- If an error occurs.
-
getSystemFunctions
java.lang.String getSystemFunctions() throws java.sql.SQLExceptionThis method returns a comma separated list of of system functions.- Returns:
- A comma separated list of system functions.
- Throws:
java.sql.SQLException- If an error occurs.
-
getTimeDateFunctions
java.lang.String getTimeDateFunctions() throws java.sql.SQLExceptionThis method returns comma separated list of time/date functions.- Returns:
- The list of time/date functions.
- Throws:
java.sql.SQLException- If an error occurs.
-
getSearchStringEscape
java.lang.String getSearchStringEscape() throws java.sql.SQLExceptionThis method returns the string used to escape wildcards in search strings.- Returns:
- The string used to escape wildcards in search strings.
- Throws:
java.sql.SQLException- If an error occurs.
-
getExtraNameCharacters
java.lang.String getExtraNameCharacters() throws java.sql.SQLExceptionThis methods returns non-standard characters that can appear in unquoted identifiers.- Returns:
- Non-standard characters that can appear in unquoted identifiers.
- Throws:
java.sql.SQLException- If an error occurs.
-
supportsAlterTableWithAddColumn
boolean supportsAlterTableWithAddColumn() throws java.sql.SQLExceptionThis method tests whether or not the database supports "ALTER TABLE ADD COLUMN"- Returns:
trueif column add supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsAlterTableWithDropColumn
boolean supportsAlterTableWithDropColumn() throws java.sql.SQLExceptionThis method tests whether or not the database supports "ALTER TABLE DROP COLUMN"- Returns:
trueif column drop supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsColumnAliasing
boolean supportsColumnAliasing() throws java.sql.SQLExceptionThis method tests whether or not column aliasing is supported.- Returns:
trueif column aliasing is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
nullPlusNonNullIsNull
boolean nullPlusNonNullIsNull() throws java.sql.SQLExceptionThis method tests whether the concatenation of a NULL and non-NULL value results in a NULL. This will always be true in fully JDBC compliant drivers.- Returns:
trueif concatenating NULL and a non-NULL value returns a NULL,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsConvert
boolean supportsConvert() throws java.sql.SQLExceptionTests whether or not CONVERT is supported.- Returns:
trueif CONVERT is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsConvert
boolean supportsConvert(int fromType, int toType) throws java.sql.SQLExceptionThis method tests whether or not CONVERT can be performed between the specified types. The types are contants fromTypes.- Parameters:
fromType- The SQL type to convert from.toType- The SQL type to convert to.- Returns:
trueif the conversion can be performed,falseotherwise.- Throws:
java.sql.SQLException- See Also:
Types
-
supportsTableCorrelationNames
boolean supportsTableCorrelationNames() throws java.sql.SQLExceptionThis method tests whether or not table correlation names are supported. This will be always betruein a fully JDBC compliant driver.- Returns:
trueif table correlation names are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsDifferentTableCorrelationNames
boolean supportsDifferentTableCorrelationNames() throws java.sql.SQLExceptionThis method tests whether correlation names must be different from the name of the table.- Returns:
trueif the correlation name must be different from the table name,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsExpressionsInOrderBy
boolean supportsExpressionsInOrderBy() throws java.sql.SQLExceptionThis method tests whether or not expressions are allowed in an ORDER BY lists.- Returns:
trueif expressions are allowed in ORDER BY lists,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsOrderByUnrelated
boolean supportsOrderByUnrelated() throws java.sql.SQLExceptionThis method tests whether or ORDER BY on a non-selected column is allowed.- Returns:
trueif a non-selected column can be used in an ORDER BY,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsGroupBy
boolean supportsGroupBy() throws java.sql.SQLExceptionThis method tests whether or not GROUP BY is supported.- Returns:
trueif GROUP BY is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsGroupByUnrelated
boolean supportsGroupByUnrelated() throws java.sql.SQLExceptionThis method tests whether GROUP BY on a non-selected column is allowed.- Returns:
trueif a non-selected column can be used in a GROUP BY,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsGroupByBeyondSelect
boolean supportsGroupByBeyondSelect() throws java.sql.SQLExceptionThis method tests whether or not a GROUP BY can add columns not in the select if it includes all the columns in the select.- Returns:
trueif GROUP BY an add columns provided it includes all columns in the select,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsLikeEscapeClause
boolean supportsLikeEscapeClause() throws java.sql.SQLExceptionThis method tests whether or not the escape character is supported in LIKE expressions. A fully JDBC compliant driver will always returntrue.- Returns:
trueif escapes are supported in LIKE expressions,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsMultipleResultSets
boolean supportsMultipleResultSets() throws java.sql.SQLExceptionThis method tests whether multiple result sets for a single statement are supported.- Returns:
trueif multiple result sets are supported for a single statement,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsMultipleTransactions
boolean supportsMultipleTransactions() throws java.sql.SQLExceptionThis method test whether or not multiple transactions may be open at once, as long as they are on different connections.- Returns:
trueif multiple transactions on different connections are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsNonNullableColumns
boolean supportsNonNullableColumns() throws java.sql.SQLExceptionThis method tests whether or not columns can be defined as NOT NULL. A fully JDBC compliant driver always returnstrue.- Returns:
trueif NOT NULL columns are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsMinimumSQLGrammar
boolean supportsMinimumSQLGrammar() throws java.sql.SQLExceptionThis method tests whether or not the minimum grammer for ODBC is supported. A fully JDBC compliant driver will always returntrue.- Returns:
trueif the ODBC minimum grammar is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsCoreSQLGrammar
boolean supportsCoreSQLGrammar() throws java.sql.SQLExceptionThis method tests whether or not the core grammer for ODBC is supported.- Returns:
trueif the ODBC core grammar is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsExtendedSQLGrammar
boolean supportsExtendedSQLGrammar() throws java.sql.SQLExceptionThis method tests whether or not the extended grammer for ODBC is supported.- Returns:
trueif the ODBC extended grammar is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsANSI92EntryLevelSQL
boolean supportsANSI92EntryLevelSQL() throws java.sql.SQLExceptionThis method tests whether or not the ANSI92 entry level SQL grammar is supported. A fully JDBC compliant drivers must returntrue.- Returns:
trueif the ANSI92 entry level SQL grammar is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsANSI92IntermediateSQL
boolean supportsANSI92IntermediateSQL() throws java.sql.SQLExceptionThis method tests whether or not the ANSI92 intermediate SQL grammar is supported.- Returns:
trueif the ANSI92 intermediate SQL grammar is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsANSI92FullSQL
boolean supportsANSI92FullSQL() throws java.sql.SQLExceptionThis method tests whether or not the ANSI92 full SQL grammar is supported.- Returns:
trueif the ANSI92 full SQL grammar is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsIntegrityEnhancementFacility
boolean supportsIntegrityEnhancementFacility() throws java.sql.SQLExceptionThis method tests whether or not the SQL integrity enhancement facility is supported.- Returns:
trueif the integrity enhancement facility is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsOuterJoins
boolean supportsOuterJoins() throws java.sql.SQLExceptionThis method tests whether or not the database supports outer joins.- Returns:
trueif outer joins are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsFullOuterJoins
boolean supportsFullOuterJoins() throws java.sql.SQLExceptionThis method tests whether or not the database supports full outer joins.- Returns:
trueif full outer joins are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsLimitedOuterJoins
boolean supportsLimitedOuterJoins() throws java.sql.SQLExceptionThis method tests whether or not the database supports limited outer joins.- Returns:
trueif limited outer joins are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getSchemaTerm
java.lang.String getSchemaTerm() throws java.sql.SQLExceptionThis method returns the vendor's term for "schema".- Returns:
- The vendor's term for schema.
- Throws:
java.sql.SQLException- if an error occurs.
-
getProcedureTerm
java.lang.String getProcedureTerm() throws java.sql.SQLExceptionThis method returns the vendor's term for "procedure".- Returns:
- The vendor's term for procedure.
- Throws:
java.sql.SQLException- if an error occurs.
-
getCatalogTerm
java.lang.String getCatalogTerm() throws java.sql.SQLExceptionThis method returns the vendor's term for "catalog".- Returns:
- The vendor's term for catalog.
- Throws:
java.sql.SQLException- if an error occurs.
-
isCatalogAtStart
boolean isCatalogAtStart() throws java.sql.SQLExceptionThis method tests whether a catalog name appears at the beginning of a fully qualified table name.- Returns:
trueif the catalog name appears at the beginning,falseif it appears at the end.- Throws:
java.sql.SQLException- If an error occurs.
-
getCatalogSeparator
java.lang.String getCatalogSeparator() throws java.sql.SQLExceptionThis method returns the separator between the catalog name and the table name.- Returns:
- The separator between the catalog name and the table name.
- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSchemasInDataManipulation
boolean supportsSchemasInDataManipulation() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in a data manipulation statement.- Returns:
trueif a catalog name can appear in a data manipulation statement,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSchemasInProcedureCalls
boolean supportsSchemasInProcedureCalls() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in a procedure call- Returns:
trueif a catalog name can appear in a procedure call,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSchemasInTableDefinitions
boolean supportsSchemasInTableDefinitions() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in a table definition.- Returns:
trueif a catalog name can appear in a table definition,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSchemasInIndexDefinitions
boolean supportsSchemasInIndexDefinitions() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in an index definition.- Returns:
trueif a catalog name can appear in an index definition,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSchemasInPrivilegeDefinitions
boolean supportsSchemasInPrivilegeDefinitions() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in privilege definitions.- Returns:
trueif a catalog name can appear in privilege definition,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsCatalogsInDataManipulation
boolean supportsCatalogsInDataManipulation() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in a data manipulation statement.- Returns:
trueif a catalog name can appear in a data manipulation statement,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsCatalogsInProcedureCalls
boolean supportsCatalogsInProcedureCalls() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in a procedure call- Returns:
trueif a catalog name can appear in a procedure call,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsCatalogsInTableDefinitions
boolean supportsCatalogsInTableDefinitions() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in a table definition.- Returns:
trueif a catalog name can appear in a table definition,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsCatalogsInIndexDefinitions
boolean supportsCatalogsInIndexDefinitions() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in an index definition.- Returns:
trueif a catalog name can appear in an index definition,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsCatalogsInPrivilegeDefinitions
boolean supportsCatalogsInPrivilegeDefinitions() throws java.sql.SQLExceptionThis method tests whether a catalog name can appear in privilege definitions.- Returns:
trueif a catalog name can appear in privilege definition,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsPositionedDelete
boolean supportsPositionedDelete() throws java.sql.SQLExceptionThis method tests whether or not that database supports positioned deletes.- Returns:
trueif positioned deletes are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsPositionedUpdate
boolean supportsPositionedUpdate() throws java.sql.SQLExceptionThis method tests whether or not that database supports positioned updates.- Returns:
trueif positioned updates are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSelectForUpdate
boolean supportsSelectForUpdate() throws java.sql.SQLExceptionThis method tests whether or not SELECT FOR UPDATE is supported by the database.- Returns:
trueif SELECT FOR UPDATE is supportedfalseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsStoredProcedures
boolean supportsStoredProcedures() throws java.sql.SQLExceptionThis method tests whether or not stored procedures are supported on this database.- Returns:
trueif stored procedures are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSubqueriesInComparisons
boolean supportsSubqueriesInComparisons() throws java.sql.SQLExceptionThis method tests whether or not subqueries are allowed in comparisons. A fully JDBC compliant driver will always returntrue.- Returns:
trueif subqueries are allowed in comparisons,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSubqueriesInExists
boolean supportsSubqueriesInExists() throws java.sql.SQLExceptionThis method tests whether or not subqueries are allowed in exists expressions. A fully JDBC compliant driver will always returntrue.- Returns:
trueif subqueries are allowed in exists expressions,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSubqueriesInIns
boolean supportsSubqueriesInIns() throws java.sql.SQLExceptionThis method tests whether subqueries are allowed in IN statements. A fully JDBC compliant driver will always returntrue.- Returns:
trueif the driver supports subqueries in IN statements,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSubqueriesInQuantifieds
boolean supportsSubqueriesInQuantifieds() throws java.sql.SQLExceptionThis method tests whether or not subqueries are allowed in quantified expressions. A fully JDBC compliant driver will always returntrue.- Returns:
trueif subqueries are allowed in quantified expressions,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsCorrelatedSubqueries
boolean supportsCorrelatedSubqueries() throws java.sql.SQLExceptionThis method test whether or not correlated subqueries are allowed. A fully JDBC compliant driver will always returntrue.- Returns:
trueif correlated subqueries are allowed,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsUnion
boolean supportsUnion() throws java.sql.SQLExceptionThis method tests whether or not the UNION statement is supported.- Returns:
trueif UNION is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsUnionAll
boolean supportsUnionAll() throws java.sql.SQLExceptionThis method tests whether or not the UNION ALL statement is supported.- Returns:
trueif UNION ALL is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsOpenCursorsAcrossCommit
boolean supportsOpenCursorsAcrossCommit() throws java.sql.SQLExceptionThis method tests whether or not the database supports cursors remaining open across commits.- Returns:
trueif cursors can remain open across commits,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsOpenCursorsAcrossRollback
boolean supportsOpenCursorsAcrossRollback() throws java.sql.SQLExceptionThis method tests whether or not the database supports cursors remaining open across rollbacks.- Returns:
trueif cursors can remain open across rollbacks,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsOpenStatementsAcrossCommit
boolean supportsOpenStatementsAcrossCommit() throws java.sql.SQLExceptionThis method tests whether or not the database supports statements remaining open across commits.- Returns:
trueif statements can remain open across commits,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsOpenStatementsAcrossRollback
boolean supportsOpenStatementsAcrossRollback() throws java.sql.SQLExceptionThis method tests whether or not the database supports statements remaining open across rollbacks.- Returns:
trueif statements can remain open across rollbacks,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxBinaryLiteralLength
int getMaxBinaryLiteralLength() throws java.sql.SQLExceptionThis method returns the number of hex characters allowed in an inline binary literal.- Returns:
- The number of hex characters allowed in a binary literal, 0 meaning either an unknown or unlimited number.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxCharLiteralLength
int getMaxCharLiteralLength() throws java.sql.SQLExceptionThis method returns the maximum length of a character literal.- Returns:
- The maximum length of a character literal.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxColumnNameLength
int getMaxColumnNameLength() throws java.sql.SQLExceptionThis method returns the maximum length of a column name.- Returns:
- The maximum length of a column name.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxColumnsInGroupBy
int getMaxColumnsInGroupBy() throws java.sql.SQLExceptionThis method returns the maximum number of columns in a GROUP BY statement.- Returns:
- The maximum number of columns in a GROUP BY statement.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxColumnsInIndex
int getMaxColumnsInIndex() throws java.sql.SQLExceptionThis method returns the maximum number of columns in an index.- Returns:
- The maximum number of columns in an index.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxColumnsInOrderBy
int getMaxColumnsInOrderBy() throws java.sql.SQLExceptionThis method returns the maximum number of columns in an ORDER BY statement.- Returns:
- The maximum number of columns in an ORDER BY statement.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxColumnsInSelect
int getMaxColumnsInSelect() throws java.sql.SQLExceptionThis method returns the maximum number of columns in a SELECT statement.- Returns:
- The maximum number of columns in a SELECT statement.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxColumnsInTable
int getMaxColumnsInTable() throws java.sql.SQLExceptionThis method returns the maximum number of columns in a table.- Returns:
- The maximum number of columns in a table.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxConnections
int getMaxConnections() throws java.sql.SQLExceptionThis method returns the maximum number of connections this client can have to the database.- Returns:
- The maximum number of database connections.
- Throws:
java.sql.SQLException
-
getMaxCursorNameLength
int getMaxCursorNameLength() throws java.sql.SQLExceptionThis method returns the maximum length of a cursor name.- Returns:
- The maximum length of a cursor name.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxIndexLength
int getMaxIndexLength() throws java.sql.SQLExceptionThis method returns the maximum length of an index.- Returns:
- The maximum length of an index.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxSchemaNameLength
int getMaxSchemaNameLength() throws java.sql.SQLExceptionThis method returns the maximum length of a schema name.- Returns:
- The maximum length of a schema name.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxProcedureNameLength
int getMaxProcedureNameLength() throws java.sql.SQLExceptionThis method returns the maximum length of a procedure name.- Returns:
- The maximum length of a procedure name.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxCatalogNameLength
int getMaxCatalogNameLength() throws java.sql.SQLExceptionThis method returns the maximum length of a catalog name.- Returns:
- The maximum length of a catalog name.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxRowSize
int getMaxRowSize() throws java.sql.SQLExceptionThis method returns the maximum size of a row in bytes.- Returns:
- The maximum size of a row.
- Throws:
java.sql.SQLException- If an error occurs.
-
doesMaxRowSizeIncludeBlobs
boolean doesMaxRowSizeIncludeBlobs() throws java.sql.SQLExceptionThis method tests whether or not the maximum row size includes BLOB's- Returns:
trueif the maximum row size includes BLOB's,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxStatementLength
int getMaxStatementLength() throws java.sql.SQLExceptionThis method includes the maximum length of a SQL statement.- Returns:
- The maximum length of a SQL statement.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxStatements
int getMaxStatements() throws java.sql.SQLExceptionThis method returns the maximum number of statements that can be active at any time.- Returns:
- The maximum number of statements that can be active at any time.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxTableNameLength
int getMaxTableNameLength() throws java.sql.SQLExceptionThis method returns the maximum length of a table name.- Returns:
- The maximum length of a table name.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxTablesInSelect
int getMaxTablesInSelect() throws java.sql.SQLExceptionThis method returns the maximum number of tables that may be referenced in a SELECT statement.- Returns:
- The maximum number of tables allowed in a SELECT statement.
- Throws:
java.sql.SQLException- If an error occurs.
-
getMaxUserNameLength
int getMaxUserNameLength() throws java.sql.SQLExceptionThis method returns the maximum length of a user name.- Returns:
- The maximum length of a user name.
- Throws:
java.sql.SQLException- If an error occurs.
-
getDefaultTransactionIsolation
int getDefaultTransactionIsolation() throws java.sql.SQLExceptionThis method returns the default transaction isolation level of the database.- Returns:
- The default transaction isolation level of the database.
- Throws:
java.sql.SQLException- If an error occurs.- See Also:
Connection
-
supportsTransactions
boolean supportsTransactions() throws java.sql.SQLExceptionThis method tests whether or not the database supports transactions.- Returns:
trueif the database supports transactions,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsTransactionIsolationLevel
boolean supportsTransactionIsolationLevel(int level) throws java.sql.SQLExceptionThis method tests whether or not the database supports the specified transaction isolation level.- Parameters:
level- The transaction isolation level.- Returns:
trueif the specified transaction isolation level is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsDataDefinitionAndDataManipulationTransactions
boolean supportsDataDefinitionAndDataManipulationTransactions() throws java.sql.SQLExceptionThis method tests whether or not DDL and DML statements allowed within the same transaction.- Returns:
trueif DDL and DML statements are allowed in the same transaction,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
supportsDataManipulationTransactionsOnly
boolean supportsDataManipulationTransactionsOnly() throws java.sql.SQLExceptionThis method tests whether or not only DML statement are allowed inside a transaction.- Returns:
trueif only DML statements are allowed in transactions,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
dataDefinitionCausesTransactionCommit
boolean dataDefinitionCausesTransactionCommit() throws java.sql.SQLExceptionThis method tests whether or not a DDL statement will cause the current transaction to be automatically committed.- Returns:
trueif DDL causes an immediate transaction commit,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
dataDefinitionIgnoredInTransactions
boolean dataDefinitionIgnoredInTransactions() throws java.sql.SQLExceptionThis method tests whether or not DDL statements are ignored in transactions.- Returns:
trueif DDL statements are ignored in transactions,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getProcedures
ResultSet getProcedures(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedurePattern) throws java.sql.SQLException
This method returns a list of all the stored procedures matching the specified pattern in the given schema and catalog. This is returned aResultSetwith the following columns:- PROCEDURE_CAT - The catalog the procedure is in, which may be
null. - PROCEDURE_SCHEM - The schema the procedures is in, which may be
null. - PROCEDURE_NAME - The name of the procedure.
- Unused
- Unused
- Unused
- REMARKS - A description of the procedure
- PROCEDURE_TYPE - Indicates the return type of the procedure, which
is one of the contstants defined in this class
(
procedureResultUnknown,procedureNoResult, orprocedureReturnsResult).
- Parameters:
catalog- The name of the catalog to return stored procedured from, or "" to return procedures from all catalogs.schemaPattern- A schema pattern for the schemas to return stored procedures from, or "" to return procedures from all schemas.procedurePattern- The pattern of procedure names to return.- Throws:
java.sql.SQLException- If an error occurs.
- PROCEDURE_CAT - The catalog the procedure is in, which may be
-
getProcedureColumns
ResultSet getProcedureColumns(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedurePattern, java.lang.String columnPattern) throws java.sql.SQLException
This method returns a list of the parameter and result columns for the requested stored procedures. This is returned in the form of aResultSetwith the following columns:- PROCEDURE_CAT - The catalog the procedure is in, which may be
null. - PROCEDURE_SCHEM - The schema the procedures is in, which may be
null. - PROCEDURE_NAME - The name of the procedure.
- COLUMN_NAME - The name of the column
- COLUMN_TYPE - The type of the column, which will be one of the
contants defined in this class (
procedureColumnUnknown,procedureColumnIn,procedureColumnInOut,procedureColumnOut,procedureColumnReturn, orprocedureColumnResult). - DATA_TYPE - The SQL type of the column. This is one of the constants
defined in
Types. - TYPE_NAME - The string name of the data type for this column.
- PRECISION - The precision of the column.
- LENGTH - The length of the column in bytes
- SCALE - The scale of the column.
- RADIX - The radix of the column.
- NULLABLE - Whether or not the column is NULLABLE. This is one of
the constants defined in this class (
procedureNoNulls,procedureNullable, orprocedureNullableUnknown) - REMARKS - A description of the column.
- Parameters:
catalog- The name of the catalog to return stored procedured from, or "" to return procedures from all catalogs.schemaPattern- A schema pattern for the schemas to return stored procedures from, or "" to return procedures from all schemas.procedurePattern- The pattern of procedures names to return.columnPattern- The pattern of column names to return.- Throws:
java.sql.SQLException- If an error occurs.
- PROCEDURE_CAT - The catalog the procedure is in, which may be
-
getTables
ResultSet getTables(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern, java.lang.String[] types) throws java.sql.SQLException
This method returns a list of the requested table as aResultSetwith the following columns:- TABLE_CAT - The catalog the table is in, which may be
null. - TABLE_SCHEM - The schema the table is in, which may be
null. - TABLE_NAME - The name of the table.
- TABLE_TYPE - A string describing the table type. This will be one
of the values returned by the
getTableTypes()method. - REMARKS - Comments about the table.
- Parameters:
catalog- The name of the catalog to return tables from, or "" to return tables from all catalogs.schemaPattern- A schema pattern for the schemas to return tables from, or "" to return tables from all schemas.tablePattern- The pattern of table names to return.types- The list of table types to include; null returns all types.- Throws:
java.sql.SQLException- If an error occurs.
- TABLE_CAT - The catalog the table is in, which may be
-
getSchemas
ResultSet getSchemas() throws java.sql.SQLException
This method returns the list of database schemas as aResultSet, with one column - TABLE_SCHEM - that is the name of the schema.- Returns:
- A
ResultSetwith all the requested schemas. - Throws:
java.sql.SQLException- If an error occurs.
-
getCatalogs
ResultSet getCatalogs() throws java.sql.SQLException
This method returns the list of database catalogs as aResultSetwith one column - TABLE_CAT - that is the name of the catalog.- Returns:
- A
ResultSetwith all the requested catalogs. - Throws:
java.sql.SQLException- If an error occurs.
-
getTableTypes
ResultSet getTableTypes() throws java.sql.SQLException
This method returns the list of database table types as aResultSetwith one column - TABLE_TYPE - that is the name of the table type.- Returns:
- A
ResultSetwith all the requested table types. - Throws:
java.sql.SQLException- If an error occurs.
-
getColumns
ResultSet getColumns(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern, java.lang.String columnPattern) throws java.sql.SQLException
This method returns a list of the tables columns for the requested tables. This is returned in the form of aResultSetwith the following columns:- TABLE_CAT - The catalog the table is in, which may be
null. - TABLE_SCHEM - The schema the tables is in, which may be
null. - TABLE_NAME - The name of the table.
- COLUMN_NAME - The name of the column
- DATA_TYPE - The SQL type of the column. This is one of the constants
defined in
Types. - TYPE_NAME - The string name of the data type for this column.
- COLUMN_SIZE - The size of the column.
- Unused
- NUM_PREC_RADIX - The radix of the column.
- NULLABLE - Whether or not the column is NULLABLE. This is one of
the constants defined in this class (
tableNoNulls,tableNullable, ortableNullableUnknown) - REMARKS - A description of the column.
- COLUMN_DEF - The default value for the column, may be
null. - SQL_DATA_TYPE - Unused
- SQL_DATETIME_SUB - Unused
- CHAR_OCTET_LENGTH - For character columns, the maximum number of bytes in the column.
- ORDINAL_POSITION - The index of the column in the table.
- IS_NULLABLE - "NO" means no, "YES" means maybe, and an empty string means unknown.
- Parameters:
catalog- The name of the catalog to return table from, or "" to return tables from all catalogs.schemaPattern- A schema pattern for the schemas to return tables from, or "" to return tables from all schemas.tablePattern- The pattern of table names to return.columnPattern- The pattern of column names to return.- Throws:
java.sql.SQLException- If an error occurs.
- TABLE_CAT - The catalog the table is in, which may be
-
getColumnPrivileges
ResultSet getColumnPrivileges(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, java.lang.String columnPattern) throws java.sql.SQLException
This method returns the access rights that have been granted to the requested columns. This information is returned as aResultSetwith the following columns:- TABLE_CAT - The catalog the table is in, which may be
null. - TABLE_SCHEM - The schema the tables is in, which may be
null. - TABLE_NAME - The name of the table.
- COLUMN_NAME - The name of the column.
- GRANTOR - The entity that granted the access.
- GRANTEE - The entity granted the access.
- PRIVILEGE - The name of the privilege granted.
- IS_GRANTABLE - "YES" if the grantee can grant the privilege to
others, "NO" if not, and
nullif unknown.
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schema- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tableName- The table name to return information for.columnPattern- A pattern of column names to return information for.- Returns:
- A
ResultSetwith all the requested privileges. - Throws:
java.sql.SQLException- If an error occurs.
- TABLE_CAT - The catalog the table is in, which may be
-
getTablePrivileges
ResultSet getTablePrivileges(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern) throws java.sql.SQLException
This method returns the access rights that have been granted to the requested tables. This information is returned as aResultSetwith the following columns:- TABLE_CAT - The catalog the table is in, which may be
null. - TABLE_SCHEM - The schema the tables is in, which may be
null. - TABLE_NAME - The name of the table.
- GRANTOR - The entity that granted the access.
- GRANTEE - The entity granted the access.
- PRIVILEGE - The name of the privilege granted.
- IS_GRANTABLE - "YES" if the grantee can grant the privilege to
others, "NO" if not, and
nullif unknown.
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schemaPattern- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tablePattern- The table name pattern of tables to return information for.- Returns:
- A
ResultSetwith all the requested privileges. - Throws:
java.sql.SQLException- If an error occurs.
- TABLE_CAT - The catalog the table is in, which may be
-
getBestRowIdentifier
ResultSet getBestRowIdentifier(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, int scope, boolean nullable) throws java.sql.SQLException
This method returns the best set of columns for uniquely identifying a row. It returns this information as aResultSetwith the following columns:- SCOPE - The scope of the results returned. This is one of the
constants defined in this class (
bestRowTemporary,bestRowTransaction, orbestRowSession). - COLUMN_NAME - The name of the column.
- DATA_TYPE - The SQL type of the column. This is one of the constants
defined in
Types. - TYPE_NAME - The string name of the data type for this column.
- COLUMN_SIZE - The precision of the columns
- BUFFER_LENGTH - Unused
- DECIMAL_DIGITS - The scale of the column.
- PSEUDO_COLUMN - Whether or not the best row identifier is a
pseudo_column. This is one of the constants defined in this class
(
bestRowUnknown,bestRowNotPseudo, orbestRowPseudo).
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schema- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tableName- The table name to return information for.scope- One of the best row id scope constants from this class.nullable-trueto include columns that are nullable,falseotherwise.- Returns:
- A
ResultSetwith the best row identifier. - Throws:
java.sql.SQLException- If an error occurs.
- SCOPE - The scope of the results returned. This is one of the
constants defined in this class (
-
getVersionColumns
ResultSet getVersionColumns(java.lang.String catalog, java.lang.String schema, java.lang.String tableName) throws java.sql.SQLException
This method returns the set of columns that are automatically updated when the row is update. It returns this information as aResultSetwith the following columns:- SCOPE - Unused
- COLUMN_NAME - The name of the column.
- DATA_TYPE - The SQL type of the column. This is one of the constants
defined in
Types. - TYPE_NAME - The string name of the data type for this column.
- COLUMN_SIZE - The precision of the columns
- BUFFER_LENGTH - Unused
- DECIMAL_DIGITS - The scale of the column.
- PSEUDO_COLUMN - Whether or not the best row identifier is a
pseudo_column. This is one of the constants defined in this class
(
versionRowUnknown,versionRowNotPseudo, orversionRowPseudo).
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schema- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tableName- The table name to return information for- Returns:
- A
ResultSetwith the version columns. - Throws:
java.sql.SQLException- If an error occurs.
-
getPrimaryKeys
ResultSet getPrimaryKeys(java.lang.String catalog, java.lang.String schema, java.lang.String tableName) throws java.sql.SQLException
This method returns a list of a table's primary key columns. These are returned as aResultSetwith the following columns.- TABLE_CAT - The catalog of the table, which may be
null. - TABLE_SCHEM - The schema of the table, which may be
null. - TABLE_NAME - The name of the table.
- COLUMN_NAME - The name of the column.
- KEY_SEQ - The sequence number of the column within the primary key.
- PK_NAME - The name of the primary key, which may be
null.
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schema- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tableName- The table name to return information for.- Returns:
- A
ResultSetwith the primary key columns. - Throws:
java.sql.SQLException- If an error occurs.
- TABLE_CAT - The catalog of the table, which may be
-
getImportedKeys
ResultSet getImportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.String tableName) throws java.sql.SQLException
This method returns a list of the table's foreign keys. These are returned as aResultSetwith the following columns:- PKTABLE_CAT - The catalog of the table the key was imported from.
- PKTABLE_SCHEM - The schema of the table the key was imported from.
- PKTABLE_NAME - The name of the table the key was imported from.
- PKCOLUMN_NAME - The name of the column that was imported.
- FKTABLE_CAT - The foreign key catalog name.
- FKTABLE_SCHEM - The foreign key schema name.
- FKTABLE_NAME - The foreign key table name.
- FKCOLUMN_NAME - The foreign key column name.
- KEY_SEQ - The sequence number of the column within the foreign key.
- UPDATE_RULE - How the foreign key behaves when the primary key is
updated. This is one of the constants defined in this class
(
importedNoAction,importedKeyCascade,importedKeySetNull,importedKeySetDefault, orimportedKeyRestrict). - DELETE_RULE - How the foreign key behaves when the primary key is
deleted. This is one of the constants defined in this class
(
importedNoAction,importedKeyCascade,importedKeySetNull, orimportedKeySetDefault) - FK_NAME - The name of the foreign key.
- PK_NAME - The name of the primary key.
- DEFERRABILITY - The deferrability value. This is one of the
constants defined in this table (
importedKeyInitiallyDeferred,importedKeyInitiallyImmediate, orimportedKeyNotDeferrable).
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schema- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tableName- The table name to return information for.- Returns:
- A
ResultSetwith the foreign key columns. - Throws:
java.sql.SQLException- If an error occurs.
-
getExportedKeys
ResultSet getExportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.String tableName) throws java.sql.SQLException
This method returns a list of the table's which use this table's primary key as a foreign key. The information is returned as aResultSetwith the following columns:- PKTABLE_CAT - The catalog of the table the key was imported from.
- PKTABLE_SCHEM - The schema of the table the key was imported from.
- PKTABLE_NAME - The name of the table the key was imported from.
- PKCOLUMN_NAME - The name of the column that was imported.
- FKTABLE_CAT - The foreign key catalog name.
- FKTABLE_SCHEM - The foreign key schema name.
- FKTABLE_NAME - The foreign key table name.
- FKCOLUMN_NAME - The foreign key column name.
- KEY_SEQ - The sequence number of the column within the foreign key.
- UPDATE_RULE - How the foreign key behaves when the primary key is
updated. This is one of the constants defined in this class
(
importedNoAction,importedKeyCascade,importedKeySetNull,importedKeySetDefault, orimportedKeyRestrict). - DELETE_RULE - How the foreign key behaves when the primary key is
deleted. This is one of the constants defined in this class
(
importedNoAction,importedKeyCascade,importedKeySetNull, orimportedKeySetDefault) - FK_NAME - The name of the foreign key.
- PK_NAME - The name of the primary key.
- DEFERRABILITY - The deferrability value. This is one of the
constants defined in this table (
importedKeyInitiallyDeferred,importedKeyInitiallyImmediate, orimportedKeyNotDeferrable).
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schema- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tableName- The table name to return information for.- Returns:
- A
ResultSetwith the requested information - Throws:
java.sql.SQLException- If an error occurs.
-
getCrossReference
ResultSet getCrossReference(java.lang.String primaryCatalog, java.lang.String primarySchema, java.lang.String primaryTableName, java.lang.String foreignCatalog, java.lang.String foreignSchema, java.lang.String foreignTableName) throws java.sql.SQLException
This method returns a description of how one table imports another table's primary key as a foreign key. The information is returned as aResultSetwith the following columns:- PKTABLE_CAT - The catalog of the table the key was imported from.
- PKTABLE_SCHEM - The schema of the table the key was imported from.
- PKTABLE_NAME - The name of the table the key was imported from.
- PKCOLUMN_NAME - The name of the column that was imported.
- FKTABLE_CAT - The foreign key catalog name.
- FKTABLE_SCHEM - The foreign key schema name.
- FKTABLE_NAME - The foreign key table name.
- FKCOLUMN_NAME - The foreign key column name.
- KEY_SEQ - The sequence number of the column within the foreign key.
- UPDATE_RULE - How the foreign key behaves when the primary key is
updated. This is one of the constants defined in this class
(
importedNoAction,importedKeyCascade,importedKeySetNull,importedKeySetDefault, orimportedKeyRestrict). - DELETE_RULE - How the foreign key behaves when the primary key is
deleted. This is one of the constants defined in this class
(
importedNoAction,importedKeyCascade,importedKeySetNull, orimportedKeySetDefault) - FK_NAME - The name of the foreign key.
- PK_NAME - The name of the primary key.
- DEFERRABILITY - The deferrability value. This is one of the
constants defined in this table (
importedKeyInitiallyDeferred,importedKeyInitiallyImmediate, orimportedKeyNotDeferrable).
- Parameters:
primaryCatalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs, on the exporting side.primarySchema- The schema to retrieve information from, or the empty string to return entities not associated with a schema, on the exporting side.primaryTableName- The table name to return information for, on the exporting side.foreignCatalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs, on the importing side.foreignSchema- The schema to retrieve information from, or the empty string to return entities not associated with a schema on the importing side.foreignTableName- The table name to return information for on the importing side.- Returns:
- A
ResultSetwith the requested information - Throws:
java.sql.SQLException- If an error occurs.
-
getTypeInfo
ResultSet getTypeInfo() throws java.sql.SQLException
This method returns a list of the SQL types supported by this database. The information is returned as aResultSetwith the following columns:- TYPE_NAME - The name of the data type.
- DATA_TYPE - A data type constant from
Typesfor this type. - PRECISION - The maximum precision of this type.
- LITERAL_PREFIX - Prefix value used to quote a literal, which may be
null. - LITERAL_SUFFIX - Suffix value used to quote a literal, which may be
null. - CREATE_PARAMS - The parameters used to create the type, which may be
null. - NULLABLE - Whether or not this type supports NULL values. This will
be one of the constants defined in this interface
(
typeNoNulls,typeNullable, ortypeNullableUnknown). - CASE_SENSITIVE - Whether or not the value is case sensitive.
- SEARCHABLE - Whether or not "LIKE" expressions are supported in
WHERE clauses for this type. This will be one of the constants defined
in this interface (
typePredNone,typePredChar,typePredBasic, ortypeSearchable). - UNSIGNED_ATTRIBUTE - Is the value of this type unsigned.
- FIXED_PREC_SCALE - Whether or not this type can be used for money.
- AUTO_INCREMENT - Whether or not this type supports auto-incrementing.
- LOCAL_TYPE_NAME - A localized name for this data type.
- MINIMUM_SCALE - The minimum scale supported by this type.
- MAXIMUM_SCALE - The maximum scale supported by this type.
- SQL_DATA_TYPE - Unused.
- SQL_DATETIME_SUB - Unused.
- NUM_PREC_RADIX - The radix of this data type.
- Returns:
- A
ResultSetwith the list of available data types. - Throws:
java.sql.SQLException- If an error occurs.
-
getIndexInfo
ResultSet getIndexInfo(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, boolean unique, boolean approximate) throws java.sql.SQLException
This method returns information about a tables indices and statistics. It is returned as aResultSetwith the following columns:- TABLE_CAT - The catalog of the table, which may be
null. - TABLE_SCHEM - The schema of the table, which may be
null. - TABLE_NAME - The name of the table.
- NON_UNIQUE - Are index values non-unique?
- INDEX_QUALIFIER The index catalog, which may be
null - INDEX_NAME - The name of the index.
- TYPE - The type of index, which will be one of the constants defined
in this interface (
tableIndexStatistic,tableIndexClustered,tableIndexHashed, ortableIndexOther). - ORDINAL_POSITION - The sequence number of this column in the index.
This will be 0 when the index type is
tableIndexStatistic. - COLUMN_NAME - The name of this column in the index.
- ASC_OR_DESC - "A" for an ascending sort sequence, "D" for a
descending sort sequence or
nullif a sort sequence is not supported. - CARDINALITY - The number of unique rows in the index, or the number
of rows in the table if the index type is
tableIndexStatistic. - PAGES - The number of pages used for the index, or the number of pages
in the table if the index type is
tableIndexStatistic. - FILTER_CONDITION - The filter condition for this index, which may be
null.
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schema- The schema to retrieve information from, or the empty string to return entities not associated with a schema.tableName- The table name to return information for.unique-trueto return only unique indexes,falseotherwise.approximate-trueif data values can be approximations,falseotherwise.- Returns:
- A
ResultSetwith the requested index information - Throws:
java.sql.SQLException- If an error occurs.
- TABLE_CAT - The catalog of the table, which may be
-
supportsResultSetType
boolean supportsResultSetType(int type) throws java.sql.SQLExceptionThis method tests whether or not the datbase supports the specified result type.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
supportsResultSetConcurrency
boolean supportsResultSetConcurrency(int type, int concurrency) throws java.sql.SQLExceptionThis method tests whether the specified result set type and result set concurrency type are supported by the database.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.concurrency- The desired concurrency type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type is supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
ownUpdatesAreVisible
boolean ownUpdatesAreVisible(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type sees its own updates.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type sees its own updates,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
ownDeletesAreVisible
boolean ownDeletesAreVisible(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type sees its own deletes.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type sees its own deletes,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
ownInsertsAreVisible
boolean ownInsertsAreVisible(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type sees its own inserts.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type sees its own inserts,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
othersUpdatesAreVisible
boolean othersUpdatesAreVisible(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type sees updates committed by others.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type sees other updates,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
othersDeletesAreVisible
boolean othersDeletesAreVisible(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type sees deletes committed by others.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type sees other deletes,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
othersInsertsAreVisible
boolean othersInsertsAreVisible(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type sees inserts committed by others.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type sees other inserts,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
updatesAreDetected
boolean updatesAreDetected(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type can detect a visible update by calling therowUpdatedmethod.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type can detect visible updates usingrowUpdated,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
deletesAreDetected
boolean deletesAreDetected(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type can detect a visible delete by calling therowUpdatedmethod.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type can detect visible deletes usingrowUpdated,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
insertsAreDetected
boolean insertsAreDetected(int type) throws java.sql.SQLExceptionThis method tests whether or not the specified result set type can detect a visible insert by calling therowUpdatedmethod.- Parameters:
type- The desired result type, which is one of the constants defined inResultSet.- Returns:
trueif the result set type can detect visible inserts usingrowUpdated,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.- See Also:
ResultSet
-
supportsBatchUpdates
boolean supportsBatchUpdates() throws java.sql.SQLExceptionThis method tests whether or not the database supports batch updates.- Returns:
trueif batch updates are supported,falseotherwise.- Throws:
java.sql.SQLException- If an error occurs.
-
getUDTs
ResultSet getUDTs(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typePattern, int[] types) throws java.sql.SQLException
This method returns the list of user defined data types in use. These are returned as aResultSetwith the following columns:- TYPE_CAT - The catalog name, which may be
null. - TYPE_SCEHM - The schema name, which may be
null. - TYPE_NAME - The user defined data type name.
- CLASS_NAME - The Java class name this type maps to.
- DATA_TYPE - A type identifier from
Typesfor this type. This will be one ofJAVA_OBJECT,STRUCT, orDISTINCT. - REMARKS - Comments about this data type.
- Parameters:
catalog- The catalog to retrieve information from, or the empty string to return entities not associated with a catalog, ornullto return information from all catalogs.schemaPattern- The schema to retrieve information from, or the empty string to return entities not associated with a schema.typePattern- The type name pattern to match.types- The type identifier patterns (fromTypes) to match.- Returns:
- A
ResultSetwith the requested type information - Throws:
java.sql.SQLException- If an error occurs.
- TYPE_CAT - The catalog name, which may be
-
getConnection
Connection getConnection() throws java.sql.SQLException
This method returns theConnectionobject that was used to generate the metadata in this object.- Returns:
- The connection for this object.
- Throws:
java.sql.SQLException- If an error occurs.
-
supportsSavepoints
boolean supportsSavepoints() throws java.sql.SQLExceptionThis method tests whether the databse supports savepoints.- Returns:
trueif the database supports savepoints,falseif it does not.- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
supportsNamedParameters
boolean supportsNamedParameters() throws java.sql.SQLExceptionThis method tests whether the database supports named parameters.- Returns:
trueif the database supports named parameters,falseif it does not.- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
supportsMultipleOpenResults
boolean supportsMultipleOpenResults() throws java.sql.SQLExceptionThis method tests whether the database supports returning multipleResultSetS from aCallableStatementat once.- Returns:
trueif the database supports returnig multiple results at once,falseif it does not.- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
supportsGetGeneratedKeys
boolean supportsGetGeneratedKeys() throws java.sql.SQLException- Throws:
java.sql.SQLException- Since:
- 1.4
-
getSuperTypes
ResultSet getSuperTypes(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typePattern) throws java.sql.SQLException
- Throws:
java.sql.SQLException- Since:
- 1.4
-
getSuperTables
ResultSet getSuperTables(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tablePattern) throws java.sql.SQLException
- Throws:
java.sql.SQLException- Since:
- 1.4
-
getAttributes
ResultSet getAttributes(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typePattern, java.lang.String attributePattern) throws java.sql.SQLException
- Throws:
java.sql.SQLException- Since:
- 1.4
-
supportsResultSetHoldability
boolean supportsResultSetHoldability(int holdability) throws java.sql.SQLExceptionThis method tests if the database supports the specified holdability type. Valid values for this parameter are specified in theResultSetclass.- Parameters:
holdability- The holdability type to test.- Returns:
trueif the database supports the holdability type,falseif it does not.- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
- See Also:
ResultSet
-
getResultSetHoldability
int getResultSetHoldability() throws java.sql.SQLExceptionThis method returns the default holdability type ofResultSetS retrieved from this database. The possible values are specified in theResultSetclass.- Returns:
- The default holdability type.
- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
getDatabaseMajorVersion
int getDatabaseMajorVersion() throws java.sql.SQLExceptionThis method returns the major version number of the database.- Returns:
- The major version number of the database.
- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
getDatabaseMinorVersion
int getDatabaseMinorVersion() throws java.sql.SQLExceptionThis method returns the minor version number of the database.- Returns:
- The minor version number of the database.
- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
getJDBCMajorVersion
int getJDBCMajorVersion() throws java.sql.SQLExceptionThis method returns the major version number of the JDBC driver.- Returns:
- The major version number of the JDBC driver.
- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
getJDBCMinorVersion
int getJDBCMinorVersion() throws java.sql.SQLExceptionThis method returns the minor version number of the JDBC driver.- Returns:
- The minor version number of the database.
- Throws:
java.sql.SQLException- If an error occurs.- Since:
- 1.4
-
getSQLStateType
int getSQLStateType() throws java.sql.SQLException- Throws:
java.sql.SQLException- Since:
- 1.4
-
locatorsUpdateCopy
boolean locatorsUpdateCopy() throws java.sql.SQLException- Throws:
java.sql.SQLException- Since:
- 1.4
-
supportsStatementPooling
boolean supportsStatementPooling() throws java.sql.SQLException- Throws:
java.sql.SQLException- Since:
- 1.4
-
-