KQLite/com.kqlite.statement

Package-level declarations

Types

sealed class Clause

A sealed class that provides a domain-specific language (DSL) for constructing SQL clauses, primarily used in WHERE and HAVING conditions. It offers a type-safe and fluent way to build complex logical expressions.

CompoundStatement

interface CompoundStatement

Represents a compound SELECT statement in SQL, allowing the combination of results from multiple SELECT statements using operators like UNION, UNION ALL, EXCEPT, and INTERSECT.

DeleteStatement

interface DeleteStatement<T : KQLiteTable>

Represents a builder for constructing and executing a SQL DELETE statement.

InsertStatement

interface InsertStatement<T : KQLiteTable> : AutoCloseable

Represents a prepared SQL INSERT statement that can be configured and executed.

JoinStatement

interface JoinStatement<T : KQLiteTable>

Represents a statement for defining the JOIN condition in a KQLite query. This is typically used after specifying the tables to join (INNER JOIN, LEFT JOIN, etc.).

SelectStatement

interface SelectStatement<T : KQLiteTable> : JoinStatement<T> , CompoundStatement

Represents a builder for a SQL SELECT statement.

Statement

interface Statement

Represents an intermediate stage in building a SQL SELECT query.

UpdateStatement

interface UpdateStatement<T : KQLiteTable>

Represents a configurable UPDATE statement in the KQLite DSL.

Functions

delete

fun <T : KQLiteTable> T.delete(): DeleteStatement<T>

Creates a DELETE statement builder for constructing a custom delete query.

fun <T : KQLiteTable> T.delete(connection: SQLiteConnection): DeleteStatement<T>

Same as delete() but executes on the given connection

insert

@JvmOverloads

fun <T : KQLiteTable> T.insert(vararg columns: KQLiteColumn<*>, onConflict: Action? = null, connection: SQLiteConnection? = null): InsertStatement<T>

Creates an InsertStatement to construct and execute an SQL INSERT query.

insertDefaultValues

fun <T : KQLiteTable> T.insertDefaultValues()

Inserts a new row into the table using the default values for all columns.

quickDelete

fun <T : KQLiteTable> T.quickDelete(connection: SQLiteConnection? = null, where: Clause.(T) -> Unit?)

Executes SQL DELETE and deletes rows from the table.

quickInsert

@JvmOverloads

fun <T : KQLiteTable> T.quickInsert(onConflict: Action? = null, connection: SQLiteConnection? = null, binding: Bind.(T) -> Unit)

Executes SQL INSERT and inserts a single row into the table.

quickSelect

@JvmOverloads

fun <T : KQLiteTable> T.quickSelect(vararg columns: KQLiteColumn<*>, connection: SQLiteConnection? = null, where: Clause.(T) -> Unit? = null): KQLiteCursor

A convenience function for performing a simple SELECT query.

quickUpdate

fun <T : KQLiteTable> T.quickUpdate(binding: Bind.(T) -> Unit, where: Clause.(T) -> Unit?, connection: SQLiteConnection? = null)

Performs a quick and simple UPDATE operation on the table.

select

@JvmOverloads

fun select(vararg columns: KQLiteColumn<*>, distinct: Boolean = false): Statement

Starts building a SELECT statement with the specified columns.

select

@JvmOverloads

fun <T : KQLiteTable> T.select(vararg columns: KQLiteColumn<*>, distinct: Boolean = false): SelectStatement<T>

Begins building a SELECT query statement.

update

@JvmOverloads

fun <T : KQLiteTable> T.update(onConflict: Action? = null, connection: SQLiteConnection? = null, binding: Bind.(T) -> Unit): UpdateStatement<T>

Creates an UPDATE statement for the table.