driver/io.github.octaviusframework.driver.query/Query

Query

abstract class Query<T : Query<T>>(val sql: String, val queryExecutor: QueryExecutor, val typeManager: TypeManager)

Base class for executing queries with parameters.

This class provides the foundational state and utilities needed for managing type conversion registries and mappings localized to a single query instance.

A converter registered here is consulted before the session's and is discarded with the query, which is what makes a one-off mapping possible without disturbing anything else on the connection.

Type Parameters

The concrete type of the query (used for fluent API return types).

Inheritors

NamedParameterQuery

NativeQuery

Constructors

Query

internal constructor(sql: String, queryExecutor: QueryExecutor, typeManager: TypeManager)

Properties

queryExecutor

internal val queryExecutor: QueryExecutor

sql

internal val sql: String

typeManager

internal val typeManager: TypeManager

The session's type manager, resolving OIDs and publishing the catalog an execution pins.

Functions

beginExecution

internal fun beginExecution(): Execution

Pins the catalog this execution will read, and builds the mappers over it.

execute

fun execute(ignoreRows: Boolean = false)

Executes a statement with no result and no row count — DDL, SET, administrative commands.

registerParameterConverter

fun registerParameterConverter(converter: ParameterConverter<*>): T

Registers a ParameterConverter for this query only, ahead of any the session already holds.

registerResultConverter

fun registerResultConverter(converter: ResultConverter<*, *>): T

Registers a ResultConverter for this query only, ahead of any the session already holds.

withQueryContext

internal inline fun <R> withQueryContext(sql: String, crossinline paramsProvider: () -> Map<String, Any?>, crossinline dbSqlProvider: () -> String? = { null }, crossinline dbParamsProvider: () -> List<Any?>? = { null }, block: () -> R): R