Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

Class org.gjt.mm.mysql.DatabaseMetaData 

java.lang.Object
  |
  +--org.gjt.mm.mysql.DatabaseMetaData
public class DatabaseMetaData
extends java.lang.Object
implements java.sql.DatabaseMetaData

Constructor Summary
DatabaseMetaData(Connection Conn)
           
 
Method Summary
boolean allProceduresAreCallable()
          Can all the procedures returned by getProcedures be called by the current user?
boolean allTablesAreSelectable()
          Can all the tables returned by getTable be SELECTed by the current user?
boolean dataDefinitionCausesTransactionCommit()
          Does a data definition statement within a transaction force the transaction to commit?
boolean dataDefinitionIgnoredInTransactions()
          Is a data definition statement within a transaction ignored?
boolean doesMaxRowSizeIncludeBlobs()
          Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?
java.sql.ResultSet getBestRowIdentifier(java.lang.String Catalog, java.lang.String Schema, java.lang.String Table, int scope, boolean nullable)
          Get a description of a table's optimal set of columns that uniquely identifies a row.
java.sql.ResultSet getCatalogs()
          Get the catalog names available in this database.
java.lang.String getCatalogSeparator()
          What's the separator between catalog and table name?
java.lang.String getCatalogTerm()
          What's the database vendor's preferred term for "catalog"?
java.sql.ResultSet getColumnPrivileges(java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String columnNamePattern)
          Get a description of the access rights for a table's columns.
java.sql.ResultSet getColumns(java.lang.String Catalog, java.lang.String SchemaPattern, java.lang.String TableName, java.lang.String ColumnNamePattern)
          Get a description of table columns available in a catalog.
java.sql.ResultSet getCrossReference(java.lang.String PrimaryCatalog, java.lang.String PrimarySchema, java.lang.String PrimaryTable, java.lang.String ForeignCatalog, java.lang.String ForeignSchema, java.lang.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.)
java.lang.String getDatabaseProductName()
          What's the name of this database product?
java.lang.String getDatabaseProductVersion()
          What's the version of this database product?
int getDefaultTransactionIsolation()
          What's the database's default transaction isolation level?
int getDriverMajorVersion()
          What's this JDBC driver's major version number?
int getDriverMinorVersion()
          What's this JDBC driver's minor version number?
java.lang.String getDriverName()
          What's the name of this JDBC driver?
java.lang.String getDriverVersion()
          What's the version of this JDBC driver?
java.sql.ResultSet getExportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.String table)
          Get a description of a foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).
java.lang.String getExtraNameCharacters()
          Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, 0-9 and _).
java.lang.String getIdentifierQuoteString()
          What's the string used to quote SQL identifiers?
java.sql.ResultSet getImportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.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).
java.sql.ResultSet getIndexInfo(java.lang.String Catalog, java.lang.String Schema, java.lang.String Table, boolean unique, boolean approximate)
          Get a description of a table's indices and statistics.
int getMaxBinaryLiteralLength()
          How many hex characters can you have in an inline binary literal?
int getMaxCatalogNameLength()
          What's the maximum length of a catalog name?
int getMaxCharLiteralLength()
          What's the max length for a character literal?
int getMaxColumnNameLength()
          What's the limit on column name length?
int getMaxColumnsInGroupBy()
          What's the maximum number of columns in a "GROUP BY" clause?
int getMaxColumnsInIndex()
          What's the maximum number of columns allowed in an index?
int getMaxColumnsInOrderBy()
          What's the maximum number of columns in an "ORDER BY" clause?
int getMaxColumnsInSelect()
          What's the maximum number of columns in a "SELECT" list?
int getMaxColumnsInTable()
          What's maximum number of columns in a table?
int getMaxConnections()
          How many active connections can we have at a time to this database?
int getMaxCursorNameLength()
          What's the maximum cursor name length?
int getMaxIndexLength()
          What's the maximum length of an index (in bytes)?
int getMaxProcedureNameLength()
          What's the maximum length of a procedure name?
int getMaxRowSize()
          What's the maximum length of a single row?
int getMaxSchemaNameLength()
          What's the maximum length allowed for a schema name?
int getMaxStatementLength()
          What's the maximum length of a SQL statement?
int getMaxStatements()
          How many active statements can we have open at one time to this database?
int getMaxTableNameLength()
          What's the maximum length of a table name?
int getMaxTablesInSelect()
          What's the maximum number of tables in a SELECT?
int getMaxUserNameLength()
          What's the maximum length of a user name?
java.lang.String getNumericFunctions()
          Get a comma separated list of math functions.
java.sql.ResultSet getPrimaryKeys(java.lang.String Catalog, java.lang.String Schema, java.lang.String Table)
          Get a description of a table's primary key columns.
java.sql.ResultSet getProcedureColumns(java.lang.String Catalog, java.lang.String SchemaPattern, java.lang.String ProcedureNamePattern, java.lang.String ColumnNamePattern)
          Get a description of a catalog's stored procedure parameters and result columns.
java.sql.ResultSet getProcedures(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern)
          Get a description of stored procedures available in a catalog.
java.lang.String getProcedureTerm()
          What's the database vendor's preferred term for "procedure"?
java.sql.ResultSet getSchemas()
          Get the schema names available in this database.
java.lang.String getSchemaTerm()
          What's the database vendor's preferred term for "schema"?
java.lang.String getSearchStringEscape()
          This is the string that can be used to escape '_' or '%' in the string pattern style catalog search parameters.
java.lang.String getSQLKeywords()
          Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.
java.lang.String getStringFunctions()
          Get a comma separated list of string functions.
java.lang.String getSystemFunctions()
          Get a comma separated list of system functions.
java.sql.ResultSet getTablePrivileges(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern)
          Get a description of the access rights for each table available in a catalog.
java.sql.ResultSet getTables(java.lang.String Catalog, java.lang.String SchemaPattern, java.lang.String TableNamePattern, java.lang.String[] Types)
          Get a description of tables available in a catalog.
java.sql.ResultSet getTableTypes()
          Get the table types available in this database.
java.lang.String getTimeDateFunctions()
          Get a comma separated list of time and date functions.
