All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class interbase.interclient.DatabaseMetaData

java.lang.Object
   |
   +----interbase.interclient.DatabaseMetaData

public final class DatabaseMetaData

extends Object

implements DatabaseMetaData

Many of the methods here return lists of information in ResultSets. You can use the normal ResultSet methods such as getString and getInt to retrieve the data from these ResultSets. If a given form of metadata is not available, these methods will throw a SQLException.

Some of these methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern are returned. If a search pattern argument is set to a null ref, it means that argument's criteria should be dropped from the search.

A SQLException will be thrown if the driver or database is not capable of supporting a method. In the case of methods that return a ResultSet (such as getSchemas() and getCatalogs()) the JDBC specification allows for either an empty ResultSet to be returned, or a SQLException to be thrown. InterClient will throw a SQLException for these unsupported methods.

bestRowNotPseudo

BEST ROW PSEUDO_COLUMN - is NOT a pseudo column.

bestRowPseudo

BEST ROW PSEUDO_COLUMN - is a pseudo column.

bestRowSession

BEST ROW SCOPE - valid for remainder of current session.

bestRowTemporary

BEST ROW SCOPE - very temporary, while using row.

bestRowTransaction

BEST ROW SCOPE - valid for remainder of current transaction.

bestRowUnknown

BEST ROW PSEUDO_COLUMN - may or may not be pseudo column.

columnNoNulls

COLUMN NULLABLE - might not allow NULL values.

columnNullable

COLUMN NULLABLE - definitely allows NULL values.

columnNullableUnknown

COLUMN NULLABLE - nullability unknown.

importedKeyCascade

IMPORT KEY UPDATE_RULE and DELETE_RULE - for update, change imported key to agree with primary key update; for delete, delete rows that import a deleted key.

importedKeyInitiallyDeferred

IMPORT KEY DEFERRABILITY - see SQL92 for definition

importedKeyInitiallyImmediate

IMPORT KEY DEFERRABILITY - see SQL92 for definition

importedKeyNoAction

IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.

importedKeyNotDeferrable

IMPORT KEY DEFERRABILITY - see SQL92 for definition

importedKeyRestrict

IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.

importedKeySetDefault

IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to default values if its primary key has been updated or deleted.

importedKeySetNull

IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to NULL if its primary key has been updated or deleted.

procedureColumnIn

COLUMN_TYPE - IN parameter.

procedureColumnInOut

COLUMN_TYPE - INOUT parameter.

procedureColumnOut

COLUMN_TYPE - OUT parameter.

procedureColumnResult

COLUMN_TYPE - result column in ResultSet.

procedureColumnReturn

COLUMN_TYPE - procedure return value.

procedureColumnUnknown

COLUMN_TYPE - nobody knows.

procedureNoNulls

TYPE NULLABLE - does not allow NULL values.

procedureNoResult

PROCEDURE_TYPE - Does not return a result.

procedureNullable

TYPE NULLABLE - allows NULL values.

procedureNullableUnknown

TYPE NULLABLE - nullability unknown.

procedureResultUnknown

PROCEDURE_TYPE - May return a result.

procedureReturnsResult

PROCEDURE_TYPE - Returns a result.

typeNoNulls

TYPE NULLABLE - does not allow NULL values.

typeNullable

TYPE NULLABLE - allows NULL values.

typeNullableUnknown

TYPE NULLABLE - nullability unknown.

typePredBasic

TYPE INFO SEARCHABLE - Supported except for WHERE ..

typePredChar

TYPE INFO SEARCHABLE - Only supported with WHERE ..

typePredNone

TYPE INFO SEARCHABLE - No support.

typeSearchable

TYPE INFO SEARCHABLE - Supported for all WHERE ...

versionColumnNotPseudo

VERSION COLUMNS PSEUDO_COLUMN - is NOT a pseudo column.

versionColumnPseudo

VERSION COLUMNS PSEUDO_COLUMN - is a pseudo column.

versionColumnUnknown

VERSION COLUMNS PSEUDO_COLUMN - may or may not be pseudo column.

allProceduresAreCallable()

Can all the procedures returned by getProcedures be called by the current user?

allTablesAreSelectable()

Can all the tables returned by getTable be SELECTed by the current user?

dataDefinitionCausesTransactionCommit()

Does a data definition statement within a transaction force the transaction to commit?

dataDefinitionIgnoredInTransactions()

Is a data definition statement within a transaction ignored?

doesMaxRowSizeIncludeBlobs()

Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?

getBestRowIdentifier(String, String, String, int, boolean)

Get a description of a table's optimal set of columns that uniquely identifies a row.

getCacheBuffers()

Get the actual number of cache page buffers being used for this connection. InterClient Extension.

getCatalogs()

Get the catalog names available in this database.

getCatalogSeparator()

What's the separator between catalog and table name?

getCatalogTerm()

What's the database vendor's preferred term for "catalog"?

getColumnPrivileges(String, String, String, String)

Get a description of the access rights for a table's columns.

getColumns(String, String, String, String)

Get a description of table columns available in a catalog.

getCrossReference(String, String, String, String, String, String)

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).

getDatabaseProductName()

What's the name of this database product?

getDatabaseProductVersion()

What's the version of this database product?

getDefaultTransactionIsolation()

Get the database's default transaction isolation level.

getDriverMajorVersion()

What's this JDBC driver's major version number?

getDriverMinorVersion()

What's this JDBC driver's minor version number?

getDriverName()

What's the name of this JDBC driver?

