jdbi3-kotlin/org.jdbi.v3.core.kotlin

Package-level declarations

Types

class KotlinMapper(val kClass: KClass<*>, prefix: String = "") : RowMapper<Any>

class KotlinMapperFactory : RowMapperFactory

This {@link RowMapperFactory} creates a new, generic {@link KotlinMapper} for every data class used. By installing this factory, any Kotlin data class will have an automatic, implicit row mapper.

KotlinPlugin

class KotlinPlugin(installKotlinMapperFactory: Boolean = true, enableCoroutineSupport: Boolean = false) : JdbiPlugin.Singleton

Installs Kotlin specific functionality.

Functions

bindKotlin

@Beta

fun <This : SqlStatement<This>> SqlStatement<This>.bindKotlin(obj: Any): This

@Beta

fun <This : SqlStatement<This>> SqlStatement<This>.bindKotlin(prefix: String, obj: Any): This

Bind all the member properties of a given Kotlin object.

configure

@Beta

fun <This : Configurable<This>, C : JdbiConfig<C>> Configurable<This>.configure(configClass: KClass<C>, configurer: Consumer<C>): This

Convenience method for Configurable.configure using Kotlin class syntax.

getConfig

fun <T : JdbiConfig<T>> StatementContext.getConfig(kClass: KClass<T>): T

Convenience helper to use any KClass for config lookup.

getQualifiers

fun getQualifiers(vararg elements: KAnnotatedElement?): Set<Annotation>

Returns the set of qualifying annotations on the given Kotlin elements.

inCoroutineContext

@Alpha

fun Jdbi.inCoroutineContext(handle: Handle? = null): CoroutineContext.Element

Returns a CoroutineContext.Element instance representing this Jdbi object which can be used to manage handles from this Jdbi in a coroutine context.

inTransactionUnchecked

@Alpha

inline fun <R> Jdbi.inTransactionUnchecked(crossinline block: (Handle) -> R): R

@Alpha

inline fun <R> Jdbi.inTransactionUnchecked(level: TransactionIsolationLevel, crossinline block: (Handle) -> R): R

Temporary extension function for Jdbi.inTransaction.

isKotlinClass

fun Class<*>.isKotlinClass(): Boolean

Returns true if the Class object represents a Kotlin class.

mapTo

inline fun <T : Any> ResultBearing.mapTo(): ResultIterable<T>

Use a reified parameter to map the result.

fun <T : Any> ResultBearing.mapTo(kClass: KClass<T>): ResultIterable<T>

Map to a Kotlin class.

useExtension

fun <E : Any, X : Exception> Jdbi.useExtension(extensionType: KClass<E>, callback: ExtensionConsumer<E, X>)

A convenience method which opens an extension of the given type, and yields it to a callback. A handle is opened if needed by the extention, and closed before returning to the caller.

useExtensionUnchecked

@Alpha

inline fun <E> Jdbi.useExtensionUnchecked(extensionType: Class<E>, crossinline callback: (E) -> Unit)

@Alpha

inline fun <E : Any> Jdbi.useExtensionUnchecked(extensionType: KClass<E>, crossinline callback: (E) -> Unit)

Temporary extension function for Jdbi.useExtension.

useHandleUnchecked

@Alpha

inline fun Jdbi.useHandleUnchecked(crossinline block: (Handle) -> Unit)

Temporary extension function for Jdbi.useHandle.

useSequence

inline fun <O : Any> ResultIterable<O>.useSequence(block: (Sequence<O>) -> Unit)

Stream all the rows of the result set out with a Sequence. Handles closing of the underlying iterator.

useTransactionUnchecked

@Alpha

inline fun Jdbi.useTransactionUnchecked(crossinline block: (Handle) -> Unit)

@Alpha

inline fun Jdbi.useTransactionUnchecked(level: TransactionIsolationLevel, crossinline block: (Handle) -> Unit)

Temporary extension function for Jdbi.useTransaction.

withExtension

fun <E : Any, R, X : Exception> Jdbi.withExtension(extensionType: KClass<E>, callback: ExtensionCallback<R, E, X>): R

A convenience method which opens an extension of the given type, yields it to a callback, and returns the result of the callback. A handle is opened if needed by the extension, and closed before returning to the caller.

withExtensionUnchecked

@Alpha

inline fun <E, R> Jdbi.withExtensionUnchecked(extensionType: Class<E>, crossinline callback: (E) -> R): R

@Alpha

inline fun <E : Any, R> Jdbi.withExtensionUnchecked(extensionType: KClass<E>, crossinline callback: (E) -> R): R

Temporary extension function for Jdbi.withExtension.

withHandleUnchecked

@Alpha

inline fun <R> Jdbi.withHandleUnchecked(crossinline block: (Handle) -> R): R

Temporary extension function for Jdbi.withHandle.