java.sql.ResultSet getTypeInfo()
          Get a description of all the standard SQL types supported by this database.
java.lang.String getURL()
          What's the url for this database?
java.lang.String getUserName()
          What's our user name as known to the database?
java.sql.ResultSet getVersionColumns(java.lang.String catalog, java.lang.String schema, java.lang.String table)
          Get a description of a table's columns that are automatically updated when any value in a row is updated.
boolean isCatalogAtStart()
          Does a catalog appear at the start of a qualified table name?
boolean isReadOnly()
          Is the database in read-only mode?
boolean nullPlusNonNullIsNull()
          Are concatenations between NULL and non-NULL values NULL?
boolean nullsAreSortedAtEnd()
          Are NULL values sorted at the end regardless of sort order?
boolean nullsAreSortedAtStart()
          Are NULL values sorted at the start regardless of sort order?
boolean nullsAreSortedHigh()
          Are NULL values sorted high?
boolean nullsAreSortedLow()
          Are NULL values sorted low?
boolean storesLowerCaseIdentifiers()
          Does the database store mixed case unquoted SQL identifiers in lower case?
boolean storesLowerCaseQuotedIdentifiers()
          Does the database store mixed case quoted SQL identifiers in lower case?
boolean storesMixedCaseIdentifiers()
          Does the database store mixed case unquoted SQL identifiers in mixed case?
boolean storesMixedCaseQuotedIdentifiers()
          Does the database store mixed case quoted SQL identifiers in mixed case?
boolean storesUpperCaseIdentifiers()
          Does the database store mixed case unquoted SQL identifiers in upper case?
boolean storesUpperCaseQuotedIdentifiers()
          Does the database store mixed case quoted SQL identifiers in upper case?
boolean supportsAlterTableWithAddColumn()
          Is "ALTER TABLE" with add column supported?
boolean supportsAlterTableWithDropColumn()
          Is "ALTER TABLE" with drop column supported?
boolean supportsANSI92EntryLevelSQL()
          Is the ANSI92 entry level SQL grammar supported?
boolean supportsANSI92FullSQL()
          Is the ANSI92 full SQL grammar supported?
boolean supportsANSI92IntermediateSQL()
          Is the ANSI92 intermediate SQL grammar supported?
boolean supportsCatalogsInDataManipulation()
          Can a catalog name be used in a data manipulation statement?
boolean supportsCatalogsInIndexDefinitions()
          Can a catalog name be used in a index definition statement?
boolean supportsCatalogsInPrivilegeDefinitions()
          Can a catalog name be used in a privilege definition statement?
boolean supportsCatalogsInProcedureCalls()
          Can a catalog name be used in a procedure call statement?
boolean supportsCatalogsInTableDefinitions()
          Can a catalog name be used in a table definition statement?
boolean supportsColumnAliasing()
          Is column aliasing supported?
boolean supportsConvert()
          Is the CONVERT function between SQL types supported?
boolean supportsConvert(int fromType, int toType)
          Is CONVERT between the given SQL types supported?
boolean supportsCoreSQLGrammar()
          Is the ODBC Core SQL grammar supported?
boolean supportsCorrelatedSubqueries()
          Are correlated subqueries supported?
boolean supportsDataDefinitionAndDataManipulationTransactions()
          Are both data definition and data manipulation statements within a transaction supported?
boolean supportsDataManipulationTransactionsOnly()
          Are only data manipulation statements within a transaction supported?
boolean supportsDifferentTableCorrelationNames()
          If table correlation names are supported, are they restricted to be different from the names of the tables?
boolean supportsExpressionsInOrderBy()
          Are expressions in "ORDER BY" lists supported?
boolean supportsExtendedSQLGrammar()
          Is the ODBC Extended SQL grammar supported?
boolean supportsFullOuterJoins()
          Are full nested outer joins supported?
boolean supportsGroupByBeyondSelect()
          Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?
boolean supportsGroupBy()
          Is some form of "GROUP BY" clause supported?
boolean supportsGroupByUnrelated()
          Can a "GROUP BY" clause use columns not in the SELECT?
boolean supportsIntegrityEnhancementFacility()
          Is the SQL Integrity Enhancement Facility supported?
boolean supportsLikeEscapeClause()
          Is the escape character in "LIKE" clauses supported?
boolean supportsLimitedOuterJoins()
          Is there limited support for outer joins?
boolean supportsMinimumSQLGrammar()
          Is the ODBC Minimum SQL grammar supported?
boolean supportsMixedCaseIdentifiers()
          Does the database support mixed case unquoted SQL identifiers?
boolean supportsMixedCaseQuotedIdentifiers()
          Does the database support mixed case quoted SQL identifiers?
boolean supportsMultipleResultSets()
          Are multiple ResultSets from a single execute supported?
boolean supportsMultipleTransactions()
          Can we have multiple transactions open at once (on different connections)?
boolean supportsNonNullableColumns()
          Can columns be defined as non-nullable?
boolean supportsOpenCursorsAcrossCommit()
          Can cursors remain open across commits?
boolean supportsOpenCursorsAcrossRollback()
          Can cursors remain open across rollbacks?
boolean supportsOpenStatementsAcrossCommit()
          Can statements remain open across commits?
boolean supportsOpenStatementsAcrossRollback()
          Can statements remain open across rollbacks?
boolean supportsOrderByUnrelated()
          Can an "ORDER BY" clause use columns not in the SELECT?
boolean supportsOuterJoins()
          Is some form of outer join supported?
boolean supportsPositionedDelete()
          Is positioned DELETE supported?
boolean supportsPositionedUpdate()
          Is positioned UPDATE supported?
boolean supportsSchemasInDataManipulation()
          Can a schema name be used in a data manipulation statement?
boolean supportsSchemasInIndexDefinitions()
          Can a schema name be used in an index definition statement?
boolean supportsSchemasInPrivilegeDefinitions()
          Can a schema name be used in a privilege definition statement?
boolean supportsSchemasInProcedureCalls()
          Can a schema name be used in a procedure call statement?
boolean supportsSchemasInTableDefinitions()
          Can a schema name be used in a table definition statement?
boolean supportsSelectForUpdate()
          Is SELECT for UPDATE supported?
