|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Comprehensive information about the database as a whole.
Many of the methods here return lists of information in
the form of ResultSet
objects.
You can use the normal ResultSet methods such as getString and getInt
to retrieve the data from these ResultSets. If a given form of
metadata is not available, these methods should throw an SQLException.
Some of these methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern are returned. If a search pattern argument is set to a null ref, that argument's criteria will be dropped from the search.
An SQLException
will be thrown if a driver does not support a meta
data method. In the case of methods that return a ResultSet,
either a ResultSet (which may be empty) is returned or a
SQLException is thrown.
Field Summary | |
static int |
bestRowNotPseudo
Indicates that the best row identifier is NOT a pseudo column. |
static int |
bestRowPseudo
Indicates that the best row identifier is a pseudo column. |
static int |
bestRowSession
Indicates that the scope of the best row identifier is the remainder of the current session. |
static int |
bestRowTemporary
Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used. |
static int |
bestRowTransaction
Indicates that the scope of the best row identifier is the remainder of the current transaction. |
static int |
bestRowUnknown
Indicates that the best row identifier may or may not be a pseudo column. |
static int |
columnNoNulls
Indicates that the column might not allow NULL values. |
static int |
columnNullable
Indicates that the column definitely allows NULL values. |
static int |
columnNullableUnknown
Indicates that the nullability of columns is unknown. |
static int |
importedKeyCascade
A possible value for the columns UPDATE_RULE
and DELETE_RULE in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
importedKeyInitiallyDeferred
A possible value for the column DEFERRABILITY
in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
importedKeyInitiallyImmediate
A possible value for the column DEFERRABILITY
in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
importedKeyNoAction
A possible value for the columns UPDATE_RULE
and DELETE_RULE in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
importedKeyNotDeferrable
A possible value for the column DEFERRABILITY
in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
importedKeyRestrict
A possible value for the columns UPDATE_RULE
and DELETE_RULE in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
importedKeySetDefault
A possible value for the columns UPDATE_RULE
and DELETE_RULE in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
importedKeySetNull
A possible value for the columns UPDATE_RULE
and DELETE_RULE in the
ResultSet objects returned by the methods
getImportedKeys , getExportedKeys ,
and getCrossReference . |
static int |
procedureColumnIn
Indicates that the column stores IN parameters. |
static int |
procedureColumnInOut
Indicates that the column stores INOUT parameters. |
static int |
procedureColumnOut
Indicates that the column stores OUT parameters. |
static int |
procedureColumnResult
Indicates that the column stores results. |
static int |
procedureColumnReturn
Indicates that the column stores return values. |
static int |
procedureColumnUnknown
Indicates that type of the column is unknown. |
static int |
procedureNoNulls
Indicates that NULL values are not allowed. |
static int |
procedureNoResult
A possible value for column PROCEDURE_TYPE in the
ResultSet object returned by the method
getProcedures . |
static int |
procedureNullable
Indicates that NULL values are allowed. |
static int |
procedureNullableUnknown
Indicates that whether NULL values are allowed
is unknown. |
static int |
procedureResultUnknown
A possible value for column PROCEDURE_TYPE in the
ResultSet object returned by the method
getProcedures . |
static int |
procedureReturnsResult
A possible value for column PROCEDURE_TYPE in the
ResultSet object returned by the method
getProcedures . |
static short |
tableIndexClustered
A possible value for column TYPE in the
ResultSet object returned by the method
getIndexInfo . |
static short |
tableIndexHashed
A possible value for column TYPE in the
ResultSet object returned by the method
getIndexInfo . |
static short |
tableIndexOther
A possible value for column TYPE in the
ResultSet object returned by the method
getIndexInfo . |
static short |
tableIndexStatistic
A possible value for column TYPE in the
ResultSet object returned by the method
getIndexInfo . |
static int |
typeNoNulls
A possible value for column NULLABLE in the
ResultSet object returned by the method
getTypeInfo . |
static int |
typeNullable
A possible value for column NULLABLE in the
ResultSet object returned by the method
getTypeInfo . |
static int |
typeNullableUnknown
A possible value for column NULLABLE in the
ResultSet object returned by the method
getTypeInfo . |
static int |
typePredBasic
A possible value for column SEARCHABLE in the
ResultSet object returned by the method
getTypeInfo . |
static int |
typePredChar
A possible value for column SEARCHABLE in the
ResultSet object returned by the method
getTypeInfo . |
static int |
typePredNone
A possible value for column SEARCHABLE in the
ResultSet object returned by the method
getTypeInfo . |
static int |
typeSearchable
A possible value for column SEARCHABLE in the
ResultSet object returned by the method
getTypeInfo . |
static int |
versionColumnNotPseudo
Indicates that this version column is NOT a pseudo column. |
static int |
versionColumnPseudo
Indicates that this version column is a pseudo column. |
static int |
versionColumnUnknown
Indicates that this version column may or may not be a pseudo column. |
Method Summary | |
boolean |
allProceduresAreCallable()
Can all the procedures returned by getProcedures be called by the current user? |
boolean |
allTablesAreSelectable()
Can all the tables returned by getTable be SELECTed by the current user? |
boolean |
dataDefinitionCausesTransactionCommit()
Does a data definition statement within a transaction force the transaction to commit? |
boolean |
dataDefinitionIgnoredInTransactions()
Is a data definition statement within a transaction ignored? |
boolean |
deletesAreDetected(int type)
JDBC 2.0 Indicates whether or not a visible row delete can be detected by calling ResultSet.rowDeleted(). |
boolean |
doesMaxRowSizeIncludeBlobs()
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs? |
ResultSet |
getBestRowIdentifier(String catalog,
String schema,
String table,
int scope,
boolean nullable)
Gets a description of a table's optimal set of columns that uniquely identifies a row. |
ResultSet |
getCatalogs()
Gets the catalog names available in this database. |
String |
getCatalogSeparator()
What's the separator between catalog and table name? |
String |
getCatalogTerm()
What's the database vendor's preferred term for "catalog"? |
ResultSet |
getColumnPrivileges(String catalog,
String schema,
String table,
String columnNamePattern)
Gets a description of the access rights for a table's columns. |
ResultSet |
getColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern)
Gets a description of table columns available in the specified catalog. |
Connection |
getConnection()
JDBC 2.0 Retrieves the connection that produced this metadata object. |
ResultSet |
getCrossReference(String primaryCatalog,
String primarySchema,
String primaryTable,
String foreignCatalog,
String foreignSchema,
String foreignTable)
Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.) This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.) They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. |
String |
getDatabaseProductName()
What's the name of this database product? |
String |
getDatabaseProductVersion()
What's the version of this database product? |
int |
getDefaultTransactionIsolation()
What's the database's default transaction isolation level? The values are defined in java.sql.Connection . |
int |
getDriverMajorVersion()
What's this JDBC driver's major version number? |
int |
getDriverMinorVersion()
What's this JDBC driver's minor version number? |
String |
getDriverName()
What's the name of this JDBC driver? |
String |
getDriverVersion()
What's the version of this JDBC driver? |
ResultSet |
getExportedKeys(String catalog,
String schema,
String table)
Gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table). |
String |
getExtraNameCharacters()
Gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). |
String |
getIdentifierQuoteString()
What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting isn't supported. |
ResultSet |
getImportedKeys(String catalog,
String schema,
String table)
Gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table). |
ResultSet |
getIndexInfo(String catalog,
String schema,
String table,
boolean unique,
boolean approximate)
Gets a description of a table's indices and statistics. |
int |
getMaxBinaryLiteralLength()
How many hex characters can you have in an inline binary literal? |
int |
getMaxCatalogNameLength()
What's the maximum length of a catalog name? |
int |
getMaxCharLiteralLength()
What's the max length for a character literal? |
int |
getMaxColumnNameLength()
What's the limit on column name length? |
int |
getMaxColumnsInGroupBy()
What's the maximum number of columns in a "GROUP BY" clause? |
int |
getMaxColumnsInIndex()
What's the maximum number of columns allowed in an index? |
int |
getMaxColumnsInOrderBy()
What's the maximum number of columns in an "ORDER BY" clause? |
int |
getMaxColumnsInSelect()
What's the maximum number of columns in a "SELECT" list? |
int |
getMaxColumnsInTable()
What's the maximum number of columns in a table? |
int |
getMaxConnections()
How many active connections can we have at a time to this database? |
int |
getMaxCursorNameLength()
What's the maximum cursor name length? |
int |
getMaxIndexLength()
What's the maximum length of an index (in bytes)? |
int |
getMaxProcedureNameLength()
What's the maximum length of a procedure name? |
int |
getMaxRowSize()
What's the maximum length of a single row? |
int |
getMaxSchemaNameLength()
What's the maximum length allowed for a schema name? |
int |
getMaxStatementLength()
What's the maximum length of a SQL statement? |
int |
getMaxStatements()
How many active statements can we have open at one time to this database? |
int |
getMaxTableNameLength()
What's the maximum length of a table name? |
int |
getMaxTablesInSelect()
What's the maximum number of tables in a SELECT statement? |
int |
getMaxUserNameLength()
What's the maximum length of a user name? |
String |
getNumericFunctions()
Gets a comma-separated list of math functions. |
ResultSet |
getPrimaryKeys(String catalog,
String schema,
String table)
Gets a description of a table's primary key columns. |
ResultSet |
getProcedureColumns(String catalog,
String schemaPattern,
String procedureNamePattern,
String columnNamePattern)
Gets a description of a catalog's stored procedure parameters and result columns. |
ResultSet |
getProcedures(String catalog,
String schemaPattern,
String procedureNamePattern)
Gets a description of the stored procedures available in a catalog. |
String |
getProcedureTerm()
What's the database vendor's preferred term for "procedure"? |
ResultSet |
getSchemas()
Gets the schema names available in this database. |
String |
getSchemaTerm()
What's the database vendor's preferred term for "schema"? |
String |
getSearchStringEscape()
Gets the string that can be used to escape wildcard characters. |
String |
getSQLKeywords()
Gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords. |
String |
getStringFunctions()
Gets a comma-separated list of string functions. |
String |
getSystemFunctions()
Gets a comma-separated list of system functions. |
ResultSet |
getTablePrivileges(String catalog,
String schemaPattern,
String tableNamePattern)
Gets a description of the access rights for each table available in a catalog. |
ResultSet |
getTables(String catalog,
String schemaPattern,
String tableNamePattern,
String[] types)
Gets a description of tables available in a catalog. |
ResultSet |
getTableTypes()
Gets the table types available in this database. |
String |
getTimeDateFunctions()
Gets a comma-separated list of time and date functions. |
ResultSet |
getTypeInfo()
Gets a description of all the standard SQL types supported by this database. |
ResultSet |
getUDTs(String catalog,
String schemaPattern,
String typeNamePattern,
int[] types)
JDBC 2.0 Gets a description of the user-defined types defined in a particular schema. |
String |
getURL()
What's the url for this database? |
String |
getUserName()
What's our user name as known to the database? |
ResultSet |
getVersionColumns(String catalog,
String schema,
String table)
Gets a description of a table's columns that are automatically updated when any value in a row is updated. |
boolean |
insertsAreDetected(int type)
JDBC 2.0 Indicates whether or not a visible row insert can be detected by calling ResultSet.rowInserted(). |
boolean |
isCatalogAtStart()
Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end) |
boolean |
isReadOnly()
Is the database in read-only mode? |
boolean |
nullPlusNonNullIsNull()
Are concatenations between NULL and non-NULL values NULL? A JDBC CompliantTM driver always returns true. |
boolean |
nullsAreSortedAtEnd()
Are NULL values sorted at the end regardless of sort order? |
boolean |
nullsAreSortedAtStart()
Are NULL values sorted at the start regardless of sort order? |
boolean |
nullsAreSortedHigh()
Are NULL values sorted high? |
boolean |
nullsAreSortedLow()
Are NULL values sorted low? |
boolean |
othersDeletesAreVisible(int type)
JDBC 2.0 Indicates whether deletes made by others are visible. |
boolean |
othersInsertsAreVisible(int type)
JDBC 2.0 Indicates whether inserts made by others are visible. |
boolean |
othersUpdatesAreVisible(int type)
JDBC 2.0 Indicates whether updates made by others are visible. |
boolean |
ownDeletesAreVisible(int type)
JDBC 2.0 Indicates whether a result set's own deletes are visible. |
boolean |
ownInsertsAreVisible(int type)
JDBC 2.0 Indicates whether a result set's own inserts are visible. |
boolean |
ownUpdatesAreVisible(int type)
JDBC 2.0 Indicates whether a result set's own updates are visible. |
boolean |
storesLowerCaseIdentifiers()
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case? |
boolean |
storesLowerCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case? |
boolean |
storesMixedCaseIdentifiers()
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case? |
boolean |
storesMixedCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case? |
boolean |
storesUpperCaseIdentifiers()
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case? |
boolean |
storesUpperCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case? |
boolean |
supportsAlterTableWithAddColumn()
Is "ALTER TABLE" with add column supported? |
boolean |
supportsAlterTableWithDropColumn()
Is "ALTER TABLE" with drop column supported? |
boolean |
supportsANSI92EntryLevelSQL()
Is the ANSI92 entry level SQL grammar supported? All JDBC CompliantTM drivers must return true. |
boolean |
supportsANSI92FullSQL()
Is the ANSI92 full SQL grammar supported? |
boolean |
supportsANSI92IntermediateSQL()
Is the ANSI92 intermediate SQL grammar supported? |
boolean |
supportsBatchUpdates()
JDBC 2.0 Indicates whether the driver supports batch updates. |
boolean |
supportsCatalogsInDataManipulation()
Can a catalog name be used in a data manipulation statement? |
boolean |
supportsCatalogsInIndexDefinitions()
Can a catalog name be used in an index definition statement? |
boolean |
supportsCatalogsInPrivilegeDefinitions()
Can a catalog name be used in a privilege definition statement? |
boolean |
supportsCatalogsInProcedureCalls()
Can a catalog name be used in a procedure call statement? |
boolean |
supportsCatalogsInTableDefinitions()
Can a catalog name be used in a table definition statement? |
boolean |
supportsColumnAliasing()
Is column aliasing supported? |
boolean |
supportsConvert()
Is the CONVERT function between SQL types supported? |
boolean |
supportsConvert(int fromType,
int toType)
Is CONVERT between the given SQL types supported? |
boolean |
supportsCoreSQLGrammar()
Is the ODBC Core SQL grammar supported? |
boolean |
supportsCorrelatedSubqueries()
Are correlated subqueries supported? A JDBC CompliantTM driver always returns true. |
boolean |
supportsDataDefinitionAndDataManipulationTransactions()
Are both data definition and data manipulation statements within a transaction supported? |
boolean |
supportsDataManipulationTransactionsOnly()
Are only data manipulation statements within a transaction supported? |
boolean |
supportsDifferentTableCorrelationNames()
If table correlation names are supported, are they restricted to be different from the names of the tables? |
boolean |
supportsExpressionsInOrderBy()
Are expressions in "ORDER BY" lists supported? |
boolean |
supportsExtendedSQLGrammar()
Is the ODBC Extended SQL grammar supported? |
boolean |
supportsFullOuterJoins()
Are full nested outer joins supported? |
boolean |
supportsGroupBy()
Is some form of "GROUP BY" clause supported? |
boolean |
supportsGroupByBeyondSelect()
Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT? |
boolean |
supportsGroupByUnrelated()
Can a "GROUP BY" clause use columns not in the SELECT? |
boolean |
supportsIntegrityEnhancementFacility()
Is the SQL Integrity Enhancement Facility supported? |
boolean |
supportsLikeEscapeClause()
Is the escape character in "LIKE" clauses supported? A JDBC CompliantTM driver always returns true. |
boolean |
supportsLimitedOuterJoins()
Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.) |
boolean |
supportsMinimumSQLGrammar()
Is the ODBC Minimum SQL grammar supported? All JDBC CompliantTM drivers must return true. |
boolean |
supportsMixedCaseIdentifiers()
Does the database treat mixed case unquoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC CompliantTM driver will always return false. |
boolean |
supportsMixedCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC CompliantTM driver will always return true. |
boolean |
supportsMultipleResultSets()
Are multiple ResultSets from a single execute supported? |
boolean |
supportsMultipleTransactions()
Can we have multiple transactions open at once (on different connections)? |
boolean |
supportsNonNullableColumns()
Can columns be defined as non-nullable? A JDBC CompliantTM driver always returns true. |
boolean |
supportsOpenCursorsAcrossCommit()
Can cursors remain open across commits? |
boolean |
supportsOpenCursorsAcrossRollback()
Can cursors remain open across rollbacks? |
boolean |
supportsOpenStatementsAcrossCommit()
Can statements remain open across commits? |
boolean |
supportsOpenStatementsAcrossRollback()
Can statements remain open across rollbacks? |
boolean |
supportsOrderByUnrelated()
Can an "ORDER BY" clause use columns not in the SELECT statement? |
boolean |
supportsOuterJoins()
Is some form of outer join supported? |
boolean |
supportsPositionedDelete()
Is positioned DELETE supported? |
boolean |
supportsPositionedUpdate()
Is positioned UPDATE supported? |
boolean |
supportsResultSetConcurrency(int type,
int concurrency)
JDBC 2.0 Does the database support the concurrency type in combination with the given result set type? |
boolean |
supportsResultSetType(int type)
JDBC 2.0 Does the database support the given result set type? |
boolean |
supportsSchemasInDataManipulation()
Can a schema name be used in a data manipulation statement? |
boolean |
supportsSchemasInIndexDefinitions()
Can a schema name be used in an index definition statement? |
boolean |
supportsSchemasInPrivilegeDefinitions()
Can a schema name be used in a privilege definition statement? |
boolean |
supportsSchemasInProcedureCalls()
Can a schema name be used in a procedure call statement? |
boolean |
supportsSchemasInTableDefinitions()
Can a schema name be used in a table definition statement? |
boolean |
supportsSelectForUpdate()
Is SELECT for UPDATE supported? |
boolean |
supportsStoredProcedures()
Are stored procedure calls using the stored procedure escape syntax supported? |
boolean |
supportsSubqueriesInComparisons()
Are subqueries in comparison expressions supported? A JDBC CompliantTM driver always returns true. |
boolean |
supportsSubqueriesInExists()
Are subqueries in 'exists' expressions supported? A JDBC CompliantTM driver always returns true. |
boolean |
supportsSubqueriesInIns()
Are subqueries in 'in' statements supported? A JDBC CompliantTM driver always returns true. |
boolean |
supportsSubqueriesInQuantifieds()
Are subqueries in quantified expressions supported? A JDBC CompliantTM driver always returns true. |
boolean |
supportsTableCorrelationNames()
Are table correlation names supported? A JDBC CompliantTM driver always returns true. |
boolean |
supportsTransactionIsolationLevel(int level)
Does this database support the given transaction isolation level? |
boolean |
supportsTransactions()
Are transactions supported? If not, invoking the method commit is a noop and the
isolation level is TRANSACTION_NONE. |
boolean |
supportsUnion()
Is SQL UNION supported? |
boolean |
supportsUnionAll()
Is SQL UNION ALL supported? |
boolean |
updatesAreDetected(int type)
JDBC 2.0 Indicates whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated . |
boolean |
usesLocalFilePerTable()
Does the database use a file for each table? |
boolean |
usesLocalFiles()
Does the database store tables in a local file? |
Field Detail |
public static final int procedureResultUnknown
PROCEDURE_TYPE
in the
ResultSet
object returned by the method
getProcedures
.
Indicates that it is not known whether the procedure returns a result.
public static final int procedureNoResult
PROCEDURE_TYPE
in the
ResultSet
object returned by the method
getProcedures
.
Indicates that the procedure does not return a result.
public static final int procedureReturnsResult
PROCEDURE_TYPE
in the
ResultSet
object returned by the method
getProcedures
.
Indicates that the procedure returns a result.
public static final int procedureColumnUnknown
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureColumnIn
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureColumnInOut
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureColumnOut
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureColumnReturn
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureColumnResult
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureNoNulls
NULL
values are not allowed.
A possible value for the column
NULLABLE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureNullable
NULL
values are allowed.
A possible value for the column
NULLABLE
in the ResultSet
returned by the method getProcedureColumns
.public static final int procedureNullableUnknown
NULL
values are allowed
is unknown.
A possible value for the column
NULLABLE
in the ResultSet
returned by the method getProcedureColumns
.public static final int columnNoNulls
NULLABLE
in the ResultSet
returned by the method
getColumns
.public static final int columnNullable
NULL
values.
A possible value for the column
NULLABLE
in the ResultSet
returned by the method
getColumns
.public static final int columnNullableUnknown
NULLABLE
in the ResultSet
returned by the method
getColumns
.public static final int bestRowTemporary
SCOPE
in the ResultSet
object
returned by the method getBestRowIdentifier
.public static final int bestRowTransaction
SCOPE
in the ResultSet
object
returned by the method getBestRowIdentifier
.public static final int bestRowSession
SCOPE
in the ResultSet
object
returned by the method getBestRowIdentifier
.public static final int bestRowUnknown
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getBestRowIdentifier
.public static final int bestRowNotPseudo
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getBestRowIdentifier
.public static final int bestRowPseudo
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getBestRowIdentifier
.public static final int versionColumnUnknown
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getVersionColumns
.public static final int versionColumnNotPseudo
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getVersionColumns
.public static final int versionColumnPseudo
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getVersionColumns
.public static final int importedKeyCascade
UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
For the column UPDATE_RULE
,
it indicates that
when the primary key is updated, the foreign key (imported key)
is changed to agree with it.
For the column DELETE_RULE
,
it indicates that
when the primary key is deleted, rows that imported that key
are deleted.
public static final int importedKeyRestrict
UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
For the column UPDATE_RULE
, it indicates that
a primary key may not be updated if it has been imported by
another table as a foreign key.
For the column DELETE_RULE
, it indicates that
a primary key may not be deleted if it has been imported by
another table as a foreign key.
public static final int importedKeySetNull
UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
For the columns UPDATE_RULE
and DELETE_RULE
,
it indicates that
when the primary key is updated or deleted, the foreign key (imported key)
is changed to NULL
.
public static final int importedKeyNoAction
UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
For the columns UPDATE_RULE
and DELETE_RULE
,
it indicates that
if the primary key has been imported, it cannot be updated or deleted.
public static final int importedKeySetDefault
UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
For the columns UPDATE_RULE
and DELETE_RULE
,
it indicates that
if the primary key is updated or deleted, the foreign key (imported key)
is set to the default value.
public static final int importedKeyInitiallyDeferred
DEFERRABILITY
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
Indicates deferrability. See SQL-92 for a definition.
public static final int importedKeyInitiallyImmediate
DEFERRABILITY
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
Indicates deferrability. See SQL-92 for a definition.
public static final int importedKeyNotDeferrable
DEFERRABILITY
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
Indicates deferrability. See SQL-92 for a definition.
public static final int typeNoNulls
NULLABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
Indicates that a NULL
value is NOT allowed for this
data type.
public static final int typeNullable
NULLABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
Indicates that a NULL
value is allowed for this
data type.
public static final int typeNullableUnknown
NULLABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
Indicates that it is not known whether a NULL
value
is allowed for this data type.
public static final int typePredNone
SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
Indicates that WHERE
search clauses are not supported
for this type.
public static final int typePredChar
SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
Indicates that the only WHERE
search clause that can
be based on this type is WHERE . . .LIKE
.
public static final int typePredBasic
SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
Indicates that one can base all WHERE
search clauses
except WHERE . . .LIKE
on this data type.
public static final int typeSearchable
SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
Indicates that all WHERE
search clauses can be
based on this type.
public static final short tableIndexStatistic
TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.
public static final short tableIndexClustered
TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
Indicates that this table index is a clustered index.
public static final short tableIndexHashed
TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
Indicates that this table index is a hashed index.
public static final short tableIndexOther
TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.
Method Detail |
public boolean allProceduresAreCallable() throws SQLException
true
if so; false
otherwisepublic boolean allTablesAreSelectable() throws SQLException
true
if so; false
otherwisepublic String getURL() throws SQLException
public String getUserName() throws SQLException
public boolean isReadOnly() throws SQLException
true
if so; false
otherwisepublic boolean nullsAreSortedHigh() throws SQLException
true
if so; false
otherwisepublic boolean nullsAreSortedLow() throws SQLException
true
if so; false
otherwisepublic boolean nullsAreSortedAtStart() throws SQLException
true
if so; false
otherwisepublic boolean nullsAreSortedAtEnd() throws SQLException
true
if so; false
otherwisepublic String getDatabaseProductName() throws SQLException
public String getDatabaseProductVersion() throws SQLException
public String getDriverName() throws SQLException
public String getDriverVersion() throws SQLException
public int getDriverMajorVersion()
public int getDriverMinorVersion()
public boolean usesLocalFiles() throws SQLException
true
if so; false
otherwisepublic boolean usesLocalFilePerTable() throws SQLException
public boolean supportsMixedCaseIdentifiers() throws SQLException
true
if so; false
otherwisepublic boolean storesUpperCaseIdentifiers() throws SQLException
true
if so; false
otherwisepublic boolean storesLowerCaseIdentifiers() throws SQLException
true
if so; false
otherwisepublic boolean storesMixedCaseIdentifiers() throws SQLException
true
if so; false
otherwisepublic boolean supportsMixedCaseQuotedIdentifiers() throws SQLException
true
if so; false
otherwisepublic boolean storesUpperCaseQuotedIdentifiers() throws SQLException
true
if so; false
otherwisepublic boolean storesLowerCaseQuotedIdentifiers() throws SQLException
true
if so; false
otherwisepublic boolean storesMixedCaseQuotedIdentifiers() throws SQLException
true
if so; false
otherwisepublic String getIdentifierQuoteString() throws SQLException
public String getSQLKeywords() throws SQLException
public String getNumericFunctions() throws SQLException
public String getStringFunctions() throws SQLException
public String getSystemFunctions() throws SQLException
public String getTimeDateFunctions() throws SQLException
public String getSearchStringEscape() throws SQLException
The '_' character represents any single character.
The '%' character represents any sequence of zero or more characters.
public String getExtraNameCharacters() throws SQLException
public boolean supportsAlterTableWithAddColumn() throws SQLException
true
if so; false
otherwisepublic boolean supportsAlterTableWithDropColumn() throws SQLException
true
if so; false
otherwisepublic boolean supportsColumnAliasing() throws SQLException
If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required. A JDBC CompliantTM driver always returns true.
true
if so; false
otherwisepublic boolean nullPlusNonNullIsNull() throws SQLException
true
if so; false
otherwisepublic boolean supportsConvert() throws SQLException
true
if so; false
otherwisepublic boolean supportsConvert(int fromType, int toType) throws SQLException
fromType
- the type to convert fromtoType
- the type to convert totrue
if so; false
otherwiseTypes
public boolean supportsTableCorrelationNames() throws SQLException
true
if so; false
otherwisepublic boolean supportsDifferentTableCorrelationNames() throws SQLException
true
if so; false
otherwisepublic boolean supportsExpressionsInOrderBy() throws SQLException
true
if so; false
otherwisepublic boolean supportsOrderByUnrelated() throws SQLException
true
if so; false
otherwisepublic boolean supportsGroupBy() throws SQLException
true
if so; false
otherwisepublic boolean supportsGroupByUnrelated() throws SQLException
true
if so; false
otherwisepublic boolean supportsGroupByBeyondSelect() throws SQLException
true
if so; false
otherwisepublic boolean supportsLikeEscapeClause() throws SQLException
true
if so; false
otherwisepublic boolean supportsMultipleResultSets() throws SQLException
true
if so; false
otherwisepublic boolean supportsMultipleTransactions() throws SQLException
true
if so; false
otherwisepublic boolean supportsNonNullableColumns() throws SQLException
true
if so; false
otherwisepublic boolean supportsMinimumSQLGrammar() throws SQLException
true
if so; false
otherwisepublic boolean supportsCoreSQLGrammar() throws SQLException
true
if so; false
otherwisepublic boolean supportsExtendedSQLGrammar() throws SQLException
true
if so; false
otherwisepublic boolean supportsANSI92EntryLevelSQL() throws SQLException
true
if so; false
otherwisepublic boolean supportsANSI92IntermediateSQL() throws SQLException
true
if so; false
otherwisepublic boolean supportsANSI92FullSQL() throws SQLException
true
if so; false
otherwisepublic boolean supportsIntegrityEnhancementFacility() throws SQLException
true
if so; false
otherwisepublic boolean supportsOuterJoins() throws SQLException
true
if so; false
otherwisepublic boolean supportsFullOuterJoins() throws SQLException
true
if so; false
otherwisepublic boolean supportsLimitedOuterJoins() throws SQLException
true
if so; false
otherwisepublic String getSchemaTerm() throws SQLException
public String getProcedureTerm() throws SQLException
public String getCatalogTerm() throws SQLException
public boolean isCatalogAtStart() throws SQLException
public String getCatalogSeparator() throws SQLException
public boolean supportsSchemasInDataManipulation() throws SQLException
true
if so; false
otherwisepublic boolean supportsSchemasInProcedureCalls() throws SQLException
true
if so; false
otherwisepublic boolean supportsSchemasInTableDefinitions() throws SQLException
true
if so; false
otherwisepublic boolean supportsSchemasInIndexDefinitions() throws SQLException
true
if so; false
otherwisepublic boolean supportsSchemasInPrivilegeDefinitions() throws SQLException
true
if so; false
otherwisepublic boolean supportsCatalogsInDataManipulation() throws SQLException
true
if so; false
otherwisepublic boolean supportsCatalogsInProcedureCalls() throws SQLException
true
if so; false
otherwisepublic boolean supportsCatalogsInTableDefinitions() throws SQLException
true
if so; false
otherwisepublic boolean supportsCatalogsInIndexDefinitions() throws SQLException
true
if so; false
otherwisepublic boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException
true
if so; false
otherwisepublic boolean supportsPositionedDelete() throws SQLException
true
if so; false
otherwisepublic boolean supportsPositionedUpdate() throws SQLException
true
if so; false
otherwisepublic boolean supportsSelectForUpdate() throws SQLException
true
if so; false
otherwisepublic boolean supportsStoredProcedures() throws SQLException
true
if so; false
otherwisepublic boolean supportsSubqueriesInComparisons() throws SQLException
true
if so; false
otherwisepublic boolean supportsSubqueriesInExists() throws SQLException
true
if so; false
otherwisepublic boolean supportsSubqueriesInIns() throws SQLException
true
if so; false
otherwisepublic boolean supportsSubqueriesInQuantifieds() throws SQLException
true
if so; false
otherwisepublic boolean supportsCorrelatedSubqueries() throws SQLException
true
if so; false
otherwisepublic boolean supportsUnion() throws SQLException
true
if so; false
otherwisepublic boolean supportsUnionAll() throws SQLException
true
if so; false
otherwisepublic boolean supportsOpenCursorsAcrossCommit() throws SQLException
true
if cursors always remain open;
false
if they might not remain openpublic boolean supportsOpenCursorsAcrossRollback() throws SQLException
true
if cursors always remain open;
false
if they might not remain openpublic boolean supportsOpenStatementsAcrossCommit() throws SQLException
true
if statements always remain open;
false
if they might not remain openpublic boolean supportsOpenStatementsAcrossRollback() throws SQLException
true
if statements always remain open;
false
if they might not remain openpublic int getMaxBinaryLiteralLength() throws SQLException
public int getMaxCharLiteralLength() throws SQLException
public int getMaxColumnNameLength() throws SQLException
public int getMaxColumnsInGroupBy() throws SQLException
public int getMaxColumnsInIndex() throws SQLException
public int getMaxColumnsInOrderBy() throws SQLException
public int getMaxColumnsInSelect() throws SQLException
public int getMaxColumnsInTable() throws SQLException
public int getMaxConnections() throws SQLException
public int getMaxCursorNameLength() throws SQLException
public int getMaxIndexLength() throws SQLException
public int getMaxSchemaNameLength() throws SQLException
public int getMaxProcedureNameLength() throws SQLException
public int getMaxCatalogNameLength() throws SQLException
public int getMaxRowSize() throws SQLException
public boolean doesMaxRowSizeIncludeBlobs() throws SQLException
true
if so; false
otherwisepublic int getMaxStatementLength() throws SQLException
public int getMaxStatements() throws SQLException
public int getMaxTableNameLength() throws SQLException
public int getMaxTablesInSelect() throws SQLException
public int getMaxUserNameLength() throws SQLException
public int getDefaultTransactionIsolation() throws SQLException
java.sql.Connection
.Connection
public boolean supportsTransactions() throws SQLException
commit
is a noop and the
isolation level is TRANSACTION_NONE.true
if transactions are supported; false
otherwisepublic boolean supportsTransactionIsolationLevel(int level) throws SQLException
level
- the values are defined in java.sql.Connection
true
if so; false
otherwiseConnection
public boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException
true
if so; false
otherwisepublic boolean supportsDataManipulationTransactionsOnly() throws SQLException
true
if so; false
otherwisepublic boolean dataDefinitionCausesTransactionCommit() throws SQLException
true
if so; false
otherwisepublic boolean dataDefinitionIgnoredInTransactions() throws SQLException
true
if so; false
otherwisepublic ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException
Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME.
Each procedure description has the the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those
without a schemaprocedureNamePattern
- a procedure name patterngetSearchStringEscape()
public ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException
Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the ResultSet is a parameter description or column description with the following fields:
Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those
without a schemaprocedureNamePattern
- a procedure name patterncolumnNamePattern
- a column name patterngetSearchStringEscape()
public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException
Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
Note: Some databases may not return information for all tables.
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those
without a schematableNamePattern
- a table name patterntypes
- a list of table types to include; null returns all typesgetSearchStringEscape()
public ResultSet getSchemas() throws SQLException
The schema column is:
public ResultSet getCatalogs() throws SQLException
The catalog column is:
public ResultSet getTableTypes() throws SQLException
The table type is:
public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException
Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION.
Each column description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those
without a schematableNamePattern
- a table name patterncolumnNamePattern
- a column name patterngetSearchStringEscape()
public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException
Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table namecolumnNamePattern
- a column name patterngetSearchStringEscape()
public ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException
Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.
Each privilige description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those
without a schematableNamePattern
- a table name patterngetSearchStringEscape()
public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException
Each column description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table namescope
- the scope of interest; use same values as SCOPEnullable
- include columns that are nullable?public ResultSet getVersionColumns(String catalog, String schema, String table) throws SQLException
Each column description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table namepublic ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException
Each primary key column description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those
without a schematable
- a table namepublic ResultSet getImportedKeys(String catalog, String schema, String table) throws SQLException
Each primary key column description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those
without a schematable
- a table namegetExportedKeys(java.lang.String, java.lang.String, java.lang.String)
public ResultSet getExportedKeys(String catalog, String schema, String table) throws SQLException
Each foreign key column description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those
without a schematable
- a table namegetImportedKeys(java.lang.String, java.lang.String, java.lang.String)
public ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException
Each foreign key column description has the following columns:
primaryCatalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaprimarySchema
- a schema name; "" retrieves those
without a schemaprimaryTable
- the table name that exports the keyforeignCatalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaforeignSchema
- a schema name; "" retrieves those
without a schemaforeignTable
- the table name that imports the keygetImportedKeys(java.lang.String, java.lang.String, java.lang.String)
public ResultSet getTypeInfo() throws SQLException
Each type description has the following columns:
public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException
Each index column description has the following columns:
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table nameunique
- when true, return only indices for unique values;
when false, return indices regardless of whether unique or notapproximate
- when true, result is allowed to reflect approximate
or out of data values; when false, results are requested to be
accuratepublic boolean supportsResultSetType(int type) throws SQLException
type
- defined in java.sql.ResultSet
true
if so; false
otherwiseConnection
public boolean supportsResultSetConcurrency(int type, int concurrency) throws SQLException
type
- defined in java.sql.ResultSet
concurrency
- type defined in java.sql.ResultSet
true
if so; false
otherwiseConnection
public boolean ownUpdatesAreVisible(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXtrue
if updates are visible for the result set type;
false
otherwisepublic boolean ownDeletesAreVisible(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXtrue
if deletes are visible for the result set type;
false
otherwisepublic boolean ownInsertsAreVisible(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXtrue
if inserts are visible for the result set type;
false
otherwisepublic boolean othersUpdatesAreVisible(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXtrue
if updates made by others
are visible for the result set type;
false
otherwisepublic boolean othersDeletesAreVisible(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXtrue
if deletes made by others
are visible for the result set type;
false
otherwisepublic boolean othersInsertsAreVisible(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXpublic boolean updatesAreDetected(int type) throws SQLException
ResultSet.rowUpdated
.result
- set type, i.e. ResultSet.TYPE_XXXtrue
if changes are detected by the result set type;
false
otherwisepublic boolean deletesAreDetected(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXpublic boolean insertsAreDetected(int type) throws SQLException
result
- set type, i.e. ResultSet.TYPE_XXXpublic boolean supportsBatchUpdates() throws SQLException
public ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException
Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.
Each type description has the following columns:
Note: If the driver does not support UDTs, an empty result set is returned.
catalog
- a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those
without a schematypeNamePattern
- a type name pattern; may be a fully-qualified
nametypes
- a list of user-named types to include (JAVA_OBJECT,
STRUCT, or DISTINCT); null returns all typespublic Connection getConnection() throws SQLException
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |