Class JtdsDatabaseMetaData
- All Implemented Interfaces:
DatabaseMetaData
,Wrapper
Implementation note:
This is basically the code from the original jTDS driver. Main changes relate to the need to support the new ResultSet implementation.
TODO: Many of the system limits need to be revised to more accurately reflect the target database constraints. In many cases limits are soft and determined by bytes per column for example. Probably more of these functions should be altered to return 0 but for now the original jTDS values are returned.
- Version:
- $Id: JtdsDatabaseMetaData.java,v 1.37.2.4 2009-12-30 08:45:34 ickzon Exp $
- Author:
- Craig Spannring, The FreeTDS project, Alin Sinpalean created 17 March 2001
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) Boolean
Boolean.TRUE
if identifiers are case sensitive (the server was installed that way).private final JtdsConnection
private final int
(package private) static final int
(package private) int
Length of a sysname object (table name, catalog name etc.) -- 128 for TDS 7.0, 30 for earlier versions.private final int
Fields inherited from interface java.sql.DatabaseMetaData
attributeNoNulls, attributeNullable, attributeNullableUnknown, bestRowNotPseudo, bestRowPseudo, bestRowSession, bestRowTemporary, bestRowTransaction, bestRowUnknown, columnNoNulls, columnNullable, columnNullableUnknown, functionColumnIn, functionColumnInOut, functionColumnOut, functionColumnResult, functionColumnUnknown, functionNoNulls, functionNoTable, functionNullable, functionNullableUnknown, functionResultUnknown, functionReturn, functionReturnsTable, importedKeyCascade, importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeyRestrict, importedKeySetDefault, importedKeySetNull, procedureColumnIn, procedureColumnInOut, procedureColumnOut, procedureColumnResult, procedureColumnReturn, procedureColumnUnknown, procedureNoNulls, procedureNoResult, procedureNullable, procedureNullableUnknown, procedureResultUnknown, procedureReturnsResult, sqlStateSQL, sqlStateSQL99, tableIndexClustered, tableIndexHashed, tableIndexOther, tableIndexStatistic, typeNoNulls, typeNullable, typeNullableUnknown, typePredBasic, typePredChar, typePredNone, typeSearchable, versionColumnNotPseudo, versionColumnPseudo, versionColumnUnknown
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Can all the procedures returned by getProcedures be called by the current user?boolean
Can all the tables returned by getTable be SELECTed by the current user?boolean
private static CachedResultSet
createTypeInfoResultSet
(JtdsResultSet rs, boolean useLOBs) boolean
Does a data definition statement within a transaction force the transaction to commit?boolean
Is a data definition statement within a transaction ignored?boolean
deletesAreDetected
(int type) JDBC 2.0 Indicates whether or not a visible row delete can be detected by calling ResultSet.rowDeleted().boolean
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?boolean
getAttributes
(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) getBestRowIdentifier
(String catalog, String schema, String table, int scope, boolean nullable) Get a description of a table's optimal set of columns that uniquely identifies a row.Get the catalog names available in this database.What's the separator between catalog and table name?What's the database vendor's preferred term for "catalog"?getColumnPrivileges
(String catalog, String schema, String table, String columnNamePattern) Get a description of the access rights for a table's columns.getColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) Get a description of table columns available in a catalog.JDBC 2.0 Retrieves the connection that produced this metadata object.getCrossReference
(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) Get a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key).int
Returns the database major version.int
Returns the database minor version.Returns the name of this database product.Returns the version of this database product.int
Returns the database's default transaction isolation level.int
Returns this JDBC driver's major version number.int
Returns this JDBC driver's minor version number.Returns the name of this JDBC driver.Returns the version of this JDBC driver.getExportedKeys
(String catalog, String schema, String table) Get a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).getFunctionColumns
(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) getFunctions
(String catalog, String schemaPattern, String functionNamePattern) Returns the string used to quote SQL identifiers.getImportedKeys
(String catalog, String schema, String table) Get a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).getIndexInfo
(String catalog, String schema, String table, boolean unique, boolean approximate) Get a description of a table's indices and statistics.int
Returns the JDBC major version.int
Returns the JDBC minor version.int
How many hex characters can you have in an inline binary literal?int
What's the maximum length of a catalog name?int
What's the max length for a character literal?int
What's the limit on column name length?int
What's the maximum number of columns in a "GROUP BY" clause?int
What's the maximum number of columns allowed in an index?int
What's the maximum number of columns in an "ORDER BY" clause?int
What's the maximum number of columns in a "SELECT" list?int
What's the maximum number of columns in a table?int
How many active connections can we have at a time to this database?int
What's the maximum cursor name length?int
What's the maximum length of an index (in bytes)?int
What's the maximum length of a procedure name?int
What's the maximum length of a single row?int
What's the maximum length allowed for a schema name?int
What's the maximum length of a SQL statement?int
How many active statements can we have open at one time to this database?int
What's the maximum length of a table name?int
What's the maximum number of tables in a SELECT?int
What's the maximum length of a user name?Get a comma separated list of math functions.getPrimaryKeys
(String catalog, String schema, String table) Get a description of a table's primary key columns.getProcedureColumns
(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) Get a description of a catalog's stored procedure parameters and result columns.getProcedures
(String catalog, String schemaPattern, String procedureNamePattern) Get a description of stored procedures available in a catalog.What's the database vendor's preferred term for "procedure"?getPseudoColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) int
Get the schema names available in this database.getSchemas
(String catalog, String schemaPattern) What's the database vendor's preferred term for "schema"?This is the string that can be used to escape '_' or '%' in the string pattern style catalog search parameters.private static Collection
getSortedTypes
(ResultSet rs, boolean useLOBs) Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.int
Get a comma separated list of string functions.getSuperTables
(String catalog, String schemaPattern, String tableNamePattern) getSuperTypes
(String catalog, String schemaPattern, String typeNamePattern) Get a comma separated list of system functions.getTablePrivileges
(String catalog, String schemaPattern, String tableNamePattern) Get a description of the access rights for each table available in a catalog.Get a description of tables available in a catalog.Get the table types available in this database.Get a comma separated list of time and date functions.Get a description of all the standard SQL types supported by this database.JDBC 2.0 Gets a description of the user-defined types defined in a particular schema.getURL()
What's the URL for this database?What's our user name as known to the database?getVersionColumns
(String catalog, String schema, String table) Get a description of a table's columns that are automatically updated when any value in a row is updated.boolean
insertsAreDetected
(int type) JDBC 2.0 Indicates whether or not a visible row insert can be detected by calling ResultSet.rowInserted().boolean
Retrieves whether a catalog appears at the start of a fully qualified table name.boolean
Is the database in read-only mode?boolean
isWrapperFor
(Class arg0) boolean
Returnstrue
if updates are made to a copy of the LOB; returnsfalse
if LOB updates are made directly to the database.boolean
Retrieves whether this database supports concatenations betweenNULL
and non-NULL
values beingNULL
.boolean
Are NULL values sorted at the end regardless of sort order?boolean
Are NULL values sorted at the start regardless of sort order?boolean
Are NULL values sorted high?boolean
Are NULL values sorted low?boolean
othersDeletesAreVisible
(int type) JDBC 2.0 Indicates whether deletes made by others are visible.boolean
othersInsertsAreVisible
(int type) JDBC 2.0 Indicates whether inserts made by others are visible.boolean
othersUpdatesAreVisible
(int type) JDBC 2.0 Indicates whether updates made by others are visible.boolean
ownDeletesAreVisible
(int type) JDBC 2.0 Indicates whether a result set's own deletes are visible.boolean
ownInsertsAreVisible
(int type) JDBC 2.0 Indicates whether a result set's own inserts are visible.boolean
ownUpdatesAreVisible
(int type) JDBC 2.0 Indicates whether a result set's own updates are visible.private static String
processEscapes
(String pattern) Format the supplied search pattern to transform the escape \x into [x].private void
boolean
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?boolean
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?boolean
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?boolean
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?boolean
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?boolean
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?boolean
Is "ALTER TABLE" with add column supported?boolean
Is "ALTER TABLE" with drop column supported?boolean
Retrieves whether this database supports the ANSI92 entry level SQL grammar.boolean
Is the ANSI92 full SQL grammar supported?boolean
Is the ANSI92 intermediate SQL grammar supported?boolean
JDBC 2.0 Indicates whether the driver supports batch updates.boolean
Can a catalog name be used in a data manipulation statement?boolean
Can a catalog name be used in an index definition statement?boolean
Can a catalog name be used in a privilege definition statement?boolean
Can a catalog name be used in a procedure call statement?boolean
Can a catalog name be used in a table definition statement?boolean
Retrieves whether this database supports column aliasing.boolean
Is the CONVERT function between SQL types supported?boolean
supportsConvert
(int fromType, int toType) Is CONVERT between the given SQL types supported?boolean
Is the ODBC Core SQL grammar supported?boolean
Retrieves whether this database supports correlated subqueries.boolean
Are both data definition and data manipulation statements within a transaction supported?boolean
Are only data manipulation statements within a transaction supported?boolean
If table correlation names are supported, are they restricted to be different from the names of the tables?boolean
Are expressions in "ORDER BY" lists supported?boolean
Is the ODBC Extended SQL grammar supported?boolean
Are full nested outer joins supported?boolean
Returnstrue
if getting auto-generated keys is supported after a statment is executed; returnsfalse
otherwiseboolean
Is some form of "GROUP BY" clause supported?boolean
Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?boolean
Can a "GROUP BY" clause use columns not in the SELECT?boolean
Is the SQL Integrity Enhancement Facility supported?boolean
Retrieves whether this database supports specifying aLIKE
escape clause.boolean
Retrieves whether this database provides limited support for outer joins.boolean
Retrieves whether this database supports the ODBC Minimum SQL grammar.boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.boolean
Returnstrue
if Callable statements can return multiple result sets; returnsfalse
if they can only return one result set.boolean
Are multiple ResultSets from a single execute supported?boolean
Can we have multiple transactions open at once (on different connections)?boolean
Returnstrue
if the database supports named parameters; returnsfalse
if the database does not support named parameters.boolean
Retrieves whether columns in this database may be defined as non-nullable.boolean
Can cursors remain open across commits?boolean
Can cursors remain open across rollbacks?boolean
Can statements remain open across commits?boolean
Can statements remain open across rollbacks?boolean
Can an "ORDER BY" clause use columns not in the SELECT?boolean
Is some form of outer join supported?boolean
Is positioned DELETE supported?boolean
Is positioned UPDATE supported?boolean
supportsResultSetConcurrency
(int type, int concurrency) Does the database support the concurrency type in combination with the given result set type?boolean
supportsResultSetHoldability
(int param) boolean
supportsResultSetType
(int type) Does the database support the given result set type?boolean
Returnstrue
if savepoints are supported; returnsfalse
otherwiseboolean
Can a schema name be used in a data manipulation statement?boolean
Can a schema name be used in an index definition statement?boolean
Can a schema name be used in a privilege definition statement?boolean
Can a schema name be used in a procedure call statement?boolean
Can a schema name be used in a table definition statement?boolean
Is SELECT for UPDATE supported?boolean
Returnstrue
if the database supports statement pooling; returnsfalse
otherwise.boolean
boolean
Are stored procedure calls using the stored procedure escape syntax supported?boolean
Retrieves whether this database supports subqueries in comparison expressions.boolean
Retrieves whether this database supports subqueries inEXISTS
expressions.boolean
Retrieves whether this database supports subqueries inIN
statements.boolean
Retrieves whether this database supports subqueries in quantified expressions.boolean
Retrieves whether this database supports table correlation names.boolean
supportsTransactionIsolationLevel
(int level) Does the database support the given transaction isolation level?boolean
Retrieves whether this database supports transactions.boolean
Is SQL UNION supported?boolean
Is SQL UNION ALL supported?private String
Format the supplied procedure call as a valid JDBC call escape.boolean
updatesAreDetected
(int type) JDBC 2.0 Indicates whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.private static void
upperCaseColumnNames
(JtdsResultSet results) Uppercase all column names.boolean
Does the database use a file for each table?boolean
Does the database store tables in a local file?Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.sql.DatabaseMetaData
getMaxLogicalLobSize, supportsRefCursors, supportsSharding
-
Field Details
-
sqlStateXOpen
static final int sqlStateXOpen- See Also:
-
tdsVersion
private final int tdsVersion -
serverType
private final int serverType -
connection
-
sysnameLength
int sysnameLengthLength of a sysname object (table name, catalog name etc.) -- 128 for TDS 7.0, 30 for earlier versions. -
caseSensitive
Boolean caseSensitiveBoolean.TRUE
if identifiers are case sensitive (the server was installed that way). Initiallynull
, set the first time any of the methods that check this are called.
-
-
Constructor Details
-
JtdsDatabaseMetaData
-
-
Method Details
-
allProceduresAreCallable
Can all the procedures returned by getProcedures be called by the current user?- Specified by:
allProceduresAreCallable
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
allTablesAreSelectable
Can all the tables returned by getTable be SELECTed by the current user?- Specified by:
allTablesAreSelectable
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
dataDefinitionCausesTransactionCommit
Does a data definition statement within a transaction force the transaction to commit?- Specified by:
dataDefinitionCausesTransactionCommit
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
dataDefinitionIgnoredInTransactions
Is a data definition statement within a transaction ignored?- Specified by:
dataDefinitionIgnoredInTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
doesMaxRowSizeIncludeBlobs
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?- Specified by:
doesMaxRowSizeIncludeBlobs
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
getBestRowIdentifier
public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException Get 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 short =>SQL data type from java.sql.Types
- TYPE_NAME String =>Data source dependent type name
- COLUMN_SIZE int =>precision
- BUFFER_LENGTH int =>not used
- DECIMAL_DIGITS short =>scale
- 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
- Specified by:
getBestRowIdentifier
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table namescope
- the scope of interest; use same values as SCOPEnullable
- include columns that are nullable?- Returns:
- ResultSet - each row is a column description
- Throws:
SQLException
- if a database-access error occurs.
- SCOPE short =>actual scope of result
-
getCatalogs
Get the catalog names available in this database. The results are ordered by catalog name.The catalog column is:
- TABLE_CAT String =>catalog name
- Specified by:
getCatalogs
in interfaceDatabaseMetaData
- Returns:
- ResultSet - each row has a single String column that is a catalog name
- Throws:
SQLException
- if a database-access error occurs.
-
getCatalogSeparator
What's the separator between catalog and table name?- Specified by:
getCatalogSeparator
in interfaceDatabaseMetaData
- Returns:
- the separator string
- Throws:
SQLException
- if a database-access error occurs.
-
getCatalogTerm
What's the database vendor's preferred term for "catalog"?- Specified by:
getCatalogTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
- Throws:
SQLException
- if a database-access error occurs.
-
getColumnPrivileges
public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException Get 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 =>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
- Specified by:
getColumnPrivileges
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schema schematable
- a table namecolumnNamePattern
- a column name pattern- Returns:
- ResultSet - each row is a column privilege description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getColumns
public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Get a description of table columns available in a catalog.Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION.
Each column description has the following columns:
- 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 short =>SQL type from java.sql.Types
- TYPE_NAME String =>Data source dependent type name
- 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.
- BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int =>the number of fractional digits
- 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 (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 =>"NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.
- IS_AUTOINCREMENT String =>"NO" means column is no identity column; "YES" means it is.
- Specified by:
getColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name patterncolumnNamePattern
- a column name pattern- Returns:
- ResultSet - each row is a column description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getCrossReference
public ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException Get a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key). This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.) They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String =>primary key table catalog (may be null)
- PKTABLE_SCHEM String =>primary key table schema (may be null)
- PKTABLE_NAME String =>primary key table name
- PKCOLUMN_NAME String =>primary key column name
- FKTABLE_CAT String =>foreign key table catalog (may be null) being exported (may be null)
- FKTABLE_SCHEM String =>foreign key table schema (may be null) being exported (may be null)
- FKTABLE_NAME String =>foreign key table name being exported
- FKCOLUMN_NAME String =>foreign key column name being exported
- KEY_SEQ short =>sequence number within foreign key
- 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)
- 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
- FK_NAME String =>foreign key name (may be null)
- PK_NAME String =>primary key name (may be null)
- 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
- Specified by:
getCrossReference
in interfaceDatabaseMetaData
- Parameters:
primaryCatalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaprimarySchema
- a schema name pattern; "" retrieves those without a schemaprimaryTable
- the table name that exports the keyforeignCatalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaforeignSchema
- a schema name pattern; "" retrieves those without a schemaforeignTable
- the table name that imports the key- Returns:
- ResultSet - each row is a foreign key column description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getDatabaseProductName
Returns the name of this database product.- Specified by:
getDatabaseProductName
in interfaceDatabaseMetaData
- Returns:
- database product name
- Throws:
SQLException
- if a database-access error occurs.
-
getDatabaseProductVersion
Returns the version of this database product.- Specified by:
getDatabaseProductVersion
in interfaceDatabaseMetaData
- Returns:
- database version
- Throws:
SQLException
- if a database-access error occurs.
-
getDefaultTransactionIsolation
Returns the database's default transaction isolation level. The values are defined in java.sql.Connection.- Specified by:
getDefaultTransactionIsolation
in interfaceDatabaseMetaData
- Returns:
- the default isolation level
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getDriverMajorVersion
public int getDriverMajorVersion()Returns this JDBC driver's major version number.- Specified by:
getDriverMajorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver major version
-
getDriverMinorVersion
public int getDriverMinorVersion()Returns this JDBC driver's minor version number.- Specified by:
getDriverMinorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver minor version number
-
getDriverName
Returns the name of this JDBC driver.- Specified by:
getDriverName
in interfaceDatabaseMetaData
- Returns:
- JDBC driver name
- Throws:
SQLException
- if a database-access error occurs.
-
getDriverVersion
Returns the version of this JDBC driver.- Specified by:
getDriverVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver version
- Throws:
SQLException
- if a database-access error occurs.
-
getExportedKeys
Get a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String =>primary key table catalog (may be null)
- PKTABLE_SCHEM String =>primary key table schema (may be null)
- PKTABLE_NAME String =>primary key table name
- PKCOLUMN_NAME String =>primary key column name
- FKTABLE_CAT String =>foreign key table catalog (may be null) being exported (may be null)
- FKTABLE_SCHEM String =>foreign key table schema (may be null) being exported (may be null)
- FKTABLE_NAME String =>foreign key table name being exported
- FKCOLUMN_NAME String =>foreign key column name being exported
- KEY_SEQ short =>sequence number within foreign key
- 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)
- 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
- FK_NAME String =>foreign key name (may be null)
- PK_NAME String =>primary key name (may be null)
- 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
- Specified by:
getExportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a foreign key column description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getExtraNameCharacters
Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).- Specified by:
getExtraNameCharacters
in interfaceDatabaseMetaData
- Returns:
- the string containing the extra characters
- Throws:
SQLException
- if a database-access error occurs.
-
getIdentifierQuoteString
Returns the string used to quote SQL identifiers. This returns a space " " if identifier quoting isn't supported. A JDBC-Compliant driver always uses a double quote character.- Specified by:
getIdentifierQuoteString
in interfaceDatabaseMetaData
- Returns:
- the quoting string
- Throws:
SQLException
- if a database-access error occurs.
-
getImportedKeys
Get a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.Each primary key column description has the following columns:
- PKTABLE_CAT String =>primary key table catalog being imported (may be null)
- PKTABLE_SCHEM String =>primary key table schema being imported (may be null)
- PKTABLE_NAME String =>primary key table name being imported
- PKCOLUMN_NAME String =>primary key column name being imported
- FKTABLE_CAT String =>foreign key table catalog (may be null)
- FKTABLE_SCHEM String =>foreign key table schema (may be null)
- FKTABLE_NAME String =>foreign key table name
- FKCOLUMN_NAME String =>foreign key column name
- KEY_SEQ short =>sequence number within foreign key
- 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)
- 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
- FK_NAME String =>foreign key name (may be null)
- PK_NAME String =>primary key name (may be null)
- 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
- Specified by:
getImportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a primary key column description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getIndexInfo
public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException Get a description of a table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.Each index 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
- NON_UNIQUE boolean =>Can index values be non-unique? false when TYPE is tableIndexStatistic
- INDEX_QUALIFIER String =>index catalog (may be null); null when TYPE is tableIndexStatistic
- INDEX_NAME String =>index name; null when TYPE is tableIndexStatistic
- 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
- ORDINAL_POSITION short =>column sequence number within index; zero when TYPE is tableIndexStatistic
- COLUMN_NAME String =>column name; null when TYPE is tableIndexStatistic
- 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
- 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.
- 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.
- FILTER_CONDITION String =>Filter condition, if any. (may be null)
- Specified by:
getIndexInfo
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table nameunique
- whentrue
, return only indices for unique values; whenfalse
, return indices regardless of whether unique or notapproximate
- whentrue
, result is allowed to reflect approximate or out of data values; whenfalse
, results are requested to be accurate- Returns:
- ResultSet - each row is an index column description
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxBinaryLiteralLength
How many hex characters can you have in an inline binary literal?- Specified by:
getMaxBinaryLiteralLength
in interfaceDatabaseMetaData
- Returns:
- max literal length
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxCatalogNameLength
What's the maximum length of a catalog name?- Specified by:
getMaxCatalogNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxCharLiteralLength
What's the max length for a character literal?- Specified by:
getMaxCharLiteralLength
in interfaceDatabaseMetaData
- Returns:
- max literal length
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxColumnNameLength
What's the limit on column name length?- Specified by:
getMaxColumnNameLength
in interfaceDatabaseMetaData
- Returns:
- max literal length
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxColumnsInGroupBy
What's the maximum number of columns in a "GROUP BY" clause?- Specified by:
getMaxColumnsInGroupBy
in interfaceDatabaseMetaData
- Returns:
- max number of columns
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxColumnsInIndex
What's the maximum number of columns allowed in an index?- Specified by:
getMaxColumnsInIndex
in interfaceDatabaseMetaData
- Returns:
- max columns
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxColumnsInOrderBy
What's the maximum number of columns in an "ORDER BY" clause?- Specified by:
getMaxColumnsInOrderBy
in interfaceDatabaseMetaData
- Returns:
- max columns
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxColumnsInSelect
What's the maximum number of columns in a "SELECT" list?- Specified by:
getMaxColumnsInSelect
in interfaceDatabaseMetaData
- Returns:
- max columns
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxColumnsInTable
What's the maximum number of columns in a table?- Specified by:
getMaxColumnsInTable
in interfaceDatabaseMetaData
- Returns:
- max columns
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxConnections
How many active connections can we have at a time to this database?- Specified by:
getMaxConnections
in interfaceDatabaseMetaData
- Returns:
- max connections
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxCursorNameLength
What's the maximum cursor name length?- Specified by:
getMaxCursorNameLength
in interfaceDatabaseMetaData
- Returns:
- max cursor name length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxIndexLength
What's the maximum length of an index (in bytes)?- Specified by:
getMaxIndexLength
in interfaceDatabaseMetaData
- Returns:
- max index length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxProcedureNameLength
What's the maximum length of a procedure name?- Specified by:
getMaxProcedureNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxRowSize
What's the maximum length of a single row?- Specified by:
getMaxRowSize
in interfaceDatabaseMetaData
- Returns:
- max row size in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxSchemaNameLength
What's the maximum length allowed for a schema name?- Specified by:
getMaxSchemaNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxStatementLength
What's the maximum length of a SQL statement?- Specified by:
getMaxStatementLength
in interfaceDatabaseMetaData
- Returns:
- max length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxStatements
How many active statements can we have open at one time to this database?- Specified by:
getMaxStatements
in interfaceDatabaseMetaData
- Returns:
- the maximum
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxTableNameLength
What's the maximum length of a table name?- Specified by:
getMaxTableNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxTablesInSelect
What's the maximum number of tables in a SELECT?- Specified by:
getMaxTablesInSelect
in interfaceDatabaseMetaData
- Returns:
- the maximum
- Throws:
SQLException
- if a database-access error occurs.
-
getMaxUserNameLength
What's the maximum length of a user name?- Specified by:
getMaxUserNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
- Throws:
SQLException
- if a database-access error occurs.
-
getNumericFunctions
Get a comma separated list of math functions.- Specified by:
getNumericFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database-access error occurs.
-
getPrimaryKeys
Get a description of a table's primary key columns. They are ordered by COLUMN_NAME.Each primary key 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
- KEY_SEQ short =>sequence number within primary key
- PK_NAME String =>primary key name (may be null)
- Specified by:
getPrimaryKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a primary key column description
- Throws:
SQLException
- if a database-access error occurs.
-
getProcedureColumns
public ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException Get a description of a catalog's stored procedure parameters and result columns.Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the ResultSet is a parameter description or column description with the following fields:
- 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 short =>SQL type from java.sql.Types
- TYPE_NAME String =>SQL type name
- PRECISION int =>precision
- LENGTH int =>length in bytes of data
- SCALE short =>scale
- 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
Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.
- Specified by:
getProcedureColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schemaprocedureNamePattern
- a procedure name patterncolumnNamePattern
- a column name pattern- Returns:
- ResultSet - each row is a stored procedure parameter or column description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getProcedures
public ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException Get a description of 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.
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 - May return a result
- procedureNoResult - Does not return a result
- procedureReturnsResult - Returns a result
- Specified by:
getProcedures
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schemaprocedureNamePattern
- a procedure name pattern- Returns:
- ResultSet - each row is a procedure description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getProcedureTerm
What's the database vendor's preferred term for "procedure"?- Specified by:
getProcedureTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
- Throws:
SQLException
- if a database-access error occurs.
-
getSchemas
Get the schema names available in this database. The results are ordered by schema name.The schema column is:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null
, JDBC 3.0)
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Returns:
- a
ResultSet
object in which each row is a schema description - Throws:
SQLException
- if a database access error occurs
-
getSchemaTerm
What's the database vendor's preferred term for "schema"?- Specified by:
getSchemaTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
- Throws:
SQLException
- if a database-access error occurs.
-
getSearchStringEscape
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.
- Specified by:
getSearchStringEscape
in interfaceDatabaseMetaData
- Returns:
- the string used to escape wildcard characters
- Throws:
SQLException
- if a database-access error occurs.
-
getSQLKeywords
Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.- Specified by:
getSQLKeywords
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database-access error occurs.
-
getStringFunctions
Get a comma separated list of string functions.- Specified by:
getStringFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database-access error occurs.
-
getSystemFunctions
Get a comma separated list of system functions.- Specified by:
getSystemFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database-access error occurs.
-
getTablePrivileges
public ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException Get 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.)Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String =>table catalog (may be null)
- TABLE_SCHEM String =>table schema (may be null)
- TABLE_NAME String =>table name
- GRANTOR =>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
- Specified by:
getTablePrivileges
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name pattern- Returns:
- ResultSet - each row is a table privilege description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getTables
public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException Get a description of tables available in a catalog.Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
- 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.
- Specified by:
getTables
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name patterntypes
- a list of table types to include; null returns all types- Returns:
- ResultSet - each row is a table description
- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
getTableTypes
Get 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".
- Specified by:
getTableTypes
in interfaceDatabaseMetaData
- Returns:
- ResultSet - each row has a single String column that is a table type
- Throws:
SQLException
- if a database-access error occurs.
-
getTimeDateFunctions
Get a comma separated list of time and date functions.- Specified by:
getTimeDateFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database-access error occurs.
-
getTypeInfo
Get 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.Each type description has the following columns:
- TYPE_NAME String =>Type name
- DATA_TYPE short =>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
- Specified by:
getTypeInfo
in interfaceDatabaseMetaData
- Returns:
- ResultSet - each row is a SQL type description
- Throws:
SQLException
- if a database-access error occurs.
-
getUDTs
public ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException JDBC 2.0 Gets 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.
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 String =>type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String =>explanatory comment on the type
Note: If the driver does not support UDTs, an empty result set is returned.
- Specified by:
getUDTs
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematypeNamePattern
- a type name pattern; may be a fully-qualified nametypes
- a list of user-named types to include (JAVA_OBJECT, STRUCT, or DISTINCT); null returns all types- Returns:
- ResultSet - each row is a type description
- Throws:
SQLException
- if a database access error occurs
-
getURL
What's the URL for this database?- Specified by:
getURL
in interfaceDatabaseMetaData
- Returns:
- the URL or null if it can't be generated
- Throws:
SQLException
- if a database-access error occurs
-
getUserName
What's our user name as known to the database?- Specified by:
getUserName
in interfaceDatabaseMetaData
- Returns:
- our database user name
- Throws:
SQLException
- if a database-access error occurs.
-
getVersionColumns
Get 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 short =>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
- 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
- Specified by:
getVersionColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without anull
means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a column description
- Throws:
SQLException
- if a database-access error occurs.
-
isCatalogAtStart
Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.- Specified by:
isCatalogAtStart
in interfaceDatabaseMetaData
- Returns:
- true if it appears at the start
- Throws:
SQLException
- if a database-access error occurs.
-
isReadOnly
Is the database in read-only mode?- Specified by:
isReadOnly
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
getConnection
JDBC 2.0 Retrieves the connection that produced this metadata object.- Specified by:
getConnection
in interfaceDatabaseMetaData
- Returns:
- the connection that produced this metadata object
- Throws:
SQLException
- if a database-access error occurs.
-
nullPlusNonNullIsNull
Retrieves whether this database supports concatenations betweenNULL
and non-NULL
values beingNULL
.- Specified by:
nullPlusNonNullIsNull
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
nullsAreSortedAtEnd
Are NULL values sorted at the end regardless of sort order?- Specified by:
nullsAreSortedAtEnd
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
nullsAreSortedAtStart
Are NULL values sorted at the start regardless of sort order?- Specified by:
nullsAreSortedAtStart
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
nullsAreSortedHigh
Are NULL values sorted high?- Specified by:
nullsAreSortedHigh
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
nullsAreSortedLow
Are NULL values sorted low?- Specified by:
nullsAreSortedLow
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
storesLowerCaseIdentifiers
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?- Specified by:
storesLowerCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
storesLowerCaseQuotedIdentifiers
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?- Specified by:
storesLowerCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
storesMixedCaseIdentifiers
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?- Specified by:
storesMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
storesMixedCaseQuotedIdentifiers
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?- Specified by:
storesMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
storesUpperCaseIdentifiers
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?- Specified by:
storesUpperCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
storesUpperCaseQuotedIdentifiers
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?- Specified by:
storesUpperCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsAlterTableWithAddColumn
Is "ALTER TABLE" with add column supported?- Specified by:
supportsAlterTableWithAddColumn
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsAlterTableWithDropColumn
Is "ALTER TABLE" with drop column supported?- Specified by:
supportsAlterTableWithDropColumn
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsANSI92EntryLevelSQL
Retrieves whether this database supports the ANSI92 entry level SQL grammar.- Specified by:
supportsANSI92EntryLevelSQL
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsANSI92FullSQL
Is the ANSI92 full SQL grammar supported?- Specified by:
supportsANSI92FullSQL
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsANSI92IntermediateSQL
Is the ANSI92 intermediate SQL grammar supported?- Specified by:
supportsANSI92IntermediateSQL
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsCatalogsInDataManipulation
Can a catalog name be used in a data manipulation statement?- Specified by:
supportsCatalogsInDataManipulation
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsCatalogsInIndexDefinitions
Can a catalog name be used in an index definition statement?- Specified by:
supportsCatalogsInIndexDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsCatalogsInPrivilegeDefinitions
Can a catalog name be used in a privilege definition statement?- Specified by:
supportsCatalogsInPrivilegeDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsCatalogsInProcedureCalls
Can a catalog name be used in a procedure call statement?- Specified by:
supportsCatalogsInProcedureCalls
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsCatalogsInTableDefinitions
Can a catalog name be used in a table definition statement?- Specified by:
supportsCatalogsInTableDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsColumnAliasing
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. A JDBC-Compliant driver always returns true.
- Specified by:
supportsColumnAliasing
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsConvert
Is the CONVERT function between SQL types supported?- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsConvert
Is CONVERT between the given SQL types supported?- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Parameters:
fromType
- the type to convert fromtoType
- the type to convert to- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsCoreSQLGrammar
Is the ODBC Core SQL grammar supported?- Specified by:
supportsCoreSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsDataDefinitionAndDataManipulationTransactions
Are both data definition and data manipulation statements within a transaction supported?- Specified by:
supportsDataDefinitionAndDataManipulationTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsDataManipulationTransactionsOnly
Are only data manipulation statements within a transaction supported?- Specified by:
supportsDataManipulationTransactionsOnly
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsDifferentTableCorrelationNames
If table correlation names are supported, are they restricted to be different from the names of the tables?- Specified by:
supportsDifferentTableCorrelationNames
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsExpressionsInOrderBy
Are expressions in "ORDER BY" lists supported?- Specified by:
supportsExpressionsInOrderBy
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsExtendedSQLGrammar
Is the ODBC Extended SQL grammar supported?- Specified by:
supportsExtendedSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsFullOuterJoins
Are full nested outer joins supported?- Specified by:
supportsFullOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsGroupBy
Is some form of "GROUP BY" clause supported?- Specified by:
supportsGroupBy
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsGroupByBeyondSelect
Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?- Specified by:
supportsGroupByBeyondSelect
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsIntegrityEnhancementFacility
Is the SQL Integrity Enhancement Facility supported?- Specified by:
supportsIntegrityEnhancementFacility
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsLikeEscapeClause
Retrieves whether this database supports specifying aLIKE
escape clause.- Specified by:
supportsLikeEscapeClause
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsLimitedOuterJoins
Retrieves whether this database provides limited support for outer joins. (This will betrue
if the methodsupportsFullOuterJoins
returnstrue
).- Specified by:
supportsLimitedOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsMinimumSQLGrammar
Retrieves whether this database supports the ODBC Minimum SQL grammar.- Specified by:
supportsMinimumSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsMixedCaseIdentifiers
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.- Specified by:
supportsMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsMixedCaseQuotedIdentifiers
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.- Specified by:
supportsMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsMultipleResultSets
Are multiple ResultSets from a single execute supported?- Specified by:
supportsMultipleResultSets
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsMultipleTransactions
Can we have multiple transactions open at once (on different connections)?- Specified by:
supportsMultipleTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsNonNullableColumns
Retrieves whether columns in this database may be defined as non-nullable.- Specified by:
supportsNonNullableColumns
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsOpenCursorsAcrossCommit
Can cursors remain open across commits?- Specified by:
supportsOpenCursorsAcrossCommit
in interfaceDatabaseMetaData
- Returns:
true
if cursors always remain open;false
if they might not remain open- Throws:
SQLException
- if a database-access error occurs.
-
supportsOpenCursorsAcrossRollback
Can cursors remain open across rollbacks?- Specified by:
supportsOpenCursorsAcrossRollback
in interfaceDatabaseMetaData
- Returns:
true
if cursors always remain open;false
if they might not remain open- Throws:
SQLException
- if a database-access error occurs.
-
supportsOpenStatementsAcrossCommit
Can statements remain open across commits?- Specified by:
supportsOpenStatementsAcrossCommit
in interfaceDatabaseMetaData
- Returns:
true
if statements always remain open;false
if they might not remain open- Throws:
SQLException
- if a database-access error occurs.
-
supportsOpenStatementsAcrossRollback
Can statements remain open across rollbacks?- Specified by:
supportsOpenStatementsAcrossRollback
in interfaceDatabaseMetaData
- Returns:
true
if statements always remain open;false
if they might not remain open- Throws:
SQLException
- if a database-access error occurs.
-
supportsOuterJoins
Is some form of outer join supported?- Specified by:
supportsOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsPositionedDelete
Is positioned DELETE supported?- Specified by:
supportsPositionedDelete
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsPositionedUpdate
Is positioned UPDATE supported?- Specified by:
supportsPositionedUpdate
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSchemasInDataManipulation
Can a schema name be used in a data manipulation statement?- Specified by:
supportsSchemasInDataManipulation
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSchemasInIndexDefinitions
Can a schema name be used in an index definition statement?- Specified by:
supportsSchemasInIndexDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSchemasInPrivilegeDefinitions
Can a schema name be used in a privilege definition statement?- Specified by:
supportsSchemasInPrivilegeDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSchemasInProcedureCalls
Can a schema name be used in a procedure call statement?- Specified by:
supportsSchemasInProcedureCalls
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSchemasInTableDefinitions
Can a schema name be used in a table definition statement?- Specified by:
supportsSchemasInTableDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSelectForUpdate
Is SELECT for UPDATE supported?- Specified by:
supportsSelectForUpdate
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsStoredProcedures
Are stored procedure calls using the stored procedure escape syntax supported?- Specified by:
supportsStoredProcedures
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSubqueriesInComparisons
Retrieves whether this database supports subqueries in comparison expressions.- Specified by:
supportsSubqueriesInComparisons
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSubqueriesInExists
Retrieves whether this database supports subqueries inEXISTS
expressions.- Specified by:
supportsSubqueriesInExists
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSubqueriesInIns
Retrieves whether this database supports subqueries inIN
statements.- Specified by:
supportsSubqueriesInIns
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsSubqueriesInQuantifieds
Retrieves whether this database supports subqueries in quantified expressions.- Specified by:
supportsSubqueriesInQuantifieds
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsTableCorrelationNames
Retrieves whether this database supports table correlation names.- Specified by:
supportsTableCorrelationNames
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsTransactionIsolationLevel
Does the database support the given transaction isolation level?- Specified by:
supportsTransactionIsolationLevel
in interfaceDatabaseMetaData
- Parameters:
level
- the values are defined in java.sql.Connection- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.- See Also:
-
supportsTransactions
Retrieves whether this database supports transactions. If not, invoking the methodcommit
is a noop, and the isolation level isTRANSACTION_NONE
.- Specified by:
supportsTransactions
in interfaceDatabaseMetaData
- Returns:
true
if transactions are supported- Throws:
SQLException
- if a database-access error occurs.
-
supportsUnion
Is SQL UNION supported?- Specified by:
supportsUnion
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsUnionAll
Is SQL UNION ALL supported?- Specified by:
supportsUnionAll
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
usesLocalFilePerTable
Does the database use a file for each table?- Specified by:
usesLocalFilePerTable
in interfaceDatabaseMetaData
- Returns:
true
if the database uses a local file for each table- Throws:
SQLException
- if a database-access error occurs.
-
usesLocalFiles
Does the database store tables in a local file?- Specified by:
usesLocalFiles
in interfaceDatabaseMetaData
- Returns:
true
if so- Throws:
SQLException
- if a database-access error occurs.
-
supportsResultSetType
Does the database support the given result set type? Supported types for SQL Server:JDBC type SQL Server cursor type Server load Description TYPE_FORWARD_ONLY Forward-only, dynamic (fast forward-only, static with useCursors=true
)Light Fast, will read all data (less fast, doesn't read all data with useCursors=true
). Forward only.TYPE_SCROLL_INSENSITIVE Static cursor Heavy Only use with CONCUR_READ_ONLY. SQL Server generates a temporary table, so changes made by others are not visible. Scrollable. TYPE_SCROLL_SENSITIVE Keyset cursor Medium Others' updates or deletes visible, but not others' inserts. Scrollable. TYPE_SCROLL_SENSITIVE + 1 Dynamic cursor Heavy Others' updates, deletes and inserts visible. Scrollable. - Specified by:
supportsResultSetType
in interfaceDatabaseMetaData
- Parameters:
type
- defined injava.sql.ResultSet
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- See Also:
-
supportsResultSetConcurrency
Does the database support the concurrency type in combination with the given result set type? Supported concurrencies for SQL Server:JDBC concurrency SQL Server concurrency Row locks Description CONCUR_READ_ONLY Read only No Read-only. CONCUR_UPDATABLE Optimistic concurrency, updatable No Row integrity checked with timestamp comparison or, when not available, value comparison (except text and image fields). CONCUR_UPDATABLE+1 Pessimistic concurrency, updatable Yes Row integrity is ensured by locking rows. CONCUR_UPDATABLE+2 Optimistic concurrency, updatable No Row integrity checked with value comparison (except text and image fields). - Specified by:
supportsResultSetConcurrency
in interfaceDatabaseMetaData
- Parameters:
type
- defined injava.sql.ResultSet
concurrency
- type defined injava.sql.ResultSet
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- See Also:
-
ownUpdatesAreVisible
JDBC 2.0 Indicates whether a result set's own updates are visible.- Specified by:
ownUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if updates are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
ownDeletesAreVisible
JDBC 2.0 Indicates whether a result set's own deletes are visible.- Specified by:
ownDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if deletes are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
ownInsertsAreVisible
JDBC 2.0 Indicates whether a result set's own inserts are visible.- Specified by:
ownInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if inserts are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
othersUpdatesAreVisible
JDBC 2.0 Indicates whether updates made by others are visible.- Specified by:
othersUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if updates made by others are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
othersDeletesAreVisible
JDBC 2.0 Indicates whether deletes made by others are visible.- Specified by:
othersDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if deletes made by others are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
othersInsertsAreVisible
JDBC 2.0 Indicates whether inserts made by others are visible.- Specified by:
othersInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if inserts made by others are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
updatesAreDetected
JDBC 2.0 Indicates whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.- Specified by:
updatesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if changes are detected by the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
deletesAreDetected
JDBC 2.0 Indicates whether or not a visible row delete can be detected by calling ResultSet.rowDeleted(). If deletesAreDetected() returns false, then deleted rows are removed from the result set.- Specified by:
deletesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if changes are detected by the result set type- Throws:
SQLException
- if a database access error occurs
-
insertsAreDetected
JDBC 2.0 Indicates whether or not a visible row insert can be detected by calling ResultSet.rowInserted().- Specified by:
insertsAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
-ResultSet
type- Returns:
true
if changes are detected by the result set type- Throws:
SQLException
- if a database access error occurs
-
supportsBatchUpdates
JDBC 2.0 Indicates whether the driver supports batch updates.- Specified by:
supportsBatchUpdates
in interfaceDatabaseMetaData
- Returns:
true
if the driver supports batch updates;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
setCaseSensitiveFlag
- Throws:
SQLException
-
getAttributes
public ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException - Specified by:
getAttributes
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getDatabaseMajorVersion
Returns the database major version.- Specified by:
getDatabaseMajorVersion
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getDatabaseMinorVersion
Returns the database minor version.- Specified by:
getDatabaseMinorVersion
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getJDBCMajorVersion
Returns the JDBC major version.- Specified by:
getJDBCMajorVersion
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getJDBCMinorVersion
Returns the JDBC minor version.- Specified by:
getJDBCMinorVersion
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getResultSetHoldability
- Specified by:
getResultSetHoldability
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getSQLStateType
- Specified by:
getSQLStateType
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getSuperTables
public ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLException - Specified by:
getSuperTables
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getSuperTypes
public ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException - Specified by:
getSuperTypes
in interfaceDatabaseMetaData
- Throws:
SQLException
-
locatorsUpdateCopy
Returnstrue
if updates are made to a copy of the LOB; returnsfalse
if LOB updates are made directly to the database.NOTE: Since SQL Server / Sybase do not support LOB locators as Oracle does (AFAIK); this method always returns
true
.- Specified by:
locatorsUpdateCopy
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsGetGeneratedKeys
Returnstrue
if getting auto-generated keys is supported after a statment is executed; returnsfalse
otherwise- Specified by:
supportsGetGeneratedKeys
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsMultipleOpenResults
Returnstrue
if Callable statements can return multiple result sets; returnsfalse
if they can only return one result set.- Specified by:
supportsMultipleOpenResults
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsNamedParameters
Returnstrue
if the database supports named parameters; returnsfalse
if the database does not support named parameters.- Specified by:
supportsNamedParameters
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsResultSetHoldability
- Specified by:
supportsResultSetHoldability
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsSavepoints
Returnstrue
if savepoints are supported; returnsfalse
otherwise- Specified by:
supportsSavepoints
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsStatementPooling
Returnstrue
if the database supports statement pooling; returnsfalse
otherwise.- Specified by:
supportsStatementPooling
in interfaceDatabaseMetaData
- Throws:
SQLException
-
processEscapes
Format the supplied search pattern to transform the escape \x into [x].- Parameters:
pattern
- the pattern to tranform- Returns:
- the transformed pattern as a
String
-
syscall
Format the supplied procedure call as a valid JDBC call escape.- Parameters:
catalog
- the database name or nullcall
- the stored procedure call to format- Returns:
- the formatted call escape as a
String
-
upperCaseColumnNames
Uppercase all column names.Sybase returns column names in lowecase while the JDBC standard suggests they should be uppercase.
- Parameters:
results
- the result set to modify- Throws:
SQLException
-
createTypeInfoResultSet
private static CachedResultSet createTypeInfoResultSet(JtdsResultSet rs, boolean useLOBs) throws SQLException - Throws:
SQLException
-
getSortedTypes
- Throws:
SQLException
-
autoCommitFailureClosesAllResultSets
- Specified by:
autoCommitFailureClosesAllResultSets
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getClientInfoProperties
- Specified by:
getClientInfoProperties
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getFunctionColumns
public ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException - Specified by:
getFunctionColumns
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getFunctions
public ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException - Specified by:
getFunctions
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getRowIdLifetime
- Specified by:
getRowIdLifetime
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getSchemas
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsStoredFunctionsUsingCallSyntax
- Specified by:
supportsStoredFunctionsUsingCallSyntax
in interfaceDatabaseMetaData
- Throws:
SQLException
-
isWrapperFor
- Specified by:
isWrapperFor
in interfaceWrapper
- Throws:
SQLException
-
unwrap
- Specified by:
unwrap
in interfaceWrapper
- Throws:
SQLException
-
getPseudoColumns
public ResultSet getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException - Specified by:
getPseudoColumns
in interfaceDatabaseMetaData
- Throws:
SQLException
-
generatedKeyAlwaysReturned
- Specified by:
generatedKeyAlwaysReturned
in interfaceDatabaseMetaData
- Throws:
SQLException
-