DatabaseMetaData

ldbc.sql.DatabaseMetaData
See theDatabaseMetaData companion object
trait DatabaseMetaData[F[_]]

Comprehensive information about the database as a whole.

This interface is implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBC™ technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.

A user for this interface is commonly a tool that needs to discover how to deal with the underlying DBMS. This is especially true for applications that are intended to be used with more than one DBMS. For example, a tool might use the method getTypeInfo to find out what data types can be used in a CREATE TABLE statement. Or a user might call the method supportsCorrelatedSubqueries to see if it is possible to use a correlated subquery or supportsBatchUpdates to see if it is possible to use batch updates.

Some DatabaseMetaData methods return lists of information in the form of ResultSet objects. Regular ResultSet methods, such as getString and getInt, can be used to retrieve the data from these ResultSet objects. If a given form of metadata is not available, an empty ResultSet will be returned. Additional columns beyond the columns defined to be returned by the ResultSet object for a given method can be defined by the JDBC driver vendor and must be accessed by their column label.

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

Type parameters

F

the effect type

Attributes

Companion
object
Source
DatabaseMetaData.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

Retrieves whether the current user can call all the procedures returned by the method getProcedures.

Retrieves whether the current user can call all the procedures returned by the method getProcedures.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.

Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a SQLException while autoCommit is true indicates that all open ResultSets are closed, even ones that are holdable. When a SQLException occurs while autocommit is true, it is vendor specific whether the JDBC driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.

Retrieves whether a SQLException while autoCommit is true indicates that all open ResultSets are closed, even ones that are holdable. When a SQLException occurs while autocommit is true, it is vendor specific whether the JDBC driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a data definition statement within a transaction forces the transaction to commit.

Retrieves whether a data definition statement within a transaction forces the transaction to commit.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database ignores a data definition statement within a transaction.

Retrieves whether this database ignores a data definition statement within a transaction.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted. If the method deletesAreDetected returns false, it means that deleted rows are removed from the result set.

Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted. If the method deletesAreDetected returns false, it means that deleted rows are removed from the result set.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if deletes are detected by the given result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a generated key will always be returned if the column name(s) or index(es) specified for the auto generated key column(s) are valid and the statement succeeds. The key that is returned may or may not be based on the column(s) for the auto generated key. Consult your JDBC driver documentation for additional details.

Retrieves whether a generated key will always be returned if the column name(s) or index(es) specified for the auto generated key column(s) are valid and the statement succeeds. The key that is returned may or may not be based on the column(s) for the auto generated key. Consult your JDBC driver documentation for additional details.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala
def getAttributes(catalog: Option[String], schemaPattern: Option[String], typeNamePattern: Option[String], attributeNamePattern: Option[String]): ResultSet

Attributes

