Class DatabaseMetaData
- java.lang.Object
-
- org.mariadb.jdbc.DatabaseMetaData
-
- All Implemented Interfaces:
DatabaseMetaData
,Wrapper
public class DatabaseMetaData extends Object implements DatabaseMetaData
Mariadb Database metadata
-
-
Field Summary
Fields Modifier and Type Field Description static String
DRIVER_NAME
MariaDB driver name-
Fields inherited from interface java.sql.DatabaseMetaData
attributeNoNulls, attributeNullable, attributeNullableUnknown, bestRowNotPseudo, bestRowPseudo, bestRowSession, bestRowTemporary, bestRowTransaction, bestRowUnknown, columnNoNulls, columnNullable, columnNullableUnknown, functionColumnIn, functionColumnInOut, functionColumnOut, functionColumnResult, functionColumnUnknown, functionNoNulls, functionNoTable, functionNullable, functionNullableUnknown, functionResultUnknown, functionReturn, functionReturnsTable, importedKeyCascade, importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeyRestrict, importedKeySetDefault, importedKeySetNull, procedureColumnIn, procedureColumnInOut, procedureColumnOut, procedureColumnResult, procedureColumnReturn, procedureColumnUnknown, procedureNoNulls, procedureNoResult, procedureNullable, procedureNullableUnknown, procedureResultUnknown, procedureReturnsResult, sqlStateSQL, sqlStateSQL99, sqlStateXOpen, tableIndexClustered, tableIndexHashed, tableIndexOther, tableIndexStatistic, typeNoNulls, typeNullable, typeNullableUnknown, typePredBasic, typePredChar, typePredNone, typeSearchable, versionColumnNotPseudo, versionColumnPseudo, versionColumnUnknown
-
-
Constructor Summary
Constructors Constructor Description DatabaseMetaData(Connection connection, Configuration conf)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allProceduresAreCallable()
boolean
allTablesAreSelectable()
boolean
autoCommitFailureClosesAllResultSets()
boolean
dataDefinitionCausesTransactionCommit()
boolean
dataDefinitionIgnoredInTransactions()
boolean
deletesAreDetected(int type)
boolean
doesMaxRowSizeIncludeBlobs()
static String
escapeString(String value, boolean noBackslashEscapes)
Escape String.boolean
generatedKeyAlwaysReturned()
ResultSet
getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)
Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.ResultSet
getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
Retrieves a description of a table's optimal set of columns that uniquely identifies a row.ResultSet
getCatalogs()
String
getCatalogSeparator()
String
getCatalogTerm()
ResultSet
getClientInfoProperties()
Retrieves a list of the client info properties that the driver supports.ResultSet
getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)
Retrieves a description of the access rights for a table's columns.ResultSet
getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
Retrieves a description of table columns available in the specified catalog.Connection
getConnection()
ResultSet
getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)
Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table).int
getDatabaseMajorVersion()
int
getDatabaseMinorVersion()
String
getDatabaseProductName()
Return Server type.String
getDatabaseProductVersion()
int
getDefaultTransactionIsolation()
int
getDriverMajorVersion()
int
getDriverMinorVersion()
String
getDriverName()
String
getDriverVersion()
ResultSet
getExportedKeys(String catalog, String schema, String table)
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).String
getExtraNameCharacters()
ResultSet
getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's system or user function parameters and return type.ResultSet
getFunctions(String catalog, String schemaPattern, String functionNamePattern)
Retrieves a description of the system and user functions available in the given catalog.String
getIdentifierQuoteString()
ResultSet
getImportedKeys(String catalog, String schema, String table)
Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table).ResultSet
getImportedKeysUsingInformationSchema(String database, String table)
GetImportedKeysUsingInformationSchema.ResultSet
getImportedKeysUsingShowCreateTable(String database, String table)
GetImportedKeysUsingShowCreateTable.ResultSet
getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
Retrieves a description of the given table's indices and statistics.int
getJDBCMajorVersion()
int
getJDBCMinorVersion()
int
getMaxBinaryLiteralLength()
int
getMaxCatalogNameLength()
int
getMaxCharLiteralLength()
int
getMaxColumnNameLength()
int
getMaxColumnsInGroupBy()
int
getMaxColumnsInIndex()
int
getMaxColumnsInOrderBy()
int
getMaxColumnsInSelect()
int
getMaxColumnsInTable()
int
getMaxConnections()
int
getMaxCursorNameLength()
int
getMaxIndexLength()
long
getMaxLogicalLobSize()
int
getMaxProcedureNameLength()
int
getMaxRowSize()
int
getMaxSchemaNameLength()
int
getMaxStatementLength()
int
getMaxStatements()
int
getMaxTableNameLength()
int
getMaxTablesInSelect()
int
getMaxUserNameLength()
String
getNumericFunctions()
List of numeric functions.ResultSet
getPrimaryKeys(String catalog, String schema, String table)
Retrieves a description of the given table's primary key columns.ResultSet
getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's stored procedure parameter and result columns.ResultSet
getProcedures(String catalog, String schemaPattern, String procedureNamePattern)
Retrieves a description of the stored procedures available in the given catalog.String
getProcedureTerm()
ResultSet
getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema.int
getResultSetHoldability()
RowIdLifetime
getRowIdLifetime()
ResultSet
getSchemas()
ResultSet
getSchemas(String catalog, String schemaPattern)
String
getSchemaTerm()
String
getSearchStringEscape()
String
getSQLKeywords()
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.int
getSQLStateType()
String
getStringFunctions()
List of string functions.ResultSet
getSuperTables(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the table hierarchies defined in a particular schema in this database.ResultSet
getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.String
getSystemFunctions()
List of system functions.ResultSet
getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the access rights for each table available in a catalog.ResultSet
getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)
Retrieves a description of the tables available in the given catalog.ResultSet
getTableTypes()
String
getTimeDateFunctions()
List of time and date functions.ResultSet
getTypeInfo()
Retrieves a description of all the data types supported by this database.ResultSet
getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)
Retrieves a description of the user-defined types (UDTs) defined in a particular schema.String
getURL()
String
getUserName()
ResultSet
getVersionColumns(String catalog, String schema, String table)
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated.boolean
insertsAreDetected(int type)
boolean
isCatalogAtStart()
boolean
isReadOnly()
boolean
isWrapperFor(Class<?> iface)
boolean
locatorsUpdateCopy()
boolean
nullPlusNonNullIsNull()
boolean
nullsAreSortedAtEnd()
boolean
nullsAreSortedAtStart()
boolean
nullsAreSortedHigh()
boolean
nullsAreSortedLow()
boolean
othersDeletesAreVisible(int type)
boolean
othersInsertsAreVisible(int type)
boolean
othersUpdatesAreVisible(int type)
boolean
ownDeletesAreVisible(int type)
boolean
ownInsertsAreVisible(int type)
boolean
ownUpdatesAreVisible(int type)
boolean
storesLowerCaseIdentifiers()
boolean
storesLowerCaseQuotedIdentifiers()
boolean
storesMixedCaseIdentifiers()
boolean
storesMixedCaseQuotedIdentifiers()
boolean
storesUpperCaseIdentifiers()
boolean
storesUpperCaseQuotedIdentifiers()
boolean
supportsAlterTableWithAddColumn()
boolean
supportsAlterTableWithDropColumn()
boolean
supportsANSI92EntryLevelSQL()
boolean
supportsANSI92FullSQL()
boolean
supportsANSI92IntermediateSQL()
boolean
supportsBatchUpdates()
boolean
supportsCatalogsInDataManipulation()
boolean
supportsCatalogsInIndexDefinitions()
boolean
supportsCatalogsInPrivilegeDefinitions()
boolean
supportsCatalogsInProcedureCalls()
boolean
supportsCatalogsInTableDefinitions()
boolean
supportsColumnAliasing()
boolean
supportsConvert()
boolean
supportsConvert(int fromType, int toType)
Retrieves whether this database supports the JDBC scalar function CONVERT for conversions between the JDBC types fromType and toType.boolean
supportsCoreSQLGrammar()
boolean
supportsCorrelatedSubqueries()
boolean
supportsDataDefinitionAndDataManipulationTransactions()
boolean
supportsDataManipulationTransactionsOnly()
boolean
supportsDifferentTableCorrelationNames()
boolean
supportsExpressionsInOrderBy()
boolean
supportsExtendedSQLGrammar()
boolean
supportsFullOuterJoins()
boolean
supportsGetGeneratedKeys()
boolean
supportsGroupBy()
boolean
supportsGroupByBeyondSelect()
boolean
supportsGroupByUnrelated()
boolean
supportsIntegrityEnhancementFacility()
boolean
supportsLikeEscapeClause()
boolean
supportsLimitedOuterJoins()
boolean
supportsMinimumSQLGrammar()
boolean
supportsMixedCaseIdentifiers()
boolean
supportsMixedCaseQuotedIdentifiers()
boolean
supportsMultipleOpenResults()
boolean
supportsMultipleResultSets()
boolean
supportsMultipleTransactions()
boolean
supportsNamedParameters()
boolean
supportsNonNullableColumns()
boolean
supportsOpenCursorsAcrossCommit()
boolean
supportsOpenCursorsAcrossRollback()
boolean
supportsOpenStatementsAcrossCommit()
boolean
supportsOpenStatementsAcrossRollback()
boolean
supportsOrderByUnrelated()
boolean
supportsOuterJoins()
boolean
supportsPositionedDelete()
boolean
supportsPositionedUpdate()
boolean
supportsResultSetConcurrency(int type, int concurrency)
Retrieves whether this database supports the given concurrency type in combination with the given result set type.boolean
supportsResultSetHoldability(int holdability)
boolean
supportsResultSetType(int type)
Retrieves whether this database supports the given result set type.boolean
supportsSavepoints()
boolean
supportsSchemasInDataManipulation()
boolean
supportsSchemasInIndexDefinitions()
boolean
supportsSchemasInPrivilegeDefinitions()
boolean
supportsSchemasInProcedureCalls()
boolean
supportsSchemasInTableDefinitions()
boolean
supportsSelectForUpdate()
boolean
supportsStatementPooling()
boolean
supportsStoredFunctionsUsingCallSyntax()
boolean
supportsStoredProcedures()
boolean
supportsSubqueriesInComparisons()
boolean
supportsSubqueriesInExists()
boolean
supportsSubqueriesInIns()
boolean
supportsSubqueriesInQuantifieds()
boolean
supportsTableCorrelationNames()
boolean
supportsTransactionIsolationLevel(int level)
Retrieves whether this database supports the given transaction isolation level.boolean
supportsTransactions()
Retrieves whether this database supports transactions.boolean
supportsUnion()
boolean
supportsUnionAll()
<T> T
unwrap(Class<T> iface)
boolean
updatesAreDetected(int type)
boolean
usesLocalFilePerTable()
boolean
usesLocalFiles()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.sql.DatabaseMetaData
supportsRefCursors, supportsSharding
-
-
-
-
Field Detail
-
DRIVER_NAME
public static final String DRIVER_NAME
MariaDB driver name- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DatabaseMetaData
public DatabaseMetaData(Connection connection, Configuration conf)
Constructor.- Parameters:
connection
- connectionconf
- configuration
-
-
Method Detail
-
escapeString
public static String escapeString(String value, boolean noBackslashEscapes)
Escape String.- Parameters:
value
- value to escapenoBackslashEscapes
- must backslash be escaped- Returns:
- escaped string.
-
getImportedKeys
public ResultSet getImportedKeys(String catalog, String schema, String table) throws SQLException
Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.Each primary key column description has the following columns:
- PKTABLE_CAT String
=>
primary key table catalog being imported (may benull
) - PKTABLE_SCHEM String
=>
primary key table schema being imported (may benull
) - PKTABLE_NAME String
=>
primary key table name being imported - PKCOLUMN_NAME String
=>
primary key column name being imported - FKTABLE_CAT String
=>
foreign key table catalog (may benull
) - FKTABLE_SCHEM String
=>
foreign key table schema (may benull
) - FKTABLE_NAME String
=>
foreign key table name - FKCOLUMN_NAME String
=>
foreign key column name - KEY_SEQ short
=>
sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key). - UPDATE_RULE short
=>
What happens to a foreign key when the primary key is updated:- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short
=>
What happens to the foreign key when primary is deleted.- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String
=>
foreign key name (may benull
) - PK_NAME String
=>
primary key name (may benull
) - DEFERRABILITY short
=>
can the evaluation of foreign key constraints be deferred until commit- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getImportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs- See Also:
getExportedKeys(java.lang.String, java.lang.String, java.lang.String)
- PKTABLE_CAT String
-
getPrimaryKeys
public ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException
Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.Each primary key column description has the following columns:
- TABLE_CAT String
=>
table catalog - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - KEY_SEQ short
=>
sequence number within primary key( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key). - PK_NAME String
=>
primary key name
- Specified by:
getPrimaryKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs
- TABLE_CAT String
-
getTables
public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException
Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered byTABLE_TYPE
,TABLE_CAT
,TABLE_SCHEM
andTABLE_NAME
. Each table description has the following columns:- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - TABLE_TYPE String
=>
table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". - REMARKS String
=>
explanatory comment on the table - TYPE_CAT String
=>
the types catalog (may benull
) - TYPE_SCHEM String
=>
the types schema (may benull
) - TYPE_NAME String
=>
type name (may benull
) - SELF_REFERENCING_COL_NAME String
=>
name of the designated "identifier" column of a typed table (may benull
) - REF_GENERATION String
=>
specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may benull
)
Note: Some databases may not return information for all tables.
- Specified by:
getTables
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasetypes
- a list of table types, which must be from the list of table types returned fromgetTableTypes()
,to include;null
returns all types- Returns:
ResultSet
- each row is a table description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- TABLE_CAT String
-
getColumns
public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException
Retrieves a description of table columns available in the specified catalog.Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by
TABLE_CAT
,TABLE_SCHEM
,TABLE_NAME
, andORDINAL_POSITION
.Each column description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL type from java.sql.Types - TYPE_NAME String
=>
Data source dependent type name, for a UDT the type name is fully qualified - COLUMN_SIZE int
=>
column size. - BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int
=>
the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. - NUM_PREC_RADIX int
=>
Radix (typically either 10 or 2) - NULLABLE int
=>
is NULL allowed.- columnNoNulls - might not allow
NULL
values - columnNullable - definitely allows
NULL
values - columnNullableUnknown - nullability unknown
- columnNoNulls - might not allow
- REMARKS String
=>
comment describing column (may benull
) - COLUMN_DEF String
=>
default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may benull
) - SQL_DATA_TYPE int
=>
unused - SQL_DATETIME_SUB int
=>
unused - CHAR_OCTET_LENGTH int
=>
for char types the maximum number of bytes in the column - ORDINAL_POSITION int
=>
index of column in table (starting at 1) - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a column.- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
- SCOPE_CATALOG String
=>
catalog of table that is the scope of a reference attribute (null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String
=>
schema of table that is the scope of a reference attribute (null
if the DATA_TYPE isn't REF) - SCOPE_TABLE String
=>
table name that this the scope of a reference attribute (null
if the DATA_TYPE isn't REF) - SOURCE_DATA_TYPE short
=>
source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null
if DATA_TYPE isn't DISTINCT or user-generated REF) - IS_AUTOINCREMENT String
=>
Indicates whether this column is auto incremented- YES --- if the column is auto incremented
- NO --- if the column is not auto incremented
- empty string --- if it cannot be determined whether the column is auto incremented
- IS_GENERATEDCOLUMN String
=>
Indicates whether this is a generated column- YES --- if this a generated column
- NO --- if this not a generated column
- empty string --- if it cannot be determined whether this is a generated column
The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Specified by:
getColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- TABLE_CAT String
-
getExportedKeys
public ResultSet getExportedKeys(String catalog, String schema, String table) throws SQLException
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String
=>
primary key table catalog (may benull
) - PKTABLE_SCHEM String
=>
primary key table schema (may benull
) - PKTABLE_NAME String
=>
primary key table name - PKCOLUMN_NAME String
=>
primary key column name - FKTABLE_CAT String
=>
foreign key table catalog (may benull
) being exported (may benull
) - FKTABLE_SCHEM String
=>
foreign key table schema (may benull
) being exported (may benull
) - FKTABLE_NAME String
=>
foreign key table name being exported - FKCOLUMN_NAME String
=>
foreign key column name being exported - KEY_SEQ short
=>
sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key). - UPDATE_RULE short
=>
What happens to foreign key when primary is updated:- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short
=>
What happens to the foreign key when primary is deleted.- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL
if its primary key has been deleted - importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String
=>
foreign key name (may benull
) - PK_NAME String
=>
primary key name (may benull
) - DEFERRABILITY short
=>
can the evaluation of foreign key constraints be deferred until commit- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getExportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in this database- Returns:
- a
ResultSet
object in which each row is a foreign key column description - Throws:
SQLException
- if a database access error occurs- See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String, org.mariadb.jdbc.Connection)
- PKTABLE_CAT String
-
getImportedKeysUsingInformationSchema
public ResultSet getImportedKeysUsingInformationSchema(String database, String table) throws SQLException
GetImportedKeysUsingInformationSchema.- Parameters:
database
- databasetable
- table- Returns:
- resultset
- Throws:
SQLException
- exception
-
getImportedKeysUsingShowCreateTable
public ResultSet getImportedKeysUsingShowCreateTable(String database, String table) throws Exception
GetImportedKeysUsingShowCreateTable.- Parameters:
database
- databasetable
- table- Returns:
- resultset
- Throws:
Exception
- exception
-
getBestRowIdentifier
public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException
Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.Each column description has the following columns:
- SCOPE short
=>
actual scope of result- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL data type from java.sql.Types - TYPE_NAME String
=>
Data source dependent type name, for a UDT the type name is fully qualified - COLUMN_SIZE int
=>
precision - BUFFER_LENGTH int
=>
not used - DECIMAL_DIGITS short
=>
scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. - PSEUDO_COLUMN short
=>
is this a pseudo column like an Oracle ROWID- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Specified by:
getBestRowIdentifier
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the databasescope
- the scope of interest; use same values as SCOPEnullable
- include columns that are nullable.- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs
- SCOPE short
-
generatedKeyAlwaysReturned
public boolean generatedKeyAlwaysReturned()
- Specified by:
generatedKeyAlwaysReturned
in interfaceDatabaseMetaData
-
getPseudoColumns
public ResultSet getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException
Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema. Pseudo or hidden columns may not always be stored within a table and are not visible in a ResultSet unless they are specified in the query's outermost SELECT list. Pseudo or hidden columns may not necessarily be able to be modified. If there are no pseudo or hidden columns, an empty ResultSet is returned.Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by
TABLE_CAT
,TABLE_SCHEM
,TABLE_NAME
andCOLUMN_NAME
.Each column description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL type from java.sql.Types - COLUMN_SIZE int
=>
column size. - DECIMAL_DIGITS int
=>
the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. - NUM_PREC_RADIX int
=>
Radix (typically either 10 or 2) - COLUMN_USAGE String
=>
The allowed usage for the column. The value returned will correspond to the enum name returned by PseudoColumnUsage.name() - REMARKS String
=>
comment describing column (may benull
) - CHAR_OCTET_LENGTH int
=>
for char types the maximum number of bytes in the column - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a column.- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Specified by:
getPseudoColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs- Since:
- 1.7
- See Also:
PseudoColumnUsage
- TABLE_CAT String
-
allProceduresAreCallable
public boolean allProceduresAreCallable()
- Specified by:
allProceduresAreCallable
in interfaceDatabaseMetaData
-
allTablesAreSelectable
public boolean allTablesAreSelectable()
- Specified by:
allTablesAreSelectable
in interfaceDatabaseMetaData
-
getURL
public String getURL()
- Specified by:
getURL
in interfaceDatabaseMetaData
-
getUserName
public String getUserName()
- Specified by:
getUserName
in interfaceDatabaseMetaData
-
isReadOnly
public boolean isReadOnly() throws SQLException
- Specified by:
isReadOnly
in interfaceDatabaseMetaData
- Throws:
SQLException
-
nullsAreSortedHigh
public boolean nullsAreSortedHigh()
- Specified by:
nullsAreSortedHigh
in interfaceDatabaseMetaData
-
nullsAreSortedLow
public boolean nullsAreSortedLow()
- Specified by:
nullsAreSortedLow
in interfaceDatabaseMetaData
-
nullsAreSortedAtStart
public boolean nullsAreSortedAtStart()
- Specified by:
nullsAreSortedAtStart
in interfaceDatabaseMetaData
-
nullsAreSortedAtEnd
public boolean nullsAreSortedAtEnd()
- Specified by:
nullsAreSortedAtEnd
in interfaceDatabaseMetaData
-
getDatabaseProductName
public String getDatabaseProductName()
Return Server type. MySQL or MariaDB. MySQL can be forced for compatibility with option "useMysqlMetadata"- Specified by:
getDatabaseProductName
in interfaceDatabaseMetaData
- Returns:
- server type
-
getDatabaseProductVersion
public String getDatabaseProductVersion()
- Specified by:
getDatabaseProductVersion
in interfaceDatabaseMetaData
-
getDriverName
public String getDriverName()
- Specified by:
getDriverName
in interfaceDatabaseMetaData
-
getDriverVersion
public String getDriverVersion()
- Specified by:
getDriverVersion
in interfaceDatabaseMetaData
-
getDriverMajorVersion
public int getDriverMajorVersion()
- Specified by:
getDriverMajorVersion
in interfaceDatabaseMetaData
-
getDriverMinorVersion
public int getDriverMinorVersion()
- Specified by:
getDriverMinorVersion
in interfaceDatabaseMetaData
-
usesLocalFiles
public boolean usesLocalFiles()
- Specified by:
usesLocalFiles
in interfaceDatabaseMetaData
-
usesLocalFilePerTable
public boolean usesLocalFilePerTable()
- Specified by:
usesLocalFilePerTable
in interfaceDatabaseMetaData
-
supportsMixedCaseIdentifiers
public boolean supportsMixedCaseIdentifiers() throws SQLException
- Specified by:
supportsMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Throws:
SQLException
-
storesUpperCaseIdentifiers
public boolean storesUpperCaseIdentifiers()
- Specified by:
storesUpperCaseIdentifiers
in interfaceDatabaseMetaData
-
storesLowerCaseIdentifiers
public boolean storesLowerCaseIdentifiers() throws SQLException
- Specified by:
storesLowerCaseIdentifiers
in interfaceDatabaseMetaData
- Throws:
SQLException
-
storesMixedCaseIdentifiers
public boolean storesMixedCaseIdentifiers() throws SQLException
- Specified by:
storesMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsMixedCaseQuotedIdentifiers
public boolean supportsMixedCaseQuotedIdentifiers() throws SQLException
- Specified by:
supportsMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Throws:
SQLException
-
storesUpperCaseQuotedIdentifiers
public boolean storesUpperCaseQuotedIdentifiers()
- Specified by:
storesUpperCaseQuotedIdentifiers
in interfaceDatabaseMetaData
-
storesLowerCaseQuotedIdentifiers
public boolean storesLowerCaseQuotedIdentifiers() throws SQLException
- Specified by:
storesLowerCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Throws:
SQLException
-
storesMixedCaseQuotedIdentifiers
public boolean storesMixedCaseQuotedIdentifiers() throws SQLException
- Specified by:
storesMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getIdentifierQuoteString
public String getIdentifierQuoteString()
- Specified by:
getIdentifierQuoteString
in interfaceDatabaseMetaData
-
getSQLKeywords
public String getSQLKeywords()
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.- Specified by:
getSQLKeywords
in interfaceDatabaseMetaData
- Returns:
- the list of this database's keywords that are not also SQL:2003 keywords
-
getNumericFunctions
public String getNumericFunctions()
List of numeric functions.- Specified by:
getNumericFunctions
in interfaceDatabaseMetaData
- Returns:
- List of numeric functions.
-
getStringFunctions
public String getStringFunctions()
List of string functions.- Specified by:
getStringFunctions
in interfaceDatabaseMetaData
- Returns:
- List of string functions.
-
getSystemFunctions
public String getSystemFunctions()
List of system functions.- Specified by:
getSystemFunctions
in interfaceDatabaseMetaData
- Returns:
- List of system functions.
-
getTimeDateFunctions
public String getTimeDateFunctions()
List of time and date functions.- Specified by:
getTimeDateFunctions
in interfaceDatabaseMetaData
- Returns:
- List of time and date functions.
-
getSearchStringEscape
public String getSearchStringEscape()
- Specified by:
getSearchStringEscape
in interfaceDatabaseMetaData
-
getExtraNameCharacters
public String getExtraNameCharacters()
- Specified by:
getExtraNameCharacters
in interfaceDatabaseMetaData
-
supportsAlterTableWithAddColumn
public boolean supportsAlterTableWithAddColumn()
- Specified by:
supportsAlterTableWithAddColumn
in interfaceDatabaseMetaData
-
supportsAlterTableWithDropColumn
public boolean supportsAlterTableWithDropColumn()
- Specified by:
supportsAlterTableWithDropColumn
in interfaceDatabaseMetaData
-
supportsColumnAliasing
public boolean supportsColumnAliasing()
- Specified by:
supportsColumnAliasing
in interfaceDatabaseMetaData
-
nullPlusNonNullIsNull
public boolean nullPlusNonNullIsNull()
- Specified by:
nullPlusNonNullIsNull
in interfaceDatabaseMetaData
-
supportsConvert
public boolean supportsConvert()
- Specified by:
supportsConvert
in interfaceDatabaseMetaData
-
supportsConvert
public boolean supportsConvert(int fromType, int toType)
Retrieves whether this database supports the JDBC scalar function CONVERT for conversions between the JDBC types fromType and toType. The JDBC types are the generic SQL data types defined in java.sql.Types.- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Parameters:
fromType
- the type to convert from; one of the type codes from the class java.sql.TypestoType
- the type to convert to; one of the type codes from the class java.sql.Types- Returns:
- true if so; false otherwise
-
supportsTableCorrelationNames
public boolean supportsTableCorrelationNames()
- Specified by:
supportsTableCorrelationNames
in interfaceDatabaseMetaData
-
supportsDifferentTableCorrelationNames
public boolean supportsDifferentTableCorrelationNames()
- Specified by:
supportsDifferentTableCorrelationNames
in interfaceDatabaseMetaData
-
supportsExpressionsInOrderBy
public boolean supportsExpressionsInOrderBy()
- Specified by:
supportsExpressionsInOrderBy
in interfaceDatabaseMetaData
-
supportsOrderByUnrelated
public boolean supportsOrderByUnrelated()
- Specified by:
supportsOrderByUnrelated
in interfaceDatabaseMetaData
-
supportsGroupBy
public boolean supportsGroupBy()
- Specified by:
supportsGroupBy
in interfaceDatabaseMetaData
-
supportsGroupByUnrelated
public boolean supportsGroupByUnrelated()
- Specified by:
supportsGroupByUnrelated
in interfaceDatabaseMetaData
-
supportsGroupByBeyondSelect
public boolean supportsGroupByBeyondSelect()
- Specified by:
supportsGroupByBeyondSelect
in interfaceDatabaseMetaData
-
supportsLikeEscapeClause
public boolean supportsLikeEscapeClause()
- Specified by:
supportsLikeEscapeClause
in interfaceDatabaseMetaData
-
supportsMultipleResultSets
public boolean supportsMultipleResultSets()
- Specified by:
supportsMultipleResultSets
in interfaceDatabaseMetaData
-
supportsMultipleTransactions
public boolean supportsMultipleTransactions()
- Specified by:
supportsMultipleTransactions
in interfaceDatabaseMetaData
-
supportsNonNullableColumns
public boolean supportsNonNullableColumns()
- Specified by:
supportsNonNullableColumns
in interfaceDatabaseMetaData
-
supportsMinimumSQLGrammar
public boolean supportsMinimumSQLGrammar()
- Specified by:
supportsMinimumSQLGrammar
in interfaceDatabaseMetaData
-
supportsCoreSQLGrammar
public boolean supportsCoreSQLGrammar()
- Specified by:
supportsCoreSQLGrammar
in interfaceDatabaseMetaData
-
supportsExtendedSQLGrammar
public boolean supportsExtendedSQLGrammar()
- Specified by:
supportsExtendedSQLGrammar
in interfaceDatabaseMetaData
-
supportsANSI92EntryLevelSQL
public boolean supportsANSI92EntryLevelSQL()
- Specified by:
supportsANSI92EntryLevelSQL
in interfaceDatabaseMetaData
-
supportsANSI92IntermediateSQL
public boolean supportsANSI92IntermediateSQL()
- Specified by:
supportsANSI92IntermediateSQL
in interfaceDatabaseMetaData
-
supportsANSI92FullSQL
public boolean supportsANSI92FullSQL()
- Specified by:
supportsANSI92FullSQL
in interfaceDatabaseMetaData
-
supportsIntegrityEnhancementFacility
public boolean supportsIntegrityEnhancementFacility()
- Specified by:
supportsIntegrityEnhancementFacility
in interfaceDatabaseMetaData
-
supportsOuterJoins
public boolean supportsOuterJoins()
- Specified by:
supportsOuterJoins
in interfaceDatabaseMetaData
-
supportsFullOuterJoins
public boolean supportsFullOuterJoins()
- Specified by:
supportsFullOuterJoins
in interfaceDatabaseMetaData
-
supportsLimitedOuterJoins
public boolean supportsLimitedOuterJoins()
- Specified by:
supportsLimitedOuterJoins
in interfaceDatabaseMetaData
-
getSchemaTerm
public String getSchemaTerm()
- Specified by:
getSchemaTerm
in interfaceDatabaseMetaData
-
getProcedureTerm
public String getProcedureTerm()
- Specified by:
getProcedureTerm
in interfaceDatabaseMetaData
-
getCatalogTerm
public String getCatalogTerm()
- Specified by:
getCatalogTerm
in interfaceDatabaseMetaData
-
isCatalogAtStart
public boolean isCatalogAtStart()
- Specified by:
isCatalogAtStart
in interfaceDatabaseMetaData
-
getCatalogSeparator
public String getCatalogSeparator()
- Specified by:
getCatalogSeparator
in interfaceDatabaseMetaData
-
supportsSchemasInDataManipulation
public boolean supportsSchemasInDataManipulation()
- Specified by:
supportsSchemasInDataManipulation
in interfaceDatabaseMetaData
-
supportsSchemasInProcedureCalls
public boolean supportsSchemasInProcedureCalls()
- Specified by:
supportsSchemasInProcedureCalls
in interfaceDatabaseMetaData
-
supportsSchemasInTableDefinitions
public boolean supportsSchemasInTableDefinitions()
- Specified by:
supportsSchemasInTableDefinitions
in interfaceDatabaseMetaData
-
supportsSchemasInIndexDefinitions
public boolean supportsSchemasInIndexDefinitions()
- Specified by:
supportsSchemasInIndexDefinitions
in interfaceDatabaseMetaData
-
supportsSchemasInPrivilegeDefinitions
public boolean supportsSchemasInPrivilegeDefinitions()
- Specified by:
supportsSchemasInPrivilegeDefinitions
in interfaceDatabaseMetaData
-
supportsCatalogsInDataManipulation
public boolean supportsCatalogsInDataManipulation()
- Specified by:
supportsCatalogsInDataManipulation
in interfaceDatabaseMetaData
-
supportsCatalogsInProcedureCalls
public boolean supportsCatalogsInProcedureCalls()
- Specified by:
supportsCatalogsInProcedureCalls
in interfaceDatabaseMetaData
-
supportsCatalogsInTableDefinitions
public boolean supportsCatalogsInTableDefinitions()
- Specified by:
supportsCatalogsInTableDefinitions
in interfaceDatabaseMetaData
-
supportsCatalogsInIndexDefinitions
public boolean supportsCatalogsInIndexDefinitions()
- Specified by:
supportsCatalogsInIndexDefinitions
in interfaceDatabaseMetaData
-
supportsCatalogsInPrivilegeDefinitions
public boolean supportsCatalogsInPrivilegeDefinitions()
- Specified by:
supportsCatalogsInPrivilegeDefinitions
in interfaceDatabaseMetaData
-
supportsPositionedDelete
public boolean supportsPositionedDelete()
- Specified by:
supportsPositionedDelete
in interfaceDatabaseMetaData
-
supportsPositionedUpdate
public boolean supportsPositionedUpdate()
- Specified by:
supportsPositionedUpdate
in interfaceDatabaseMetaData
-
supportsSelectForUpdate
public boolean supportsSelectForUpdate()
- Specified by:
supportsSelectForUpdate
in interfaceDatabaseMetaData
-
supportsStoredProcedures
public boolean supportsStoredProcedures()
- Specified by:
supportsStoredProcedures
in interfaceDatabaseMetaData
-
supportsSubqueriesInComparisons
public boolean supportsSubqueriesInComparisons()
- Specified by:
supportsSubqueriesInComparisons
in interfaceDatabaseMetaData
-
supportsSubqueriesInExists
public boolean supportsSubqueriesInExists()
- Specified by:
supportsSubqueriesInExists
in interfaceDatabaseMetaData
-
supportsSubqueriesInIns
public boolean supportsSubqueriesInIns()
- Specified by:
supportsSubqueriesInIns
in interfaceDatabaseMetaData
-
supportsSubqueriesInQuantifieds
public boolean supportsSubqueriesInQuantifieds()
- Specified by:
supportsSubqueriesInQuantifieds
in interfaceDatabaseMetaData
-
supportsCorrelatedSubqueries
public boolean supportsCorrelatedSubqueries()
- Specified by:
supportsCorrelatedSubqueries
in interfaceDatabaseMetaData
-
supportsUnion
public boolean supportsUnion()
- Specified by:
supportsUnion
in interfaceDatabaseMetaData
-
supportsUnionAll
public boolean supportsUnionAll()
- Specified by:
supportsUnionAll
in interfaceDatabaseMetaData
-
supportsOpenCursorsAcrossCommit
public boolean supportsOpenCursorsAcrossCommit()
- Specified by:
supportsOpenCursorsAcrossCommit
in interfaceDatabaseMetaData
-
supportsOpenCursorsAcrossRollback
public boolean supportsOpenCursorsAcrossRollback()
- Specified by:
supportsOpenCursorsAcrossRollback
in interfaceDatabaseMetaData
-
supportsOpenStatementsAcrossCommit
public boolean supportsOpenStatementsAcrossCommit()
- Specified by:
supportsOpenStatementsAcrossCommit
in interfaceDatabaseMetaData
-
supportsOpenStatementsAcrossRollback
public boolean supportsOpenStatementsAcrossRollback()
- Specified by:
supportsOpenStatementsAcrossRollback
in interfaceDatabaseMetaData
-
getMaxBinaryLiteralLength
public int getMaxBinaryLiteralLength()
- Specified by:
getMaxBinaryLiteralLength
in interfaceDatabaseMetaData
-
getMaxCharLiteralLength
public int getMaxCharLiteralLength()
- Specified by:
getMaxCharLiteralLength
in interfaceDatabaseMetaData
-
getMaxColumnNameLength
public int getMaxColumnNameLength()
- Specified by:
getMaxColumnNameLength
in interfaceDatabaseMetaData
-
getMaxColumnsInGroupBy
public int getMaxColumnsInGroupBy()
- Specified by:
getMaxColumnsInGroupBy
in interfaceDatabaseMetaData
-
getMaxColumnsInIndex
public int getMaxColumnsInIndex()
- Specified by:
getMaxColumnsInIndex
in interfaceDatabaseMetaData
-
getMaxColumnsInOrderBy
public int getMaxColumnsInOrderBy()
- Specified by:
getMaxColumnsInOrderBy
in interfaceDatabaseMetaData
-
getMaxColumnsInSelect
public int getMaxColumnsInSelect()
- Specified by:
getMaxColumnsInSelect
in interfaceDatabaseMetaData
-
getMaxColumnsInTable
public int getMaxColumnsInTable()
- Specified by:
getMaxColumnsInTable
in interfaceDatabaseMetaData
-
getMaxConnections
public int getMaxConnections()
- Specified by:
getMaxConnections
in interfaceDatabaseMetaData
-
getMaxCursorNameLength
public int getMaxCursorNameLength()
- Specified by:
getMaxCursorNameLength
in interfaceDatabaseMetaData
-
getMaxIndexLength
public int getMaxIndexLength()
- Specified by:
getMaxIndexLength
in interfaceDatabaseMetaData
-
getMaxSchemaNameLength
public int getMaxSchemaNameLength()
- Specified by:
getMaxSchemaNameLength
in interfaceDatabaseMetaData
-
getMaxProcedureNameLength
public int getMaxProcedureNameLength()
- Specified by:
getMaxProcedureNameLength
in interfaceDatabaseMetaData
-
getMaxCatalogNameLength
public int getMaxCatalogNameLength()
- Specified by:
getMaxCatalogNameLength
in interfaceDatabaseMetaData
-
getMaxRowSize
public int getMaxRowSize()
- Specified by:
getMaxRowSize
in interfaceDatabaseMetaData
-
doesMaxRowSizeIncludeBlobs
public boolean doesMaxRowSizeIncludeBlobs()
- Specified by:
doesMaxRowSizeIncludeBlobs
in interfaceDatabaseMetaData
-
getMaxStatementLength
public int getMaxStatementLength()
- Specified by:
getMaxStatementLength
in interfaceDatabaseMetaData
-
getMaxStatements
public int getMaxStatements()
- Specified by:
getMaxStatements
in interfaceDatabaseMetaData
-
getMaxTableNameLength
public int getMaxTableNameLength()
- Specified by:
getMaxTableNameLength
in interfaceDatabaseMetaData
-
getMaxTablesInSelect
public int getMaxTablesInSelect()
- Specified by:
getMaxTablesInSelect
in interfaceDatabaseMetaData
-
getMaxUserNameLength
public int getMaxUserNameLength()
- Specified by:
getMaxUserNameLength
in interfaceDatabaseMetaData
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()
- Specified by:
getDefaultTransactionIsolation
in interfaceDatabaseMetaData
-
supportsTransactions
public boolean supportsTransactions()
Retrieves whether this database supports transactions. If not, invoking the methodcommit
is a noop, and the isolation level isTRANSACTION_NONE
.- Specified by:
supportsTransactions
in interfaceDatabaseMetaData
- Returns:
true
if transactions are supported;false
otherwise
-
supportsTransactionIsolationLevel
public boolean supportsTransactionIsolationLevel(int level)
Retrieves whether this database supports the given transaction isolation level.- Specified by:
supportsTransactionIsolationLevel
in interfaceDatabaseMetaData
- Parameters:
level
- one of the transaction isolation levels defined injava.sql.Connection
- Returns:
true
if so;false
otherwise- See Also:
Connection
-
supportsDataDefinitionAndDataManipulationTransactions
public boolean supportsDataDefinitionAndDataManipulationTransactions()
- Specified by:
supportsDataDefinitionAndDataManipulationTransactions
in interfaceDatabaseMetaData
-
supportsDataManipulationTransactionsOnly
public boolean supportsDataManipulationTransactionsOnly()
- Specified by:
supportsDataManipulationTransactionsOnly
in interfaceDatabaseMetaData
-
dataDefinitionCausesTransactionCommit
public boolean dataDefinitionCausesTransactionCommit()
- Specified by:
dataDefinitionCausesTransactionCommit
in interfaceDatabaseMetaData
-
dataDefinitionIgnoredInTransactions
public boolean dataDefinitionIgnoredInTransactions()
- Specified by:
dataDefinitionIgnoredInTransactions
in interfaceDatabaseMetaData
-
getProcedures
public ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException
Retrieves a description of the stored procedures available in the given catalog. Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered byPROCEDURE_CAT
,PROCEDURE_SCHEM
,PROCEDURE_NAME
andSPECIFIC_ NAME
.Each procedure description has the following columns:
- PROCEDURE_CAT String
=>
procedure catalog (may benull
) - PROCEDURE_SCHEM String
=>
procedure schema (may benull
) - PROCEDURE_NAME String
=>
procedure name - reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String
=>
explanatory comment on the procedure - PROCEDURE_TYPE short
=>
kind of procedure:- procedureResultUnknown - Cannot determine if a return value will be returned
- procedureNoResult - Does not return a return value
- procedureReturnsResult - Returns a return value
- SPECIFIC_NAME String
=>
The name which uniquely identifies this procedure within its schema.
A user may not have permissions to execute any of the procedures that are returned by
getProcedures
- Specified by:
getProcedures
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchprocedureNamePattern
- a procedure name pattern; must match the procedure name as it is stored in the database- Returns:
ResultSet
- each row is a procedure description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- PROCEDURE_CAT String
-
getProcedureColumns
public ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException
Retrieves a description of the given catalog's stored procedure parameter and result columns.Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the
ResultSet
is a parameter description or column description with the following fields:- PROCEDURE_CAT String
=>
procedure catalog (may benull
) - PROCEDURE_SCHEM String
=>
procedure schema (may benull
) - PROCEDURE_NAME String
=>
procedure name - COLUMN_NAME String
=>
column/parameter name - COLUMN_TYPE Short
=>
kind of column/parameter:- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in
ResultSet
- DATA_TYPE int
=>
SQL type from java.sql.Types - TYPE_NAME String
=>
SQL type name, for a UDT type the type name is fully qualified - PRECISION int
=>
precision - LENGTH int
=>
length in bytes of data - SCALE short
=>
scale - null is returned for data types where SCALE is not applicable. - RADIX short
=>
radix - NULLABLE short
=>
can it contain NULL.- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
- REMARKS String
=>
comment describing parameter/column - COLUMN_DEF String
=>
default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may benull
)- The string NULL (not enclosed in quotes) - if NULL was specified as the default value
- TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation
- NULL - if a default value was not specified
- SQL_DATA_TYPE int
=>
reserved for future use - SQL_DATETIME_SUB int
=>
reserved for future use - CHAR_OCTET_LENGTH int
=>
the maximum length of binary and character based columns. For any other datatype the returned value is a NULL - ORDINAL_POSITION int
=>
the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 is returned if this row describes the procedure's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. If there are multiple result sets, the column ordinal positions are implementation defined. - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a column.- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
- SPECIFIC_NAME String
=>
the name which uniquely identifies this procedure within its schema.
Note: Some databases may not return the column descriptions for a procedure.
The PRECISION column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Specified by:
getProcedureColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchprocedureNamePattern
- a procedure name pattern; must match the procedure name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row describes a stored procedure parameter or column- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- PROCEDURE_CAT String
-
getFunctionColumns
public ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException
Retrieves a description of the given catalog's system or user function parameters and return type.Only descriptions matching the schema, function and parameter name criteria are returned. They are ordered by
FUNCTION_CAT
,FUNCTION_SCHEM
,FUNCTION_NAME
andSPECIFIC_ NAME
. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.Each row in the
ResultSet
is a parameter description, column description or return type description with the following fields:- FUNCTION_CAT String
=>
function catalog (may benull
) - FUNCTION_SCHEM String
=>
function schema (may benull
) - FUNCTION_NAME String
=>
function name. This is the name used to invoke the function - COLUMN_NAME String
=>
column/parameter name - COLUMN_TYPE Short
=>
kind of column/parameter:- functionColumnUnknown - nobody knows
- functionColumnIn - IN parameter
- functionColumnInOut - INOUT parameter
- functionColumnOut - OUT parameter
- functionColumnReturn - function return value
- functionColumnResult - Indicates that the parameter or column is a column in the
ResultSet
- DATA_TYPE int
=>
SQL type from java.sql.Types - TYPE_NAME String
=>
SQL type name, for a UDT type the type name is fully qualified - PRECISION int
=>
precision - LENGTH int
=>
length in bytes of data - SCALE short
=>
scale - null is returned for data types where SCALE is not applicable. - RADIX short
=>
radix - NULLABLE short
=>
can it contain NULL.- functionNoNulls - does not allow NULL values
- functionNullable - allows NULL values
- functionNullableUnknown - nullability unknown
- REMARKS String
=>
comment describing column/parameter - CHAR_OCTET_LENGTH int
=>
the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL - ORDINAL_POSITION int
=>
the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a parameter or column.- YES --- if the parameter or column can include NULLs
- NO --- if the parameter or column cannot include NULLs
- empty string --- if the nullability for the parameter or column is unknown
- SPECIFIC_NAME String
=>
the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then theFUNCTION_NAME
for example with overload functions
The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Specified by:
getFunctionColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchfunctionNamePattern
- a procedure name pattern; must match the function name as it is stored in the databasecolumnNamePattern
- a parameter name pattern; must match the parameter or column name as it is stored in the database- Returns:
ResultSet
- each row describes a user function parameter, column or return type- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
- See Also:
getSearchStringEscape()
- FUNCTION_CAT String
-
getSchemas
public ResultSet getSchemas() throws SQLException
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getSchemas
public ResultSet getSchemas(String catalog, String schemaPattern) throws SQLException
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getCatalogs
public ResultSet getCatalogs() throws SQLException
- Specified by:
getCatalogs
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getTableTypes
public ResultSet getTableTypes() throws SQLException
- Specified by:
getTableTypes
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getColumnPrivileges
public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException
Retrieves a description of the access rights for a table's columns.Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilege description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - GRANTOR String
=>
grantor of access (may benull
) - GRANTEE String
=>
grantee of access - PRIVILEGE String
=>
name of access (SELECT, INSERT, UPDATE, REFRENCES, ...) - IS_GRANTABLE String
=>
"YES" if grantee is permitted to grant to others; "NO" if not;null
if unknown
- Specified by:
getColumnPrivileges
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column privilege description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- TABLE_CAT String
-
getTablePrivileges
public ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException
Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)Only privileges matching the schema and table name criteria are returned. They are ordered by
TABLE_CAT
,TABLE_SCHEM
,TABLE_NAME
, andPRIVILEGE
.Each privilege description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - GRANTOR String
=>
grantor of access (may benull
) - GRANTEE String
=>
grantee of access - PRIVILEGE String
=>
name of access (SELECT, INSERT, UPDATE, REFRENCES, ...) - IS_GRANTABLE String
=>
"YES" if grantee is permitted to grant to others; "NO" if not;null
if unknown
- Specified by:
getTablePrivileges
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a table privilege description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- TABLE_CAT String
-
getVersionColumns
public ResultSet getVersionColumns(String catalog, String schema, String table) throws SQLException
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.Each column description has the following columns:
- SCOPE short
=>
is not used - COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL data type fromjava.sql.Types
- TYPE_NAME String
=>
Data source-dependent type name - COLUMN_SIZE int
=>
precision - BUFFER_LENGTH int
=>
length of column value in bytes - DECIMAL_DIGITS short
=>
scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. - PSEUDO_COLUMN short
=>
whether this is pseudo column like an Oracle ROWID- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Specified by:
getVersionColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the database- Returns:
- a
ResultSet
object in which each row is a column description - Throws:
SQLException
- if a database access error occurs
- SCOPE short
-
getCrossReference
public ResultSet getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException
Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table). The number of columns returned from the parent table must match the number of columns that make up the foreign key. They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String
=>
parent key table catalog (may benull
) - PKTABLE_SCHEM String
=>
parent key table schema (may benull
) - PKTABLE_NAME String
=>
parent key table name - PKCOLUMN_NAME String
=>
parent key column name - FKTABLE_CAT String
=>
foreign key table catalog (may benull
) being exported (may benull
) - FKTABLE_SCHEM String
=>
foreign key table schema (may benull
) being exported (may benull
) - FKTABLE_NAME String
=>
foreign key table name being exported - FKCOLUMN_NAME String
=>
foreign key column name being exported - KEY_SEQ short
=>
sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key). - UPDATE_RULE short
=>
What happens to foreign key when parent key is updated:- importedNoAction - do not allow update of parent key if it has been imported
- importedKeyCascade - change imported key to agree with parent key update
- importedKeySetNull - change imported key to
NULL
if its parent key has been updated - importedKeySetDefault - change imported key to default values if its parent key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short
=>
What happens to the foreign key when parent key is deleted.- importedKeyNoAction - do not allow delete of parent 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 parent key has been deleted
- FK_NAME String
=>
foreign key name (may benull
) - PK_NAME String
=>
parent key name (may benull
) - DEFERRABILITY short
=>
can the evaluation of foreign key constraints be deferred until commit- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getCrossReference
in interfaceDatabaseMetaData
- Parameters:
parentCatalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaparentSchema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means drop schema name from the selection criteriaparentTable
- the name of the table that exports the key; pattern, or null (means any table) valueforeignCatalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaforeignSchema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means drop schema name from the selection criteriaforeignTable
- the name of the table that imports the key; pattern, or null (means any table) value is stored in the database- Returns:
ResultSet
- each row is a foreign key column description- Throws:
SQLException
- if a database access error occurs- See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String, org.mariadb.jdbc.Connection)
- PKTABLE_CAT String
-
getTypeInfo
public ResultSet getTypeInfo()
Retrieves a description of all the data types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.If the database supports SQL distinct types, then getTypeInfo() will return a single row with a TYPE_NAME of DISTINCT and a DATA_TYPE of Types.DISTINCT. If the database supports SQL structured types, then getTypeInfo() will return a single row with a TYPE_NAME of STRUCT and a DATA_TYPE of Types.STRUCT.
If SQL distinct or structured types are supported, then information on the individual types may be obtained from the getUDTs() method.
Each type description has the following columns:
- TYPE_NAME String
=>
Type name - DATA_TYPE int
=>
SQL data type from java.sql.Types - PRECISION int
=>
maximum precision - LITERAL_PREFIX String
=>
prefix used to quote a literal (may benull
) - LITERAL_SUFFIX String
=>
suffix used to quote a literal (may benull
) - CREATE_PARAMS String
=>
parameters used in creating the type (may benull
) - NULLABLE short
=>
can you use NULL for this type.- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean
=>
is it case sensitive. - SEARCHABLE short
=>
can you use "WHERE" based on this type:- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean
=>
is it unsigned. - FIXED_PREC_SCALE boolean
=>
can it be a money value. - AUTO_INCREMENT boolean
=>
can it be used for an auto-increment value. - LOCAL_TYPE_NAME String
=>
localized version of type name (may benull
) - MINIMUM_SCALE short
=>
minimum scale supported - MAXIMUM_SCALE short
=>
maximum scale supported - SQL_DATA_TYPE int
=>
unused - SQL_DATETIME_SUB int
=>
unused - NUM_PREC_RADIX int
=>
usually 2 or 10
The PRECISION column represents the maximum column size that the server supports for the given datatype. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Specified by:
getTypeInfo
in interfaceDatabaseMetaData
- Returns:
- a
ResultSet
object in which each row is an SQL type description
- TYPE_NAME String
-
getIndexInfo
public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException
Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.Each index column description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - NON_UNIQUE boolean
=>
Can index values be non-unique. false when TYPE is tableIndexStatistic - INDEX_QUALIFIER String
=>
index catalog (may benull
);null
when TYPE is tableIndexStatistic - INDEX_NAME String
=>
index name;null
when TYPE is tableIndexStatistic - TYPE short
=>
index type:- tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
- ORDINAL_POSITION short
=>
column sequence number within index; zero when TYPE is tableIndexStatistic - COLUMN_NAME String
=>
column name;null
when TYPE is tableIndexStatistic - ASC_OR_DESC String
=>
column sort sequence, "A"=>
ascending, "D"=>
descending, may benull
if sort sequence is not supported;null
when TYPE is tableIndexStatistic - CARDINALITY long
=>
When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index. - PAGES long
=>
When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index. - FILTER_CONDITION String
=>
Filter condition, if any. (may benull
)
- Specified by:
getIndexInfo
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in this database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in this databaseunique
- when true, return only indices for unique values; when false, return indices regardless of whether unique or notapproximate
- 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 a database access error occurs
- TABLE_CAT String
-
supportsResultSetType
public boolean supportsResultSetType(int type)
Retrieves whether this database supports the given result set type. ResultSet.TYPE_FORWARD_ONLY and ResultSet.TYPE_SCROLL_INSENSITIVE are supported.- Specified by:
supportsResultSetType
in interfaceDatabaseMetaData
- Parameters:
type
- one of the followingResultSet
constants:ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
- true if supported
-
supportsResultSetConcurrency
public boolean supportsResultSetConcurrency(int type, int concurrency)
Retrieves whether this database supports the given concurrency type in combination with the given result set type. All are supported, but combination that use ResultSet.TYPE_SCROLL_INSENSITIVE.- Specified by:
supportsResultSetConcurrency
in interfaceDatabaseMetaData
- Parameters:
type
- one of the followingResultSet
constants:ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE
concurrency
- one of the followingResultSet
constants:ResultSet.CONCUR_READ_ONLY
ResultSet.CONCUR_UPDATABLE
- Returns:
- true if supported
-
ownUpdatesAreVisible
public boolean ownUpdatesAreVisible(int type)
- Specified by:
ownUpdatesAreVisible
in interfaceDatabaseMetaData
-
ownDeletesAreVisible
public boolean ownDeletesAreVisible(int type)
- Specified by:
ownDeletesAreVisible
in interfaceDatabaseMetaData
-
ownInsertsAreVisible
public boolean ownInsertsAreVisible(int type)
- Specified by:
ownInsertsAreVisible
in interfaceDatabaseMetaData
-
othersUpdatesAreVisible
public boolean othersUpdatesAreVisible(int type)
- Specified by:
othersUpdatesAreVisible
in interfaceDatabaseMetaData
-
othersDeletesAreVisible
public boolean othersDeletesAreVisible(int type)
- Specified by:
othersDeletesAreVisible
in interfaceDatabaseMetaData
-
othersInsertsAreVisible
public boolean othersInsertsAreVisible(int type)
- Specified by:
othersInsertsAreVisible
in interfaceDatabaseMetaData
-
updatesAreDetected
public boolean updatesAreDetected(int type)
- Specified by:
updatesAreDetected
in interfaceDatabaseMetaData
-
deletesAreDetected
public boolean deletesAreDetected(int type)
- Specified by:
deletesAreDetected
in interfaceDatabaseMetaData
-
insertsAreDetected
public boolean insertsAreDetected(int type)
- Specified by:
insertsAreDetected
in interfaceDatabaseMetaData
-
supportsBatchUpdates
public boolean supportsBatchUpdates()
- Specified by:
supportsBatchUpdates
in interfaceDatabaseMetaData
-
getUDTs
public ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException
Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have typeJAVA_OBJECT
,STRUCT
, orDISTINCT
.Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by
DATA_TYPE
,TYPE_CAT
,TYPE_SCHEM
andTYPE_NAME
. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.Each type description has the following columns:
- TYPE_CAT String
=>
the type's catalog (may benull
) - TYPE_SCHEM String
=>
type's schema (may benull
) - TYPE_NAME String
=>
type name - CLASS_NAME String
=>
Java class name - DATA_TYPE int
=>
type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT - REMARKS String
=>
explanatory comment on the type - BASE_TYPE short
=>
type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in java.sql.Types (null
if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty result set is returned.
- Specified by:
getUDTs
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema pattern name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtypeNamePattern
- a type name pattern; must match the type name as it is stored in the database; may be a fully qualified nametypes
- a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include;null
returns all types- Returns:
ResultSet
object in which each row describes a UDT- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
getSearchStringEscape()
- TYPE_CAT String
-
getConnection
public Connection getConnection()
- Specified by:
getConnection
in interfaceDatabaseMetaData
-
supportsSavepoints
public boolean supportsSavepoints()
- Specified by:
supportsSavepoints
in interfaceDatabaseMetaData
-
supportsNamedParameters
public boolean supportsNamedParameters()
- Specified by:
supportsNamedParameters
in interfaceDatabaseMetaData
-
supportsMultipleOpenResults
public boolean supportsMultipleOpenResults()
- Specified by:
supportsMultipleOpenResults
in interfaceDatabaseMetaData
-
supportsGetGeneratedKeys
public boolean supportsGetGeneratedKeys()
- Specified by:
supportsGetGeneratedKeys
in interfaceDatabaseMetaData
-
getSuperTypes
public ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ subtype relationship is modeled. Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored. If a UDT does not have a direct super type, it is not listed here. A row of theResultSet
object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:- TYPE_CAT String
=>
the UDT's catalog (may benull
) - TYPE_SCHEM String
=>
UDT's schema (may benull
) - TYPE_NAME String
=>
type name of the UDT - SUPERTYPE_CAT String
=>
the direct super type's catalog (may benull
) - SUPERTYPE_SCHEM String
=>
the direct super type's schema (may benull
) - SUPERTYPE_NAME String
=>
the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
- Specified by:
getSuperTypes
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematypeNamePattern
- a UDT name pattern; may be a fully-qualified name- Returns:
- a
ResultSet
object in which a row gives information about the designated UDT - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getSearchStringEscape()
- TYPE_CAT String
-
getSuperTables
public ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLException
Retrieves a description of the table hierarchies defined in a particular schema in this database.Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully-qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.
Each type description has the following columns:
- TABLE_CAT String
=>
the type's catalog (may benull
) - TABLE_SCHEM String
=>
type's schema (may benull
) - TABLE_NAME String
=>
type name - SUPERTABLE_NAME String
=>
the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
- Specified by:
getSuperTables
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name pattern; may be a fully-qualified name- Returns:
- a
ResultSet
object in which each row is a type description - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getSearchStringEscape()
- TABLE_CAT String
-
getAttributes
public ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException
Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog. Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered byTYPE_CAT
,TYPE_SCHEM
,TYPE_NAME
andORDINAL_POSITION
. This description does not contain inherited attributes. TheResultSet
object that is returned has the following columns:- TYPE_CAT String
=>
type catalog (may benull
) - TYPE_SCHEM String
=>
type schema (may benull
) - TYPE_NAME String
=>
type name - ATTR_NAME String
=>
attribute name - DATA_TYPE int
=>
attribute type SQL type from java.sql.Types - ATTR_TYPE_NAME String
=>
Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type. - ATTR_SIZE int
=>
column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision. - DECIMAL_DIGITS int
=>
the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. - NUM_PREC_RADIX int
=>
Radix (typically either 10 or 2) - NULLABLE int
=>
whether NULL is allowed- attributeNoNulls - might not allow NULL values
- attributeNullable - definitely allows NULL values
- attributeNullableUnknown - nullability unknown
- REMARKS String
=>
comment describing column (may benull
) - ATTR_DEF String
=>
default value (may benull
) - SQL_DATA_TYPE int
=>
unused - SQL_DATETIME_SUB int
=>
unused - CHAR_OCTET_LENGTH int
=>
for char types the maximum number of bytes in the column - ORDINAL_POSITION int
=>
index of the attribute in the UDT (starting at 1) - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a attribute.- YES --- if the attribute can include NULLs
- NO --- if the attribute cannot include NULLs
- empty string --- if the nullability for the attribute is unknown
- SCOPE_CATALOG String
=>
catalog of table that is the scope of a reference attribute (null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String
=>
schema of table that is the scope of a reference attribute (null
if DATA_TYPE isn't REF) - SCOPE_TABLE String
=>
table name that is the scope of a reference attribute (null
if the DATA_TYPE isn't REF) - SOURCE_DATA_TYPE short
=>
source type of a distinct type or user-generated Ref type,SQL type from java.sql.Types (null
if DATA_TYPE isn't DISTINCT or user-generated REF)
- Specified by:
getAttributes
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtypeNamePattern
- a type name pattern; must match the type name as it is stored in the databaseattributeNamePattern
- an attribute name pattern; must match the attribute name as it is declared in the database- Returns:
- a
ResultSet
object in which each row is an attribute description - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
getSearchStringEscape()
- TYPE_CAT String
-
supportsResultSetHoldability
public boolean supportsResultSetHoldability(int holdability)
- Specified by:
supportsResultSetHoldability
in interfaceDatabaseMetaData
-
getResultSetHoldability
public int getResultSetHoldability()
- Specified by:
getResultSetHoldability
in interfaceDatabaseMetaData
-
getDatabaseMajorVersion
public int getDatabaseMajorVersion()
- Specified by:
getDatabaseMajorVersion
in interfaceDatabaseMetaData
-
getDatabaseMinorVersion
public int getDatabaseMinorVersion()
- Specified by:
getDatabaseMinorVersion
in interfaceDatabaseMetaData
-
getJDBCMajorVersion
public int getJDBCMajorVersion()
- Specified by:
getJDBCMajorVersion
in interfaceDatabaseMetaData
-
getJDBCMinorVersion
public int getJDBCMinorVersion()
- Specified by:
getJDBCMinorVersion
in interfaceDatabaseMetaData
-
getSQLStateType
public int getSQLStateType()
- Specified by:
getSQLStateType
in interfaceDatabaseMetaData
-
locatorsUpdateCopy
public boolean locatorsUpdateCopy()
- Specified by:
locatorsUpdateCopy
in interfaceDatabaseMetaData
-
supportsStatementPooling
public boolean supportsStatementPooling()
- Specified by:
supportsStatementPooling
in interfaceDatabaseMetaData
-
getRowIdLifetime
public RowIdLifetime getRowIdLifetime()
- Specified by:
getRowIdLifetime
in interfaceDatabaseMetaData
-
supportsStoredFunctionsUsingCallSyntax
public boolean supportsStoredFunctionsUsingCallSyntax()
- Specified by:
supportsStoredFunctionsUsingCallSyntax
in interfaceDatabaseMetaData
-
autoCommitFailureClosesAllResultSets
public boolean autoCommitFailureClosesAllResultSets()
- Specified by:
autoCommitFailureClosesAllResultSets
in interfaceDatabaseMetaData
-
getClientInfoProperties
public ResultSet getClientInfoProperties()
Retrieves a list of the client info properties that the driver supports. The result set contains the following columns- NAME String : The name of the client info property
- MAX_LEN int : The maximum length of the value for the property
- DEFAULT_VALUE String : The default value of the property
- DESCRIPTION String : A description of the property. This will typically contain information as to where this property is stored in the database.
The ResultSet is sorted by the NAME column
- Specified by:
getClientInfoProperties
in interfaceDatabaseMetaData
- Returns:
- A ResultSet object; each row is a supported client info property
-
getFunctions
public ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException
Retrieves a description of the system and user functions available in the given catalog. Only system and user function descriptions matching the schema and function name criteria are returned. They are ordered byFUNCTION_CAT
,FUNCTION_SCHEM
,FUNCTION_NAME
andSPECIFIC_ NAME
.Each function description has the following columns:
- FUNCTION_CAT String
=>
function catalog (may benull
) - FUNCTION_SCHEM String
=>
function schema (may benull
) - FUNCTION_NAME String
=>
function name. This is the name used to invoke the function - REMARKS String
=>
explanatory comment on the function - FUNCTION_TYPE short
=>
kind of function:- functionResultUnknown - Cannot determine if a return value or table will be returned
- functionNoTable- Does not return a table
- functionReturnsTable - Returns a table
- SPECIFIC_NAME String
=>
the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then theFUNCTION_NAME
for example with overload functions
A user may not have permission to execute any of the functions that are returned by
getFunctions
- Specified by:
getFunctions
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchfunctionNamePattern
- a function name pattern; must match the function name as it is stored in the database- Returns:
ResultSet
- each row is a function description- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
- See Also:
getSearchStringEscape()
- FUNCTION_CAT String
-
unwrap
public <T> T unwrap(Class<T> iface) throws SQLException
- Specified by:
unwrap
in interfaceWrapper
- Throws:
SQLException
-
isWrapperFor
public boolean isWrapperFor(Class<?> iface)
- Specified by:
isWrapperFor
in interfaceWrapper
-
getMaxLogicalLobSize
public long getMaxLogicalLobSize()
- Specified by:
getMaxLogicalLobSize
in interfaceDatabaseMetaData
-
-