Back to Exposed

DatabaseDialectMetadata

docs/api/exposed-jdbc/org.jetbrains.exposed.v1.jdbc.vendors/-database-dialect-metadata/index.html

1.2.09.6 KB
Original Source

DatabaseDialectMetadata

abstract class DatabaseDialectMetadata

Common interface for all database dialect metadata.

Inheritors

H2DialectMetadata

MysqlDialectMetadata

OracleDialectMetadata

PostgreSQLDialectMetadata

SQLServerDialectMetadata

SQLiteDialectMetadata

Members

Constructors

DatabaseDialectMetadata

Link copied to clipboard

constructor()

Properties

allTablesNames

Link copied to clipboard

val allTablesNames: List<String>

Returns a list with the names of all the defined tables in the current schema.

Functions

allTablesNames

Link copied to clipboard

fun allTablesNames(): List<String>

Returns a list with the names of all the defined tables in the current database schema. The names will be returned with schema prefixes if the database supports it.

allTablesNamesInAllSchemas

Link copied to clipboard

fun allTablesNamesInAllSchemas(): List<String>

Returns a list with the names of all the tables in all database schemas. The names will be returned with schema prefixes, if the database supports it, and non-user defined tables, like system information table names, will be included.

areEquivalentColumnTypes

Link copied to clipboard

fun areEquivalentColumnTypes(columnMetadataSqlType: String, columnMetadataType: Int, columnType: String): Boolean

Returns whether a defined column is of the same type as the column to which it is mapped in the database.

catalog

Link copied to clipboard

fun catalog(transaction: JdbcTransaction): String

Returns the catalog name of the connection of the specified transaction.

columnConstraints

Link copied to clipboard

fun columnConstraints(vararg tables: Table): Map<Pair<Table, LinkedHashSet<Column<*>>>, List<ForeignKeyConstraint>>

Returns a map with the foreign key constraints of all the defined columns sets in each of the specified tables.

existingCheckConstraints

Link copied to clipboard

fun existingCheckConstraints(vararg tables: Table): Map<Table, List<CheckConstraint>>

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

existingIndices

Link copied to clipboard

open fun existingIndices(vararg tables: Table): Map<Table, List<Index>>

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

existingPrimaryKeys

Link copied to clipboard

fun existingPrimaryKeys(vararg tables: Table): Map<Table, PrimaryKeyMetadata?>

Returns a map with the primary key metadata in each of the specified tables.

existingSequences

Link copied to clipboard

fun existingSequences(vararg tables: Table): Map<Table, List<Sequence>>

Returns a map with all the defined sequences that hold a relation to the specified tables in the database.

getDatabase

Link copied to clipboard

fun getDatabase(): String

Returns the name of the current database.

resetCaches

Link copied to clipboard

fun resetCaches()

Clears any cached values.

resetSchemaCaches

Link copied to clipboard

fun resetSchemaCaches()

Clears any cached values including schema names.

schemaExists

Link copied to clipboard

fun schemaExists(schema: Schema): Boolean

Checks if the specified schema exists.

sequenceExists

Link copied to clipboard

fun sequenceExists(sequence: Sequence): Boolean

Returns whether the specified sequence exists.

sequences

Link copied to clipboard

fun sequences(): List<String>

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

supportsLimitWithUpdateOrDelete

Link copied to clipboard

open fun supportsLimitWithUpdateOrDelete(): Boolean

Returns true if the database supports the LIMIT clause with update and delete statements.

tableColumns

Link copied to clipboard

fun tableColumns(vararg tables: Table): Map<Table, List<ColumnMetadata>>

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

tableExists

Link copied to clipboard

fun tableExists(table: Table): Boolean

Checks if the specified table exists in the database.

Generated by Dokka © 2026 Copyright