# 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

Companion
Link copied to clipboard
object Companion

## Properties

config
Link copied to clipboard
val config: DatabaseConfig
defaultFetchSize
Link copied to clipboard
var defaultFetchSize: Int?

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

dialect
Link copied to clipboard
abstract val dialect: DatabaseDialect

The name of the database as a DatabaseDialect.

dialectMode
Link copied to clipboard
abstract val dialectMode: String?

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

fullVersion
Link copied to clipboard
abstract val fullVersion: String

The full version number of the database as a String.

identifierManager
Link copied to clipboard
abstract val identifierManager: IdentifierManagerApi

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

supportsAlterTableWithAddColumn
Link copied to clipboard
abstract val supportsAlterTableWithAddColumn: Boolean

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

supportsAlterTableWithDropColumn
Link copied to clipboard
abstract val supportsAlterTableWithDropColumn: Boolean

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

supportsMultipleResultSets
Link copied to clipboard
abstract val supportsMultipleResultSets: Boolean

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

supportsSelectForUpdate
Link copied to clipboard
abstract val supportsSelectForUpdate: Boolean

Whether the database supports SELECT FOR UPDATE statements.

url
Link copied to clipboard
abstract val url: String

The connection URL for the database.

useNestedTransactions
Link copied to clipboard
val useNestedTransactions: Boolean

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

vendor
Link copied to clipboard
abstract val vendor: String

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

version
Link copied to clipboard
abstract val version: Version

The version number of the database as a Version.

## Functions

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