boolean supportsStoredProcedures()
          Are stored procedure calls using the stored procedure escape syntax supported?
boolean supportsSubqueriesInComparisons()
          Are subqueries in comparison expressions supported?
boolean supportsSubqueriesInExists()
          Are subqueries in exists expressions supported?
boolean supportsSubqueriesInIns()
          Are subqueries in "in" statements supported?
boolean supportsSubqueriesInQuantifieds()
          Are subqueries in quantified expressions supported?
boolean supportsTableCorrelationNames()
          Are table correlation names supported?
boolean supportsTransactionIsolationLevel(int level)
          Does the database support the given transaction isolation level?
boolean supportsTransactions()
          Are transactions supported?
boolean supportsUnionAll()
          Is SQL UNION ALL supported?
boolean supportsUnion()
          Is SQL UNION supported?
boolean usesLocalFilePerTable()
          Does the database use a file for each table?
boolean usesLocalFiles()
          Does the database store tables in a local file?
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait
 

Constructor Detail

DatabaseMetaData

public DatabaseMetaData(Connection Conn)
Method Detail

allProceduresAreCallable

public boolean allProceduresAreCallable()
                                throws java.sql.SQLException
Can all the procedures returned by getProcedures be called by the current user?
Specified by:
allProceduresAreCallable() in interface java.sql.DatabaseMetaData
Returns:
true if so

allTablesAreSelectable

public boolean allTablesAreSelectable()
                              throws java.sql.SQLException
Can all the tables returned by getTable be SELECTed by the current user?
Specified by:
allTablesAreSelectable() in interface java.sql.DatabaseMetaData
Returns:
true if so

getURL

public java.lang.String getURL()
                       throws java.sql.SQLException
What's the url for this database?
Specified by:
getURL() in interface java.sql.DatabaseMetaData
Returns:
the url or null if it can't be generated

getUserName

public java.lang.String getUserName()
                            throws java.sql.SQLException
What's our user name as known to the database?
Specified by:
getUserName() in interface java.sql.DatabaseMetaData
Returns:
our database user name

isReadOnly

public boolean isReadOnly()
                  throws java.sql.SQLException
Is the database in read-only mode?
Specified by:
isReadOnly() in interface java.sql.DatabaseMetaData
Returns:
true if so

nullsAreSortedHigh

public boolean nullsAreSortedHigh()
                          throws java.sql.SQLException
Are NULL values sorted high?
Specified by:
nullsAreSortedHigh() in interface java.sql.DatabaseMetaData
Returns:
true if so

nullsAreSortedLow

public boolean nullsAreSortedLow()
                         throws java.sql.SQLException
Are NULL values sorted low?
Specified by:
nullsAreSortedLow() in interface java.sql.DatabaseMetaData
Returns:
true if so

nullsAreSortedAtStart

public boolean nullsAreSortedAtStart()
                             throws java.sql.SQLException
Are NULL values sorted at the start regardless of sort order?
Specified by:
nullsAreSortedAtStart() in interface java.sql.DatabaseMetaData
Returns:
true if so

nullsAreSortedAtEnd

public boolean nullsAreSortedAtEnd()
                           throws java.sql.SQLException
Are NULL values sorted at the end regardless of sort order?
Specified by:
nullsAreSortedAtEnd() in interface java.sql.DatabaseMetaData
Returns:
true if so

getDatabaseProductName

public java.lang.String getDatabaseProductName()
                                       throws java.sql.SQLException
What's the name of this database product?
Specified by:
getDatabaseProductName() in interface java.sql.DatabaseMetaData
Returns:
database product name

getDatabaseProductVersion

public java.lang.String getDatabaseProductVersion()
                                          throws java.sql.SQLException
What's the version of this database product?
Specified by:
getDatabaseProductVersion() in interface java.sql.DatabaseMetaData
Returns:
database version

getDriverName

public java.lang.String getDriverName()
                              throws java.sql.SQLException
What's the name of this JDBC driver?
Specified by:
getDriverName() in interface java.sql.DatabaseMetaData
Returns:
JDBC driver name

getDriverVersion

public java.lang.String getDriverVersion()
                                 throws java.sql.SQLException
What's the version of this JDBC driver?
Specified by:
getDriverVersion() in interface java.sql.DatabaseMetaData
Returns:
JDBC driver version

getDriverMajorVersion

public int getDriverMajorVersion()
What's this JDBC driver's major version number?
Specified by:
getDriverMajorVersion() in interface java.sql.DatabaseMetaData
Returns:
JDBC driver major version

getDriverMinorVersion

public int getDriverMinorVersion()
What's this JDBC driver's minor version number?
Specified by:
getDriverMinorVersion() in interface java.sql.DatabaseMetaData
Returns:
JDBC driver minor version number

usesLocalFiles

public boolean usesLocalFiles()
                      throws java.sql.SQLException
Does the database store tables in a local file?
Specified by:
usesLocalFiles() in interface java.sql.DatabaseMetaData
Returns:
true if so

usesLocalFilePerTable

public boolean usesLocalFilePerTable()
                             throws java.sql.SQLException
Does the database use a file for each table?
Specified by:
usesLocalFilePerTable() in interface java.sql.DatabaseMetaData
Returns:
true if the database uses a local file for each table

supportsMixedCaseIdentifiers

public boolean supportsMixedCaseIdentifiers()
                                    throws java.sql.SQLException
Does the database support mixed case unquoted SQL identifiers?
Specified by:
supportsMixedCaseIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

storesUpperCaseIdentifiers

public boolean storesUpperCaseIdentifiers()
                                  throws java.sql.SQLException
Does the database store mixed case unquoted SQL identifiers in upper case?
Specified by:
storesUpperCaseIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

storesLowerCaseIdentifiers

public boolean storesLowerCaseIdentifiers()
                                  throws java.sql.SQLException
Does the database store mixed case unquoted SQL identifiers in lower case?
Specified by:
storesLowerCaseIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

storesMixedCaseIdentifiers

public boolean storesMixedCaseIdentifiers()
                                  throws java.sql.SQLException
Does the database store mixed case unquoted SQL identifiers in mixed case?
Specified by:
storesMixedCaseIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsMixedCaseQuotedIdentifiers

public boolean supportsMixedCaseQuotedIdentifiers()
                                          throws java.sql.SQLException
Does the database support mixed case quoted SQL identifiers? A JDBC compliant driver will always return true.
Specified by:
supportsMixedCaseQuotedIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

storesUpperCaseQuotedIdentifiers

public boolean storesUpperCaseQuotedIdentifiers()
                                        throws java.sql.SQLException
Does the database store mixed case quoted SQL identifiers in upper case? A JDBC compliant driver will always return true.
Specified by:
storesUpperCaseQuotedIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

storesLowerCaseQuotedIdentifiers

public boolean storesLowerCaseQuotedIdentifiers()
                                        throws java.sql.SQLException
Does the database store mixed case quoted SQL identifiers in lower case? A JDBC compliant driver will always return false.
Specified by:
storesLowerCaseQuotedIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

storesMixedCaseQuotedIdentifiers

public boolean storesMixedCaseQuotedIdentifiers()
                                        throws java.sql.SQLException
Does the database store mixed case quoted SQL identifiers in mixed case? A JDBC compliant driver will always return false.
Specified by:
storesMixedCaseQuotedIdentifiers() in interface java.sql.DatabaseMetaData
Returns:
true if so

getIdentifierQuoteString

public java.lang.String getIdentifierQuoteString()
                                         throws java.sql.SQLException
What's 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 interface java.sql.DatabaseMetaData
Returns:
the quoting string

getSQLKeywords

public java.lang.String getSQLKeywords()
                               throws java.sql.SQLException
Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.
Specified by:
getSQLKeywords() in interface java.sql.DatabaseMetaData
Returns:
the list

getNumericFunctions

public java.lang.String getNumericFunctions()
                                    throws java.sql.SQLException
Get a comma separated list of math functions.
Specified by:
getNumericFunctions() in interface java.sql.DatabaseMetaData
Returns:
the list

getStringFunctions

public java.lang.String getStringFunctions()
                                   throws java.sql.SQLException
Get a comma separated list of string functions.
Specified by:
getStringFunctions() in interface java.sql.DatabaseMetaData
Returns:
the list

getSystemFunctions

public java.lang.String getSystemFunctions()
                                   throws java.sql.SQLException
Get a comma separated list of system functions.
Specified by:
getSystemFunctions() in interface java.sql.DatabaseMetaData
Returns:
the list

getTimeDateFunctions

public java.lang.String getTimeDateFunctions()
                                     throws java.sql.SQLException
Get a comma separated list of time and date functions.
Specified by:
getTimeDateFunctions() in interface java.sql.DatabaseMetaData
Returns:
the list

getSearchStringEscape

public java.lang.String getSearchStringEscape()
                                      throws java.sql.SQLException
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 interface java.sql.DatabaseMetaData
Returns:
the string used to escape wildcard characters

getExtraNameCharacters

public java.lang.String getExtraNameCharacters()
                                       throws java.sql.SQLException
Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, 0-9 and _).
Specified by:
getExtraNameCharacters() in interface java.sql.DatabaseMetaData
Returns:
the string containing the extra characters

supportsAlterTableWithAddColumn

public boolean supportsAlterTableWithAddColumn()
                                       throws java.sql.SQLException
Is "ALTER TABLE" with add column supported?
Specified by:
supportsAlterTableWithAddColumn() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsAlterTableWithDropColumn

public boolean supportsAlterTableWithDropColumn()
                                        throws java.sql.SQLException
Is "ALTER TABLE" with drop column supported?
Specified by:
supportsAlterTableWithDropColumn() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsColumnAliasing

public boolean supportsColumnAliasing()
                              throws java.sql.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. A JDBC compliant driver always returns true.

Specified by:
supportsColumnAliasing() in interface java.sql.DatabaseMetaData
Returns:
true if so

nullPlusNonNullIsNull

public boolean nullPlusNonNullIsNull()
                             throws java.sql.SQLException
Are concatenations between NULL and non-NULL values NULL? A JDBC compliant driver always returns true.
Specified by:
nullPlusNonNullIsNull() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsConvert

public boolean supportsConvert()
                       throws java.sql.SQLException
Is the CONVERT function between SQL types supported?
Specified by:
supportsConvert() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsConvert

public boolean supportsConvert(int fromType,
                               int toType)
                       throws java.sql.SQLException
Is CONVERT between the given SQL types supported?
Specified by:
supportsConvert(int, int) in interface java.sql.DatabaseMetaData
Parameters:
fromType - the type to convert from
toType - the type to convert to
Returns:
true if so
See Also:
Types

supportsTableCorrelationNames

public boolean supportsTableCorrelationNames()
                                     throws java.sql.SQLException
Are table correlation names supported? A JDBC compliant driver always returns true.
Specified by:
supportsTableCorrelationNames() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsDifferentTableCorrelationNames

public boolean supportsDifferentTableCorrelationNames()
                                              throws java.sql.SQLException
If table correlation names are supported, are they restricted to be different from the names of the tables? A JDBC compliant driver always returns true.
Specified by:
supportsDifferentTableCorrelationNames() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsExpressionsInOrderBy

public boolean supportsExpressionsInOrderBy()
                                    throws java.sql.SQLException
Are expressions in "ORDER BY" lists supported?
Specified by:
supportsExpressionsInOrderBy() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsOrderByUnrelated

public boolean supportsOrderByUnrelated()
                                throws java.sql.SQLException
Can an "ORDER BY" clause use columns not in the SELECT?
Specified by:
supportsOrderByUnrelated() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsGroupBy

public boolean supportsGroupBy()
                       throws java.sql.SQLException
Is some form of "GROUP BY" clause supported?
Specified by:
supportsGroupBy() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsGroupByUnrelated

public boolean supportsGroupByUnrelated()
                                throws java.sql.SQLException
Can a "GROUP BY" clause use columns not in the SELECT?
Specified by:
supportsGroupByUnrelated() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsGroupByBeyondSelect

public boolean supportsGroupByBeyondSelect()
                                   throws java.sql.SQLException
Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?
Specified by:
supportsGroupByBeyondSelect() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsLikeEscapeClause

public boolean supportsLikeEscapeClause()
                                throws java.sql.SQLException
Is the escape character in "LIKE" clauses supported? A JDBC compliant driver always returns true.
Specified by:
supportsLikeEscapeClause() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsMultipleResultSets

public boolean supportsMultipleResultSets()
                                  throws java.sql.SQLException
Are multiple ResultSets from a single execute supported?
Specified by:
supportsMultipleResultSets() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsMultipleTransactions

public boolean supportsMultipleTransactions()
                                    throws java.sql.SQLException
Can we have multiple transactions open at once (on different connections)?
Specified by:
supportsMultipleTransactions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsNonNullableColumns

public boolean supportsNonNullableColumns()
                                  throws java.sql.SQLException
Can columns be defined as non-nullable? A JDBC compliant driver always returns true.
Specified by:
supportsNonNullableColumns() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsMinimumSQLGrammar

public boolean supportsMinimumSQLGrammar()
                                 throws java.sql.SQLException
Is the ODBC Minimum SQL grammar supported? All JDBC compliant drivers must return true.
Specified by:
supportsMinimumSQLGrammar() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsCoreSQLGrammar

public boolean supportsCoreSQLGrammar()
                              throws java.sql.SQLException
Is the ODBC Core SQL grammar supported?
Specified by:
supportsCoreSQLGrammar() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsExtendedSQLGrammar

public boolean supportsExtendedSQLGrammar()
                                  throws java.sql.SQLException
Is the ODBC Extended SQL grammar supported?
Specified by:
supportsExtendedSQLGrammar() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsANSI92EntryLevelSQL

public boolean supportsANSI92EntryLevelSQL()
                                   throws java.sql.SQLException
Is the ANSI92 entry level SQL grammar supported? All JDBC compliant drivers must return true.
Specified by:
supportsANSI92EntryLevelSQL() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsANSI92IntermediateSQL

public boolean supportsANSI92IntermediateSQL()
                                     throws java.sql.SQLException
Is the ANSI92 intermediate SQL grammar supported?
Specified by:
supportsANSI92IntermediateSQL() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsANSI92FullSQL

public boolean supportsANSI92FullSQL()
                             throws java.sql.SQLException
Is the ANSI92 full SQL grammar supported?
Specified by:
supportsANSI92FullSQL() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsIntegrityEnhancementFacility

public boolean supportsIntegrityEnhancementFacility()
                                            throws java.sql.SQLException
Is the SQL Integrity Enhancement Facility supported?
Specified by:
supportsIntegrityEnhancementFacility() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsOuterJoins

public boolean supportsOuterJoins()
                          throws java.sql.SQLException
Is some form of outer join supported?
Specified by:
supportsOuterJoins() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsFullOuterJoins

public boolean supportsFullOuterJoins()
                              throws java.sql.SQLException
Are full nested outer joins supported?
Specified by:
supportsFullOuterJoins() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsLimitedOuterJoins

public boolean supportsLimitedOuterJoins()
                                 throws java.sql.SQLException
Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.)
Specified by:
supportsLimitedOuterJoins() in interface java.sql.DatabaseMetaData
Returns:
true if so

getSchemaTerm

public java.lang.String getSchemaTerm()
                              throws java.sql.SQLException
What's the database vendor's preferred term for "schema"?
Specified by:
getSchemaTerm() in interface java.sql.DatabaseMetaData
Returns:
the vendor term

getProcedureTerm

public java.lang.String getProcedureTerm()
                                 throws java.sql.SQLException
What's the database vendor's preferred term for "procedure"?
Specified by:
getProcedureTerm() in interface java.sql.DatabaseMetaData
Returns:
the vendor term

getCatalogTerm

public java.lang.String getCatalogTerm()
                               throws java.sql.SQLException
What's the database vendor's preferred term for "catalog"?
Specified by:
getCatalogTerm() in interface java.sql.DatabaseMetaData
Returns:
the vendor term

isCatalogAtStart

public boolean isCatalogAtStart()
                        throws java.sql.SQLException
Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end)
Specified by:
isCatalogAtStart() in interface java.sql.DatabaseMetaData
Returns:
true if it appears at the start

getCatalogSeparator

public java.lang.String getCatalogSeparator()
                                    throws java.sql.SQLException
What's the separator between catalog and table name?
Specified by:
getCatalogSeparator() in interface java.sql.DatabaseMetaData
Returns:
the separator string

supportsSchemasInDataManipulation

public boolean supportsSchemasInDataManipulation()
                                         throws java.sql.SQLException
Can a schema name be used in a data manipulation statement?
Specified by:
supportsSchemasInDataManipulation() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSchemasInProcedureCalls

public boolean supportsSchemasInProcedureCalls()
                                       throws java.sql.SQLException
Can a schema name be used in a procedure call statement?
Specified by:
supportsSchemasInProcedureCalls() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSchemasInTableDefinitions

public boolean supportsSchemasInTableDefinitions()
                                         throws java.sql.SQLException
Can a schema name be used in a table definition statement?
Specified by:
supportsSchemasInTableDefinitions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSchemasInIndexDefinitions

public boolean supportsSchemasInIndexDefinitions()
                                         throws java.sql.SQLException
Can a schema name be used in an index definition statement?
Specified by:
supportsSchemasInIndexDefinitions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSchemasInPrivilegeDefinitions

public boolean supportsSchemasInPrivilegeDefinitions()
                                             throws java.sql.SQLException
Can a schema name be used in a privilege definition statement?
Specified by:
supportsSchemasInPrivilegeDefinitions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsCatalogsInDataManipulation

public boolean supportsCatalogsInDataManipulation()
                                          throws java.sql.SQLException
Can a catalog name be used in a data manipulation statement?
Specified by:
supportsCatalogsInDataManipulation() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsCatalogsInProcedureCalls

public boolean supportsCatalogsInProcedureCalls()
                                        throws java.sql.SQLException
Can a catalog name be used in a procedure call statement?
Specified by:
supportsCatalogsInProcedureCalls() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsCatalogsInTableDefinitions

public boolean supportsCatalogsInTableDefinitions()
                                          throws java.sql.SQLException