getDriverVersion()

What's the version of this JDBC driver?

getExportedKeys(String, String, String)

Get a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).

getExtraNameCharacters()

Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

getIdentifierQuoteString()

Get the string used to quote SQL identifiers.

getImportedKeys(String, String, String)

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, String, String, boolean, boolean)

Get a description of a table's indices and statistics.

getMaxBinaryLiteralLength()

How many hex characters can you have in an inline binary literal?

getMaxCatalogNameLength()

What's the maximum length of a catalog name?

getMaxCharLiteralLength()

What's the max length for a character literal?

getMaxColumnNameLength()

What's the limit on column name length?

getMaxColumnsInGroupBy()

What's the maximum number of columns in a "GROUP BY" clause?

getMaxColumnsInIndex()

What's the maximum number of columns allowed in an index?

getMaxColumnsInOrderBy()

What's the maximum number of columns in an "ORDER BY" clause?

getMaxColumnsInSelect()

What's the maximum number of columns in a "SELECT" list?

getMaxColumnsInTable()

What's the maximum number of columns in a table?

getMaxConnections()

How many active connections can we have at a time to this database?

getMaxCursorNameLength()

What's the maximum cursor name length?

getMaxIndexLength()

What's the maximum length of an index (in bytes)?

getMaxProcedureNameLength()

What's the maximum length of a procedure name?

getMaxRowSize()

What's the maximum length of a single row?

getMaxSchemaNameLength()

What's the maximum length allowed for a schema name?

getMaxStatementLength()

What's the maximum length of a SQL statement?

getMaxStatements()

How many active statements can we have open at one time to this database?

getMaxTableNameLength()

What's the maximum length of a table name?

getMaxTablesInSelect()

What's the maximum number of tables in a SELECT?

getMaxUserNameLength()

What's the maximum length of a user name?

getNumericFunctions()

Get a comma separated list of math functions.

getODSMajorVersion()

Get the On Disk Structure (ODS) major version for the database. InterClient Extension.

getODSMinorVersion()

Get the On Disk Structure (ODS) minor version for the database. InterClient Extension.

getPageAllocation()

Get the number of pages allocated for this database at the time of connection. InterClient Extension.

getPageSize()

Get the page size for this database. InterClient Extension.

getPrimaryKeys(String, String, String)

Get a description of a table's primary key columns.

getProcedureColumns(String, String, String, String)

Get a description of a catalog's stored procedure parameters and result columns.

getProcedures(String, String, String)

Get a description of stored procedures available in a catalog.

getProcedureTerm()

What's the database vendor's preferred term for "procedure"?

getSchemas()

Get the schema names available in this database.

getSchemaTerm()

What's the database vendor's preferred term for "schema"?

getSearchStringEscape()

This is the string that can be used to escape the wildcard characters '_' or '%' in the string pattern style catalog search parameters.

getServerBuildNumber()

What's the build number for this version of the server side JDBC middleware server (InterServer)? InterClient Extension.

getServerCompanyName()

Who developed the JDBC/Net middleware server (InterServer). InterClient Extension.

getServerExpirationDate()

Get the expiration date for the server side JDBC middleware server (InterServer). InterClient Extension.

getServerJDBCNetProtocolVersion()

Get the JDBC/Net protocol used by InterServer. InterClient Extension.

getServerName()

What's the name of the server side JDBC middleware server? InterClient Extension.

getServerPort()

Get the JDBC/Net middleware server (InterServer) port. InterClient Extension.

getServerVersion()

What's the version of the server side JDBC middleware server (InterServer)? InterClient Extension.

getSQLKeywords()

Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.

getStringFunctions()

Get a comma separated list of string functions.

getSweepInterval()

Get the sweep interval for automatic housekeeping. InterClient Extension.

getSystemFunctions()

Get a comma separated list of system functions.

getTablePrivileges(String, String, String)

Get a description of the access rights for each table available in a catalog.

getTables(String, String, String, String[])

Get a description of tables available in a catalog.

getTableTypes()

Get the table types available in this database.

getTimeDateFunctions()

Get a comma separated list of time and date functions.

getTypeInfo()

Get a description of all the standard SQL types supported by this database.

getUDFs()

Return a list of the User-Defined Functions on this database. InterClient Extension.

getURL()

What's the url for this database?

getUserName()

What's our user name as known to the database?

getVersionColumns(String, String, String)

Get a description of a table's columns that are automatically updated when any value in a row is updated.

isCatalogAtStart()

Does a catalog appear at the start of a qualified table name?

isReadOnly()

Is the database in read-only mode?

isSpaceReservedForVersioning()

Is space being reserved on each newly created database page for anticipated record versions? InterClient Extension.

isSynchronous()

Are disk writes synchronous for this connection. InterClient Extension.

nullPlusNonNullIsNull()

Is concatenation between a NULL and a non-NULL value NULL?

nullsAreSortedAtEnd()

Are NULL values sorted at the end regardless of sort order?

nullsAreSortedAtStart()

Are NULL values sorted at the start regardless of sort order?

nullsAreSortedHigh()

Are NULL values sorted high?

nullsAreSortedLow()

Are NULL values sorted low?

storesLowerCaseIdentifiers()

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?

storesLowerCaseQuotedIdentifiers()

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?

storesMixedCaseIdentifiers()

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?

storesMixedCaseQuotedIdentifiers()

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?

storesUpperCaseIdentifiers()

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?

storesUpperCaseQuotedIdentifiers()

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?

supportsAlterTableWithAddColumn()

