ExposedDatabaseMetadata

abstract class ExposedDatabaseMetadata(val database: String)

Base class responsible for retrieving and storing information about the JDBC driver and underlying database.

Constructors

Link copied to clipboard
constructor(database: String)

Properties

Link copied to clipboard
Link copied to clipboard

The name of the database based on the name of the underlying JDBC driver.

Link copied to clipboard

The version number of the database product as a String.

Link copied to clipboard

The default transaction isolation level for the database.

Link copied to clipboard

The database-specific and metadata-reliant implementation of IdentifierManagerApi.

Link copied to clipboard
abstract val schemaNames: List<String>

A list of existing schema names.

Link copied to clipboard

Whether the database supports ALTER TABLE with an add column clause.

Link copied to clipboard

Whether the database supports ALTER TABLE with a drop column clause.

Link copied to clipboard

Whether the database supports getting multiple result sets from a single execute.

Link copied to clipboard

Whether the database supports SELECT FOR UPDATE statements.

Link copied to clipboard
abstract val tableNames: Map<String, List<String>>

A mapping of all schema names in the database to a list of all defined table names in each schema.

Link copied to clipboard
abstract val url: String

The connection URL for the database.

Link copied to clipboard
abstract val version: BigDecimal

The version number of the database as a BigDecimal.

Functions

Link copied to clipboard
abstract fun cleanCache()

Clears any cached values.

Link copied to clipboard
abstract fun columns(vararg tables: Table): Map<Table, List<ColumnMetadata>>

Returns a map with the ColumnMetadata of all the defined columns in each of the specified tables.

Link copied to clipboard
abstract fun existingIndices(vararg tables: Table): Map<Table, List<Index>>

Returns a map with all the defined indices in each of the specified tables.

Link copied to clipboard
abstract fun existingPrimaryKeys(vararg tables: Table): Map<Table, PrimaryKeyMetadata?>

Returns a map with the PrimaryKeyMetadata in each of the specified tables.

Link copied to clipboard
abstract fun resetCurrentScheme()

Clears and resets any stored information about the database's current schema to default values.

Link copied to clipboard
abstract fun sequences(): List<String>

Returns a list of the names of all sequences in the database.

Link copied to clipboard

Returns a map with the ForeignKeyConstraint of all the defined columns in each of the specified tables, with the table name used as the key.

Link copied to clipboard
abstract fun tableNamesByCurrentSchema(tableNamesCache: Map<String, List<String>>?): SchemaMetadata

Returns the current schema name and a list of its existing table names, stored as SchemaMetadata.