driver/io.github.octaviusframework.driver.jdbc/OctaviusConnection

OctaviusConnection

internal class OctaviusConnection(val stream: PgStream, val databaseKey: DatabaseKey, maxParameterWriterCapacity: Int?, initialParameterWriterCapacity: Int?, logParameterValues: Boolean) : Connection

Represents a connection to a database within the Octavius Framework. It implements the standard JDBC Connection interface but overrides certain behaviors to fit the framework's architecture.

Constructors

OctaviusConnection

constructor(stream: PgStream, databaseKey: DatabaseKey, maxParameterWriterCapacity: Int?, initialParameterWriterCapacity: Int?, logParameterValues: Boolean)

Properties

open override var autoCommit: Boolean

open override var catalog: String

val catalogHolder: CatalogHolder

open override var clientInfo: Properties

internal val databaseKey: DatabaseKey

open override var holdability: Int

open override val isClosed: Boolean

var isClosedFlag: Boolean

open override var isReadOnly: Boolean

open override val metaData: DatabaseMetaData

open override val networkTimeout: Int

val queryExecutor: QueryExecutor

open override var schema: String

serverTransactionState

internal val serverTransactionState: TransactionState

The transaction state as the server reported it on its last ReadyForQuery, a waiting BEGIN not counted.

internal val stream: PgStream

transactionIsolation

open override var transactionIsolation: Int

transactionState

val transactionState: TransactionState

The transaction state as the session reports it: the server's, with the BEGIN still waiting counted in.

open override var typeMap: MutableMap<String, Class<*>>

open override val warnings: SQLWarning?

Functions

open override fun abort(executor: Executor?)

open fun beginRequest()

fun cancelQuery()

Asks the server to abandon whatever this connection is currently running.

fun checkClosed()

Raises unless this connection is still usable, checking both what was asked of it and what happened to it — a connection closed by the caller and one whose stream broke underneath are different failures and are reported as different SQLSTATEs.

open override fun clearWarnings()

open override fun close()

open override fun commit()

Commits, and leaves the next transaction to the next statement.

open override fun createArrayOf(typeName: String?, elements: Array<out Any>?): Array

open override fun createBlob(): Blob

open override fun createClob(): Clob

open override fun createNClob(): NClob

open override fun createSQLXML(): SQLXML

createStatement

open override fun createStatement(): Statement

open override fun createStatement(resultSetType: Int, resultSetConcurrency: Int): Statement

open override fun createStatement(resultSetType: Int, resultSetConcurrency: Int, resultSetHoldability: Int): Statement

open override fun createStruct(typeName: String?, attributes: Array<out Any>?): Struct

deferTransactionTerms

internal fun deferTransactionTerms(terms: String)

Hands terms - SET TRANSACTION, SET LOCAL - to the transaction auto-commit was just turned off for, to go out with its BEGIN.

open fun endRequest()

open override fun getAutoCommit(): Boolean

open override fun getCatalog(): String

open override fun getClientInfo(): Properties

open override fun getClientInfo(name: String?): String

open override fun getHoldability(): Int

open override fun getMetaData(): DatabaseMetaData

getNetworkTimeout

open override fun getNetworkTimeout(): Int

getOctaviusSession

fun Connection.getOctaviusSession(ownsConnection: Boolean = true): OctaviusSession

Retrieves a new OctaviusSession from this Connection.

open override fun getSchema(): String

fun getSearchPath(): List<String>

Retrieves the entries of the current search path, as the server reads the setting it last reported.

getTransactionIsolation

open override fun getTransactionIsolation(): Int

getTypeLookupOrder

fun getTypeLookupOrder(): List<String>

The schemas the server looks an unqualified type name up in, in its order - what type names resolve against.

open override fun getTypeMap(): MutableMap<String, Class<*>>

open override fun getWarnings(): SQLWarning?

open override fun isClosed(): Boolean

open override fun isReadOnly(): Boolean

open override fun isValid(timeout: Int): Boolean

open override fun isWrapperFor(iface: Class<*>): Boolean

open override fun nativeSQL(sql: String?): String

open override fun prepareCall(sql: String?): CallableStatement

open override fun prepareCall(sql: String?, resultSetType: Int, resultSetConcurrency: Int): CallableStatement

open override fun prepareCall(sql: String?, resultSetType: Int, resultSetConcurrency: Int, resultSetHoldability: Int): CallableStatement

prepareStatement

open override fun prepareStatement(sql: String?): PreparedStatement

open override fun prepareStatement(sql: String?, columnNames: Array<out String>?): PreparedStatement

open override fun prepareStatement(sql: String?, autoGeneratedKeys: Int): PreparedStatement

open override fun prepareStatement(sql: String?, columnIndexes: IntArray?): PreparedStatement

open override fun prepareStatement(sql: String?, resultSetType: Int, resultSetConcurrency: Int): PreparedStatement

open override fun prepareStatement(sql: String?, resultSetType: Int, resultSetConcurrency: Int, resultSetHoldability: Int): PreparedStatement

releaseSavepoint

open override fun releaseSavepoint(savepoint: Savepoint?)

open override fun rollback()

Rolls back, on the same terms as commit.

open override fun rollback(savepoint: Savepoint?)

open override fun setAutoCommit(autoCommit: Boolean)

Switches auto-commit, sending nothing that is not needed.

open override fun setCatalog(catalog: String?): Nothing

open override fun setClientInfo(properties: Properties?): Nothing

open override fun setClientInfo(name: String?, value: String?): Nothing

open override fun setHoldability(holdability: Int): Nothing

setNetworkTimeout

open override fun setNetworkTimeout(executor: Executor?, milliseconds: Int)

open override fun setReadOnly(readOnly: Boolean)

open override fun setSavepoint(): Savepoint

open override fun setSavepoint(name: String?): Savepoint

open override fun setSchema(schema: String?): Nothing

open fun setShardingKey(shardingKey: ShardingKey?)

open fun setShardingKey(shardingKey: ShardingKey?, superShardingKey: ShardingKey?)

setShardingKeyIfValid

open fun setShardingKeyIfValid(shardingKey: ShardingKey?, timeout: Int): Boolean

open fun setShardingKeyIfValid(shardingKey: ShardingKey?, superShardingKey: ShardingKey?, timeout: Int): Boolean

setTransactionIsolation

open override fun setTransactionIsolation(level: Int)

open override fun setTypeMap(map: MutableMap<String, Class<*>>?): Nothing

open override fun <T> unwrap(iface: Class<T>): T

inline fun <T : Any> Connection.unwrap(): T

Unwraps this Connection to an instance of the specified type T.