Is "ALTER TABLE" with add column supported?

supportsAlterTableWithDropColumn()

Is "ALTER TABLE" with drop column supported?

supportsANSI92EntryLevelSQL()

Is the ANSI92 entry level SQL grammar supported?

supportsANSI92FullSQL()

Is the ANSI92 full SQL grammar supported?

supportsANSI92IntermediateSQL()

Is the ANSI92 intermediate SQL grammar supported?

supportsCatalogsInDataManipulation()

Can a catalog name be used in a data manipulation statement?

supportsCatalogsInIndexDefinitions()

Can a catalog name be used in an index definition statement?

supportsCatalogsInPrivilegeDefinitions()

Can a catalog name be used in a privilege definition statement?

supportsCatalogsInProcedureCalls()

Can a catalog name be used in a procedure call statement?

supportsCatalogsInTableDefinitions()

Can a catalog name be used in a table definition statement?

supportsColumnAliasing()

Is column aliasing supported?

supportsConvert()

Is the CONVERT function between SQL types supported?

supportsConvert(int, int)

Is CONVERT between the given SQL types supported?

supportsCoreSQLGrammar()

Is the ODBC Core SQL grammar supported?

supportsCorrelatedSubqueries()

Are correlated subqueries supported?

supportsDataDefinitionAndDataManipulationTransactions()

Are both data definition and data manipulation statements within a transaction supported?

supportsDataManipulationTransactionsOnly()

Are only data manipulation statements within a transaction supported?

supportsDifferentTableCorrelationNames()

If table correlation names are supported, are they restricted to be different from the names of the tables?

supportsExpressionsInOrderBy()

Are expressions in "ORDER BY" lists supported?

supportsExtendedSQLGrammar()

Is the ODBC Extended SQL grammar supported?

supportsFullOuterJoins()

Are full nested outer joins supported?

supportsGroupBy()

Is some form of "GROUP BY" clause supported?

supportsGroupByBeyondSelect()

Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?

supportsGroupByUnrelated()

Can a "GROUP BY" clause use columns not in the SELECT?

supportsIntegrityEnhancementFacility()

Is the SQL Integrity Enhancement Facility supported?

supportsLikeEscapeClause()

Is the escape character in "LIKE" clauses supported?

supportsLimitedOuterJoins()

Is there limited support for outer joins?

supportsMinimumSQLGrammar()

Is the ODBC Minimum SQL grammar supported?

supportsMixedCaseIdentifiers()

Check if the database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

supportsMixedCaseQuotedIdentifiers()

Check if the database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

supportsMultipleResultSets()

Are multiple ResultSets from a single execute supported?

supportsMultipleTransactions()

Can we have multiple transactions open at once (on different connections)?

supportsNonNullableColumns()

Can columns be defined as non-nullable?

supportsOpenCursorsAcrossCommit()

Can cursors remain open across commits?

supportsOpenCursorsAcrossRollback()

Can cursors remain open across rollbacks?

supportsOpenStatementsAcrossCommit()

Can statements remain open across commits?

supportsOpenStatementsAcrossRollback()

Can statements remain open across rollbacks?

supportsOrderByUnrelated()

Can an "ORDER BY" clause use columns not in the SELECT?

supportsOuterJoins()

Is some form of outer join supported?

supportsPositionedDelete()

Is positioned DELETE supported?

supportsPositionedUpdate()

Is positioned UPDATE supported?

supportsSchemasInDataManipulation()

Can a schema name be used in a data manipulation statement?

supportsSchemasInIndexDefinitions()

Can a schema name be used in an index definition statement?

supportsSchemasInPrivilegeDefinitions()

Can a schema name be used in a privilege definition statement?

supportsSchemasInProcedureCalls()

Can a schema name be used in a procedure call statement?

supportsSchemasInTableDefinitions()

Can a schema name be used in a table definition statement?

supportsSelectForUpdate()

Is SELECT for UPDATE supported?

supportsStoredProcedures()

Are stored procedure calls using the stored procedure escape syntax supported?

supportsSubqueriesInComparisons()

Are subqueries in comparison expressions supported?

supportsSubqueriesInExists()

Are subqueries in 'exists' expressions supported?

supportsSubqueriesInIns()

Are subqueries in 'in' statements supported?

supportsSubqueriesInQuantifieds()

Are subqueries in quantified expressions supported?

supportsTableCorrelationNames()

Are table correlation names supported?

supportsTransactionIsolationLevel(int)

Does the database support the given transaction isolation level?

supportsTransactions()

Are transactions supported?

supportsUnion()

Is SQL UNION supported?

supportsUnionAll()

Is SQL UNION ALL supported?

usesLocalFilePerTable()

Does the database use a file for each table?

usesLocalFiles()

Does the database store tables in a local file?

  public final static int procedureResultUnknown

PROCEDURE_TYPE - May return a result.

  public final static int procedureNoResult

PROCEDURE_TYPE - Does not return a result.

  public final static int procedureReturnsResult

PROCEDURE_TYPE - Returns a result.

  public final static int procedureColumnUnknown

COLUMN_TYPE - nobody knows.

  public final static int procedureColumnIn

COLUMN_TYPE - IN parameter.

  public final static int procedureColumnInOut

COLUMN_TYPE - INOUT parameter.

  public final static int procedureColumnOut

COLUMN_TYPE - OUT parameter.

  public final static int procedureColumnReturn

COLUMN_TYPE - procedure return value.

  public final static int procedureColumnResult

