BotCommands/io.github.freya022.botcommands.api.core.db

Package-level declarations

Types

AbstractPreparedStatement

sealed class AbstractPreparedStatement : PreparedStatement

BlockingDatabase

@Lazy

@BService

open class BlockingDatabase

Utility class to use connections given by the ConnectionSupplier.

BlockingPreparedStatement

class BlockingPreparedStatement : AbstractPreparedStatement

BlockingTransaction

class BlockingTransaction : Record

ConnectionSupplier

@InterfacedService(acceptMultiple = false)

@MissingServiceMessage(message = "Using a database required a service implementing ConnectionSupplier")

interface ConnectionSupplier

Allows access to an SQL database.

Database

@InterfacedService(acceptMultiple = false)

interface Database

Utility class to use connections given by the ConnectionSupplier, in a suspending style.

DBResult

class DBResult : Iterable<DBResult> , ResultSet

Utility class to iterate over a ResultSet, with a few methods to use nullable objects instead of booleans.

HikariSourceSupplier

@InterfacedService(acceptMultiple = false)

interface HikariSourceSupplier : ConnectionSupplier

Sub-interface of ConnectionSupplier delegating simple HikariDataSource getters.

StatementFunction

@FunctionalInterface

interface StatementFunction<R, E : Exception?>

Functional interface for Java JDBC prepared statements.

SuspendingPreparedStatement

class SuspendingPreparedStatement : AbstractPreparedStatement

Transaction

class Transaction

TransactionFunction

@FunctionalInterface

interface TransactionFunction<R, E : Exception?>

Functional interface for Java JDBC transactions.

Properties

UNIQUE_VIOLATION

@ApiStatus.ScheduledForRemoval

const val ~~UNIQUE_VIOLATION~~: String

Functions

getKotlinInstant

fun DBResult.getKotlinInstant(columnName: String): Instant

getKotlinInstantOrNull

fun DBResult.getKotlinInstantOrNull(columnName: String): Instant?

isUniqueViolation

@ApiStatus.ScheduledForRemoval

fun SQLException.~~isUniqueViolation~~(): Boolean

preparedStatement

inline suspend fun <R> Database.preparedStatement(@Language(value = "PostgreSQL") sql: String, readOnly: Boolean = false, columnNames: Array<out String>, block: SuspendingPreparedStatement.() -> R): R

inline suspend fun <R> Database.preparedStatement(@Language(value = "PostgreSQL") sql: String, readOnly: Boolean = false, generatedKeys: Boolean = false, block: SuspendingPreparedStatement.() -> R): R

inline suspend fun <R> Database.preparedStatement(@Language(value = "PostgreSQL") sql: String, readOnly: Boolean = false, columnIndexes: IntArray, block: SuspendingPreparedStatement.() -> R): R

Creates a statement from the given SQL statement, runs the block, commits the changes and closes the connection.

transactional

inline suspend fun <R> Database.transactional(readOnly: Boolean = false, crossinline block: suspend Transaction.() -> R): R

Acquires a database connection, runs the block, commits the changes and closes the connection.

withLogger

fun PreparedStatement.withLogger(logger: KLogger)

fun PreparedStatement.withLogger(name: String)

fun PreparedStatement.withLogger(logger: Logger)

Sets the logger used to log the query.