Can a catalog name be used in a table definition statement?
Specified by:
supportsCatalogsInTableDefinitions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsCatalogsInIndexDefinitions

public boolean supportsCatalogsInIndexDefinitions()
                                          throws java.sql.SQLException
Can a catalog name be used in a index definition statement?
Specified by:
supportsCatalogsInIndexDefinitions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsCatalogsInPrivilegeDefinitions

public boolean supportsCatalogsInPrivilegeDefinitions()
                                              throws java.sql.SQLException
Can a catalog name be used in a privilege definition statement?
Specified by:
supportsCatalogsInPrivilegeDefinitions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsPositionedDelete

public boolean supportsPositionedDelete()
                                throws java.sql.SQLException
Is positioned DELETE supported?
Specified by:
supportsPositionedDelete() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsPositionedUpdate

public boolean supportsPositionedUpdate()
                                throws java.sql.SQLException
Is positioned UPDATE supported?
Specified by:
supportsPositionedUpdate() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSelectForUpdate

public boolean supportsSelectForUpdate()
                               throws java.sql.SQLException
Is SELECT for UPDATE supported?
Specified by:
supportsSelectForUpdate() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsStoredProcedures

public boolean supportsStoredProcedures()
                                throws java.sql.SQLException
Are stored procedure calls using the stored procedure escape syntax supported?
Specified by:
supportsStoredProcedures() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSubqueriesInComparisons

public boolean supportsSubqueriesInComparisons()
                                       throws java.sql.SQLException
Are subqueries in comparison expressions supported? A JDBC compliant driver always returns true.
Specified by:
supportsSubqueriesInComparisons() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSubqueriesInExists

public boolean supportsSubqueriesInExists()
                                  throws java.sql.SQLException
Are subqueries in exists expressions supported? A JDBC compliant driver always returns true.
Specified by:
supportsSubqueriesInExists() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSubqueriesInIns

public boolean supportsSubqueriesInIns()
                               throws java.sql.SQLException
Are subqueries in "in" statements supported? A JDBC compliant driver always returns true.
Specified by:
supportsSubqueriesInIns() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsSubqueriesInQuantifieds

public boolean supportsSubqueriesInQuantifieds()
                                       throws java.sql.SQLException
Are subqueries in quantified expressions supported? A JDBC compliant driver always returns true.
Specified by:
supportsSubqueriesInQuantifieds() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsCorrelatedSubqueries

public boolean supportsCorrelatedSubqueries()
                                    throws java.sql.SQLException
Are correlated subqueries supported? A JDBC compliant driver always returns true.
Specified by:
supportsCorrelatedSubqueries() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsUnion

public boolean supportsUnion()
                     throws java.sql.SQLException
Is SQL UNION supported? A JDBC compliant driver always returns true.
Specified by:
supportsUnion() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsUnionAll

public boolean supportsUnionAll()
                        throws java.sql.SQLException
Is SQL UNION ALL supported? A JDBC compliant driver always returns true.
Specified by:
supportsUnionAll() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsOpenCursorsAcrossCommit

public boolean supportsOpenCursorsAcrossCommit()
                                       throws java.sql.SQLException
Can cursors remain open across commits?
Specified by:
supportsOpenCursorsAcrossCommit() in interface java.sql.DatabaseMetaData
Returns:
true if so
See Also:
Connection#disableAutoClose

supportsOpenCursorsAcrossRollback

public boolean supportsOpenCursorsAcrossRollback()
                                         throws java.sql.SQLException
Can cursors remain open across rollbacks?
Specified by:
supportsOpenCursorsAcrossRollback() in interface java.sql.DatabaseMetaData
Returns:
true if so
See Also:
Connection#disableAutoClose

supportsOpenStatementsAcrossCommit

public boolean supportsOpenStatementsAcrossCommit()
                                          throws java.sql.SQLException
Can statements remain open across commits?
Specified by:
supportsOpenStatementsAcrossCommit() in interface java.sql.DatabaseMetaData
Returns:
true if so
See Also:
Connection#disableAutoClose

supportsOpenStatementsAcrossRollback

public boolean supportsOpenStatementsAcrossRollback()
                                            throws java.sql.SQLException
Can statements remain open across rollbacks?
Specified by:
supportsOpenStatementsAcrossRollback() in interface java.sql.DatabaseMetaData
Returns:
true if so
See Also:
Connection#disableAutoClose

getMaxBinaryLiteralLength

public int getMaxBinaryLiteralLength()
                             throws java.sql.SQLException
How many hex characters can you have in an inline binary literal?
Specified by:
getMaxBinaryLiteralLength() in interface java.sql.DatabaseMetaData
Returns:
max literal length

getMaxCharLiteralLength

public int getMaxCharLiteralLength()
                           throws java.sql.SQLException
What's the max length for a character literal?
Specified by:
getMaxCharLiteralLength() in interface java.sql.DatabaseMetaData
Returns:
max literal length

getMaxColumnNameLength

public int getMaxColumnNameLength()
                          throws java.sql.SQLException
What's the limit on column name length?
Specified by:
getMaxColumnNameLength() in interface java.sql.DatabaseMetaData
Returns:
max literal length

getMaxColumnsInGroupBy

public int getMaxColumnsInGroupBy()
                          throws java.sql.SQLException
What's the maximum number of columns in a "GROUP BY" clause?
Specified by:
getMaxColumnsInGroupBy() in interface java.sql.DatabaseMetaData
Returns:
max number of columns

getMaxColumnsInIndex

public int getMaxColumnsInIndex()
                        throws java.sql.SQLException
What's the maximum number of columns allowed in an index?
Specified by:
getMaxColumnsInIndex() in interface java.sql.DatabaseMetaData
Returns:
max columns

getMaxColumnsInOrderBy

public int getMaxColumnsInOrderBy()
                          throws java.sql.SQLException
What's the maximum number of columns in an "ORDER BY" clause?
Specified by:
getMaxColumnsInOrderBy() in interface java.sql.DatabaseMetaData
Returns:
max columns

getMaxColumnsInSelect

public int getMaxColumnsInSelect()
                         throws java.sql.SQLException