COLUMN_TYPE - result column in ResultSet.

  public final static int procedureNoNulls

TYPE NULLABLE - does not allow NULL values.

  public final static int procedureNullable

TYPE NULLABLE - allows NULL values.

  public final static int procedureNullableUnknown

TYPE NULLABLE - nullability unknown.

  public final static int columnNoNulls

COLUMN NULLABLE - might not allow NULL values.

  public final static int columnNullable

COLUMN NULLABLE - definitely allows NULL values.

  public final static int columnNullableUnknown

COLUMN NULLABLE - nullability unknown.

  public final static int bestRowTemporary

BEST ROW SCOPE - very temporary, while using row.

  public final static int bestRowTransaction

BEST ROW SCOPE - valid for remainder of current transaction.

  public final static int bestRowSession

BEST ROW SCOPE - valid for remainder of current session.

  public final static int bestRowUnknown

BEST ROW PSEUDO_COLUMN - may or may not be pseudo column.

  public final static int bestRowNotPseudo

BEST ROW PSEUDO_COLUMN - is NOT a pseudo column.

  public final static int bestRowPseudo

BEST ROW PSEUDO_COLUMN - is a pseudo column.

  public final static int versionColumnUnknown

VERSION COLUMNS PSEUDO_COLUMN - may or may not be pseudo column.

  public final static int versionColumnNotPseudo

VERSION COLUMNS PSEUDO_COLUMN - is NOT a pseudo column.

  public final static int versionColumnPseudo

VERSION COLUMNS PSEUDO_COLUMN - is a pseudo column.

  public final static int importedKeyCascade

IMPORT KEY UPDATE_RULE and DELETE_RULE - for update, change imported key to agree with primary key update; for delete, delete rows that import a deleted key.

  public final static int importedKeyRestrict

IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.

  public final static int importedKeySetNull

IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to NULL if its primary key has been updated or deleted.

  public final static int importedKeyNoAction

IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.

  public final static int importedKeySetDefault

IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to default values if its primary key has been updated or deleted.

  public final static int importedKeyInitiallyDeferred

IMPORT KEY DEFERRABILITY - see SQL92 for definition

  public final static int importedKeyInitiallyImmediate

IMPORT KEY DEFERRABILITY - see SQL92 for definition

  public final static int importedKeyNotDeferrable

IMPORT KEY DEFERRABILITY - see SQL92 for definition

  public final static int typeNoNulls

TYPE NULLABLE - does not allow NULL values.

  public final static int typeNullable

TYPE NULLABLE - allows NULL values.

  public final static int typeNullableUnknown

TYPE NULLABLE - nullability unknown.

  public final static int typePredNone

TYPE INFO SEARCHABLE - No support.

  public final static int typePredChar

TYPE INFO SEARCHABLE - Only supported with WHERE .. LIKE.

  public final static int typePredBasic

TYPE INFO SEARCHABLE - Supported except for WHERE .. LIKE.

  public final static int typeSearchable

TYPE INFO SEARCHABLE - Supported for all WHERE ...

  public synchronized boolean allProceduresAreCallable() throws SQLException

Can all the procedures returned by getProcedures be called by the current user?

Note: This is always true for sysdba.

Throws: SQLException

If connection is closed.

  public synchronized boolean allTablesAreSelectable() throws SQLException

Can all the tables returned by getTable be SELECTed by the current user?

Note: This is always true for sysdba.

Throws: SQLException

If connection is closed.

  public String getURL() throws SQLException

What's the url for this database?

For InterBase this is always of the form

 jdbc:interbase://server//database
 

Returns:

the url or null if it can't be generated

Throws: SQLException

If connection is closed.

  public String getUserName() throws SQLException

What's our user name as known to the database?

Throws: SQLException

If connection is closed.

  public boolean isReadOnly() throws SQLException

Is the database in read-only mode?

Throws: SQLException

If connection is closed.

  public boolean nullsAreSortedHigh() throws SQLException

Are NULL values sorted high?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean nullsAreSortedLow() throws SQLException

Are NULL values sorted low?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean nullsAreSortedAtStart() throws SQLException

Are NULL values sorted at the start regardless of sort order?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean nullsAreSortedAtEnd() throws SQLException

Are NULL values sorted at the end regardless of sort order?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public String getDatabaseProductName() throws SQLException

What's the name of this database product?

Returns:

"InterBase".

Throws: SQLException

If connection is closed.

  public String getDatabaseProductVersion() throws SQLException

What's the version of this database product?

Returns:

something like "SO-V4.0B" for an InterBase 4.0B server on Solaris.

Throws: SQLException

If connection is closed.

  public String getDriverName() throws SQLException

What's the name of this JDBC driver?

Returns:

"InterClient".

Throws: SQLException

If connection is closed.

See Also:

getServerName

  public String getDriverVersion() throws SQLException

What's the version of this JDBC driver?

Returns:

InterClient version.

Throws: SQLException

If connection is closed.

See Also:

getServerVersion

  public int getDriverMajorVersion()

What's this JDBC driver's major version number?

Returns:

InterClient driver major version.

Throws: SQLException

If connection is closed.

See Also:

getMajorVersion

  public int getDriverMinorVersion()

What's this JDBC driver's minor version number?

Returns:

InterClient driver minor version number.

Throws: SQLException

If connection is closed.

See Also:

getMinorVersion

  public boolean usesLocalFiles() throws SQLException

Does the database store tables in a local file?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean usesLocalFilePerTable() throws SQLException

