# Package-level declarations

## Types

ColumnMetadata
Link copied to clipboard
data class ColumnMetadata(val name: String, val jdbcType: Int, val sqlType: String, val nullable: Boolean, val size: Int?, val scale: Int?, val autoIncrement: Boolean, val defaultDbValue: String?, val comment: String? = null)

Represents metadata information about a specific column.

DatabaseDialect
Link copied to clipboard
interface DatabaseDialect

Common interface for all database dialects.

DataTypeProvider
Link copied to clipboard
abstract class DataTypeProvider

Provides definitions for all the supported SQL data types. By default, definitions from the SQL standard are provided but if a vendor doesn't support a specific type, or it is implemented differently, the corresponding function should be overridden.

ForUpdateOption
Link copied to clipboard
sealed class ForUpdateOption

Clauses that perform a locking read at row-level for SELECT statements.

FunctionProvider
Link copied to clipboard
abstract class FunctionProvider

Provides definitions for all the supported SQL functions. By default, definitions from the SQL standard are provided but if a vendor doesn't support a specific function, or it is implemented differently, the corresponding function should be overridden.

H2Dialect
Link copied to clipboard
open class H2Dialect : VendorDialect

H2 dialect implementation.

MariaDBDialect
Link copied to clipboard
open class MariaDBDialect : MysqlDialect

MariaDB dialect implementation.

MysqlDialect
Link copied to clipboard
open class MysqlDialect : VendorDialect

MySQL dialect implementation.

OracleDialect
Link copied to clipboard
open class OracleDialect : VendorDialect

Oracle dialect implementation.

PostgreSQLDialect
Link copied to clipboard
open class PostgreSQLDialect(val name: String = dialectName) : VendorDialect

PostgreSQL dialect implementation.

PostgreSQLNGDialect
Link copied to clipboard
open class PostgreSQLNGDialect : PostgreSQLDialect

PostgreSQL dialect implementation using the pgjdbc-ng jdbc driver.

PrimaryKeyMetadata
Link copied to clipboard
data class PrimaryKeyMetadata(val name: String, val columnNames: List<String>)

Represents metadata information about a specific table's primary key.

SchemaMetadata
Link copied to clipboard
data class SchemaMetadata(val schemaName: String, val tableNames: List<String>)

Represents metadata information about the current schema and its associated tables.

SQLiteDialect
Link copied to clipboard
open class SQLiteDialect : VendorDialect

SQLite dialect implementation.

SQLServerDialect
Link copied to clipboard
open class SQLServerDialect : VendorDialect

SQLServer dialect implementation.

VendorDialect
Link copied to clipboard
abstract class VendorDialect(val name: String, val dataTypeProvider: DataTypeProvider, val functionProvider: FunctionProvider) : DatabaseDialect

Base implementation of a vendor dialect

## Properties

ANSI_SQL_2003_KEYWORDS
Link copied to clipboard
val ANSI_SQL_2003_KEYWORDS: Set<String>

Returns a set with all the keywords that are part of the SQL:2003 standard.

currentDialect
Link copied to clipboard
val currentDialect: DatabaseDialect

Returns the dialect used in the current transaction, may throw an exception if there is no current transaction.

h2Mode
Link copied to clipboard
val DatabaseDialect.h2Mode: H2Dialect.H2CompatibilityMode?

The current H2 database compatibility mode or `null` if the current database is not H2.

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

Returns a map of vendor specific keywords.