What's the maximum number of columns in a "SELECT" list?
Specified by:
getMaxColumnsInSelect() in interface java.sql.DatabaseMetaData
Returns:
max columns

getMaxColumnsInTable

public int getMaxColumnsInTable()
                        throws java.sql.SQLException
What's maximum number of columns in a table?
Specified by:
getMaxColumnsInTable() in interface java.sql.DatabaseMetaData
Returns:
max columns

getMaxConnections

public int getMaxConnections()
                     throws java.sql.SQLException
How many active connections can we have at a time to this database?
Specified by:
getMaxConnections() in interface java.sql.DatabaseMetaData
Returns:
max connections

getMaxCursorNameLength

public int getMaxCursorNameLength()
                          throws java.sql.SQLException
What's the maximum cursor name length?
Specified by:
getMaxCursorNameLength() in interface java.sql.DatabaseMetaData
Returns:
max cursor name length in bytes

getMaxIndexLength

public int getMaxIndexLength()
                     throws java.sql.SQLException
What's the maximum length of an index (in bytes)?
Specified by:
getMaxIndexLength() in interface java.sql.DatabaseMetaData
Returns:
max index length in bytes

getMaxSchemaNameLength

public int getMaxSchemaNameLength()
                          throws java.sql.SQLException
What's the maximum length allowed for a schema name?
Specified by:
getMaxSchemaNameLength() in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes

getMaxProcedureNameLength

public int getMaxProcedureNameLength()
                             throws java.sql.SQLException
What's the maximum length of a procedure name?
Specified by:
getMaxProcedureNameLength() in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes

getMaxCatalogNameLength

public int getMaxCatalogNameLength()
                           throws java.sql.SQLException
What's the maximum length of a catalog name?
Specified by:
getMaxCatalogNameLength() in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes

getMaxRowSize

public int getMaxRowSize()
                 throws java.sql.SQLException
What's the maximum length of a single row?
Specified by:
getMaxRowSize() in interface java.sql.DatabaseMetaData
Returns:
max row size in bytes

doesMaxRowSizeIncludeBlobs

public boolean doesMaxRowSizeIncludeBlobs()
                                  throws java.sql.SQLException
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?
Specified by:
doesMaxRowSizeIncludeBlobs() in interface java.sql.DatabaseMetaData
Returns:
true if so

getMaxStatementLength

public int getMaxStatementLength()
                         throws java.sql.SQLException
What's the maximum length of a SQL statement?
Specified by:
getMaxStatementLength() in interface java.sql.DatabaseMetaData
Returns:
max length in bytes

getMaxStatements

public int getMaxStatements()
                    throws java.sql.SQLException
How many active statements can we have open at one time to this database?
Specified by:
getMaxStatements() in interface java.sql.DatabaseMetaData
Returns:
the maximum

getMaxTableNameLength

public int getMaxTableNameLength()
                         throws java.sql.SQLException
What's the maximum length of a table name?
Specified by:
getMaxTableNameLength() in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes

getMaxTablesInSelect

public int getMaxTablesInSelect()
                        throws java.sql.SQLException
What's the maximum number of tables in a SELECT?
Specified by:
getMaxTablesInSelect() in interface java.sql.DatabaseMetaData
Returns:
the maximum

getMaxUserNameLength

public int getMaxUserNameLength()
                        throws java.sql.SQLException
What's the maximum length of a user name?
Specified by:
getMaxUserNameLength() in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes

getDefaultTransactionIsolation

public int getDefaultTransactionIsolation()
                                  throws java.sql.SQLException
What's the database's default transaction isolation level? The values are defined in java.sql.Connection.
Specified by:
getDefaultTransactionIsolation() in interface java.sql.DatabaseMetaData
Returns:
the default isolation level
See Also:
Connection

supportsTransactions

public boolean supportsTransactions()
                            throws java.sql.SQLException
Are transactions supported? If not, commit is a noop and the isolation level is TRANSACTION_NONE.
Specified by:
supportsTransactions() in interface java.sql.DatabaseMetaData
Returns:
true if transactions are supported

supportsTransactionIsolationLevel

public boolean supportsTransactionIsolationLevel(int level)
                                         throws java.sql.SQLException
Does the database support the given transaction isolation level?
Specified by:
supportsTransactionIsolationLevel(int) in interface java.sql.DatabaseMetaData
Parameters:
level - the values are defined in java.sql.Connection
Returns:
true if so
See Also:
Connection

supportsDataDefinitionAndDataManipulationTransactions

public boolean supportsDataDefinitionAndDataManipulationTransactions()
                                                             throws java.sql.SQLException
Are both data definition and data manipulation statements within a transaction supported?
Specified by:
supportsDataDefinitionAndDataManipulationTransactions() in interface java.sql.DatabaseMetaData
Returns:
true if so

supportsDataManipulationTransactionsOnly

public boolean supportsDataManipulationTransactionsOnly()
                                                throws java.sql.SQLException
Are only data manipulation statements within a transaction supported?
Specified by:
supportsDataManipulationTransactionsOnly() in interface java.sql.DatabaseMetaData
Returns:
true if so

dataDefinitionCausesTransactionCommit

public boolean dataDefinitionCausesTransactionCommit()
                                             throws java.sql.SQLException
Does a data definition statement within a transaction force the transaction to commit?
Specified by:
dataDefinitionCausesTransactionCommit() in interface java.sql.DatabaseMetaData
Returns:
true if so

dataDefinitionIgnoredInTransactions

public boolean dataDefinitionIgnoredInTransactions()
                                           throws java.sql.SQLException
Is a data definition statement within a transaction ignored?
Specified by:
dataDefinitionIgnoredInTransactions() in interface java.sql.DatabaseMetaData
Returns:
true if so

getProcedures

public java.sql.ResultSet getProcedures(java.lang.String catalog,
                               java.lang.String schemaPattern,
                               java.lang.String procedureNamePattern)
                                throws java.sql.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
