DatabaseApi

abstract class DatabaseApi

Base class representing the underlying database to which connections are made and on which transaction tasks are performed.

Parameters

config

Configuration holding all parameters that apply to a transaction using this database instance.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard

The default number of results that should be fetched when queries are executed.

Link copied to clipboard
abstract val dialect: DatabaseDialect

The name of the database as a DatabaseDialect.

Link copied to clipboard
abstract val dialectMode: String?

The mode of the database. This currently only applies to H2 databases.

Link copied to clipboard
abstract val fullVersion: String

The full version number of the database as a String.

Link copied to clipboard

The database-specific class responsible for parsing and processing identifier tokens in SQL syntax.

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
abstract val url: String

The connection URL for the database.

Link copied to clipboard

Whether nested transaction blocks are configured to act like top-level transactions.

Link copied to clipboard
abstract val vendor: String

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

Link copied to clipboard
abstract val version: Version

The version number of the database as a Version.

Functions

Link copied to clipboard
open override fun toString(): String