Does the database use a file for each table?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsMixedCaseIdentifiers() throws SQLException

Check if the database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Returns:

false for InterBase.

JDBC Compliance:

must return false.

Throws: SQLException

If connection is closed.

  public boolean storesUpperCaseIdentifiers() throws SQLException

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean storesLowerCaseIdentifiers() throws SQLException

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean storesMixedCaseIdentifiers() throws SQLException

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsMixedCaseQuotedIdentifiers() throws SQLException

Check if the database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Note: InterBase does not support quoted SQL identifiers.

Returns:

false for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean storesUpperCaseQuotedIdentifiers() throws SQLException

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?

Note: InterBase does not support quoted SQL identifiers.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean storesLowerCaseQuotedIdentifiers() throws SQLException

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?

Note: InterBase does not support quoted SQL identifiers.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean storesMixedCaseQuotedIdentifiers() throws SQLException

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?

Note: InterBase does not support quoted SQL identifiers.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public String getIdentifierQuoteString() throws SQLException

Get the string used to quote SQL identifiers. This returns a space " " if identifier quoting isn't supported.

Note: InterBase does not support identifier quoting.

Returns:

" " for InterBase.

JDBC Compliance:

must return the double quote character.

Throws: SQLException

If connection is closed.

  public String getSQLKeywords() throws SQLException

Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.

Throws: SQLException

If connection is closed.

  public String getNumericFunctions() throws SQLException

Get a comma separated list of math functions.

InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Returns:

"" for InterBase.

Throws: SQLException

If connection is closed.

See Also:

getUDFs

  public String getStringFunctions() throws SQLException

Get a comma separated list of string functions.

InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Returns:

"" for InterBase.

Throws: SQLException

If connection is closed.

See Also:

getUDFs

  public String getSystemFunctions() throws SQLException

Get a comma separated list of system functions.

InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Returns:

"" for InterBase.

Throws: SQLException

If connection is closed.

See Also:

getUDFs

  public String getTimeDateFunctions() throws SQLException

Get a comma separated list of time and date functions.

InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Returns:

"" for InterBase.

Throws: SQLException

If connection is closed.

See Also:

getUDFs

  public String getSearchStringEscape() throws SQLException

This is the string that can be used to escape the wildcard characters '_' 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.

Returns:

"\" for InterBase.

Throws: SQLException

If connection is closed.

  public String getExtraNameCharacters() throws SQLException

Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

Returns:

"" for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsAlterTableWithAddColumn() throws SQLException

Is "ALTER TABLE" with add column supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsAlterTableWithDropColumn() throws SQLException

Is "ALTER TABLE" with drop column supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsColumnAliasing() throws SQLException

Is column aliasing supported?

If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.

Technically, SQL AS isn't supported everywhere in InterBase.

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean nullPlusNonNullIsNull() throws SQLException

Is concatenation between a NULL and a non-NULL value NULL?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsConvert() throws SQLException

Is the CONVERT function between SQL types supported?

Note: InterBase supports this function using the CAST operator.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsConvert(int fromType,
                                 int toType) throws SQLException

Is CONVERT between the given SQL types supported?

Note: InterBase supports this function using the CAST operator.

Parameters:

fromType - the type to convert from

toType - the type to convert to

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

See Also:

Types

  public boolean supportsTableCorrelationNames() throws SQLException

Are table correlation names supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsDifferentTableCorrelationNames() throws SQLException

If table correlation names are supported, are they restricted to be different from the names of the tables?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsExpressionsInOrderBy() throws SQLException

Are expressions in "ORDER BY" lists supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsOrderByUnrelated() throws SQLException

Can an "ORDER BY" clause use columns not in the SELECT?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsGroupBy() throws SQLException

Is some form of "GROUP BY" clause supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsGroupByUnrelated() throws SQLException

Can a "GROUP BY" clause use columns not in the SELECT?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsGroupByBeyondSelect() throws SQLException

Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsLikeEscapeClause() throws SQLException

Is the escape character in "LIKE" clauses supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsMultipleResultSets() throws SQLException

Are multiple ResultSets from a single execute supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsMultipleTransactions() throws SQLException

Can we have multiple transactions open at once (on different connections)?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsNonNullableColumns() throws SQLException

Can columns be defined as non-nullable?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsMinimumSQLGrammar() throws SQLException

Is the ODBC Minimum SQL grammar supported?

Technically, InterBase 4.0 does not support DROP TABLE CASCADE/RESTRICT.

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsCoreSQLGrammar() throws SQLException

Is the ODBC Core SQL grammar supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsExtendedSQLGrammar() throws SQLException

Is the ODBC Extended SQL grammar supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsANSI92EntryLevelSQL() throws SQLException

Is the ANSI92 entry level SQL grammar supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsANSI92IntermediateSQL() throws SQLException

Is the ANSI92 intermediate SQL grammar supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsANSI92FullSQL() throws SQLException

Is the ANSI92 full SQL grammar supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsIntegrityEnhancementFacility() throws SQLException

Is the SQL Integrity Enhancement Facility supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsOuterJoins() throws SQLException

Is some form of outer join supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsFullOuterJoins() throws SQLException

Are full nested outer joins supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsLimitedOuterJoins() throws SQLException

Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.)

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public String getSchemaTerm() throws SQLException

What's the database vendor's preferred term for "schema"?

Throws: SQLException

InterBase does not support schemas.

  public String getProcedureTerm() throws SQLException

What's the database vendor's preferred term for "procedure"?

