client/io.github.octaviusframework.client/OctaviusClientImpl

OctaviusClientImpl

internal class OctaviusClientImpl(provider: SessionProvider, onClose: () -> Unit? = null, dynamicJson: Json = octaviusJson, dynamicWriteStrategy: DynamicWriteStrategy = DynamicWriteStrategy.AUTOMATIC_WHEN_UNAMBIGUOUS) : OctaviusClient

The only implementation of OctaviusClient, doing everything through its SessionProvider.

Parameters

onClose

What close releases, or null where the client owns nothing.

Constructors

OctaviusClientImpl

constructor(provider: SessionProvider, onClose: () -> Unit? = null, dynamicJson: Json = octaviusJson, dynamicWriteStrategy: DynamicWriteStrategy = DynamicWriteStrategy.AUTOMATIC_WHEN_UNAMBIGUOUS)

Properties

dynamicTypes

open override val dynamicTypes: DynamicTypes

The dynamic_dto types this client knows. Nothing reaches the database until a type is registered.

Functions

open override fun close()

Releases what this client holds. A data source it was given rather than built is not closed.

deleteFrom

open override fun deleteFrom(table: String): DeleteQuery

Starts a DELETE from table, which renders only with a WHERE.

execute

open override fun <T> execute(block: OctaviusSessionOperations.() -> T): T

Runs block on a session: inside a transaction on this thread the transaction's, otherwise one borrowed for this call, whose statements commit as they go.

executeTransactionPlan

open fun executeTransactionPlan(plan: TransactionPlan, propagation: TransactionPropagation = TransactionPropagation.REQUIRED, isolation: TransactionIsolationLevel? = null, readOnly: Boolean = false, statementTimeout: Duration? = null, transactionTimeout: Duration? = null): TransactionPlanResult

Runs every step of plan in one transaction, in order, and returns what each produced. A step's TransactionValues are resolved just before it runs.

insertInto

open override fun insertInto(table: String): InsertQuery

Starts an INSERT into table.

rawQuery

open override fun rawQuery(sql: String): RawQuery

SQL written by hand, with @name parameters. Every terminal call runs it, so calling two runs it twice.

select

open override fun select(vararg columns: String): SelectQuery

Starts a SELECT of columns, each passed through as SQL: "id", "count(*) AS total".

transaction

open override fun <T> transaction(propagation: TransactionPropagation = TransactionPropagation.REQUIRED, isolation: TransactionIsolationLevel? = null, readOnly: Boolean = false, statementTimeout: Duration? = null, transactionTimeout: Duration? = null, block: OctaviusClient.() -> T): T

Runs block in a transaction, committing when it returns and rolling back when it throws. The receiver offers no commit or rollback of its own.

transactionResult

open fun <T> transactionResult(propagation: TransactionPropagation = TransactionPropagation.REQUIRED, isolation: TransactionIsolationLevel? = null, readOnly: Boolean = false, statementTimeout: Duration? = null, transactionTimeout: Duration? = null, block: OctaviusClient.() -> DataResult<T>): DataResult<T>

transaction for the result style. A plain transaction rolls back only on a throw, so a failure turned into a value inside it is committed over; here a returned DataResult.Failure rolls back.

update

open override fun update(table: String): UpdateQuery

Starts an UPDATE of table, which renders only with a WHERE.