Back to Exposed

R2dbcExposedConnection

docs/api/exposed-r2dbc/org.jetbrains.exposed.v1.r2dbc.statements.api/-r2dbc-exposed-connection/index.html

1.2.06.9 KB
Original Source

R2dbcExposedConnection

interface R2dbcExposedConnection<OriginalConnection : Any>

Represents a wrapper for a database connection.

Inheritors

R2dbcConnectionImpl

Members

Properties

connection

Link copied to clipboard

abstract val connection: OriginalConnection

The underlying database connection object contained by this wrapper.

Functions

close

Link copied to clipboard

abstract suspend fun close()

Closes the connection and releases any of its database and/or driver resources.

commit

Link copied to clipboard

abstract suspend fun commit()

Saves all changes since the last commit or rollback operation.

executeInBatch

Link copied to clipboard

abstract suspend fun executeInBatch(sqls: List<String>)

Sends a collection of SQL strings to the database for execution as a batch statement.

getAutoCommit

Link copied to clipboard

abstract suspend fun getAutoCommit(): Boolean

Retrieves whether the connection is in auto-commit mode.

getCatalog

Link copied to clipboard

abstract suspend fun getCatalog(): String

Retrieves the name of the connection's catalog.

getReadOnly

Link copied to clipboard

abstract suspend fun getReadOnly(): Boolean

Retrieves whether the connection is in read-only mode.

getSchema

Link copied to clipboard

abstract suspend fun getSchema(): String

Retrieves the name of the connection's schema.

getTransactionIsolation

Link copied to clipboard

abstract suspend fun getTransactionIsolation(): IsolationLevel

Retrieves the transaction isolation level of the connection.

isClosed

Link copied to clipboard

abstract suspend fun isClosed(): Boolean

Whether the connection has been closed.

metadata

Link copied to clipboard

abstract suspend fun <T> metadata(body: suspend R2dbcExposedDatabaseMetadata.() -> T): T

Calls the specified function body with an R2dbcExposedDatabaseMetadata implementation as its receiver and returns the retrieved metadata from the database as a result.

prepareStatement

Link copied to clipboard

abstract suspend fun prepareStatement(sql: String, columns: Array<String>): R2dbcPreparedStatementImpl

abstract suspend fun prepareStatement(sql: String, returnKeys: Boolean): R2dbcPreparedStatementImpl

Returns a precompiled sql statement stored as an R2dbcPreparedStatementImpl implementation.

releaseSavepoint

Link copied to clipboard

abstract suspend fun releaseSavepoint(savepoint: ExposedSavepoint)

Removes the specified savepoint.

rollback

Link copied to clipboard

abstract suspend fun rollback()

Reverts all changes since the last commit or rollback operation.

abstract suspend fun rollback(savepoint: ExposedSavepoint)

Reverts all changes since the specified savepoint was set.

setAutoCommit

Link copied to clipboard

abstract suspend fun setAutoCommit(value: Boolean)

Sets whether the connection is in auto-commit mode or not.

setCatalog

Link copied to clipboard

abstract suspend fun setCatalog(value: String)

Sets the name of the connection's catalog.

setReadOnly

Link copied to clipboard

abstract suspend fun setReadOnly(value: Boolean)

Set whether the connection is in read-only mode.

setSavepoint

Link copied to clipboard

abstract suspend fun setSavepoint(name: String): ExposedSavepoint

Sets and returns a new savepoint with the specified name.

setTransactionDefinition

Link copied to clipboard

abstract fun setTransactionDefinition(definition: TransactionDefinition?)

Sets specific transaction properties to be used together when starting a transaction explicitly. Passing a null argument will force beginTransaction() to be invoked without any transaction definition.

setTransactionIsolation

Link copied to clipboard

abstract suspend fun setTransactionIsolation(value: IsolationLevel)

Sets the transaction isolation level of the connection.

Generated by Dokka © 2026 Copyright