Source
DatabaseMetaData.scala
def getBestRowIdentifier(catalog: Option[String], schema: Option[String], table: String, scope: Option[Int], nullable: Option[Boolean]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves the String that this database uses as the separator between a catalog and table name.

Retrieves the String that this database uses as the separator between a catalog and table name.

Attributes

Returns

the separator string

Source
DatabaseMetaData.scala

Retrieves the database vendor's preferred term for "catalog".

Retrieves the database vendor's preferred term for "catalog".

Attributes

Returns

the vendor term for "catalog"

Source
DatabaseMetaData.scala

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

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

The catalog column is:

  1. TABLE_CAT String => catalog name

Attributes

Returns

a ResultSet object in which each row has a single String column that is a catalog name

Source
DatabaseMetaData.scala

Retrieves a list of the client info properties that the driver supports. The result set contains the following columns

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

Attributes

Returns

A ResultSet object; each row is a supported client info property

Source
DatabaseMetaData.scala
def getColumnPrivileges(catalog: Option[String], schema: Option[String], table: Option[String], columnNamePattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala
def getColumns(catalog: Option[String], schemaPattern: Option[String], tableName: Option[String], columnNamePattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves the connection that produced this metadata object.

Retrieves the connection that produced this metadata object.

Attributes

Returns

the connection that produced this metadata object

Source
DatabaseMetaData.scala
def getCrossReference(parentCatalog: Option[String], parentSchema: Option[String], parentTable: String, foreignCatalog: Option[String], foreignSchema: Option[String], foreignTable: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves the major version number of the underlying database.

Retrieves the major version number of the underlying database.

Attributes

Returns

the underlying database's major version

Source
DatabaseMetaData.scala

Retrieves the minor version number of the underlying database.

Retrieves the minor version number of the underlying database.

Attributes

Returns

underlying database's minor version

Source
DatabaseMetaData.scala

Retrieves the name of this database product.

Retrieves the name of this database product.

Attributes

Returns

database product name

Source
DatabaseMetaData.scala

Retrieves the version number of this database product.

Retrieves the version number of this database product.

Attributes

Returns

database version number

Source
DatabaseMetaData.scala

Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection.

Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection.

Attributes

Returns

the default isolation level

Source
DatabaseMetaData.scala

Retrieves this JDBC driver's major version number.

Retrieves this JDBC driver's major version number.

Attributes

Returns

JDBC driver major version

Source
DatabaseMetaData.scala

Retrieves this JDBC driver's minor version number.

Retrieves this JDBC driver's minor version number.

Attributes

Returns

JDBC driver minor version number

Source
DatabaseMetaData.scala

Retrieves the name of this JDBC driver.

Retrieves the name of this JDBC driver.

Attributes

Returns

JDBC driver name

Source
DatabaseMetaData.scala

Retrieves the version number of this JDBC driver as a String.

Retrieves the version number of this JDBC driver as a String.

Attributes

Returns

JDBC driver version

Source
DatabaseMetaData.scala
def getExportedKeys(catalog: Option[String], schema: Option[String], table: String): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

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

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

Attributes

Returns

the string containing the extra characters

Source
DatabaseMetaData.scala
def getFunctionColumns(catalog: Option[String], schemaPattern: Option[String], functionNamePattern: Option[String], columnNamePattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala
def getFunctions(catalog: Option[String], schemaPattern: Option[String], functionNamePattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.

Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.

Attributes

Returns

the quoting string or a space if quoting is not supported

Source
DatabaseMetaData.scala
def getImportedKeys(catalog: Option[String], schema: Option[String], table: String): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala
def getIndexInfo(catalog: Option[String], schema: Option[String], table: Option[String], unique: Boolean, approximate: Boolean): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves the major JDBC version number for this driver.

Retrieves the major JDBC version number for this driver.

Attributes

Returns

JDBC version major number

Source
DatabaseMetaData.scala

Retrieves the minor JDBC version number for this driver.

Retrieves the minor JDBC version number for this driver.

Attributes

Returns

JDBC version minor number

Source
DatabaseMetaData.scala

Retrieves the maximum number of hex characters this database allows in an inline binary literal.

Retrieves the maximum number of hex characters this database allows in an inline binary literal.

Attributes

Returns

max the maximum length (in hex characters) for a binary literal; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters that this database allows in a catalog name.

Retrieves the maximum number of characters that this database allows in a catalog name.

Attributes

Returns

the maximum number of characters allowed in a catalog name; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters this database allows for a character literal.

Retrieves the maximum number of characters this database allows for a character literal.

Attributes

Returns

the maximum number of characters allowed for a character literal; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters this database allows for a column name.

Retrieves the maximum number of characters this database allows for a column name.

Attributes

Returns

the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of columns this database allows in a GROUP BY clause.

Retrieves the maximum number of columns this database allows in a GROUP BY clause.

Attributes

Returns

the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of columns this database allows in an index.

Retrieves the maximum number of columns this database allows in an index.

Attributes

Returns

the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of columns this database allows in an ORDER BY clause.

Retrieves the maximum number of columns this database allows in an ORDER BY clause.

Attributes

Returns

the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of columns this database allows in a SELECT list.

Retrieves the maximum number of columns this database allows in a SELECT list.

Attributes

Returns

the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of columns this database allows in a table.

Retrieves the maximum number of columns this database allows in a table.

Attributes

Returns

the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of concurrent connections to this database that are possible.

Retrieves the maximum number of concurrent connections to this database that are possible.

Attributes

Returns

the maximum number of active connections possible at one time; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters that this database allows in a cursor name.

Retrieves the maximum number of characters that this database allows in a cursor name.

Attributes

Returns

the maximum number of characters allowed in a cursor name; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

Attributes

Returns

the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters that this database allows in a procedure name.

Retrieves the maximum number of characters that this database allows in a procedure name.

Attributes

Returns

the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of bytes this database allows in a single row.

Retrieves the maximum number of bytes this database allows in a single row.

Attributes

Returns

the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters that this database allows in a schema name.

Retrieves the maximum number of characters that this database allows in a schema name.

Attributes

Returns

the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters this database allows in an SQL statement.

Retrieves the maximum number of characters this database allows in an SQL statement.

Attributes

Returns

the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of active statements to this database that can be open at the same time.

Retrieves the maximum number of active statements to this database that can be open at the same time.

Attributes

Returns

the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters this database allows in a table name.

Retrieves the maximum number of characters this database allows in a table name.

Attributes

Returns

the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of tables this database allows in a SELECT statement.

Retrieves the maximum number of tables this database allows in a SELECT statement.

Attributes

Returns

the maximum number of tables allowed in a SELECT statement; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves the maximum number of characters this database allows in a user name.

Retrieves the maximum number of characters this database allows in a user name.

Attributes

Returns

the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala

Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.

Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.

Attributes

Returns

the list of math functions supported by this database

Source
DatabaseMetaData.scala
def getPrimaryKeys(catalog: Option[String], schema: Option[String], table: String): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala
def getProcedureColumns(catalog: Option[String], schemaPattern: Option[String], procedureNamePattern: Option[String], columnNamePattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves the database vendor's preferred term for "procedure".

Retrieves the database vendor's preferred term for "procedure".

Attributes

Returns

the vendor term for "procedure"

Source
DatabaseMetaData.scala
def getProcedures(catalog: Option[String], schemaPattern: Option[String], procedureNamePattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala
def getPseudoColumns(catalog: Option[String], schemaPattern: Option[String], tableNamePattern: Option[String], columnNamePattern: Option[String]): ResultSet

Attributes

Source
DatabaseMetaData.scala

Retrieves this database's default holdability for ResultSet objects.

Retrieves this database's default holdability for ResultSet objects.

Attributes

Returns

the default holdability; either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Source
DatabaseMetaData.scala

Indicates whether this data source supports the SQL ROWID type, and the lifetime for which a [[RowId]] object remains valid.

Indicates whether this data source supports the SQL ROWID type, and the lifetime for which a [[RowId]] object remains valid.

Attributes

Returns

the status indicating the lifetime of a RowId

Source
DatabaseMetaData.scala

Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.

Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.

Attributes

Returns

the list of this database's keywords that are not also SQL:2003 keywords

Source
DatabaseMetaData.scala

Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.

Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.

Attributes

Returns

the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL

Source
DatabaseMetaData.scala

Retrieves the database vendor's preferred term for "schema".

Retrieves the database vendor's preferred term for "schema".

Attributes

Returns

the vendor term for "schema"

Source
DatabaseMetaData.scala
def getSchemas(catalog: Option[String], schemaPattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).

Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).

The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.

Attributes

Returns

the string used to escape wildcard characters

Source
DatabaseMetaData.scala

Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.

Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.

Attributes

Returns

the list of string functions supported by this database

Source
DatabaseMetaData.scala
def getSuperTables(catalog: Option[String], schemaPattern: Option[String], tableNamePattern: Option[String]): ResultSet

Attributes

Source
DatabaseMetaData.scala
def getSuperTypes(catalog: Option[String], schemaPattern: Option[String], typeNamePattern: Option[String]): ResultSet

Attributes

Source
DatabaseMetaData.scala

Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.

Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.

Attributes

Returns

a list of system functions supported by this database

Source
DatabaseMetaData.scala
def getTablePrivileges(catalog: Option[String], schemaPattern: Option[String], tableNamePattern: Option[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

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

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

The table type is:

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

Attributes

Returns

a ResultSet object in which each row has a single String column that is a table type

Source
DatabaseMetaData.scala
def getTables(catalog: Option[String], schemaPattern: Option[String], tableNamePattern: Option[String], types: Array[String]): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves a comma-separated list of the time and date functions available with this database.

Retrieves a comma-separated list of the time and date functions available with this database.

Attributes

Returns

the list of time and date functions supported by this database

Source
DatabaseMetaData.scala

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.

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:

  1. TYPE_NAME String => Type name
  2. DATA_TYPE int => SQL data type from java.sql.Types
  3. PRECISION int => maximum precision
  4. LITERAL_PREFIX String => prefix used to quote a literal (may be null)
  5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
  6. CREATE_PARAMS String => parameters used in creating the type (may be null)
  7. NULLABLE short => can you use NULL for this type.
    • typeNoNulls - does not allow NULL values
    • typeNullable - allows NULL values
    • typeNullableUnknown - nullability unknown
  8. CASE_SENSITIVE boolean=> is it case sensitive.
  9. SEARCHABLE short => can you use "WHERE" based on this type:
    • typePredNone - No support
    • typePredChar - Only supported with WHERE .. LIKE
    • typePredBasic - Supported except for WHERE .. LIKE
    • typeSearchable - Supported for all WHERE ..
  10. UNSIGNED_ATTRIBUTE boolean => is it unsigned.
  11. FIXED_PREC_SCALE boolean => can it be a money value.
  12. AUTO_INCREMENT boolean => can it be used for an auto-increment value.
  13. LOCAL_TYPE_NAME String => localized version of type name (may be null)
  14. MINIMUM_SCALE short => minimum scale supported
  15. MAXIMUM_SCALE short => maximum scale supported
  16. SQL_DATA_TYPE int => unused
  17. SQL_DATETIME_SUB int => unused
  18. NUM_PREC_RADIX int => usually 2 or 10

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.

Attributes

Returns

a ResultSet object in which each row is an SQL type description

Source
DatabaseMetaData.scala
def getUDTs(catalog: Option[String], schemaPattern: Option[String], typeNamePattern: Option[String], types: Array[Int]): ResultSet

Attributes

Source
DatabaseMetaData.scala
def getURL(): String

Retrieves the URL for this DBMS.

Retrieves the URL for this DBMS.

Attributes

Returns

the URL for this DBMS

Source
DatabaseMetaData.scala
def getUserName(): F[String]

Retrieves the user name as known to this database.

Retrieves the user name as known to this database.

Attributes

Returns

the database user name

Source
DatabaseMetaData.scala
def getVersionColumns(catalog: Option[String], schema: Option[String], table: String): F[ResultSet]

Attributes

Source
DatabaseMetaData.scala

Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.

Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if changes are detected by the specified result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.

Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.

Attributes

Returns

true if the catalog name appears at the beginning of a fully qualified table name; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database is in read-only mode.

Retrieves whether this database is in read-only mode.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

Attributes

Returns

true if updates are made to a copy of the LOB; false if updates are made directly to the LOB

Source
DatabaseMetaData.scala

Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.

Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether NULL values are sorted at the end regardless of sort order.

Retrieves whether NULL values are sorted at the end regardless of sort order.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether NULL values are sorted at the start regardless of sort order.

Retrieves whether NULL values are sorted at the start regardless of sort order.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether deletes made by others are visible.

Retrieves whether deletes made by others are visible.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if deletes made by others are visible for the given result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether inserts made by others are visible.

Retrieves whether inserts made by others are visible.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if inserts made by others are visible for the given result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether updates made by others are visible.

Retrieves whether updates made by others are visible.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if updates made by others are visible for the given result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a result set's own deletes are visible.

Retrieves whether a result set's own deletes are visible.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if deletes are visible for the given result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a result set's own inserts are visible.

Retrieves whether a result set's own inserts are visible.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if inserts are visible for the given result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the ANSI92 entry level SQL grammar.

Retrieves whether this database supports the ANSI92 entry level SQL grammar.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the ANSI92 full SQL grammar supported.

Retrieves whether this database supports the ANSI92 full SQL grammar supported.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.

Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports ALTER TABLE with add column.

Retrieves whether this database supports ALTER TABLE with add column.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports ALTER TABLE with drop column.

Retrieves whether this database supports ALTER TABLE with drop column.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports batch updates.

Retrieves whether this database supports batch updates.

Attributes

Returns

true if this database supports batch updates; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a catalog name can be used in a data manipulation statement.

Retrieves whether a catalog name can be used in a data manipulation statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a catalog name can be used in an index definition statement.

Retrieves whether a catalog name can be used in an index definition statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a catalog name can be used in a privilege definition statement.

Retrieves whether a catalog name can be used in a privilege definition statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a catalog name can be used in a procedure call statement.

Retrieves whether a catalog name can be used in a procedure call statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a catalog name can be used in a table definition statement.

Retrieves whether a catalog name can be used in a table definition statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports column aliasing.

Retrieves whether this database supports column aliasing.

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

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the JDBC scalar function CONVERT for the conversion of one JDBC type to another. The JDBC types are the generic SQL data types defined in java.sql.Types.

Retrieves whether this database supports the JDBC scalar function CONVERT for the conversion of one JDBC type to another. The JDBC types are the generic SQL data types defined in java.sql.Types.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala
def supportsConvert(fromType: Int, toType: Int): Boolean

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.

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.

Value parameters

fromType

the type to convert from; one of the type codes from the class java.sql.Types

toType

the type to convert to; one of the type codes from the class java.sql.Types

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the ODBC Core SQL grammar.

Retrieves whether this database supports the ODBC Core SQL grammar.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports correlated subqueries.

Retrieves whether this database supports correlated subqueries.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports both data definition and data manipulation statements within a transaction.

Retrieves whether this database supports both data definition and data manipulation statements within a transaction.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports only data manipulation statements within a transaction.

Retrieves whether this database supports only data manipulation statements within a transaction.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports expressions in ORDER BY lists.

Retrieves whether this database supports expressions in ORDER BY lists.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the ODBC Extended SQL grammar.

Retrieves whether this database supports the ODBC Extended SQL grammar.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports full nested outer joins.

Retrieves whether this database supports full nested outer joins.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether auto-generated keys can be retrieved after a statement has been executed

Retrieves whether auto-generated keys can be retrieved after a statement has been executed

Attributes

Returns

true if auto-generated keys can be retrieved after a statement has executed; false otherwise If true is returned, the JDBC driver must support the returning of auto-generated keys for at least SQL INSERT statements

Source
DatabaseMetaData.scala

Retrieves whether this database supports some form of GROUP BY clause.

Retrieves whether this database supports some form of GROUP BY clause.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports using columns not included in the SELECT statement in a GROUP BY clause provided that all of the columns in the SELECT statement are included in the GROUP BY clause.

Retrieves whether this database supports using columns not included in the SELECT statement in a GROUP BY clause provided that all of the columns in the SELECT statement are included in the GROUP BY clause.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.

Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the SQL Integrity Enhancement Facility.

Retrieves whether this database supports the SQL Integrity Enhancement Facility.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports specifying a LIKE escape clause.

Retrieves whether this database supports specifying a LIKE escape clause.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database provides limited support for outer joins. (This will be true if the method supportsFullOuterJoins returns true).

Retrieves whether this database provides limited support for outer joins. (This will be true if the method supportsFullOuterJoins returns true).

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the ODBC Minimum SQL grammar.

Retrieves whether this database supports the ODBC Minimum SQL grammar.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.

Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.

Attributes

Returns

true if a CallableStatement object can return multiple ResultSet objects simultaneously; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports getting multiple ResultSet objects from a single call to the method execute.

Retrieves whether this database supports getting multiple ResultSet objects from a single call to the method execute.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database allows having multiple transactions open at once (on different connections).

Retrieves whether this database allows having multiple transactions open at once (on different connections).

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports named parameters to callable statements.

Retrieves whether this database supports named parameters to callable statements.

Attributes

Returns

true if named parameters are supported; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether columns in this database may be defined as non-nullable.

Retrieves whether columns in this database may be defined as non-nullable.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports keeping cursors open across commits.

Retrieves whether this database supports keeping cursors open across commits.

Attributes

Returns

true if cursors always remain open; false if they might not remain open

Source
DatabaseMetaData.scala

Retrieves whether this database supports keeping cursors open across rollbacks.

Retrieves whether this database supports keeping cursors open across rollbacks.

Attributes

Returns

true if cursors always remain open; false if they might not remain open

Source
DatabaseMetaData.scala

Retrieves whether this database supports keeping statements open across commits.

Retrieves whether this database supports keeping statements open across commits.

Attributes

Returns

true if statements always remain open; false if they might not remain open

Source
DatabaseMetaData.scala

Retrieves whether this database supports keeping statements open across rollbacks.

Retrieves whether this database supports keeping statements open across rollbacks.

Attributes

Returns

true if statements always remain open; false if they might not remain open

Source
DatabaseMetaData.scala

Retrieves whether this database supports using a column that is not in the SELECT statement in an ORDER BY clause.

Retrieves whether this database supports using a column that is not in the SELECT statement in an ORDER BY clause.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports some form of outer join.

Retrieves whether this database supports some form of outer join.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports positioned DELETE statements.

Retrieves whether this database supports positioned DELETE statements.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports positioned UPDATE statements.

Retrieves whether this database supports positioned UPDATE statements.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala
def supportsResultSetConcurrency(`type`: Int, concurrency: Int): Boolean

Retrieves whether this database supports the given concurrency type in combination with the given result set type.

Retrieves whether this database supports the given concurrency type in combination with the given result set type.

Value parameters

`type`

defined in java.sql.ResultSet

concurrency

type defined in java.sql.ResultSet

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the given result set holdability.

Retrieves whether this database supports the given result set holdability.

Value parameters

holdability

one of the following constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the given result set type.

Retrieves whether this database supports the given result set type.

Value parameters

`type`

defined in java.sql.ResultSet

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports savepoints.

Retrieves whether this database supports savepoints.

Attributes

Returns

true if savepoints are supported; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a schema name can be used in a data manipulation statement.

Retrieves whether a schema name can be used in a data manipulation statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a schema name can be used in an index definition statement.

Retrieves whether a schema name can be used in an index definition statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a schema name can be used in a privilege definition statement.

Retrieves whether a schema name can be used in a privilege definition statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a schema name can be used in a procedure call statement.

Retrieves whether a schema name can be used in a procedure call statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether a schema name can be used in a table definition statement.

Retrieves whether a schema name can be used in a table definition statement.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports SELECT FOR UPDATE statements.

Retrieves whether this database supports SELECT FOR UPDATE statements.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports statement pooling.

Retrieves whether this database supports statement pooling.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.

Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.

Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports subqueries in comparison expressions.

Retrieves whether this database supports subqueries in comparison expressions.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports subqueries in EXISTS expressions.

Retrieves whether this database supports subqueries in EXISTS expressions.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports subqueries in IN expressions.

Retrieves whether this database supports subqueries in IN expressions.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports subqueries in quantified expressions.

Retrieves whether this database supports subqueries in quantified expressions.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports table correlation names.

Retrieves whether this database supports table correlation names.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports the given transaction isolation level.

Retrieves whether this database supports the given transaction isolation level.

Value parameters

level

one of the transaction isolation levels defined in java.sql.Connection

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports transactions. If not, invoking the method commit is a noop, and the isolation level is TRANSACTION_NONE.

Retrieves whether this database supports transactions. If not, invoking the method commit is a noop, and the isolation level is TRANSACTION_NONE.

Attributes

Returns

true if transactions are supported; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports SQL UNION.

Retrieves whether this database supports SQL UNION.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports SQL UNION ALL.

Retrieves whether this database supports SQL UNION ALL.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated.

Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated.

Value parameters

type

the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Attributes

Returns

true if changes are detected by the result set type; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database uses a file for each table.

Retrieves whether this database uses a file for each table.

Attributes

Returns

true if this database uses a local file for each table; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database stores tables in a local file.

Retrieves whether this database stores tables in a local file.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Concrete methods

def getAttributes(catalog: String, schemaPattern: String, typeNamePattern: String, attributeNamePattern: String): ResultSet

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.

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 by TYPE_CAT, TYPE_SCHEM, TYPE_NAME and ORDINAL_POSITION. This description does not contain inherited attributes.

The ResultSet object that is returned has the following columns:

  1. TYPE_CAT String => type catalog (may be null)
  2. TYPE_SCHEM String => type schema (may be null)
  3. TYPE_NAME String => type name
  4. ATTR_NAME String => attribute name
  5. DATA_TYPE int => attribute type SQL type from java.sql.Types
  6. 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.
  7. 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.
  8. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  9. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  10. NULLABLE int => whether NULL is allowed
    • attributeNoNulls - might not allow NULL values
    • attributeNullable - definitely allows NULL values
    • attributeNullableUnknown - nullability unknown
  11. REMARKS String => comment describing column (may be null)
  12. ATTR_DEF String => default value (may be null)
  13. SQL_DATA_TYPE int => unused
  14. SQL_DATETIME_SUB int => unused
  15. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  16. ORDINAL_POSITION int => index of the attribute in the UDT (starting at 1)
  17. 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
  18. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  19. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  20. SCOPE_TABLE String => table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  21. 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)

Value parameters

attributeNamePattern

an attribute name pattern; must match the attribute name as it is declared in the database

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 search

schemaPattern

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 search

typeNamePattern

a type name pattern; must match the type name as it is stored in the database

Attributes

Returns

a ResultSet object in which each row is an attribute description

Source
DatabaseMetaData.scala
def getBestRowIdentifier(catalog: String, schema: String, table: String, scope: Int, nullable: Boolean): F[ResultSet]

Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.

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:

  1. SCOPE short => actual scope of result
    • bestRowTemporary - very temporary, while using row
    • bestRowTransaction - valid for remainder of current transaction
    • bestRowSession - valid for remainder of current session
  2. COLUMN_NAME String => column name
  3. DATA_TYPE int => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => not used
  7. DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • bestRowUnknown - may or may not be pseudo column
    • bestRowNotPseudo - is NOT a pseudo column
    • bestRowPseudo - is a pseudo column

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.

Value 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 search

nullable

include columns that are nullable.

schema

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 search

scope

the scope of interest; use same values as SCOPE

table

a table name; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a column description

Source
DatabaseMetaData.scala
def getColumnPrivileges(catalog: String, schema: String, table: String, columnNamePattern: String): F[ResultSet]

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

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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. GRANTOR String => grantor of access (may be null)
  6. GRANTEE String => grantee of access
  7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFERENCES, ...)
  8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Value 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 search

columnNamePattern

a column name pattern; must match the column name as it is stored in the database

schema

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 search

table

a table name; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a column privilege description

Source
DatabaseMetaData.scala
def getColumns(catalog: String, schemaPattern: String, tableName: String, columnNamePattern: String): F[ResultSet]

Retrieves a description of table columns available in the specified catalog.

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, and ORDINAL_POSITION.

Each column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. DATA_TYPE int => SQL type from java.sql.Types
  6. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  7. COLUMN_SIZE int => column size.
  8. BUFFER_LENGTH is not used.
  9. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  11. NULLABLE int => is NULL allowed.
    • columnNoNulls - might not allow NULL values
    • columnNullable - definitely allows NULL values
    • columnNullableUnknown - nullability unknown
  12. REMARKS String => comment describing column (may be null)
  13. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
  14. SQL_DATA_TYPE int => unused
  15. SQL_DATETIME_SUB int => unused
  16. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  17. ORDINAL_POSITION int => index of column in table (starting at 1)
  18. IS_NULLABLE String => 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
  19. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  20. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  21. SCOPE_TABLE String => table name that this the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  22. 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)
  23. 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
  24. 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.

Value 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 search

columnNamePattern

a column name pattern; must match the column name as it is stored in the database

schemaPattern

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 search

tableNamePattern

a table name pattern; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a column description

Source
DatabaseMetaData.scala
def getCrossReference(parentCatalog: String, parentSchema: String, parentTable: String, foreignCatalog: String, foreignSchema: String, foreignTable: String): F[ResultSet]

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.

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:

  1. PKTABLE_CAT String => parent key table catalog (may be null)
  2. PKTABLE_SCHEM String => parent key table schema (may be null)
  3. PKTABLE_NAME String => parent key table name
  4. PKCOLUMN_NAME String => parent key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key( 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).
  10. 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)
  11. 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
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => parent key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Value parameters

foreignCatalog

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 criteria

foreignSchema

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 criteria

foreignTable

the name of the table that imports the key; must match the table name as it is stored in the database

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 criteria

parentSchema

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 criteria

parentTable

the name of the table that exports the key; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a foreign key column description

Source
DatabaseMetaData.scala
def getExportedKeys(catalog: String, schema: String, table: String): F[ResultSet]

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.

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:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be null)
  3. PKTABLE_NAME String => primary key table name
  4. PKCOLUMN_NAME String => primary key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key( 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).
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Value 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 search

schema

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 search

table

a table name; must match the table name as it is stored in this database

Attributes

Returns

a ResultSet object in which each row is a foreign key column description

Source
DatabaseMetaData.scala
def getFunctionColumns(catalog: String, schemaPattern: String, functionNamePattern: String, columnNamePattern: String): F[ResultSet]

Retrieves a description of the given catalog's system or user function parameters and return type.

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 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, column description or return type description with the following fields:

  1. FUNCTION_CAT String => function catalog (may be null)
  2. FUNCTION_SCHEM String => function schema (may be null)
  3. FUNCTION_NAME String => function name. This is the name used to invoke the function
  4. COLUMN_NAME String => column/parameter name
  5. 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
  6. DATA_TYPE int => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL.
    • functionNoNulls - does not allow NULL values
    • functionNullable - allows NULL values
    • functionNullableUnknown - nullability unknown
  13. REMARKS String => comment describing column/parameter
  14. 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
  15. 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.
  16. 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
  17. 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 the FUNCTION_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.

Value 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 search

columnNamePattern

a parameter name pattern; must match the parameter or column name as it is stored in the database

functionNamePattern

a procedure name pattern; must match the function name as it is stored in the database

schemaPattern

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 search

Attributes

Returns

ResultSet - each row describes a user function parameter, column or return type

Source
DatabaseMetaData.scala
def getFunctions(catalog: String, schemaPattern: String, functionNamePattern: String): F[ResultSet]

Retrieves a description of the system and user functions available in the given catalog.

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 by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME.

Each function description has the following columns:

  1. FUNCTION_CAT String => function catalog (may be null)
  2. FUNCTION_SCHEM String => function schema (may be null)
  3. FUNCTION_NAME String => function name. This is the name used to invoke the function
  4. REMARKS String => explanatory comment on the function
  5. 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
  6. 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 the FUNCTION_NAME for example with overload functions

A user may not have permission to execute any of the functions that are returned by getFunctions

Value 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 search

functionNamePattern

a function name pattern; must match the function name as it is stored in the database

schemaPattern

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 search

Attributes

Returns

ResultSet - each row is a function description

Source
DatabaseMetaData.scala
def getImportedKeys(catalog: String, schema: String, table: String): F[ResultSet]

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.

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:

  1. PKTABLE_CAT String => primary key table catalog being imported (may be null)
  2. PKTABLE_SCHEM String => primary key table schema being imported (may be null)
  3. PKTABLE_NAME String => primary key table name being imported
  4. PKCOLUMN_NAME String => primary key column name being imported
  5. FKTABLE_CAT String => foreign key table catalog (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null)
  7. FKTABLE_NAME String => foreign key table name
  8. FKCOLUMN_NAME String => foreign key column name
  9. KEY_SEQ short => sequence number within 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).
  10. 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)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Value 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 search

schema

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 search

table

a table name; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a primary key column description

Source
DatabaseMetaData.scala
def getIndexInfo(catalog: String, schema: String, table: String, unique: Boolean, approximate: Boolean): F[ResultSet]

Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. NON_UNIQUE boolean => Can index values be non-unique. false when TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
  6. INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
  7. TYPE short => index type:
    • tableIndexStatistic - this identifies table statistics that are returned in conjunction with a table's index descriptions
    • tableIndexClustered - this is a clustered index
    • tableIndexHashed - this is a hashed index
    • tableIndexOther - this is some other style of index
  8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
  9. COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
  10. ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
  11. CARDINALITY 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.
  12. PAGES long => When TYPE is tableIndexStatistic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
  13. FILTER_CONDITION String => Filter condition, if any. (may be null)

Value parameters

approximate

when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate

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 search

schema

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 search

table

a table name; must match the table name as it is stored in this database

unique

when true, return only indices for unique values; when false, return indices regardless of whether unique or not

Attributes

Returns

ResultSet - each row is an index column description

Source
DatabaseMetaData.scala

Retrieves the maximum number of bytes this database allows for the logical size for a LOB.

Retrieves the maximum number of bytes this database allows for the logical size for a LOB.

The default implementation will return 0

Attributes

Returns

the maximum number of bytes allowed; a result of zero means that there is no limit or the limit is not known

Source
DatabaseMetaData.scala
def getPrimaryKeys(catalog: String, schema: String, table: String): F[ResultSet]

Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.

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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. KEY_SEQ short => sequence number within primary key( 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).
  6. PK_NAME String => primary key name (may be null)

Value 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 search

schema

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 search

table

a table name; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a primary key column description

Source
DatabaseMetaData.scala
def getProcedureColumns(catalog: String, schemaPattern: String, procedureNamePattern: String, columnNamePattern: String): F[ResultSet]

Retrieves a description of the given catalog's stored procedure parameter and result columns.

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:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. COLUMN_NAME String => column/parameter name
  5. COLUMN_TYPE Short => kind of column/parameter:
    • procedureColumnUnknown - nobody knows
    • procedureColumnIn - IN parameter
    • procedureColumnInOut - INOUT parameter
    • procedureColumnOut - OUT parameter
    • procedureColumnReturn - procedure return value
    • procedureColumnResult - result column in ResultSet
  6. DATA_TYPE int => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL.
    • procedureNoNulls - does not allow NULL values
    • procedureNullable - allows NULL values
    • procedureNullableUnknown - nullability unknown
  13. REMARKS String => comment describing parameter/column
  14. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
    • 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
  15. SQL_DATA_TYPE int => reserved for future use
  16. SQL_DATETIME_SUB int => reserved for future use
  17. CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL
  18. 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.
  19. 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
  20. 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.

Value 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 search

columnNamePattern

a column name pattern; must match the column name as it is stored in the database

procedureNamePattern

a procedure name pattern; must match the procedure name as it is stored in the database

schemaPattern

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 search

Attributes

Returns

ResultSet - each row describes a stored procedure parameter or column

Source
DatabaseMetaData.scala
def getProcedures(catalog: String, schemaPattern: String, procedureNamePattern: String): F[ResultSet]

Retrieves a description of the stored procedures available in the given catalog.

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 by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME.

Each procedure description has the following columns:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. reserved for future use
  5. reserved for future use
  6. reserved for future use
  7. REMARKS String => explanatory comment on the procedure
  8. PROCEDURE_TYPE short => kind of procedure:
    • procedureResultUnknown - Cannot determine if a return value will be returned
    • procedureNoResult - Does not return a return value
    • procedureReturnsResult - Returns a return value
  9. 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

Value 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 search

procedureNamePattern

a procedure name pattern; must match the procedure name as it is stored in the database

schemaPattern

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 search

Attributes

Returns

ResultSet - each row is a procedure description

Source
DatabaseMetaData.scala
def getPseudoColumns(catalog: String, schemaPattern: String, tableNamePattern: String, columnNamePattern: String): ResultSet

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.

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

Each column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. DATA_TYPE int => SQL type from java.sql.Types
  6. COLUMN_SIZE int => column size.
  7. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  9. COLUMN_USAGE String => The allowed usage for the column. The value returned will correspond to the enum name returned by `[[PseudoColumnUsage#name PseudoColumnUsage.name()]]`
  10. REMARKS String => comment describing column (may be null)
  11. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  12. 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.

Value 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 search

columnNamePattern

a column name pattern; must match the column name as it is stored in the database

schemaPattern

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 search

tableNamePattern

a table name pattern; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a column description

Source
DatabaseMetaData.scala
def getSchemas(): F[ResultSet]

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

The schema columns are:

  1. TABLE_SCHEM String => schema name
  2. TABLE_CATALOG String => catalog name (may be null)

Attributes

Returns

a ResultSet object in which each row is a schema description

Source
DatabaseMetaData.scala
def getSchemas(catalog: String, schemaPattern: String): F[ResultSet]

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

The schema columns are:

  1. TABLE_SCHEM String => schema name
  2. TABLE_CATALOG String => catalog name (may be null)

Value parameters

catalog

a catalog name; must match the catalog name as it is stored in the database;"" retrieves those without a catalog; null means catalog name should not be used to narrow down the search.

schemaPattern

a schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search.

Attributes

Returns

a ResultSet object in which each row is a schema description

Source
DatabaseMetaData.scala
def getSuperTables(catalog: String, schemaPattern: String, tableNamePattern: String): ResultSet

Retrieves a description of the table hierarchies defined in a particular schema in this database.

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:

  1. TABLE_CAT String => the type's catalog (may be null)
  2. TABLE_SCHEM String => type's schema (may be null)
  3. TABLE_NAME String => type name
  4. SUPERTABLE_NAME String => the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

Value parameters

catalog

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

schemaPattern

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

tableNamePattern

a table name pattern; may be a fully-qualified name

Attributes

Returns

a ResultSet object in which each row is a type description

Source
DatabaseMetaData.scala
def getSuperTypes(catalog: String, schemaPattern: String, typeNamePattern: String): ResultSet

Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.

Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type 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 the ResultSet object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:

  1. TYPE_CAT String => the UDT's catalog (may be null)
  2. TYPE_SCHEM String => UDT's schema (may be null)
  3. TYPE_NAME String => type name of the UDT
  4. SUPERTYPE_CAT String => the direct super type's catalog (may be null)
  5. SUPERTYPE_SCHEM String => the direct super type's schema (may be null)
  6. SUPERTYPE_NAME String => the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

Value parameters

catalog

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

schemaPattern

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

typeNamePattern

a UDT name pattern; may be a fully-qualified name

Attributes

Returns

a ResultSet object in which a row gives information about the designated UDT

Source
DatabaseMetaData.scala
def getTablePrivileges(catalog: String, schemaPattern: String, tableNamePattern: String): F[ResultSet]

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

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, and PRIVILEGE.

Each privilege description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. GRANTOR String => grantor of access (may be null)
  5. GRANTEE String => grantee of access
  6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFERENCES, ...)
  7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Value 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 search

schemaPattern

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 search

tableNamePattern

a table name pattern; must match the table name as it is stored in the database

Attributes

Returns

ResultSet - each row is a table privilege description

Source
DatabaseMetaData.scala
def getTables(catalog: String, schemaPattern: String, tableNamePattern: String, types: Array[String]): F[ResultSet]

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 by TABLE_TYPE, TABLE_CAT, TABLE_SCHEM and TABLE_NAME.

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 by TABLE_TYPE, TABLE_CAT, TABLE_SCHEM and TABLE_NAME.

Each table description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
  5. REMARKS String => explanatory comment on the table (may be null)
  6. TYPE_CAT String => the types catalog (may be null)
  7. TYPE_SCHEM String => the types schema (may be null)
  8. TYPE_NAME String => type name (may be null)
  9. SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null)
  10. REF_GENERATION String => specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be null)

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