Returns:

"PROCEDURE" for InterBase.

Throws: SQLException

If connection is closed.

  public String getCatalogTerm() throws SQLException

What's the database vendor's preferred term for "catalog"?

Throws: SQLException

InterBase does not support catalogs.

  public boolean isCatalogAtStart() throws SQLException

Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end)

Throws: SQLException

InterBase does not support catalogs.

  public String getCatalogSeparator() throws SQLException

What's the separator between catalog and table name?

Throws: SQLException

InterBase does not support catalogs.

  public boolean supportsSchemasInDataManipulation() throws SQLException

Can a schema name be used in a data manipulation statement?

Note: InterBase does not support schemas.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsSchemasInProcedureCalls() throws SQLException

Can a schema name be used in a procedure call statement?

Note: InterBase does not support schemas.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsSchemasInTableDefinitions() throws SQLException

Can a schema name be used in a table definition statement?

Note: InterBase does not support schemas.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsSchemasInIndexDefinitions() throws SQLException

Can a schema name be used in an index definition statement?

Note: InterBase does not support schemas.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsSchemasInPrivilegeDefinitions() throws SQLException

Can a schema name be used in a privilege definition statement?

Note: InterBase does not support schemas.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsCatalogsInDataManipulation() throws SQLException

Can a catalog name be used in a data manipulation statement?

Note: InterBase does not support catalogs.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsCatalogsInProcedureCalls() throws SQLException

Can a catalog name be used in a procedure call statement?

Note: InterBase does not support catalogs.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsCatalogsInTableDefinitions() throws SQLException

Can a catalog name be used in a table definition statement?

Note: InterBase does not support catalogs.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsCatalogsInIndexDefinitions() throws SQLException

Can a catalog name be used in an index definition statement?

Note: InterBase does not support catalogs.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException

Can a catalog name be used in a privilege definition statement?

Note: InterBase does not support catalogs.

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsPositionedDelete() throws SQLException

Is positioned DELETE supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsPositionedUpdate() throws SQLException

Is positioned UPDATE supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsSelectForUpdate() throws SQLException

Is SELECT for UPDATE supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsStoredProcedures() throws SQLException

Are stored procedure calls using the stored procedure escape syntax supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsSubqueriesInComparisons() throws SQLException

Are subqueries in comparison expressions supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsSubqueriesInExists() throws SQLException

Are subqueries in 'exists' expressions supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsSubqueriesInIns() throws SQLException

Are subqueries in 'in' statements supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsSubqueriesInQuantifieds() throws SQLException

Are subqueries in quantified expressions supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsCorrelatedSubqueries() throws SQLException

Are correlated subqueries supported?

Returns:

true for InterBase.

JDBC Compliance:

must return true.

Throws: SQLException

If connection is closed.

  public boolean supportsUnion() throws SQLException

Is SQL UNION supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsUnionAll() throws SQLException

Is SQL UNION ALL supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsOpenCursorsAcrossCommit() throws SQLException

Can cursors remain open across commits?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsOpenCursorsAcrossRollback() throws SQLException

Can cursors remain open across rollbacks?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsOpenStatementsAcrossCommit() throws SQLException

Can statements remain open across commits?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsOpenStatementsAcrossRollback() throws SQLException

Can statements remain open across rollbacks?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxBinaryLiteralLength() throws SQLException

How many hex characters can you have in an inline binary literal?

Throws: SQLException

InterBase does not support binary literals.

  public int getMaxCharLiteralLength() throws SQLException

What's the max length for a character literal?

Returns:

1024 (1K) for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxColumnNameLength() throws SQLException

What's the limit on column name length?

Returns:

31 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxColumnsInGroupBy() throws SQLException

What's the maximum number of columns in a "GROUP BY" clause?

Returns:

16 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxColumnsInIndex() throws SQLException

What's the maximum number of columns allowed in an index?

Returns:

16 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxColumnsInOrderBy() throws SQLException

What's the maximum number of columns in an "ORDER BY" clause?

Returns:

16 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxColumnsInSelect() throws SQLException

What's the maximum number of columns in a "SELECT" list?

Returns:

32767 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxColumnsInTable() throws SQLException

What's the maximum number of columns in a table?

Returns:

32767 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxConnections() throws SQLException

How many active connections can we have at a time to this database?

Note: This depends mostly on the OS configuration (kernel, RAM, etc...). Practical limits are around 150 using NT-V4.2.

Returns:

0 (unlimited) for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxCursorNameLength() throws SQLException

What's the maximum cursor name length?

Returns:

31 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxIndexLength() throws SQLException

What's the maximum length of an index (in bytes)?

Returns:

198 bytes for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxSchemaNameLength() throws SQLException

What's the maximum length allowed for a schema name?

Throws: SQLException

InterBase does not support schemas.

  public int getMaxProcedureNameLength() throws SQLException

What's the maximum length of a procedure name?

Returns:

27 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxCatalogNameLength() throws SQLException

What's the maximum length of a catalog name?

Throws: SQLException

InterBase does not support schemas.

  public int getMaxRowSize() throws SQLException

What's the maximum length of a single row?

Returns:

32664 bytes for InterBase.

Throws: SQLException

If connection is closed.

  public boolean doesMaxRowSizeIncludeBlobs() throws SQLException

Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxStatementLength() throws SQLException

What's the maximum length of a SQL statement?

Returns:

640 bytes for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxStatements() throws SQLException

How many active statements can we have open at one time to this database?

