| Method from java.sql.DatabaseMetaData Detail: |
|---|
 public boolean allProceduresAreCallable() throws SQLException
Retrieves whether the current user can call all the procedures
returned by the method getProcedures. |
public boolean allTablesAreSelectable() throws SQLException Retrieves whether the current user can use all the tables returned
by the method getTables in a SELECT
statement. |
public boolean autoCommitFailureClosesAllResultSets() throws SQLException Retrieves whether a SQLException while autoCommit is true inidcates
that all open ResultSets are closed, even ones that are holdable. When a SQLException occurs while
autocommit is true, it is vendor specific whether the JDBC driver responds with a commit operation, a
rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference
is in whether or not holdable ResultSets are closed. |
public boolean dataDefinitionCausesTransactionCommit() throws SQLException Retrieves whether a data definition statement within a transaction forces
the transaction to commit. |
public boolean dataDefinitionIgnoredInTransactions() throws SQLException Retrieves whether this database ignores a data definition statement
within a transaction. |
public boolean deletesAreDetected(int type) throws SQLException Retrieves whether or not a visible row delete can be detected by
calling the method ResultSet.rowDeleted. If the method
deletesAreDetected returns false, it means that
deleted rows are removed from the result set. |
public boolean doesMaxRowSizeIncludeBlobs() throws SQLException Retrieves whether the return value for the method
getMaxRowSize includes the SQL data types
LONGVARCHAR and LONGVARBINARY. |
public boolean generatedKeyAlwaysReturned() throws SQLException Retrieves whether a generated key will always be returned if the column
name(s) or index(es) specified for the auto generated key column(s)
are valid and the statement succeeds. The key that is returned may or
may not be based on the column(s) for the auto generated key.
Consult your JDBC driver documentation for additional details. |
public ResultSet getAttributes(String catalog,
String schemaPattern,
String typeNamePattern,
String attributeNamePattern) throws SQLException Retrieves a description of the given attribute of the given type
for a user-defined type (UDT) that is available in the given schema
and catalog.
Descriptions are returned only for attributes of UDTs matching the
catalog, schema, type, and attribute name criteria. They are ordered by
TYPE_CAT, TYPE_SCHEM,
TYPE_NAME and ORDINAL_POSITION. This description
does not contain inherited attributes.
The ResultSet object that is returned has the following
columns:
- TYPE_CAT String => type catalog (may be
null)
- TYPE_SCHEM String => type schema (may be
null)
- TYPE_NAME String => type name
- ATTR_NAME String => attribute name
- DATA_TYPE int => attribute type SQL type from java.sql.Types
- ATTR_TYPE_NAME String => Data source dependent type name.
For a UDT, the type name is fully qualified. For a REF, the type name is
fully qualified and represents the target type of the reference type.
- ATTR_SIZE int => column size. For char or date
types this is the maximum number of characters; for numeric or
decimal types this is precision.
- DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where
DECIMAL_DIGITS is not applicable.
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => whether NULL is allowed
- attributeNoNulls - might not allow NULL values
- attributeNullable - definitely allows NULL values
- attributeNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be
null)
- ATTR_DEF String => default value (may be
null)
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the
maximum number of bytes in the column
- ORDINAL_POSITION int => index of the attribute in the UDT
(starting at 1)
- IS_NULLABLE String => ISO rules are used to determine
the nullability for a attribute.
- YES --- if the attribute can include NULLs
- NO --- if the attribute cannot include NULLs
- empty string --- if the nullability for the
attribute is unknown
- SCOPE_CATALOG String => catalog of table that is the
scope of a reference attribute (
null if DATA_TYPE isn't REF)
- SCOPE_SCHEMA String => schema of table that is the
scope of a reference attribute (
null if DATA_TYPE isn't REF)
- SCOPE_TABLE String => table name that is the scope of a
reference attribute (
null if the DATA_TYPE isn't REF)
- SOURCE_DATA_TYPE short => source type of a distinct type or user-generated
Ref type,SQL type from java.sql.Types (
null if DATA_TYPE
isn't DISTINCT or user-generated REF)
|
public ResultSet getBestRowIdentifier(String catalog,
String schema,
String table,
int scope,
boolean nullable) throws SQLException Retrieves a description of a table's optimal set of columns that
uniquely identifies a row. They are ordered by SCOPE.
Each column description has the following columns:
- SCOPE short => actual scope of result
- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name,
for a UDT the type name is fully qualified
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => not used
- DECIMAL_DIGITS short => scale - Null is returned for data types where
DECIMAL_DIGITS is not applicable.
- PSEUDO_COLUMN short => is this a pseudo column
like an Oracle ROWID
- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column.
For numeric data, this is the maximum precision. For character data, this is the length in characters.
For datetime datatypes, this is the length in characters of the String representation (assuming the
maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype,
this is the length in bytes. Null is returned for data types where the
column size is not applicable. |
public String getCatalogSeparator() throws SQLException Retrieves the String that this database uses as the
separator between a catalog and table name. |
public String getCatalogTerm() throws SQLException Retrieves the database vendor's preferred term for "catalog". |
public ResultSet getCatalogs() throws SQLException Retrieves the catalog names available in this database. The results
are ordered by catalog name.
The catalog column is:
- TABLE_CAT String => catalog name
|
public ResultSet getClientInfoProperties() throws SQLException |
public ResultSet getColumnPrivileges(String catalog,
String schema,
String table,
String columnNamePattern) throws SQLException Retrieves a description of the access rights for a table's columns.
Only privileges matching the column name criteria are
returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- GRANTOR String => grantor of access (may be
null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT,
INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted
to grant to others; "NO" if not;
null if unknown
|
public ResultSet getColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern) throws SQLException Retrieves a description of table columns available in
the specified catalog.
Only column descriptions matching the catalog, schema, table
and column name criteria are returned. They are ordered by
TABLE_CAT,TABLE_SCHEM,
TABLE_NAME, and ORDINAL_POSITION.
Each column description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => Data source dependent type name,
for a UDT the type name is fully qualified
- COLUMN_SIZE int => column size.
- BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where
DECIMAL_DIGITS is not applicable.
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => is NULL allowed.
- columnNoNulls - might not allow
NULL values
- columnNullable - definitely allows
NULL values
- columnNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be
null)
- COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be
null)
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the
maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table
(starting at 1)
- IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the
column is unknown
- SCOPE_CATALOG String => catalog of table that is the scope
of a reference attribute (
null if DATA_TYPE isn't REF)
- SCOPE_SCHEMA String => schema of table that is the scope
of a reference attribute (
null if the DATA_TYPE isn't REF)
- SCOPE_TABLE String => table name that this the scope
of a reference attribute (
null if the DATA_TYPE isn't REF)
- SOURCE_DATA_TYPE short => source type of a distinct type or user-generated
Ref type, SQL type from java.sql.Types (
null if DATA_TYPE
isn't DISTINCT or user-generated REF)
- IS_AUTOINCREMENT String => Indicates whether this column is auto incremented
- YES --- if the column is auto incremented
- NO --- if the column is not auto incremented
- empty string --- if it cannot be determined whether the column is auto incremented
- IS_GENERATEDCOLUMN String => Indicates whether this is a generated column
- YES --- if this a generated column
- NO --- if this not a generated column
- empty string --- if it cannot be determined whether this is a generated column
The COLUMN_SIZE column specifies the column size for the given column.
For numeric data, this is the maximum precision. For character data, this is the length in characters.
For datetime datatypes, this is the length in characters of the String representation (assuming the
maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype,
this is the length in bytes. Null is returned for data types where the
column size is not applicable. |
public Connection getConnection() throws SQLException Retrieves the connection that produced this metadata object.
|
public ResultSet getCrossReference(String parentCatalog,
String parentSchema,
String parentTable,
String foreignCatalog,
String foreignSchema,
String foreignTable) throws SQLException |
public int getDatabaseMajorVersion() throws SQLException Retrieves the major version number of the underlying database. |
public int getDatabaseMinorVersion() throws SQLException Retrieves the minor version number of the underlying database. |
public String getDatabaseProductName() throws SQLException Retrieves the name of this database product. |
public String getDatabaseProductVersion() throws SQLException Retrieves the version number of this database product. |
public int getDefaultTransactionIsolation() throws SQLException Retrieves this database's default transaction isolation level. The
possible values are defined in java.sql.Connection. |
public int getDriverMajorVersion() Retrieves this JDBC driver's major version number. |
public int getDriverMinorVersion() Retrieves this JDBC driver's minor version number. |
public String getDriverName() throws SQLException Retrieves the name of this JDBC driver. |
public String getDriverVersion() throws SQLException Retrieves the version number of this JDBC driver as a String. |
public ResultSet getExportedKeys(String catalog,
String schema,
String table) throws SQLException |
public String getExtraNameCharacters() throws SQLException Retrieves all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, A-Z, 0-9 and _). |
public ResultSet getFunctionColumns(String catalog,
String schemaPattern,
String functionNamePattern,
String columnNamePattern) throws SQLException Retrieves a description of the given catalog's system or user
function parameters and return type.
Only descriptions matching the schema, function and
parameter name criteria are returned. They are ordered by
FUNCTION_CAT, FUNCTION_SCHEM,
FUNCTION_NAME and
SPECIFIC_ NAME. Within this, the return value,
if any, is first. Next are the parameter descriptions in call
order. The column descriptions follow in column number order.
Each row in the ResultSet
is a parameter description, column description or
return type description with the following fields:
- FUNCTION_CAT String => function catalog (may be
null)
- FUNCTION_SCHEM String => function schema (may be
null)
- FUNCTION_NAME String => function name. This is the name
used to invoke the function
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- functionColumnUnknown - nobody knows
- functionColumnIn - IN parameter
- functionColumnInOut - INOUT parameter
- functionColumnOut - OUT parameter
- functionColumnReturn - function return value
- functionColumnResult - Indicates that the parameter or column
is a column in the
ResultSet
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the
type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale - null is returned for data types where
SCALE is not applicable.
- RADIX short => radix
- NULLABLE short => can it contain NULL.
- functionNoNulls - does not allow NULL values
- functionNullable - allows NULL values
- functionNullableUnknown - nullability unknown
- REMARKS String => comment describing column/parameter
- CHAR_OCTET_LENGTH int => the maximum length of binary
and character based parameters or columns. For any other datatype the returned value
is a NULL
- ORDINAL_POSITION int => the ordinal position, starting
from 1, for the input and output parameters. A value of 0
is returned if this row describes the function's return value.
For result set columns, it is the
ordinal position of the column in the result set starting from 1.
- IS_NULLABLE String => ISO rules are used to determine
the nullability for a parameter or column.
- YES --- if the parameter or column can include NULLs
- NO --- if the parameter or column cannot include NULLs
- empty string --- if the nullability for the
parameter or column is unknown
- SPECIFIC_NAME String => the name which uniquely identifies
this function within its schema. This is a user specified, or DBMS
generated, name that may be different then the
FUNCTION_NAME
for example with overload functions
The PRECISION column represents the specified column size for the given
parameter or column.
For numeric data, this is the maximum precision. For character data, this is the length in characters.
For datetime datatypes, this is the length in characters of the String representation (assuming the
maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype,
this is the length in bytes. Null is returned for data types where the
column size is not applicable. |
public ResultSet getFunctions(String catalog,
String schemaPattern,
String functionNamePattern) throws SQLException Retrieves a description of the system and user functions available
in the given catalog.
Only system and user function descriptions matching the schema and
function name criteria are returned. They are ordered by
FUNCTION_CAT, FUNCTION_SCHEM,
FUNCTION_NAME and
SPECIFIC_ NAME.
Each function description has the the following columns:
- FUNCTION_CAT String => function catalog (may be
null)
- FUNCTION_SCHEM String => function schema (may be
null)
- FUNCTION_NAME String => function name. This is the name
used to invoke the function
- REMARKS String => explanatory comment on the function
- FUNCTION_TYPE short => kind of function:
- functionResultUnknown - Cannot determine if a return value
or table will be returned
- functionNoTable- Does not return a table
- functionReturnsTable - Returns a table
- SPECIFIC_NAME String => the name which uniquely identifies
this function within its schema. This is a user specified, or DBMS
generated, name that may be different then the
FUNCTION_NAME
for example with overload functions
A user may not have permission to execute any of the functions that are
returned by getFunctions |
public String getIdentifierQuoteString() throws SQLException Retrieves the string used to quote SQL identifiers.
This method returns a space " " if identifier quoting is not supported. |
public ResultSet getImportedKeys(String catalog,
String schema,
String table) throws SQLException |
public ResultSet getIndexInfo(String catalog,
String schema,
String table,
boolean unique,
boolean approximate) throws SQLException |
public int getJDBCMajorVersion() throws SQLException Retrieves the major JDBC version number for this
driver. |
public int getJDBCMinorVersion() throws SQLException Retrieves the minor JDBC version number for this
driver. |
public int getMaxBinaryLiteralLength() throws SQLException Retrieves the maximum number of hex characters this database allows in an
inline binary literal. |
public int getMaxCatalogNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a
catalog name. |
public int getMaxCharLiteralLength() throws SQLException Retrieves the maximum number of characters this database allows
for a character literal. |
public int getMaxColumnNameLength() throws SQLException Retrieves the maximum number of characters this database allows
for a column name. |
public int getMaxColumnsInGroupBy() throws SQLException Retrieves the maximum number of columns this database allows in a
GROUP BY clause. |
public int getMaxColumnsInIndex() throws SQLException Retrieves the maximum number of columns this database allows in an index. |
public int getMaxColumnsInOrderBy() throws SQLException Retrieves the maximum number of columns this database allows in an
ORDER BY clause. |
public int getMaxColumnsInSelect() throws SQLException Retrieves the maximum number of columns this database allows in a
SELECT list. |
public int getMaxColumnsInTable() throws SQLException Retrieves the maximum number of columns this database allows in a table. |
public int getMaxConnections() throws SQLException Retrieves the maximum number of concurrent connections to this
database that are possible. |
public int getMaxCursorNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a
cursor name. |
public int getMaxIndexLength() throws SQLException Retrieves the maximum number of bytes this database allows for an
index, including all of the parts of the index. |
public int getMaxProcedureNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a
procedure name. |
public int getMaxRowSize() throws SQLException Retrieves the maximum number of bytes this database allows in
a single row. |
public int getMaxSchemaNameLength() throws SQLException Retrieves the maximum number of characters that this database allows in a
schema name. |
public int getMaxStatementLength() throws SQLException Retrieves the maximum number of characters this database allows in
an SQL statement. |
public int getMaxStatements() throws SQLException Retrieves the maximum number of active statements to this database
that can be open at the same time. |
public int getMaxTableNameLength() throws SQLException Retrieves the maximum number of characters this database allows in
a table name. |
public int getMaxTablesInSelect() throws SQLException Retrieves the maximum number of tables this database allows in a
SELECT statement. |
public int getMaxUserNameLength() throws SQLException Retrieves the maximum number of characters this database allows in
a user name. |
public String getNumericFunctions() throws SQLException Retrieves a comma-separated list of math functions available with
this database. These are the Open /Open CLI math function names used in
the JDBC function escape clause. |
public ResultSet getPrimaryKeys(String catalog,
String schema,
String table) throws SQLException |
public ResultSet getProcedureColumns(String catalog,
String schemaPattern,
String procedureNamePattern,
String columnNamePattern) throws SQLException Retrieves a description of the given catalog's stored procedure parameter
and result columns.
Only descriptions matching the schema, procedure and
parameter name criteria are returned. They are ordered by
PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME. Within this, the return value,
if any, is first. Next are the parameter descriptions in call
order. The column descriptions follow in column number order.
Each row in the ResultSet is a parameter description or
column description with the following fields:
- PROCEDURE_CAT String => procedure catalog (may be
null)
- PROCEDURE_SCHEM String => procedure schema (may be
null)
- PROCEDURE_NAME String => procedure name
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in
ResultSet
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the
type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale - null is returned for data types where
SCALE is not applicable.
- RADIX short => radix
- NULLABLE short => can it contain NULL.
- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
- REMARKS String => comment describing parameter/column
- COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be
null)
- The string NULL (not enclosed in quotes) - if NULL was specified as the default value
- TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation
- NULL - if a default value was not specified
- SQL_DATA_TYPE int => reserved for future use
- SQL_DATETIME_SUB int => reserved for future use
- CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a
NULL
- ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0
is returned if this row describes the procedure's return value. For result set columns, it is the
ordinal position of the column in the result set starting from 1. If there are
multiple result sets, the column ordinal positions are implementation
defined.
- IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the
column is unknown
- SPECIFIC_NAME String => the name which uniquely identifies this procedure within its schema.
Note: Some databases may not return the column
descriptions for a procedure.
The PRECISION column represents the specified column size for the given column.
For numeric data, this is the maximum precision. For character data, this is the length in characters.
For datetime datatypes, this is the length in characters of the String representation (assuming the
maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype,
this is the length in bytes. Null is returned for data types where the
column size is not applicable. |
public String getProcedureTerm() throws SQLException Retrieves the database vendor's preferred term for "procedure". |
public ResultSet getProcedures(String catalog,
String schemaPattern,
String procedureNamePattern) throws SQLException Retrieves a description of the stored procedures available in the given
catalog.
Only procedure descriptions matching the schema and
procedure name criteria are returned. They are ordered by
PROCEDURE_CAT, PROCEDURE_SCHEM,
PROCEDURE_NAME and SPECIFIC_ NAME.
Each procedure description has the the following columns:
- PROCEDURE_CAT String => procedure catalog (may be
null)
- PROCEDURE_SCHEM String => procedure schema (may be
null)
- PROCEDURE_NAME String => procedure name
- reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String => explanatory comment on the procedure
- PROCEDURE_TYPE short => kind of procedure:
- procedureResultUnknown - Cannot determine if a return value
will be returned
- procedureNoResult - Does not return a return value
- procedureReturnsResult - Returns a return value
- SPECIFIC_NAME String => The name which uniquely identifies this
procedure within its schema.
A user may not have permissions to execute any of the procedures that are
returned by getProcedures |
public ResultSet getPseudoColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern) throws SQLException Retrieves a description of the pseudo or hidden columns available
in a given table within the specified catalog and schema.
Pseudo or hidden columns may not always be stored within
a table and are not visible in a ResultSet unless they are
specified in the query's outermost SELECT list. Pseudo or hidden
columns may not necessarily be able to be modified. If there are
no pseudo or hidden columns, an empty ResultSet is returned.
Only column descriptions matching the catalog, schema, table
and column name criteria are returned. They are ordered by
TABLE_CAT,TABLE_SCHEM, TABLE_NAME
and COLUMN_NAME.
Each column description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL type from java.sql.Types
- COLUMN_SIZE int => column size.
- DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where
DECIMAL_DIGITS is not applicable.
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- COLUMN_USAGE String => The allowed usage for the column. The
value returned will correspond to the enum name returned by PseudoColumnUsage.name()
- REMARKS String => comment describing column (may be
null)
- CHAR_OCTET_LENGTH int => for char types the
maximum number of bytes in the column
- IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
The COLUMN_SIZE column specifies the column size for the given column.
For numeric data, this is the maximum precision. For character data, this is the length in characters.
For datetime datatypes, this is the length in characters of the String representation (assuming the
maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype,
this is the length in bytes. Null is returned for data types where the
column size is not applicable. |
public int getResultSetHoldability() throws SQLException Retrieves this database's default holdability for ResultSet
objects. |
public RowIdLifetime getRowIdLifetime() throws SQLException
ROWID_UNSUPPORTED < ROWID_VALID_OTHER < ROWID_VALID_TRANSACTION
< ROWID_VALID_SESSION < ROWID_VALID_FOREVER
so conditional logic such as
if (metadata.getRowIdLifetime() > DatabaseMetaData.ROWID_VALID_TRANSACTION)
can be used. Valid Forever means valid across all Sessions, and valid for
a Session means valid across all its contained Transactions. |
public String getSQLKeywords() throws SQLException Retrieves a comma-separated list of all of this database's SQL keywords
that are NOT also SQL:2003 keywords. |
public int getSQLStateType() throws SQLException Indicates whether the SQLSTATE returned by SQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003. |
public String getSchemaTerm() throws SQLException Retrieves the database vendor's preferred term for "schema". |
public ResultSet getSchemas() throws SQLException Retrieves the schema names available in this database. The results
are ordered by TABLE_CATALOG and
TABLE_SCHEM.
The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null)
|
public ResultSet getSchemas(String catalog,
String schemaPattern) throws SQLException Retrieves the schema names available in this database. The results
are ordered by TABLE_CATALOG and
TABLE_SCHEM.
The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null)
|
public String getSearchStringEscape() throws SQLException Retrieves the string that can be used to escape wildcard characters.
This is the string that can be used to escape '_' or '%' in
the catalog search parameters that are a pattern (and therefore use one
of the wildcard characters).
The '_' character represents any single character;
the '%' character represents any sequence of zero or
more characters. |
public String getStringFunctions() throws SQLException Retrieves a comma-separated list of string functions available with
this database. These are the Open Group CLI string function names used
in the JDBC function escape clause. |
public ResultSet getSuperTables(String catalog,
String schemaPattern,
String tableNamePattern) throws SQLException Retrieves a description of the table hierarchies defined in a particular
schema in this database.
Only supertable information for tables matching the catalog, schema
and table name are returned. The table name parameter may be a fully-
qualified name, in which case, the catalog and schemaPattern parameters
are ignored. If a table does not have a super table, it is not listed here.
Supertables have to be defined in the same catalog and schema as the
sub tables. Therefore, the type description does not need to include
this information for the supertable.
Each type description has the following columns:
- TABLE_CAT String => the type's catalog (may be
null)
- TABLE_SCHEM String => type's schema (may be
null)
- TABLE_NAME String => type name
- SUPERTABLE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an
empty result set is returned. |
public ResultSet getSuperTypes(String catalog,
String schemaPattern,
String typeNamePattern) throws SQLException Retrieves a description of the user-defined type (UDT) hierarchies defined in a
particular schema in this database. Only the immediate super type/
sub type relationship is modeled.
Only supertype information for UDTs matching the catalog,
schema, and type name is returned. The type name parameter
may be a fully-qualified name. When the UDT name supplied is a
fully-qualified name, the catalog and schemaPattern parameters are
ignored.
If a UDT does not have a direct super type, it is not listed here.
A row of the ResultSet object returned by this method
describes the designated UDT and a direct supertype. A row has the following
columns:
- TYPE_CAT String => the UDT's catalog (may be
null)
- TYPE_SCHEM String => UDT's schema (may be
null)
- TYPE_NAME String => type name of the UDT
- SUPERTYPE_CAT String => the direct super type's catalog
(may be
null)
- SUPERTYPE_SCHEM String => the direct super type's schema
(may be
null)
- SUPERTYPE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an
empty result set is returned. |
public String getSystemFunctions() throws SQLException Retrieves a comma-separated list of system functions available with
this database. These are the Open Group CLI system function names used
in the JDBC function escape clause. |
public ResultSet getTablePrivileges(String catalog,
String schemaPattern,
String tableNamePattern) throws SQLException Retrieves a description of the access rights for each table available
in a catalog. Note that a table privilege applies to one or
more columns in the table. It would be wrong to assume that
this privilege applies to all columns (this may be true for
some systems but is not true for all.)
Only privileges matching the schema and table name
criteria are returned. They are ordered by
TABLE_CAT,
TABLE_SCHEM, TABLE_NAME,
and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- GRANTOR String => grantor of access (may be
null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT,
INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted
to grant to others; "NO" if not;
null if unknown
|
public ResultSet getTableTypes() throws SQLException Retrieves the table types available in this database. The results
are ordered by table type.
The table type is:
- TABLE_TYPE String => table type. Typical types are "TABLE",
"VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
"LOCAL TEMPORARY", "ALIAS", "SYNONYM".
|
public ResultSet getTables(String catalog,
String schemaPattern,
String tableNamePattern,
String[] types) throws SQLException Retrieves a description of the tables available in the given catalog.
Only table descriptions matching the catalog, schema, table
name and type criteria are returned. They are ordered by
TABLE_TYPE, TABLE_CAT,
TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- TABLE_TYPE String => table type. Typical types are "TABLE",
"VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
"LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- REMARKS String => explanatory comment on the table
- TYPE_CAT String => the types catalog (may be
null)
- TYPE_SCHEM String => the types schema (may be
null)
- TYPE_NAME String => type name (may be
null)
- SELF_REFERENCING_COL_NAME String => name of the designated
"identifier" column of a typed table (may be
null)
- REF_GENERATION String => specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are
"SYSTEM", "USER", "DERIVED". (may be
null)
Note: Some databases may not return information for
all tables. |
public String getTimeDateFunctions() throws SQLException Retrieves a comma-separated list of the time and date functions available
with this database. |
public ResultSet getTypeInfo() throws SQLException Retrieves a description of all the data types supported by
this database. They are ordered by DATA_TYPE and then by how
closely the data type maps to the corresponding JDBC SQL type.
If the database supports SQL distinct types, then getTypeInfo() will return
a single row with a TYPE_NAME of DISTINCT and a DATA_TYPE of Types.DISTINCT.
If the database supports SQL structured types, then getTypeInfo() will return
a single row with a TYPE_NAME of STRUCT and a DATA_TYPE of Types.STRUCT.
If SQL distinct or structured types are supported, then information on the
individual types may be obtained from the getUDTs() method.
Each type description has the following columns:
- TYPE_NAME String => Type name
- DATA_TYPE int => SQL data type from java.sql.Types
- PRECISION int => maximum precision
- LITERAL_PREFIX String => prefix used to quote a literal
(may be
null)
- LITERAL_SUFFIX String => suffix used to quote a literal
(may be
null)
- CREATE_PARAMS String => parameters used in creating
the type (may be
null)
- NULLABLE short => can you use NULL for this type.
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean=> is it case sensitive.
- SEARCHABLE short => can you use "WHERE" based on this type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean => is it unsigned.
- FIXED_PREC_SCALE boolean => can it be a money value.
- AUTO_INCREMENT boolean => can it be used for an
auto-increment value.
- LOCAL_TYPE_NAME String => localized version of type name
(may be
null)
- MINIMUM_SCALE short => minimum scale supported
- MAXIMUM_SCALE short => maximum scale supported
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- NUM_PREC_RADIX int => usually 2 or 10
The PRECISION column represents the maximum column size that the server supports for the given datatype.
For numeric data, this is the maximum precision. For character data, this is the length in characters.
For datetime datatypes, this is the length in characters of the String representation (assuming the
maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype,
this is the length in bytes. Null is returned for data types where the
column size is not applicable. |
public ResultSet getUDTs(String catalog,
String schemaPattern,
String typeNamePattern,
int[] types) throws SQLException Retrieves a description of the user-defined types (UDTs) defined
in a particular schema. Schema-specific UDTs may have type
JAVA_OBJECT, STRUCT,
or DISTINCT.
Only types matching the catalog, schema, type name and type
criteria are returned. They are ordered by DATA_TYPE,
TYPE_CAT, TYPE_SCHEM and
TYPE_NAME. The type name parameter may be a fully-qualified
name. In this case, the catalog and schemaPattern parameters are
ignored.
Each type description has the following columns:
- TYPE_CAT String => the type's catalog (may be
null)
- TYPE_SCHEM String => type's schema (may be
null)
- TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE int => type value defined in java.sql.Types.
One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String => explanatory comment on the type
- BASE_TYPE short => type code of the source type of a
DISTINCT type or the type that implements the user-generated
reference type of the SELF_REFERENCING_COLUMN of a structured
type as defined in java.sql.Types (
null if DATA_TYPE is not
DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty
result set is returned. |
public String getURL() throws SQLException Retrieves the URL for this DBMS. |
public String getUserName() throws SQLException Retrieves the user name as known to this database. |
public ResultSet getVersionColumns(String catalog,
String schema,
String table) throws SQLException Retrieves a description of a table's columns that are automatically
updated when any value in a row is updated. They are
unordered.
Each column description has the following columns:
- SCOPE short => is not used
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from
java.sql.Types
- TYPE_NAME String => Data source-dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => length of column value in bytes
- DECIMAL_DIGITS short => scale - Null is returned for data types where
DECIMAL_DIGITS is not applicable.
- PSEUDO_COLUMN short => whether this is pseudo column
like an Oracle ROWID
- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column.
For numeric data, this is the maximum precision. For character data, this is the length in characters.
For datetime datatypes, this is the length in characters of the String representation (assuming the
maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype,
this is the length in bytes. Null is returned for data types where the
column size is not applicable. |
public boolean insertsAreDetected(int type) throws SQLException Retrieves whether or not a visible row insert can be detected
by calling the method ResultSet.rowInserted. |
public boolean isCatalogAtStart() throws SQLException Retrieves whether a catalog appears at the start of a fully qualified
table name. If not, the catalog appears at the end. |
public boolean isReadOnly() throws SQLException Retrieves whether this database is in read-only mode. |
public boolean locatorsUpdateCopy() throws SQLException Indicates whether updates made to a LOB are made on a copy or directly
to the LOB. |
public boolean nullPlusNonNullIsNull() throws SQLException Retrieves whether this database supports concatenations between
NULL and non-NULL values being
NULL. |
public boolean nullsAreSortedAtEnd() throws SQLException Retrieves whether NULL values are sorted at the end regardless of
sort order. |
public boolean nullsAreSortedAtStart() throws SQLException Retrieves whether NULL values are sorted at the start regardless
of sort order. |
public boolean nullsAreSortedHigh() throws SQLException Retrieves whether NULL values are sorted high.
Sorted high means that NULL values
sort higher than any other value in a domain. In an ascending order,
if this method returns true, NULL values
will appear at the end. By contrast, the method
nullsAreSortedAtEnd indicates whether NULL values
are sorted at the end regardless of sort order. |
public boolean nullsAreSortedLow() throws SQLException Retrieves whether NULL values are sorted low.
Sorted low means that NULL values
sort lower than any other value in a domain. In an ascending order,
if this method returns true, NULL values
will appear at the beginning. By contrast, the method
nullsAreSortedAtStart indicates whether NULL values
are sorted at the beginning regardless of sort order. |
public boolean othersDeletesAreVisible(int type) throws SQLException Retrieves whether deletes made by others are visible. |
public boolean othersInsertsAreVisible(int type) throws SQLException Retrieves whether inserts made by others are visible. |
public boolean othersUpdatesAreVisible(int type) throws SQLException Retrieves whether updates made by others are visible. |
public boolean ownDeletesAreVisible(int type) throws SQLException Retrieves whether a result set's own deletes are visible. |
public boolean ownInsertsAreVisible(int type) throws SQLException Retrieves whether a result set's own inserts are visible. |
public boolean ownUpdatesAreVisible(int type) throws SQLException Retrieves whether for the given type of ResultSet object,
the result set's own updates are visible. |
public boolean storesLowerCaseIdentifiers() throws SQLException Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in lower case. |
public boolean storesLowerCaseQuotedIdentifiers() throws SQLException Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in lower case. |
public boolean storesMixedCaseIdentifiers() throws SQLException Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in mixed case. |
public boolean storesMixedCaseQuotedIdentifiers() throws SQLException Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in mixed case. |
public boolean storesUpperCaseIdentifiers() throws SQLException Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in upper case. |
public boolean storesUpperCaseQuotedIdentifiers() throws SQLException Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in upper case. |
public boolean supportsANSI92EntryLevelSQL() throws SQLException Retrieves whether this database supports the ANSI92 entry level SQL
grammar. |
public boolean supportsANSI92FullSQL() throws SQLException Retrieves whether this database supports the ANSI92 full SQL grammar supported. |
public boolean supportsANSI92IntermediateSQL() throws SQLException Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported. |
public boolean supportsAlterTableWithAddColumn() throws SQLException Retrieves whether this database supports ALTER TABLE
with add column. |
public boolean supportsAlterTableWithDropColumn() throws SQLException Retrieves whether this database supports ALTER TABLE
with drop column. |
public boolean supportsBatchUpdates() throws SQLException Retrieves whether this database supports batch updates. |
public boolean supportsCatalogsInDataManipulation() throws SQLException Retrieves whether a catalog name can be used in a data manipulation statement. |
public boolean supportsCatalogsInIndexDefinitions() throws SQLException Retrieves whether a catalog name can be used in an index definition statement. |
public boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException Retrieves whether a catalog name can be used in a privilege definition statement. |
public boolean supportsCatalogsInProcedureCalls() throws SQLException Retrieves whether a catalog name can be used in a procedure call statement. |
public boolean supportsCatalogsInTableDefinitions() throws SQLException Retrieves whether a catalog name can be used in a table definition statement. |
public boolean supportsColumnAliasing() throws SQLException Retrieves whether this database supports column aliasing.
If so, the SQL AS clause can be used to provide names for
computed columns or to provide alias names for columns as
required. |
public boolean supportsConvert() throws SQLException Retrieves whether this database supports the JDBC scalar function
CONVERT for the conversion of one JDBC type to another.
The JDBC types are the generic SQL data types defined
in java.sql.Types. |
public boolean supportsConvert(int fromType,
int toType) throws SQLException Retrieves whether this database supports the JDBC scalar function
CONVERT for conversions between the JDBC types fromType
and toType. The JDBC types are the generic SQL data types defined
in java.sql.Types. |
public boolean supportsCoreSQLGrammar() throws SQLException Retrieves whether this database supports the ODBC Core SQL grammar. |
public boolean supportsCorrelatedSubqueries() throws SQLException Retrieves whether this database supports correlated subqueries. |
public boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException Retrieves whether this database supports both data definition and
data manipulation statements within a transaction. |
public boolean supportsDataManipulationTransactionsOnly() throws SQLException Retrieves whether this database supports only data manipulation
statements within a transaction. |
public boolean supportsDifferentTableCorrelationNames() throws SQLException Retrieves whether, when table correlation names are supported, they
are restricted to being different from the names of the tables. |
public boolean supportsExpressionsInOrderBy() throws SQLException Retrieves whether this database supports expressions in
ORDER BY lists. |
public boolean supportsExtendedSQLGrammar() throws SQLException Retrieves whether this database supports the ODBC Extended SQL grammar. |
public boolean supportsFullOuterJoins() throws SQLException Retrieves whether this database supports full nested outer joins. |
public boolean supportsGetGeneratedKeys() throws SQLException Retrieves whether auto-generated keys can be retrieved after
a statement has been executed |
public boolean supportsGroupBy() throws SQLException Retrieves whether this database supports some form of
GROUP BY clause. |
public boolean supportsGroupByBeyondSelect() throws SQLException Retrieves whether this database supports using columns not included in
the SELECT statement in a GROUP BY clause
provided that all of the columns in the SELECT statement
are included in the GROUP BY clause. |
public boolean supportsGroupByUnrelated() throws SQLException Retrieves whether this database supports using a column that is
not in the SELECT statement in a
GROUP BY clause. |
public boolean supportsIntegrityEnhancementFacility() throws SQLException Retrieves whether this database supports the SQL Integrity
Enhancement Facility. |
public boolean supportsLikeEscapeClause() throws SQLException Retrieves whether this database supports specifying a
LIKE escape clause. |
public boolean supportsLimitedOuterJoins() throws SQLException Retrieves whether this database provides limited support for outer
joins. (This will be true if the method
supportsFullOuterJoins returns true). |
public boolean supportsMinimumSQLGrammar() throws SQLException Retrieves whether this database supports the ODBC Minimum SQL grammar. |
public boolean supportsMixedCaseIdentifiers() throws SQLException Retrieves whether this database treats mixed case unquoted SQL identifiers as
case sensitive and as a result stores them in mixed case. |
public boolean supportsMixedCaseQuotedIdentifiers() throws SQLException Retrieves whether this database treats mixed case quoted SQL identifiers as
case sensitive and as a result stores them in mixed case. |
public boolean supportsMultipleOpenResults() throws SQLException Retrieves whether it is possible to have multiple ResultSet objects
returned from a CallableStatement object
simultaneously. |
public boolean supportsMultipleResultSets() throws SQLException Retrieves whether this database supports getting multiple
ResultSet objects from a single call to the
method execute. |
public boolean supportsMultipleTransactions() throws SQLException Retrieves whether this database allows having multiple
transactions open at once (on different connections). |
public boolean supportsNamedParameters() throws SQLException Retrieves whether this database supports named parameters to callable
statements. |
public boolean supportsNonNullableColumns() throws SQLException Retrieves whether columns in this database may be defined as non-nullable. |
public boolean supportsOpenCursorsAcrossCommit() throws SQLException Retrieves whether this database supports keeping cursors open
across commits. |
public boolean supportsOpenCursorsAcrossRollback() throws SQLException Retrieves whether this database supports keeping cursors open
across rollbacks. |
public boolean supportsOpenStatementsAcrossCommit() throws SQLException Retrieves whether this database supports keeping statements open
across commits. |
public boolean supportsOpenStatementsAcrossRollback() throws SQLException Retrieves whether this database supports keeping statements open
across rollbacks. |
public boolean supportsOrderByUnrelated() throws SQLException Retrieves whether this database supports using a column that is
not in the SELECT statement in an
ORDER BY clause. |
public boolean supportsOuterJoins() throws SQLException Retrieves whether this database supports some form of outer join. |
public boolean supportsPositionedDelete() throws SQLException Retrieves whether this database supports positioned DELETE
statements. |
public boolean supportsPositionedUpdate() throws SQLException Retrieves whether this database supports positioned UPDATE
statements. |
public boolean supportsResultSetConcurrency(int type,
int concurrency) throws SQLException Retrieves whether this database supports the given concurrency type
in combination with the given result set type. |
public boolean supportsResultSetHoldability(int holdability) throws SQLException Retrieves whether this database supports the given result set holdability. |
public boolean supportsResultSetType(int type) throws SQLException Retrieves whether this database supports the given result set type. |
public boolean supportsSavepoints() throws SQLException Retrieves whether this database supports savepoints. |
public boolean supportsSchemasInDataManipulation() throws SQLException Retrieves whether a schema name can be used in a data manipulation statement. |
public boolean supportsSchemasInIndexDefinitions() throws SQLException Retrieves whether a schema name can be used in an index definition statement. |
public boolean supportsSchemasInPrivilegeDefinitions() throws SQLException Retrieves whether a schema name can be used in a privilege definition statement. |
public boolean supportsSchemasInProcedureCalls() throws SQLException Retrieves whether a schema name can be used in a procedure call statement. |
public boolean supportsSchemasInTableDefinitions() throws SQLException Retrieves whether a schema name can be used in a table definition statement. |
public boolean supportsSelectForUpdate() throws SQLException Retrieves whether this database supports SELECT FOR UPDATE
statements. |
public boolean supportsStatementPooling() throws SQLException Retrieves whether this database supports statement pooling. |
public boolean supportsStoredFunctionsUsingCallSyntax() throws SQLException Retrieves whether this database supports invoking user-defined or vendor functions
using the stored procedure escape syntax. |
public boolean supportsStoredProcedures() throws SQLException Retrieves whether this database supports stored procedure calls
that use the stored procedure escape syntax. |
public boolean supportsSubqueriesInComparisons() throws SQLException Retrieves whether this database supports subqueries in comparison
expressions. |
public boolean supportsSubqueriesInExists() throws SQLException Retrieves whether this database supports subqueries in
EXISTS expressions. |
public boolean supportsSubqueriesInIns() throws SQLException Retrieves whether this database supports subqueries in
IN expressions. |
public boolean supportsSubqueriesInQuantifieds() throws SQLException Retrieves whether this database supports subqueries in quantified
expressions. |
public boolean supportsTableCorrelationNames() throws SQLException Retrieves whether this database supports table correlation names. |
public boolean supportsTransactionIsolationLevel(int level) throws SQLException Retrieves whether this database supports the given transaction isolation level. |
public boolean supportsTransactions() throws SQLException Retrieves whether this database supports transactions. If not, invoking the
method commit is a noop, and the isolation level is
TRANSACTION_NONE. |
public boolean supportsUnion() throws SQLException Retrieves whether this database supports SQL UNION. |
public boolean supportsUnionAll() throws SQLException Retrieves whether this database supports SQL UNION ALL. |
public boolean updatesAreDetected(int type) throws SQLException Retrieves whether or not a visible row update can be detected by
calling the method ResultSet.rowUpdated. |
public boolean usesLocalFilePerTable() throws SQLException Retrieves whether this database uses a file for each table. |
public boolean usesLocalFiles() throws SQLException Retrieves whether this database stores tables in a local file. |