Value 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 search

schemaPattern

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 search

tableNamePattern

a table name pattern; must match the table name as it is stored in the database

types

a list of table types, which must be from the list of table types returned from [[#getTableTypes]],to include; null returns all types

Attributes

Returns

ResultSet - each row is a table description

Source
DatabaseMetaData.scala
def getUDTs(catalog: String, schemaPattern: String, typeNamePattern: String, types: Array[Int]): ResultSet

Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_CAT, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.

Each type description has the following columns:

  1. TYPE_CAT String => the type's catalog (may be null)
  2. TYPE_SCHEM String => type's schema (may be null)
  3. TYPE_NAME String => type name
  4. CLASS_NAME String => Java class name
  5. DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
  6. REMARKS String => explanatory comment on the type
  7. 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.

Value 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 search

schemaPattern

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 search

typeNamePattern

a type name pattern; must match the type name as it is stored in the database; may be a fully qualified name

types

a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include; null returns all types

Attributes

Returns

ResultSet object in which each row describes a UDT

Source
DatabaseMetaData.scala
def getVersionColumns(catalog: String, schema: String, table: String): F[ResultSet]

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

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:

  1. SCOPE short => is not used
  2. COLUMN_NAME String => column name
  3. DATA_TYPE int => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source-dependent type name
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => length of column value in bytes
  7. DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. 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.

Value 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 search

schema

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 search

table

a table name; must match the table name as it is stored in the database

Attributes

Returns

a ResultSet object in which each row is a column description

Source
DatabaseMetaData.scala

Retrieves whether NULL values are sorted high. Sorted high means that NULL values sort higher than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the end. By contrast, the method nullsAreSortedAtEnd indicates whether NULL values are sorted at the end regardless of sort order.

Retrieves whether NULL values are sorted high. Sorted high means that NULL values sort higher than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the end. By contrast, the method nullsAreSortedAtEnd indicates whether NULL values are sorted at the end regardless of sort order.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether NULL values are sorted low. Sorted low means that NULL values sort lower than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the beginning. By contrast, the method nullsAreSortedAtStart indicates whether NULL values are sorted at the beginning regardless of sort order.

Retrieves whether NULL values are sorted low. Sorted low means that NULL values sort lower than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the beginning. By contrast, the method nullsAreSortedAtStart indicates whether NULL values are sorted at the beginning regardless of sort order.

Attributes

Returns

true if so; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports REF CURSOR.

Retrieves whether this database supports REF CURSOR.

The default implementation will return false

Attributes

Returns

true if this database supports REF CURSOR; false otherwise

Source
DatabaseMetaData.scala

Retrieves whether this database supports sharding.

Retrieves whether this database supports sharding.

Attributes

Returns

true if this database supports sharding; false otherwise

Source
DatabaseMetaData.scala