Returns:

0 (unlimited) for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxTableNameLength() throws SQLException

What's the maximum length of a table name?

Returns:

31 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxTablesInSelect() throws SQLException

What's the maximum number of tables in a SELECT?

Returns:

12 for InterBase.

Throws: SQLException

If connection is closed.

  public int getMaxUserNameLength() throws SQLException

What's the maximum length of a user name?

Returns:

31 for InterBase.

Throws: SQLException

If connection is closed.

  public int getDefaultTransactionIsolation() throws SQLException

Get the database's default transaction isolation level. The values are defined in java.sql.Connection.

Returns:

TRANSACTION_SERIALIZABLE for InterBase.

Throws: SQLException

If connection is closed.

See Also:

Connection

  public boolean supportsTransactions() throws SQLException

Are transactions supported? If not, commit is a noop and the isolation level is TRANSACTION_NONE.

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsTransactionIsolationLevel(int level) throws SQLException

Does the database support the given transaction isolation level?

Note: InterBase supports the JDBC isolation levels

• TRANSACTION_READ_COMMITTED
• TRANSACTION_SERIALIZABLE

In addition, InterBase's native isolation modes are

• TRANSACTION_READ_MOST_RECENT_COMMITTED_VERSION (aka TRANSACTION_READ_COMMITTED)
• TRANSACTION_READ_LATEST_COMMITTED_VERSION
• TRANSACTION_SNAPSHOT (aka TRANSACTION_SERIALIZABLE)
• TRANSACTION_SNAPSHOT_TABLE_STABILITY

Parameters:

level - the values are defined in interbase.interclient.Connection

Throws: SQLException

If connection is closed or the isolation level is invalid.

See Also:

Connection

  public boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException

Are both data definition and data manipulation statements within a transaction supported?

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean supportsDataManipulationTransactionsOnly() throws SQLException

Are only data manipulation statements within a transaction supported?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public boolean dataDefinitionCausesTransactionCommit() throws SQLException

Does a data definition statement within a transaction force the transaction to commit?

Note: InterClient does not follow the isql transaction model. There is no autocommit DDL mode in which DML is not autocommitted.

Returns:

true for InterBase.

Throws: SQLException

If connection is closed.

  public boolean dataDefinitionIgnoredInTransactions() throws SQLException

Is a data definition statement within a transaction ignored?

Returns:

false for InterBase.

Throws: SQLException

If connection is closed.

  public synchronized 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:

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

Parameters:

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

procedureNamePattern - a procedure name pattern

Returns:

ResultSet - each row is a procedure description

Throws: SQLException

If connection is closed or a catalog/schema pattern is given.

See Also:

getSearchStringEscape

  public synchronized 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:

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
   • procedureColumnIn - IN parameter
   • procedureColumnInOut - INOUT parameter
   • procedureColumnOut - OUT parameter
   • procedureColumnReturn - procedure return value
   • procedureColumnResult - result column in ResultSet
6. DATA_TYPE short => SQL type from java.sql.Types
7. TYPE_NAME String => SQL type name
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

Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.

Parameters:

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

procedureNamePattern - a procedure name pattern

columnNamePattern - a column name pattern

Returns:

ResultSet - each row is a stored procedure parameter or column description

Throws: SQLException

If connection is closed or a catalog/schema pattern is given.

See Also:

getSearchStringEscape

  public synchronized 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:

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. 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

Note: Some databases may not return information for all tables.

Parameters:

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

tableNamePattern - a table name pattern

types - a list of table types to include; null returns all types

Returns:

ResultSet - each row is a table description

Throws: SQLException

If connection is closed or a catalog/schema pattern is given.

See Also:

getSearchStringEscape

  public ResultSet getSchemas() throws SQLException

Get the schema names available in this database. The results are ordered by schema name.

The schema column is:

1. TABLE_SCHEM String => schema name

Returns:

ResultSet - each row has a single String column that is a schema name

Throws: SQLException

If connection is closed.

  public ResultSet getCatalogs() throws SQLException

Get the catalog names available in this database. The results are ordered by catalog name.

The catalog column is:

1. TABLE_CAT String => catalog name

Returns:

ResultSet - each row has a single String column that is a catalog name

Throws: SQLException

If connection is closed.

  public synchronized ResultSet getTableTypes() throws SQLException

Get the table types available in this database. The results are ordered by table type.

The table type is:

1. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

Returns:

ResultSet - each row has a single String column that is a table type

Throws: SQLException

If connection is closed.

  public synchronized 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:

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
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.

Parameters:

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

tableNamePattern - a table name pattern

columnNamePattern - a column name pattern

Returns:

ResultSet - each row is a column description

Throws: SQLException

If connection is closed or a catalog/schema pattern is given.

See Also:

getSearchStringEscape

  public synchronized 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:

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 (SELECT, INSERT, UPDATE, REFRENCES, ...)
8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Parameters:

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

columnNamePattern - a column name pattern

Returns:

ResultSet - each row is a column privilege description

Throws: SQLException

If connection is closed or a catalog/schema is given.

See Also:

getSearchStringEscape

  public synchronized 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:

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

Parameters:

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

tableNamePattern - a table name pattern

Returns:

ResultSet - each row is a table privilege description

Throws: SQLException

If connection is closed or a catalog/schema pattern is given.

See Also:

getSearchStringEscape

  public synchronized 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:

1. 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
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 => 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

Parameters:

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

scope - the scope of interest; use same values as SCOPE

nullable - include columns that are nullable?