Specified by:
getProcedures(java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
schemaPattern - a schema name pattern; "" retrieves those without a schema
procedureNamePattern - a procedure name pattern
Returns:
ResultSet each row is a procedure description
See Also:
getSearchStringEscape

getProcedureColumns

public java.sql.ResultSet getProcedureColumns(java.lang.String Catalog,
                                     java.lang.String SchemaPattern,
                                     java.lang.String ProcedureNamePattern,
                                     java.lang.String ColumnNamePattern)
                                      throws java.sql.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 desription 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.

Specified by:
getProcedureColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
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
See Also:
getSearchStringEscape

getTables

public java.sql.ResultSet getTables(java.lang.String Catalog,
                           java.lang.String SchemaPattern,
                           java.lang.String TableNamePattern,
                           java.lang.String[] Types)
                            throws java.sql.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.

Specified by:
getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[]) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
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
See Also:
getSearchStringEscape

getSchemas

public java.sql.ResultSet getSchemas()
                             throws java.sql.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
Specified by:
getSchemas() in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row has a single String column that is a schema name

getCatalogs

public java.sql.ResultSet getCatalogs()
                              throws java.sql.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
Specified by:
getCatalogs() in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row has a single String column that is a catalog name

getTableTypes

public java.sql.ResultSet getTableTypes()
                                throws java.sql.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".
Specified by:
getTableTypes() in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row has a single String column that is a table type

getColumns

public java.sql.ResultSet getColumns(java.lang.String Catalog,
                            java.lang.String SchemaPattern,
                            java.lang.String TableName,
                            java.lang.String ColumnNamePattern)
                             throws java.sql.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.
Specified by:
getColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
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
See Also:
getSearchStringEscape

getColumnPrivileges

public java.sql.ResultSet getColumnPrivileges(java.lang.String catalog,
                                     java.lang.String schema,
                                     java.lang.String table,
                                     java.lang.String columnNamePattern)
                                      throws java.sql.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
Specified by:
getColumnPrivileges(java.lang.String, java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
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
See Also:
getSearchStringEscape

getTablePrivileges

public java.sql.ResultSet getTablePrivileges(java.lang.String catalog,
                                    java.lang.String schemaPattern,
                                    java.lang.String tableNamePattern)
                                     throws java.sql.SQLException
Get a description of the access rights for each table available in a catalog.

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. 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
Specified by:
getTablePrivileges(java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
schemaPattern - a schema name pattern; "" retrieves those without a schema
tableNamePattern - a table name pattern
Returns:
ResultSet each row is a table privilege description
See Also:
getSearchStringEscape

getBestRowIdentifier

public java.sql.ResultSet getBestRowIdentifier(java.lang.String Catalog,
                                      java.lang.String Schema,
                                      java.lang.String Table,
                                      int scope,
                                      boolean nullable)
                                       throws java.sql.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
Specified by:
getBestRowIdentifier(java.lang.String, java.lang.String, java.lang.String, int, boolean) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
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

getVersionColumns

public java.sql.ResultSet getVersionColumns(java.lang.String catalog,
                                   java.lang.String schema,
                                   java.lang.String table)
                                    throws java.sql.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
Specified by:
getVersionColumns(java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
schema - a schema name; "" retrieves those without a schema
table - a table name
Returns:
ResultSet each row is a column description

getPrimaryKeys

public java.sql.ResultSet getPrimaryKeys(java.lang.String Catalog,
                                java.lang.String Schema,
                                java.lang.String Table)
                                 throws java.sql.SQLException
Get a description of a table's primary key columns. They are ordered by COLUMN_NAME.

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. KEY_SEQ short => sequence number within primary key
  6. PK_NAME String => primary key name (may be null)
Specified by:
getPrimaryKeys(java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
schema - a schema name pattern; "" retrieves those without a schema
table - a table name
Returns:
ResultSet each row is a primary key column description

getImportedKeys

public java.sql.ResultSet getImportedKeys(java.lang.String catalog,
                                 java.lang.String schema,
                                 java.lang.String table)
                                  throws java.sql.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:
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeyRestrict - do not allow update of primary key if it has been imported
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeyRestrict - do not allow delete of primary key if it has been imported
    • importedKeySetNull - change imported key to NULL 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)
Specified by:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
schema - a schema name pattern; "" retrieves those without a schema
table - a table name
Returns:
ResultSet each row is a primary key column description
See Also:
getExportedKeys

getExportedKeys

public java.sql.ResultSet getExportedKeys(java.lang.String catalog,
                                 java.lang.String schema,
                                 java.lang.String table)
                                  throws java.sql.SQLException
Get a description of a 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:
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeyRestrict - do not allow update of primary key if it has been imported
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeyRestrict - do not allow delete of primary key if it has been imported
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
  12. FK_NAME String => foreign key identifier (may be null)
  13. PK_NAME String => primary key identifier (may be null)
Specified by:
getExportedKeys(java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
schema - a schema name pattern; "" retrieves those without a schema
table - a table name
Returns:
ResultSet each row is a foreign key column description
See Also:
getImportedKeys

getCrossReference

public java.sql.ResultSet getCrossReference(java.lang.String PrimaryCatalog,
                                   java.lang.String PrimarySchema,
                                   java.lang.String PrimaryTable,
                                   java.lang.String ForeignCatalog,
                                   java.lang.String ForeignSchema,
                                   java.lang.String ForeignTable)
                                    throws java.sql.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:
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeyRestrict - do not allow update of primary key if it has been imported
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeyRestrict - do not allow delete of primary key if it has been imported
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
  12. FK_NAME String => foreign key identifier (may be null)
  13. PK_NAME String => primary key identifier (may be null)
Specified by:
getCrossReference(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
schema - a schema name pattern; "" retrieves those without a schema
table - a table name
Returns:
ResultSet each row is a foreign key column description
See Also:
getImportedKeys

getTypeInfo

public java.sql.ResultSet getTypeInfo()
                              throws java.sql.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
Specified by:
getTypeInfo() in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row is a SQL type description

getIndexInfo

public java.sql.ResultSet getIndexInfo(java.lang.String Catalog,
                              java.lang.String Schema,
                              java.lang.String Table,
                              boolean unique,
                              boolean approximate)
                               throws java.sql.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 tableIndexStatisic 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)
Specified by:
getIndexInfo(java.lang.String, java.lang.String, java.lang.String, boolean, boolean) in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog
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
Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD