| Documentation | Provides comprehensive information about the database as a whole.
Some of the methods respond by creating lists of information in the form of ResultSet objects, the same
as those created by executing a sql query. You can use the $sqlResultSet function to retrieve the data.
If a method of this function is not implemented by the drivers vendor, it should throw an SQLException.
In the case of methods that respond by creating a ResultSet, either a ResultSet wich may be empty will
be created or a SQLException is thrown.
Some of these methods take as arguments string patterns that serve as search filters. These arguments
all have names wich end with "Pattern", such as catalogPattern or schemaPattern. Within such pattern
strings, an underscore "_" calls for the match of any single character, the percent sign "%" calls for
the match of zero or more characters. Note that identifier name patterns are case sensitive.If a search
pattern argument is set to "null", it signifies that this criterion should not be used in the search.
If a database does not support a particular search criterion such as catalog or schema, null must be
supplied instead.
Methods
$jdbcDBMetaData{allProceduresAreCallable}
Description:
examines whether the current user has the required security permission to call all
the procedures as returned by the method getProcedures.
Parameters:
allProceduresAreCallable, a flag to indicate the examination of the current users permissions.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{allTablesAreSelectable}
Description:
examines whether the current user can use a SELECT statemnt with all the tables as returned by the method getTables.
Parameters:
allTablesAreSelectable, a flag to indicate this examination.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{dataDefinitionCausesTransactionCommit}
Description:
examines whether data definition statement within a transaction force the transaction to commit.
Parameters:
dataDefinitionCausesTransactionCommit, a flag to indicate this examination.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{dataDefinitionIgnoredInTransactions}
Description:
examines whether a data definition statement within a transaction is ignored.
Parameters:
dataDefinitionIgnoredInTransactions, a flag to indicate this examination.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{deletesAreDetected}{type}
Description:
examines whether a deletion that is visible in a ResultSet object of the given type can be detected by calling the method
rowDeleted of the $sqlResultSet function. A deletion is visible under the contition that the row is removed or
an empty row (a "hole") replaces the deleted row. this method returns 1 if a "hole" replaces the deleted row, 0 if it is removed
from the ResultSet.
Parameters:
deletesAreDetected, a flag to indicate this examination.
type, an integer indicating the type of the ResultSet object to examined.
Valid values are (see also $sqlResultSet):
TYPE_FORWARD_ONLY = 1003,
TYPE_SCROLL_INSENSITIVE = 1004,
TYPE_SCROLL_SENSITIVE = 1005.
Returns:
1 if a "hole" replaces a deleted row (deletion can be detected); 0 if a visible deleted row is simply removed.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{doesMaxRowSizeIncludeBlobs}
Description:
examines whether the value as returned by the method getMaxRowSize includes LONGVARCHAR and LONGVARBINARY blobs.
Parameters:
doesMaxRowSizeIncludeBlobs, a flag to indicate this examination.
Returns:
1 if blobs are counted as part of the row size; 0 otherwise.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getBestRowIdentifier}{catalog}{schema}{table}{scope}{nullable}
Description:
Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.
Parameters:
getBestRowIdentifier, a flag to indicate this examination.
catalog, a catalog name; "" retrieves those without a catalog.
schema, a schema name; "" retrieves those without a schema.
table, a table name.
scope, an integer representing the scope of interest.
Valid values are (also field description):
bestRowTemporary, bestRowTransaction, bestRowSession.
nullable, 1 indicates that nullable columns may be included; 0 to indicate that nullable columns must be excluded.
Returns:
this method responds by creating a ResultSet object. Each row of this ResultSet is a description of a column that belongs
to the optimal set of rows that can be used for unique row identification. This set may consist of one or more columns,
and it may include pseudo columns. Each column description has the following columns:
1.SCOPE short => actual scope of result;
valid values are (see also field description):
bestRowTemporary - very temporary, while using row
bestRowTransaction - valid for remainder of current transaction
bestRowSession - valid for remainder of current session
2.COLUMN_NAME String => column name
3.DATA_TYPE short => SQL data type from java.sql.Types
4.TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
5.COLUMN_SIZE int => precision
6.BUFFER_LENGTH int => not used
7.DECIMAL_DIGITS short => scale
8.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
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getCatalogs}
Description:
Gets the catalog names available in this database. The results are ordered by catalog name.
Parameters:
getCatalogs, a flag to indicate this request.
Returns:
Generates a ResultSet object with on column:
1.TABLE_CAT String => catalog name Each row represents a catalog name available in this database.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getCatalogSeparator}
Description:
Retrieves the string used to separate a catalog name and table name.
Parameters:
getCatalogSeparator, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getCatalogTerm}
Description:
retrieves the database vendor's preferred term for catalog.
Parameters:
getCatalogTerm, a flag to indicate this request.
Returns:
the requested vendor term.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getColumnPrivileges}{catalog}{schema}{table}{columnNamePattern}
Description:
retrieves a description of the access rights for a table's columns. All of the following must be true
for this method to return descriptions of permissions: the catalog name of column's table matches the given,
the schema name of the column's table matches the given, the column's table name matches the given
and the column name matches the given name pattern.
Parameters:
getColumnPrivileges, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection.
schema, a schema name; "" retrieves those without a schema.
table, a table name.
columnNamePattern, a column name pattern.
Returns:
generates a ResultSet object with the following columns.
The results are ordered by the columns COLUMN_NAME AND PRIVILEGE.
1.TABLE_CAT String => table catalog (may be null)
2.TABLE_SCHEM String => table schema (may be null)
3.TABLE_NAME String => table name
4.COLUMN_NAME String => column name
5.GRANTOR => grantor of access (may be null)
6.GRANTEE String => grantee of access
7.PRIVILEGE String => name of access, one of SELECT, INSERT, UPDATE, REFRENCES, ...)
8.IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getColumns}{catalog}{schemaPattern}{tableNamePattern}{columnNamePattern}
Description:
retrieves a description of the named table columns. Only column descriptions matching the catalog, schema, table
and column name criteria are returned.
Parameters:
getColumns, a flag to inducate this request.
catalog, a catalog name pattern; "" retrieves those without a catalog; null means drop catalog name from the selection.
schemaPattern, a schema name pattern; "" retrieves those without a schema.
tableNamePattern, a table name pattern.
columnNamePattern, a column name pattern.
Returns:
creates a ResultSet object with the following columns:
1.TABLE_CAT String => table catalog (may be null)
2.TABLE_SCHEM String => table schema (may be null)
3.TABLE_NAME String => table name
4.COLUMN_NAME String => column name
5.DATA_TYPE short => SQL type from java.sql.Types
6.TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
7.COLUMN_SIZE int => column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
8.BUFFER_LENGTH is not used.
9.DECIMAL_DIGITS int => the number of fractional digits
10.NUM_PREC_RADIX int => Radix (typically either 10 or 2)
11.NULLABLE int => is NULL allowed , columnNoNulls - might not allow NULL values, columnNullable - definitely allows NULL values,
columnNullableUnknown - nullability unknown
12.REMARKS String => comment describing column (may be null)
13.COLUMN_DEF String => default value (may be null)
14.SQL_DATA_TYPE int => unused
15.SQL_DATETIME_SUB int => unused
16.CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
17.ORDINAL_POSITION int => index of column in table (starting at 1)
18.IS_NULLABLE String => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values.
An empty string means nobody knows. SQLException - if a database access error occurs.
$jdbcDBMetaData{getCrossReference}{primaryCatalog}{primarySchema}{primaryTable}{foreignCatalog}{foreignSchema}{foreignTable}
Description:
describes how one table imports the keys of other table.
Parameters:
getCrossReference, a flag to indicate this request.
primaryCatalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria.
primarySchema - a schema name; "" retrieves those without a schema.
primaryTable - the table name that exports the key.
foreignCatalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria.
foreignSchema - a schema name; "" retrieves those without a schema.
foreignTable - the table name that imports the key.
Returns:
creates a ResultSet object whos each row is a foreign key column description. Each foreign key column description has the following columns:
1.PKTABLE_CAT String => primary key table catalog (may be null)
2.PKTABLE_SCHEM String => primary key table schema (may be null)
3.PKTABLE_NAME String => primary key table name
4.PKCOLUMN_NAME String => primary key column name
5.FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
6.FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
7.FKTABLE_NAME String => foreign key table name being exported
8.FKCOLUMN_NAME String => foreign key column name being exported
9.KEY_SEQ short => sequence number within foreign key
10.UPDATE_RULE short => What happens to foreign key when primary is updated:
importedNoAction - do not allow update of primary key if it has been imported
importedKeyCascade - change imported key to agree with primary key update
importedKeySetNull - change imported key to NULL if its primary key has been updated
importedKeySetDefault - change imported key to default values if its primary key has been updated
importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
11.DELETE_RULE short => What happens to the foreign key when primary is deleted.
importedKeyNoAction - do not allow delete of primary key if it has been imported
importedKeyCascade - delete rows that import a deleted key
importedKeySetNull - change imported key to NULL if its primary key has been deleted
importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
importedKeySetDefault - change imported key to default if its primary key has been deleted
12.FK_NAME String => foreign key name (may be null)
13.PK_NAME String => primary key name (may be null)
14.DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
importedKeyInitiallyDeferred - see SQL92 for definition
importedKeyInitiallyImmediate - see SQL92 for definition
importedKeyNotDeferrable - see SQL92 for definition
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getDatabaseProductName}
Description:
retrieves the product name for the database product currently connected to.
Parameters:
getDatabaseProductName, a flag to indicate this request.
Returns:
the name of database product currently connected to.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getDatabaseProductVersion}
Description:
retrieves the version of the database product currently connected to.
Parameters:
getDatabaseProductVersion, a flag to indicate this request.
Returns:
the version of the database product currently connected to.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getDefaultTransactionIsolation}
Description:
retrieves the default transaction isolation level of the database currently connected to.
Parameters:
getDefaultTransactionIsolation, a flag to indicate this request
Returns:
one of the following integer values representing the default transaction level:
0 (TRANSACTION_NONE),
1 (TRANSACTION_READ_UNCOMMITED),
2 (TRANSACTION_READ_COMMITED),
4 (TRANSACTION_REPEATABLE_READ),
8 (TRANSACTION_SERIALIZABLE).
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getDriverMajorVersion}
Description:
retrieves the major version of the JDBC driver currently in use.
Parameters:
getDriverMajorVersion, a flag to indicate this request.
Returns:
a number representing the major version of the JDBC driver currently in use.
$jdbcDBMetaData{getDriverMinorVersion}
Description:
retrieves the minor version of the JDBC driver currently in use.
Parameters:
getDriverMinorVersion, a flag to indicate this request.
Returns:
a number representing the major version of the JDBC driver currently in use.
$jdbcDBMetaData{getDriverName}
Description:
retrieves the name of the JDBC driver currently in use.
Parameters:
getDriverName, a flag to indicate this request.
Returns:
the name of the JDBC driver currently in use.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getDriverVersion}
Description:
retrieves the version of the driver currently in use.
Parameters:
getDriverVersion, a flag to indicate this request.
Returns:
a string representing the version of the JDBC driver currently in use containing
the drivers major and minor version numbers.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getExportedKeys}{catalog}{schema}{table}
Description:
retrieves a description of the foreign key columns that reference a table's primary key columns
(the foreign keys exported by a table).
Parameters:
getExportedKeys,
catalog, a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection.
schema, a schema name; "" retrieves those without a schema.
table, a table name.
Returns:
creates a ResultSet object whos each row is a foreign key column description with the following columns:
1.PKTABLE_CAT String => primary key table catalog (may be null)
2.PKTABLE_SCHEM String => primary key table schema (may be null)
3.PKTABLE_NAME String => primary key table name
4.PKCOLUMN_NAME String => primary key column name
5.FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
6.FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
7.FKTABLE_NAME String => foreign key table name being exported
8.FKCOLUMN_NAME String => foreign key column name being exported
9.KEY_SEQ short => sequence number within foreign key
10.UPDATE_RULE short => What happens to foreign key when primary is updated:
importedNoAction - do not allow update of primary key if it has been imported
importedKeyCascade - change imported key to agree with primary key update
importedKeySetNull - change imported key to NULL if its primary key has been updated
importedKeySetDefault - change imported key to default values if its primary key has been updated
importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
11.DELETE_RULE short => What happens to the foreign key when primary is deleted:
importedKeyNoAction - do not allow delete of primary key if it has been imported
importedKeyCascade - delete rows that import a deleted key
importedKeySetNull - change imported key to NULL if its primary key has been deleted
importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
importedKeySetDefault - change imported key to default if its primary key has been deleted
12.FK_NAME String => foreign key name (may be null)
13.PK_NAME String => primary key name (may be null)
14.DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
importedKeyInitiallyDeferred - see SQL92 for definition
importedKeyInitiallyImmediate - see SQL92 for definition
importedKeyNotDeferrable - see SQL92 for definition
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getExtraNameCharacters}
Description:
retrieves all "extra" characters (those beyond a-z, A-Z, 0-9 and _) that can be used in unquoted identifier names.
Parameters:
getExtraNameCharacters, a flag to indicate this request.
Returns:
the string containing the extra characters.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getIdentifierQuoteString}
Description:
returns the string used to quote SQL identifiers or a space " " if quoting identifiers isn't
supported by the database currently in use.
Parameters:
getIdentifierQuoteString, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getImportedKeys}{catalog}{schema}{table}
Description:
returns a description of the primary key columns that are referenced by a table's foreign key columns
(the primary keys imported by a table).
Parameters:
getImportedKeys, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection.
schema - a schema name; "" retrieves those without a schema.
table - a table name.
Returns:
creates a ResultSet object each row of is a primary key column description containing following columns:
1.PKTABLE_CAT String => primary key table catalog being imported (may be null)
2.PKTABLE_SCHEM String => primary key table schema being imported (may be null)
3.PKTABLE_NAME String => primary key table name being imported
4.PKCOLUMN_NAME String => primary key column name being imported
5.FKTABLE_CAT String => foreign key table catalog (may be null)
6.FKTABLE_SCHEM String => foreign key table schema (may be null)
7.FKTABLE_NAME String => foreign key table name
8.FKCOLUMN_NAME String => foreign key column name
9.KEY_SEQ short => sequence number within foreign key
10.UPDATE_RULE short => What happens to foreign key when primary is updated:
importedNoAction - do not allow update of primary key if it has been imported
importedKeyCascade - change imported key to agree with primary key update
importedKeySetNull - change imported key to NULL if its primary key has been updated
importedKeySetDefault - change imported key to default values if its primary key has been updated
importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
11.DELETE_RULE short => What happens to the foreign key when primary is deleted:
importedKeyNoAction - do not allow delete of primary key if it has been imported
importedKeyCascade - delete rows that import a deleted key
importedKeySetNull - change imported key to NULL if its primary key has been deleted
importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
importedKeySetDefault - change imported key to default if its primary key has been deleted
12.FK_NAME String => foreign key name (may be null)
13.PK_NAME String => primary key name (may be null)
14.DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
importedKeyInitiallyDeferred - see SQL92 for definition
importedKeyInitiallyImmediate - see SQL92 for definition
importedKeyNotDeferrable - see SQL92 for definition
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getIndexInfo}{catalog}{schema}{table}{unique}{approximate}
Description:
returns a description of a table's indices and statistics.
Parameters:
getIndexInfo, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection.
schema, a schema name; "" retrieves those without a schema.
table, a table name.
unique, when true, return only indices for unique values; when false, return indices regardless of whether unique or not.
approximate, when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate.
Returns:
creates a ResultSet object each row of is an index column description containing the following columns:
1.TABLE_CAT String => table catalog (may be null)
2.TABLE_SCHEM String => table schema (may be null)
3.TABLE_NAME String => table name
4.NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
5.INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
6.INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
7.TYPE short => index type:
tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
tableIndexClustered - this is a clustered index
tableIndexHashed - this is a hashed index
tableIndexOther - this is some other style of index
8.ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
9.COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
10.ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending,
may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
11.CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table;
otherwise, it is the number of unique values in the index.
12.PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table,
otherwise it is the number of pages used for the current index.
13.FILTER_CONDITION String => Filter condition, if any. (may be null)
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxBinaryLiteralLength}
Description:
returns the maximum number of hexadecimal characters allowed in an inline binary literal.
Parameters:
getMaxBinaryLiteralLength, a flag to indicate this request.
Returns:
an integer representing the maximum amount of hexadecimal characters;
a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxCatalogNameLength}
Description:
returns the maximum amount of characters allowed in a catalog name.
Parameters:
getMaxCatalogNameLength, a flag to indicate this request.
Returns:
the maximum amount of characters; a result of zero means that there is no limit or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxCharLiteralLength}
Description:
returns the maximum number of characters allowed in a character literal.
Parameters:
getMaxCharLiteralLength, a flag to indicate this request.
Returns:
the maximum number of characters allowed in a character literal;
a result of zero means that there is no limit or the limit is not known.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxColumnNameLength}
Description:
returns the maximum number of characters allowed in a column name.
Parameters:
getMaxColumnNameLength, a flag to indicate this request.
Returns:
maximum column name length;
a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxColumnsInGroupBy}
Description:
returns the maximum number of columns in a "GROUP BY" clause.
Parameters:
getMaxColumnsInGroupBy, a flag to indicate this request.
Returns:
maximum number of columns;
a result of zero means that there is no limit or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxColumnsInIndex}
Description:
returns the maximum number of columns allowed in an index.
Parameters:
getMaxColumnsInIndex, a flag to indicate this request.
Returns:
maximum number of columns;
a result of zero means that there is no limit or the limit is not known
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxColumnsInOrderBy}
Description:
returns the maximum number of columns in an "ORDER BY" clause.
Paramaters:
getMaxColumnsInOrderBy, a flag to indicate this request.
Returns:
the maximum number of columns;
a result of zero means that there is no limit or thelimit is not known.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxColumnsInSelect}
Description:
returns the maximum number of columns in a "SELECT" list.
Parameters:
getMaxColumnsInSelect, a flag to indicate this request.
Returns:
the maximum number of columns; a result of zero means that there is no limit or
the limit is not known
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxColumnsInTable}
Description:
returns the maximum number of columns in a table.
Parameters:
getMaxColumnsInTable, a flag to indicate this request.
Returns:
the maximum number of columns; a result of zero means that there is no limit or
the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxConnections}
Description:
returns the number of active connections that can be established simultaneously
by the driver currently in use to its database.
Parameters:
getMaxConnections, a flag to indicate this request.
Returns:
the maximum number of active connections; a result of zero means that there is
no limit or the limit is not known
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxCursorNameLength}
Description:
returns the maximum cursor name length.
Parameters:
getMaxCursorNameLength, a flag to indicate this request.
Returns:
the maximum cursor name length in bytes; a result of zero means that there is
no limit or the limit is not known
Throws:
SQLException - if a database acce
$jdbcDBMetaData{getMaxIndexLength}
Description:
returns the maximum length of an index (in bytes).
Parameters:
getMaxIndexLength, a flag to indicate this request.
Returns:
the maximum index length in bytes; a result of zero means that there is no
limit or the limit is not known.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxProcedureNameLength}
Description:
returns the maximum length of a procedure name.
Parameters:
getMaxProcedureNameLength, a flag to indicate this request.
Returns:
the maximum name length in bytes; a result of zero means that there is no limit
or the limit is not known
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getMaxRowSize}
Description:
returns the maximum length of a single row in bytes.
Parameters:
getMaxRowSize, a flag to indicate this request.
Returns:
the maximum row size in bytes; a result of zero means that there is no limit or
the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxSchemaNameLength}
Description:
returns the maximum length allowed for a schema name in characters.
Parameters:
getMaxSchemaNameLength, a flag to indicate this request.
Returns:
the maximum name length in bytes; a result of zero means that there is no limit
or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxStatementLength}
Description:
returns the maximum length of a SQL statement in characters.
Parameters:
getMaxStatementLength, a flag to indicate this request.
Returns:
the maximum length in bytes; a result of zero means that there is no limit or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxStatements}
Description:
returns the maximum number of active statements that can simultaneously be open
to this database.
Parameters:
getMaxStatements, a flag to indicate this request.
Returns:
the maximum number of statements that can be open simultaneously; a result of
zero means that there is no limit or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxTableNameLength}
Description:
returns the maximum length of a table name in characters.
Parameters:
getMaxTableNameLength, a flag to indicate this request.
Returns:
the maximum name length in characters; a result of zero means that there is no
limit or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxTablesInSelect}
Description:
returns the maximum number of tables in a SELECT statement.
Parameters:
getMaxTablesInSelect, a flag to indicate this request.
Returns:
the maximum number of tables allowed in a SELECT statement; a result of zero
means that there is no limit or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getMaxUserNameLength}
Description:
returns the maximum length of a user name in characters.
Parameters:
getMaxUserNameLength, a flag to indicate this request.
Returns:
the maximum user name length in bytes; a result of zero means that there is no
limit or the limit is not known.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getNumericFunctions}
Description:
returns a comma-separated list of math functions. These are the X/Open CLI math
function names used in the JDBC function escape clause.
Parameters:
getNumericFunctions, a flag to indicate this request.
Returns:
a comma-separeted list of math functions.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getPrimaryKeys}{catalog}{schema}{table}
Description:
returns a description of a table's primary key columns if catalog, schema and
table name matches. They are ordered by COLUMN_NAME.
Parameters:
getPrimaryKeys, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop
catalog name from the selection.
schema, a schema name; "" retrieves those without a schema.
table, a table name.
Returns:
creates a ResultSet object with the following columns:
1.TABLE_CAT String => table catalog (may be null)
2.TABLE_SCHEM String => table schema (may be null)
3.TABLE_NAME String => table name
4.COLUMN_NAME String => column name
5.KEY_SEQ short => sequence number within primary key
6.PK_NAME String => primary key name (may be null)
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getProcedureColumns}{catalog}{schemaPattern}{procedureNamePattern}{columnNamePattern}
Description:
returns a description of a catalog's stored procedure parameters and result
columns if schema, procedure name and column name are matched.
Parameters:
getProcedureColumns, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop
catalog name from the selection.
schemaPattern, a schema name pattern; "" retrieves those without a schema.
procedureNamePattern, a procedure name pattern.
columnNamePattern, a column name pattern.
Returns:
creates a ResultSet object each row of describes a stored procedure parameter
or column. Only descriptions matching the schema, procedure and parameter name
criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME.
The columns of the ResultSet object are the following:
1.PROCEDURE_CAT String => procedure catalog (may be null)
2.PROCEDURE_SCHEM String => procedure schema (may be null)
3.PROCEDURE_NAME String => procedure name
4.COLUMN_NAME String => column/parameter name
5.COLUMN_TYPE Short => kind of column/parameter:
procedureColumnUnknown - nobody knows
edureColumnIn - IN parameter
edureColumnInOut - INOUT parameter
edureColumnOut - OUT parameter
edureColumnReturn - procedure return value
edureColumnResult - result column in ResultSet
6.DATA_TYPE short => SQL type from java.sql.Types
7.TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
8.PRECISION int => precision
9.LENGTH int => length in bytes of data
10.SCALE short => scale
11.RADIX short => radix
12.NULLABLE short => can it contain NULL?
procedureNoNulls - does not allow NULL values
procedureNullable - allows NULL values
procedureNullableUnknown - nullability unknown
13.REMARKS String => comment describing parameter/column
Throws:
SQLException - if a database access error occurs
Note:
Some databases may not return the column descriptions for a procedure.
Additional columns beyond REMARKS can be defined by the database.
$jdbcDBMetaData{getProcedures}{catalog}{schemaPattern}{procedureNamePattern}
Description:
returns a description of the stored procedures available in a catalog. Only
procedure descriptions matching the schema and procedure name criteria are
returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME.
Parameters:
getProcedures, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop
catalog name from the selection.
schemaPattern, a schema name pattern; "" retrieves those without a schema.
procedureNamePattern, a procedure name pattern.
Returns:
creates a ResultSet object each row of is a procedure description with the
following columns:
1.PROCEDURE_CAT String => procedure catalog (may be null)
2.PROCEDURE_SCHEM String => procedure schema (may be null)
3.PROCEDURE_NAME String => procedure name
4.reserved for future use
5.reserved for future use
6.reserved for future use
7.REMARKS String => explanatory comment on the procedure
8.PROCEDURE_TYPE short => kind of procedure:
procedureResultUnknown - May return a result
procedureNoResult - Does not return a result
procedureReturnsResult - Returns a result
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getProcedureTerm}
Description:
returns the database vendor's preferred term for "procedure".
Parameters:
getProcedureTerm, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getSchemas}
Description:
returns the schema names available in this database. The results are ordered by
schema name.
Parameters:
getSchemas, a flag to indicate this request.
Returns:
creates a ResultSet object with the following columns:
1.TABLE_SCHEM String => schema name
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getSchemaTerm}
Description:
returns the database vendor's preferred term for "schema".
Parameters:
getSchemaTerm, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getSearchStringEscape}
Description:
returns the string that can be used to escape wildcard characters. This is the
string that can be used to escape '_' or '%' in the string pattern style
catalog search parameters. The '_' character represents any single character.
The '%' character represents any sequence of zero or more characters.
Parameters:
getSearchStringEscape, a flag to indicate this request.
Returns:
the string used to escape wildcard characters.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getSQLKeywords}
Description:
returns a comma-separated list of all a database's SQL keywords that are NOT
also SQL92 keywords.
Parameters:
getSQLKeywords, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getStringFunctions}
Description:
returns a comma-separated list of string functions. These are the X/Open CLI
string function names used in the JDBC function escape clause.
Parameters:
getStringFunctions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getSystemFunctions}
Description:
returns a comma-separated list of system functions. These are the X/Open CLI
system function names used in the JDBC function escape clause.
Parameters:
getSystemFunctions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getTablePrivileges}{catalog}{schemaPattern}{tableNamePattern}
Description:
returns 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 priviledge applies to all columns
(this may be true for some systems but is not true for all.)
Parameters:
getTablePrivileges, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop
catalog name from the selection
schemaPattern - a schema name pattern; "" retrieves those without a schema
tableNamePattern - a table name pattern
Returns:
creates a ResultSet object each row of is a table privilege description with
the following columns:
1.TABLE_CAT String => table catalog (may be null)
2.TABLE_SCHEM String => table schema (may be null)
3.TABLE_NAME String => table name
4.GRANTOR => grantor of access (may be null)
5.GRANTEE String => grantee of access
6.PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
7.IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getTables}{catalog}{schemaPattern}{tableNamePattern}{types}
Description:
returns a description of tables available in a catalog.
Parameters:
getTables, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection.
schemaPattern - a schema name pattern; "" retrieves those without a schema.
tableNamePattern - a table name pattern.
types - a list of table types to include; null returns all types.
Returns:
creates a ResultSet object each row is a table description with the following
columns:
1.TABLE_CAT String => table catalog (may be null)
2.TABLE_SCHEM String =$gt; table schema (may be null)
3.TABLE_NAME String => table name
4.TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW",
"SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY","ALIAS", "SYNONYM".
5.REMARKS String => explanatory comment on the table
Throws:
SQLException - if a database access error occurs.
Note:
Some databases may not return information for all tables.
$jdbcDBMetaData{getTableTypes}
Description:
returns the table types available in this database. The results are ordered by
table type.
Parameters:
getTableTypes, a flag to indicate this request.
Returns:
creates a ResultSet object each row of has a single String column that is a
table type:
1.TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW",
"SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getTimeDateFunctions}
Description:
returns a comma-separated list of time and date functions.
Parameters:
getTimeDateFunctions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getTypeInfo}
Description:
returns a description of all the standard SQL 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.
Parameters:
getTypeInfo, a flag to indicate this request.
Returns:
creates a ResultSet object each row of is a SQL type description with the
following columns:
1.TYPE_NAME String => Type name
2.DATA_TYPE short => SQL data type from java.sql.Types
3.PRECISION int => maximum precision
4.LITERAL_PREFIX String => prefix used to quote a literal (may be null)
5.LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
6.CREATE_PARAMS String => parameters used in creating the type (may be null)
7.NULLABLE short => can you use NULL for this type?
typeNoNulls - does not allow NULL values
typeNullable - allows NULL values
typeNullableUnknown - nullability unknown
8.CASE_SENSITIVE boolean=> is it case sensitive?
9.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 ...
10.UNSIGNED_ATTRIBUTE boolean => is it unsigned?
11.FIXED_PREC_SCALE boolean => can it be a money value?
12.AUTO_INCREMENT boolean => can it be used for an auto-increment value?
13.LOCAL_TYPE_NAME String => localized version of type name (may be null)
14.MINIMUM_SCALE short => minimum scale supported
15.MAXIMUM_SCALE short => maximum scale supported
16.SQL_DATA_TYPE int => unused
17.SQL_DATETIME_SUB int => unused
18.NUM_PREC_RADIX int => usually 2 or 10
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getUDTs}{catalog}{schemaPattern}{typeNamePattern}{types}
Description:
returns a description of the user-defined types 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_SCHEM and TYPE_NAME. The type name parameter may
be a fully-qualified name. In this case, the catalog and schemaPattern
parameters are ignored.
Parameters:
getUDTs, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria.
schemaPattern - a schema name pattern; "" retrieves those without a schema.
typeNamePattern - a type name pattern; may be a fully-qualified name.
types - a list of user-named types to include (JAVA_OBJECT, STRUCT, or DISTINCT); null returns all types.
Returns:
creates a ResultSet object each row of is a type description with the following columns:
1.TYPE_CAT String => the type's catalog (may be null)
2.TYPE_SCHEM String => type's schema (may be null)
3.TYPE_NAME String => type name
4.CLASS_NAME String => Java class name
5.DATA_TYPE String => type value defined in java.sql.Types. One of JAVA_OBJECT,STRUCT, or DISTINCT
6.REMARKS String => explanatory comment on the type
Throws:
SQLException - if a database access error occurs.
Note:
If the driver does not support UDTs, an empty result set is returned.
$jdbcDBMetaData{getURL}
Description:
returns the url for this database.
Parameters:
getURL, a flag to indicate this request.
Returns:
the url or null if it cannot be generated.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{getUserName}
Description:
returns the user name as known to the database.
Parameters:
getUserName, a flag to indicate this request.
Returns:
the database user name currently connected to the database.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{getVersionColumns}{catalog}{schema}{table}
Description:
returns a description of a table's columns that are automatically updated when
any value in a row is updated. They are unordered.
Parameters:
getVersionColumns, a flag to indicate this request.
catalog, a catalog name; "" retrieves those without a catalog;
null means drop catalog name from the selection criteria.
schema, a schema name; "" retrieves those without a schema.
table, a table name.
Returns:
creares a ResultSet object each row of is a column description with the
following columns:
1.SCOPE short => is not used
2.COLUMN_NAME String => column name
3.DATA_TYPE short => SQL data type from java.sql.Types
4.TYPE_NAME String => Data source dependent type name
5.COLUMN_SIZE int => precision
6.BUFFER_LENGTH int => length of column value in bytes
7.DECIMAL_DIGITS short => scale
8.PSEUDO_COLUMN short => is this a 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
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{insertsAreDetected}{type}
Description:
indicates whether or not a visible row insert can be detected by calling
$sqlResultSet{rowInserted}.
Parameters:
insertsAreDetected, a flag to indicate this request.
type, one of the ResultSet types TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE or TYPE_SCROLL_SENSITIVE.
Returns:
1 if changes are detected by the resultset type; 0 otherwise.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{isCatalogAtStart}
Description:
indicates whether a catalog name appears at the start of a fully qualified
table name. (Otherwise it appears at the end)
Parameters:
isCatalogAtStart, a flag to indicate this request.
Returns:
1 if a catalog name appears at the start of a fully qualified table name;0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{isReadOnly}
Description:
examines whether the database is in read-only mode.
Parameters:
isReadOnly, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{nullPlusNonNullIsNull}
Description:
examines whether the concatenations between NULL and non-NULL values results in a NULL value.
Parameters:
nullPlusNonNullIsNull, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{nullsAreSortedAtEnd}
Description:
checks whether NULL values are sorted at the end regardless of sort order.
Parameters:
nullsAreSortedAtEnd, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{nullsAreSortedAtStart}
Description:
checks whether NULL values are sorted at the start regardless of sort order.
Parameters:
nullsAreSortedAtStart, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{nullsAreSortedHigh}
Description:
checks whether NULL values are sorted high.
Parameters:
nullsAreSortedHigh, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{nullsAreSortedLow}
Description:
checks whether NULL values are sorted low.
Parameters:
nullsAreSortedLow, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{othersDeletesAreVisible}{type}
Description:
indicates whether deletes made by others are visible.
Parameters:
othersDeletesAreVisible, a flag to indicate this request.
type, the ResultSet object type, one of the values TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
1 if deletes made by others are visible for the result set type; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{othersInsertsAreVisible}{type}
Description:
indicates whether inserts made by others are visible.
Parameters:
othersInsertsAreVisible, a flag to indicate this request.
type, the ResultSet object type, one of the values TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
1 if updates are visible for the result set type; 0 otherwise.
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{othersUpdatesAreVisible}{type}
Description:
indicates whether updates made by others are visible.
Parameters:
othersUpdatesAreVisible, a flag to indicate this request.
type, the ResultSet object type, one of the values TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
1 if updates made by others are visible for the result set type; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{ownDeletesAreVisible}{type}
Description:
indicates whether a result set's own deletes are visible.
Parameters:
ownDeletesAreVisible, a flag to indicate this request.
type, the ResultSet object type, one of the values TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
1 if deletes are visible for the result set type; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{ownInsertsAreVisible}{type}
Description:
indicates whether a result set's own inserts are visible.
Parameters:
ownInsertsAreVisible, a flag to indicate this request.
type, the ResultSet object type, one of the values TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
1 if inserts are visible for the result set type; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{ownUpdatesAreVisible}{type}
Description:
indicates whether a result set's own updates are visible.
Parameters:
ownUpdatesAreVisible, a flag to indicate this request.
type, the ResultSet object type, one of the values TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
1 if updates are visible for the result set type; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{storesLowerCaseIdentifiers}
Description:
examines whether the database treat mixed case unquoted SQL identifiers as case
insensitive and store them in lower case.
Parameters:
storesLowerCaseIdentifiers, a flag to indicate this request.
Returns:
1
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{storesLowerCaseQuotedIdentifiers}
Description:
examines whether the database treat mixed case quoted SQL identifiers as case
insensitive and store them in lower case.
Parameters:
storesLowerCaseQuotedIdentifiers, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{storesMixedCaseIdentifiers}
Description:
examines whether the database treat mixed case unquoted SQL identifiers as case
insensitive and store them in mixed case.
Parameters:
storesMixedCaseIdentifiers, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{storesMixedCaseQuotedIdentifiers}
Description:
examines whether the database treat mixed case quoted SQL identifiers as case
insensitive and store them in mixed case.
Parameters:
storesMixedCaseQuotedIdentifiers, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{storesUpperCaseIdentifiers}
Description:
examines whether the database treat mixed case unquoted SQL identifiers as case
insensitive and store them in upper case.
Parameters:
storesUpperCaseIdentifiers, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{storesUpperCaseQuotedIdentifiers}
Description:
examines whether the database treat mixed case quoted SQL identifiers as case
insensitive and store them in upper case.
Parameters:
storesUpperCaseQuotedIdentifiers, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsAlterTableWithAddColumn}
Description:
examines whether "ALTER TABLE" with add column is supported.
Parameters:
supportsAlterTableWithAddColumn, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsAlterTableWithDropColumn}
Description:
examines whether "ALTER TABLE" with drop column is supported.
Parameters:
supportsAlterTableWithDropColumn, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsANSI92EntryLevelSQL}
Description:
examines whether the ANSI92 entry level SQL grammar is supported.
Parameters:
supportsANSI92EntryLevelSQL, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsANSI92FullSQL}
Description:
examines whether the ANSI92 full SQL grammar is supported.
Parameters:
supportsANSI92FullSQL, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsANSI92IntermediateSQL}
Description:
examines whether the ANSI92 intermediate SQL grammar is supported.
Parameters:
supportsANSI92IntermediateSQL, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsBatchUpdates}
Description:
indicates whether the driver supports batch updates.
Parameters:
supportsBatchUpdates, a flag to indicate this request.
Returns:
1 if the driver supports batch updates; 0 otherwise
$jdbcDBMetaData{supportsCatalogsInDataManipulation}
Description:
examines whether a catalog name can be used in a data manipulation statement.
Parameters:
supportsCatalogsInDataManipulation, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsCatalogsInIndexDefinitions}
Description:
examines whether a catalog name can be used in an index definition statement.
Parameters:
supportsCatalogsInIndexDefinitions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsCatalogsInPrivilegeDefinitions}
Description:
examines whether a catalog name can be used in a privilege definition
statement.
Parameters:
supportsCatalogsInPrivilegeDefinitions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsCatalogsInProcedureCalls}
Description:
examines whether a catalog name can be used in a procedure call statement.
Parameters:
supportsCatalogsInProcedureCalls, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsCatalogsInTableDefinitions}
Description:
examines whether a catalog name can be used in a table definition statement.
Parameters:
supportsCatalogsInTableDefinitions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{supportsColumnAliasing}
Description:
examines whether the database supports column aliasing.
Parameters:
supportsColumnAliasing, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsConvert}
Description:
examines whether the CONVERT function between SQL types is supported.
Parameters:
supportsConvert, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsConvert}{fromType}{toType}
Description:
examines whether CONVERT is supported between the given SQL types.
Parameters:
supportsConvert, a flag to indicate this request.
fromType, the SQL type to convert from.
toType, the SQL type to convert to.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsCoreSQLGrammar}
Description:
examines whether the ODBC Core SQL grammar is supported.
Parameters:
supportsCoreSQLGrammar, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsCorrelatedSubqueries}
Description:
examines whether correlated subqueries are supported.
Parameters:
supportsCorrelatedSubqueries, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsDataDefinitionAndDataManipulationTransactions}
Description:
examines whether both data definition and data manipulation statements within a
transaction are supported.
Parameters:
supportsDataDefinitionAndDataManipulationTransactions, a flag to indicate this
request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsDataManipulationTransactionsOnly}
Description:
examines whether only data manipulation statements are supported within a
transaction.
Parameters:
supportsDataManipulationTransactionsOnly, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsDifferentTableCorrelationNames}
Description:
examines whether when table correlation names are supported, if they are
restricted to be different from the names of the tables.
Parameters:
supportsDifferentTableCorrelationNames, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsExpressionsInOrderBy}
Description:
examines whether expressions in "ORDER BY" lists are supported.
Parameters:
supportsExpressionsInOrderBy, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsExtendedSQLGrammar}
Description:
examines whether the ODBC Extended SQL grammar is supported.
Parameters:
supportsExtendedSQLGrammar, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsFullOuterJoins}
Description:
examines whether full nested outer joins are supported.
Parameters:
supportsFullOuterJoins, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsGroupBy}
Description:
examines whether some form of "GROUP BY" clause is supported.
Parameters:
supportsGroupBy, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsGroupByBeyondSelect}
Description:
examines whether a "GROUP BY" clause add columns not in the SELECT provided
that it specifies all the columns in the SELECT.
Parameters:
supportsGroupByBeyondSelect, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{supportsGroupByUnrelated}
Description:
examines whether a "GROUP BY" clause use columns not in the SELECT.
Parameters:
supportsGroupByUnrelated, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsIntegrityEnhancementFacility}
Description:
examines whether the SQL Integrity Enhancement Facility is supported.
Parameters:
supportsIntegrityEnhancementFacility, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsLikeEscapeClause}
Description:
examines whether the escape character is supported in "LIKE" clauses.
Parameters:
supportsLikeEscapeClause, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsLimitedOuterJoins}
Description:
examines whether there is limited support for outer joins.
Parameters:
supportsLimitedOuterJoins, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsMinimumSQLGrammar}
Description:
examines whether the ODBC Minimum SQL grammar is supported.
Parameters:
supportsMinimumSQLGrammar, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsMixedCaseIdentifiers}
Description:
examines whether the database treat mixed case unquoted SQL identifiers as case
sensitive and store them as a result in mixed case.
Parameters:
supportsMixedCaseIdentifiers, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsMixedCaseQuotedIdentifiers}
Description:
examines whether the database does treat mixed case quoted SQL identifiers as
case sensitive and as a result store them in mixed case.
Parameters:
supportsMixedCaseQuotedIdentifiers, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsMultipleResultSets}
Description:
examines whether multiple ResultSets from a single execute statement are
supported.
Parameters:
supportsMultipleResultSets, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsMultipleTransactions}
Description:
examines whether multiple transactions can be executed simultaneously on
different connections.
Parameters:
supportsMultipleTransactions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsNonNullableColumns}
Description:
examines whether columns can be defined as non-nullable.
Parameters:
supportsNonNullableColumns, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsOpenCursorsAcrossCommit}
Description:
examines whether a cursor can remain open across commits.
Parameters:
supportsOpenCursorsAcrossCommit, a flag to indicate this request.
Returns:
1 if cursors always remain open; 0 if they might not remain open
Throws:
SQLException - if a database access error occurs
$jdbcDBMetaData{supportsOpenCursorsAcrossRollback}
Description:
examines whether a cursors can remain open across rollbacks.
Parameters:
supportsOpenCursorsAcrossRollback, a flag to indicate this request.
Returns:
1 if cursors always remain open; 0 if they might not remain open.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsOpenStatementsAcrossCommit}
Description:
examines whether a statements can remain open across commits.
Parameters:
supportsOpenStatementsAcrossCommit, a flag to indicate this request.
Returns:
1 if statements always remain open; 0 if they might not remain open.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsOpenStatementsAcrossRollback}
Description:
examines whether a statements can remain open across rollbacks.
Parameters:
supportsOpenStatementsAcrossRollback, a flag to indicate this request.
Returns:
1 if statements always remain open; 0 if they might not remain open.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsOrderByUnrelated}
Description:
examines whether an "ORDER BY" clause use columns not in the SELECT statement.
Parameters:
supportsOrderByUnrelated, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsOuterJoins}
Description:
examines whether some form of outer join is supported.
Parameters:
supportsOuterJoins, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsPositionedDelete}
Description:
examines whether positioned DELETE statements are supported.
Parameters:
supportsPositionedDelete, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsPositionedUpdate}
Description:
examines whether positioned UPDATE statements are supported.
Parameters:
supportsPositionedUpdate, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsResultSetConcurrency}{type}{concurrency}
Description:
examines whether the database support the concurrency type in combination with
the given result set type.
Parameters:
supportsResultSetConcurrency, a flag to indicate this request.
type, the type of the ResultSet object. Valid values are: TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
concurrency, the concurency type of the ResultSet object. Valid values are:
CONCUR_READ_ONLY, CONCUR_UPDATABLE.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsResultSetType}{type}
Description:
examines whether the database currently connected to supports the given type of
ResultSet.
Parameters:
supportsResultSetType, a flag to indicate this request.
type, the type of the ResultSet object. Valid values are: TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSchemasInDataManipulation}
Description:
examines whether a schema name can be used in a data manipulation statement.
Parameters:
supportsSchemasInDataManipulation, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSchemasInIndexDefinitions}
Description:
examines whether a schema name can be used in an index definition statement.
Parameters:
supportsSchemasInIndexDefinitions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSchemasInPrivilegeDefinitions}
Description:
examines whether a schema name can be used in a privilege definition statement.
Parameters:
supportsSchemasInPrivilegeDefinitions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSchemasInProcedureCalls}
Description:
examines whether a schema name can be used in a procedure call statement.
Parameters:
supportsSchemasInProcedureCalls, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSchemasInTableDefinitions}
Description:
examines whether a schema name can be used in a table definition statement.
Parameters:
supportsSchemasInTableDefinitions, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSelectForUpdate}
Description:
examines whether SELECT for UPDATE statements are supported.
Parameters:
supportsSelectForUpdate, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsStoredProcedures}
Description:
examines whether stored procedure calls using the stored procedure escape
syntax are supported.
Parameters:
supportsStoredProcedures, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSubqueriesInComparisons}
Description:
examines whether subqueries in comparison expressions are supported.
Parameters:
supportsSubqueriesInComparisons, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSubqueriesInExists}
Description:
examines whether subqueries in 'exists' expressions are supported.
Parameters:
supportsSubqueriesInExists, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSubqueriesInIns}
Description:
examines whether subqueries in 'in' statements are supported.
Parameters:
supportsSubqueriesInIns, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsSubqueriesInQuantifieds}
Description:
examines whether subqueries in quantified expressions are supported.
Parameters:
supportsSubqueriesInQuantifieds, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsTableCorrelationNames}
Description:
examines whether table correlation names are supported.
Parameters:
supportsTableCorrelationNames, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsTransactionIsolationLevel}{level}
Description:
examines whether this database support the given transaction isolation level.
Parameters:
supportsTransactionIsolationLevel, a flag to indicate this request.
level, an integer representing the transaction isolation level. Valid values
are: TRANSACTION_NONE, TRANSACTION_READ_UNCOMMITED, TRANSACTION_READ_COMMITED,
TRANSACTION_REPEATABLE_READ and TRANSACTION_SERIALIZABLE.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsTransactions}
Description:
examins whether transactions are supported.
Parameters:
supportsTransactions, a flag to indicate this request.
Returns:
1 if transactions are supported; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsUnion}
Description:
examins whether SQL UNION are supported.
Parameters:
supportsUnion, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{supportsUnionAll}
Description:
examines whether SQL UNION ALL is supported.
Parameters:
supportsUnionAll, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{updatesAreDetected}{type}
Description:
indicates whether or not a visible row update can be detected by calling the
method ResultSet.rowUpdated.
Parameters:
updatesAreDetected, a flag to indicate this request.
type, the type of the ResultSet object. Valid values are: TYPE_FORWARD_ONLY,
TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE.
Returns:
1 if changes are detected by the result set type; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{usesLocalFilePerTable}
Description:
examines whether the database use a file for each table.
Parameters:
usesLocalFilePerTable, a flag to indicate this request.
Returns:
1 if the database uses a local file for each table; 0 otherwise.
Throws:
SQLException - if a database access error occurs.
$jdbcDBMetaData{usesLocalFiles}
Description:
examines whether the database does store tables in a local file.
Parameters:
usesLocalFiles, a flag to indicate this request.
Returns:
Throws:
SQLException - if a database access error occurs.
bestRowNotPseudo = 1
Description:
indicates that the best row identifier is NOT a pseudo column. A possible value
for the column PSEUDO_COLUMN in the ResultSet object returned by the method
getBestRowIdentifier.
bestRowPseudo = 2
Description:
indicates that the best row identifier is a pseudo column. A possible value for
the column PSEUDO_COLUMN in the ResultSet object returned by the method
getBestRowIdentifier.
bestRowSession = 2
Description:
indicates that the scope of the best row identifier is the remainder of the
current session. A possible value for the column SCOPE in the ResultSet object
returned by the method getBestRowIdentifier.
bestRowTemporary = 0
Description:
indicates that the scope of the best row identifier is very temporary, lasting
only while the row is being used. A possible value for the column SCOPE in the
ResultSet object returned by the method getBestRowIdentifier.
bestRowTransaction = 1
Description:
indicates that the scope of the best row identifier is the remainder of the
current transaction. A possible value for the column SCOPE in the ResultSet
object returned by the method getBestRowIdentifier.
bestRowUnknown = 0
Description:
indicates that the best row identifier may or may not be a pseudo column. A
possible value for the column PSEUDO_COLUMN in the ResultSet object returned by
the method getBestRowIdentifier.
columnNoNulls = 0
Description:
indicates that the column might not allow NULL values. A possible value for the
column NULLABLE in the ResultSet returned by the method getColumns.
columnNullable = 1
Description:
Indicates that the column definitely allows NULL values. A possible value for
the column NULLABLE in the ResultSet returned by the method getColumns.
columnNullableUnknown = 2
Description:
indicates that the nullability of columns is unknown. A possible value for the
column NULLABLE in the ResultSet returned by the method getColumns.
importedKeyCascade = 0
Description:
a possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet
objects returned by the methods getImportedKeys, getExportedKeys, and
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.
importedKeyInitiallyDeferred = 5
Description:
a possible value for the column DEFERRABILITY in the ResultSet objects returned
by the methods getImportedKeys, getExportedKeys, and getCrossReference.
Indicates deferrability. See SQL-92 for a definition.
importedKeyInitiallyImmediate = 6
Description:
a possible value for the column DEFERRABILITY in the ResultSet objects returned
by the methods getImportedKeys, getExportedKeys, and getCrossReference.
Indicates deferrability. See SQL-92 for a definition.
importedKeyNoAction = 3
Description:
a possible value for the columns 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.
importedKeyNotDeferrable = 7
Description:
a possible value for the column DEFERRABILITY in the ResultSet objects returned
by the methods getImportedKeys, getExportedKeys, and getCrossReference.
Indicates deferrability. See SQL-92 for a definition.
importedKeyRestrict = 1
Description:
a possible value for the columns 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.
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.
importedKeySetNull = 2
Description:
a possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet
objects returned by the methods getImportedKeys, getExportedKeys, and
getCrossReference.
procedureColumnIn = 1
Description:
indicates that the column stores IN parameters. A possible value for the column
COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
procedureColumnInOut = 2
Description:
indicates that the column stores INOUT parameters. A possible value for the
column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
procedureColumnOut = 4
Description:
indicates that the column stores OUT parameters. A possible value for the
column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
procedureColumnResult = 3
Description:
indicates that the column stores results. A possible value for the column
COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
procedureColumnReturn = 5
Description:
indicates that the column stores return values. A possible value for the column
COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
procedureColumnUnknown = 0
Description:
indicates that type of the column is unknown. A possible value for the column
COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
procedureNoNulls = 0
Description:
indicates that NULL values are not allowed. A possible value for the column
NULLABLE in the ResultSet returned by the method getProcedureColumns.
procedureNoResult = 1
Description:
a possible value for column PROCEDURE_TYPE in the ResultSet object returned by
the method getProcedures. Indicates that the procedure does not return a
result.
procedureNullable = 1
Description:
indicates that NULL values are allowed. A possible value for the column
NULLABLE in the ResultSet returned by the method getProcedureColumns.
procedureNullableUnknown = 2
Description:
indicates that whether NULL values are allowed is unknown. A possible value for
the column NULLABLE in the ResultSet returned by the method
getProcedureColumns.
procedureResultUnknown = 0
Description:
a possible value for column PROCEDURE_TYPE in the ResultSet object returned by
the method getProcedures. Indicates that it is not known whether the procedure
returns a result.
procedureReturnsResult = 2
Description:
a possible value for column PROCEDURE_TYPE in the ResultSet object returned by
the method getProcedures. Indicates that the procedure returns a result.
tableIndexClustered
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.
Indicates that this table index is a clustered index.
versionColumnUnknown
Indicates that this version column may or may not be a pseudo column. A possible value for the column
PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.
versionColumnNotPseudo
Indicates that this version column is NOT a pseudo column. A possible value for the column PSEUDO_COLUMN in the
ResultSet object returned by the method getVersionColumns.
versionColumnPseudo
Indicates that this version column is a pseudo column. A possible value for the column PSEUDO_COLUMN in the
ResultSet object returned by the method getVersionColumns.
importedKeySetDefault
A possible value for the columns 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.
typeNoNulls
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.
Indicates that a NULL value is NOT allowed for this data type.
typeNullable
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.
Indicates that a NULL value is allowed for this data type.
typeNullableUnknown
A possible value for column 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.
typePredNone
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.
Indicates that WHERE search clauses are not supported for this type.
typePredChar
A possible value for column 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.
typePredBasic
A possible value for column 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.
typeSearchable
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.
Indicates that all WHERE search clauses can be based on this type.
tableIndexStatistic
A possible value for column 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.
tableIndexHashed
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.
Indicates that this table index is a hashed index.
tableIndexOther
A possible value for column 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. |