exposed-core/org.jetbrains.exposed.sql/SchemaUtils

SchemaUtils

Utility functions that assist with creating, altering, and dropping database schema objects.

Functions

fun addMissingColumnsStatements(vararg tables: Table, withLogs: Boolean = true): List<String>

Returns the SQL statements that create any columns defined in tables, which are missing from the existing tables in the database.

checkCycle

fun checkCycle(vararg tables: Table): Boolean

Checks whether any of the tables have a sequence of foreign key constraints that cycle back to them.

checkExcessiveForeignKeyConstraints

fun checkExcessiveForeignKeyConstraints(vararg tables: Table, withLogs: Boolean): List<ForeignKeyConstraint>

Checks all tables for any that have more than one defined foreign key constraint and logs the findings. If found, this function also logs the SQL statements that can be used to drop these foreign key constraints.

checkExcessiveIndices

fun checkExcessiveIndices(vararg tables: Table, withLogs: Boolean): List<Index>

Checks all tables for any that have more than one defined index and logs the findings. If found, this function also logs the SQL statements that can be used to drop these indices.

checkMappingConsistence

fun checkMappingConsistence(vararg tables: Table, withLogs: Boolean = true): List<String>

Log Exposed table mappings <-> real database mapping problems and returns DDL Statements to fix them

create

fun <T : Table> create(vararg tables: T, inBatch: Boolean = false)

Creates all tables that do not already exist, using a batch execution if inBatch is set to true.

createDatabase

fun createDatabase(vararg databases: String, inBatch: Boolean = false)

Creates databases

createFKey

fun createFKey(foreignKey: ForeignKeyConstraint): List<String>

Returns the SQL statements that create the provided ForeignKeyConstraint.

createIndex

fun createIndex(index: Index): List<String>

Returns the SQL statements that create the provided index.

createMissingTablesAndColumns

fun createMissingTablesAndColumns(vararg tables: Table, inBatch: Boolean = false, withLogs: Boolean = true)

This function should be used in cases when an easy-to-use auto-actualization of database schema is required. It creates any missing tables and, if possible, adds any missing columns for existing tables (for example, when columns are nullable or have default values).

createSchema

fun createSchema(vararg schemas: Schema, inBatch: Boolean = false)

Creates schemas

createSequence

fun createSequence(vararg seq: Sequence, inBatch: Boolean = false)

Creates the provided sequences, using a batch execution if inBatch is set to true.

createStatements

fun createStatements(vararg tables: Table): List<String>

Returns the SQL statements that create all tables that do not already exist.

drop

fun drop(vararg tables: Table, inBatch: Boolean = false)

Drops all tables, using a batch execution if inBatch is set to true.

dropDatabase

fun dropDatabase(vararg databases: String, inBatch: Boolean = false)

Drops databases

dropSchema

fun dropSchema(vararg schemas: Schema, cascade: Boolean = false, inBatch: Boolean = false)

Drops schemas

dropSequence

fun dropSequence(vararg seq: Sequence, inBatch: Boolean = false)

Drops the provided sequences, using a batch execution if inBatch is set to true.

listDatabases

fun listDatabases(): List<String>

Returns a list of all databases.

listTables

fun listTables(): List<String>

Retrieves a list of all table names in the current database.

setSchema

fun setSchema(schema: Schema, inBatch: Boolean = false)

Sets the current default schema to schema. Supported by H2, MariaDB, Mysql, Oracle, PostgreSQL and SQL Server. SQLite doesn't support schemas.

sortTablesByReferences

fun sortTablesByReferences(tables: Iterable<Table>): List<Table>

Returns a list of tables sorted according to the targets of their foreign key constraints, if any exist.

statementsRequiredToActualizeScheme

fun statementsRequiredToActualizeScheme(vararg tables: Table, withLogs: Boolean = true): List<String>

Returns the SQL statements that need to be executed to make the existing database schema compatible with the table objects defined using Exposed.

withDataBaseLock

fun <T> Transaction.withDataBaseLock(body: () -> T)

Creates table with name "busy" (if not present) and single column to be used as "synchronization" point. Table wont be dropped after execution.