Returns:

ResultSet - each row is a column description

Throws: SQLException

If connection is closed or a catalog/schema is given.

  public synchronized ResultSet getVersionColumns(String catalog,
                                                  String schema,
                                                  String table) throws SQLException

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:

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

Parameters:

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:

ResultSet - each row is a column description

Throws: SQLException

If connection is closed or a catalog/schema is given.

  public synchronized ResultSet getPrimaryKeys(String catalog,
                                               String schema,
                                               String table) throws SQLException

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:

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)

Parameters:

catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

schema - a schema name pattern; "" retrieves those without a schema

table - a table name

Returns:

ResultSet - each row is a primary key column description

Throws: SQLException

If connection is closed or a catalog/schema is given.

  public synchronized ResultSet getImportedKeys(String catalog,
                                                String schema,
                                                String table) throws SQLException

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:

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

Parameters:

catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

schema - a schema name pattern; "" retrieves those without a schema

table - a table name

Returns:

ResultSet - each row is a primary key column description

Throws: SQLException

If connection is closed or a catalog/schema is given.

See Also:

getExportedKeys

  public synchronized ResultSet getExportedKeys(String catalog,
                                                String schema,
                                                String table) throws SQLException

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:

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

Parameters:

catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

schema - a schema name pattern; "" retrieves those without a schema

table - a table name

Returns:

ResultSet - each row is a foreign key column description

Throws: SQLException

If connection is closed or a catalog/schema is given.

See Also:

getImportedKeys

  public synchronized 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:

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

Parameters:

primaryCatalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

primarySchema - a schema name pattern; "" 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 pattern; "" retrieves those without a schema

foreignTable - the table name that imports the key

Returns:

ResultSet - each row is a foreign key column description

Throws: SQLException

If connection is closed or a catalog/schema is given.

See Also:

getImportedKeys

  public synchronized ResultSet getTypeInfo() throws SQLException

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:

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

Returns:

ResultSet - each row is a SQL type description

Throws: SQLException

If connection is closed.

  public synchronized 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:

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)

Parameters:

catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

schema - a schema name pattern; "" 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:

ResultSet - each row is an index column description

Throws: SQLException

If connection is closed or a catalog/schema is given.

  public String getUDFs() throws SQLException

InterClient Extension for future release

Return a list of the User-Defined Functions on this database.

Throws: SQLException

Not yet implemented.

  public String getServerName() throws SQLException

InterClient Extension

What's the name of the server side JDBC middleware server?

Returns:

"InterServer".

Throws: SQLException

If the connection is closed.

See Also:

getDriverName

  public int getServerVersion() throws SQLException

InterClient Extension

What's the version of the server side JDBC middleware server (InterServer)?

Returns:

InterServer version.

Throws: SQLException

If the connection is closed.

See Also:

getDriverVersion

  public int getServerBuildNumber() throws SQLException

InterClient Extension

What's the build number for this version of the server side JDBC middleware server (InterServer)?

Returns:

InterServer build number.

Throws: SQLException

If the connection is closed.

  public Date getServerExpirationDate() throws SQLException

InterClient Extension

Get the expiration date for the server side JDBC middleware server (InterServer).

Throws: SQLException

If the connection is closed.

See Also:

getExpirationDate

  public int getServerJDBCNetProtocolVersion() throws SQLException

InterClient Extension

Get the JDBC/Net protocol used by InterServer.

Throws: SQLException

If the connection is closed.

See Also:

getJDBCNetProtocolVersion

  public String getServerCompanyName() throws SQLException

InterClient Extension

Who developed the JDBC/Net middleware server (InterServer).

Throws: SQLException

If the connection is closed.

See Also:

getCompanyName

  public int getServerPort() throws SQLException

InterClient Extension

Get the JDBC/Net middleware server (InterServer) port.

Throws: SQLException

If the connection is closed.

  public int getODSMajorVersion() throws SQLException

InterClient Extension for future release

Get the On Disk Structure (ODS) major version for the database.

Throws: SQLException

If the connection is closed.

  public int getODSMinorVersion() throws SQLException

InterClient Extension for future release

Get the On Disk Structure (ODS) minor version for the database.

Throws: SQLException

If the connection is closed.

  public synchronized int getPageSize() throws SQLException

InterClient Extension for future release

Get the page size for this database.

Throws: SQLException

If the connection is closed.

  public synchronized int getPageAllocation() throws SQLException

InterClient Extension for future release

Get the number of pages allocated for this database at the time of connection.

Throws: SQLException

If the connection is closed.

  public boolean getSweepInterval() throws SQLException

InterClient Extension for future release

Get the sweep interval for automatic housekeeping.

Throws: SQLException

Not yet implemented.

  public boolean isSpaceReservedForVersioning() throws SQLException

InterClient Extension for future release

Is space being reserved on each newly created database page for anticipated record versions?

Throws: SQLException

Not yet implemented.

See Also:

reserveNoSpaceForVersioning

  public boolean isSynchronous() throws SQLException

InterClient Extension for future release

Are disk writes synchronous for this connection.

Throws: SQLException

Not yet implemented.

See Also:

allowAsynchronousDiskWrites

  public int getCacheBuffers() throws SQLException

InterClient Extension for future release

Get the actual number of cache page buffers being used for this connection.

Throws: SQLException

Not yet implemented.

See Also:

setCacheBuffers, getCacheBuffers, getDefaultCacheBuffers

All Packages  Class Hierarchy  This Package  Previous  Next  Index