KQLite/com.kqlite.column

Package-level declarations

Types

interface Bind

An interface that defines the binding of values with ? to handle safely. Typically used within the context of INSERT or UPDATE statements.

BooleanLiteral

class BooleanLiteral(value: Boolean) : Literal<Boolean>

Represents standard BOOLEAN as Boolean literal in a KQLite query.

ByteArrayLiteral

class ByteArrayLiteral(value: ByteArray) : Literal<ByteArray>

Represents standard BLOB as ByteArray literal in a KQLite query.

ByteLiteral

class ByteLiteral(value: Byte) : Literal<Byte>

Represents an 8-bit signed Byte literal in a KQLite query.

CASE

class CASE(builder: CaseBuilder.() -> Unit) : KQLiteColumn<String>

Represents a SQL CASE expression in a KQLite query.

CaseBuilder

interface CaseBuilder

DSL builder for constructing the branches of a CASE expression.

CharLiteral

class CharLiteral(value: Char) : Literal<Char>

Represents a single Char literal in a KQLite query.

DateLiteral

class DateLiteral(value: String) : Literal<KQLiteDate>

Represents a DATE as KQLiteDate literal in a KQLite query.

DateTimeLiteral

class DateTimeLiteral(value: String) : Literal<KQLiteDateTime>

Represents a DATETIME as KQLiteDateTime literal in a KQLite query.

DateTimeModifier

interface DateTimeModifier

A marker interface to work with SQLite's date and time functions.

DoubleLiteral

class DoubleLiteral(value: Double) : Literal<Double>

Represents standard REAL a 64-bit double-precision Double literal in a KQLite query.

FloatLiteral

class FloatLiteral(value: Float) : Literal<Float>

Represents a 32-bit single-precision Float literal in a KQLite query.

Generated

enum Generated : Enum<Generated>

Specifies GENERATED ALWAYS AS in a database table.

IntLiteral

class IntLiteral(value: Int) : Literal<Int>

Represents a 32-bit signed Int literal in a KQLite query.

JsonArrayLiteral

class JsonArrayLiteral(value: String) : Literal<KQLiteJsonArray>

Represents a JSON ARRAY as KQLiteJsonArray literal in a KQLite query.

JsonLiteral

class JsonLiteral(value: String) : Literal<KQLiteJson>

Represents a JSON as KQLiteJson literal in a KQLite query.

JsonObjectLiteral

class JsonObjectLiteral(value: String) : Literal<KQLiteJsonObject>

Represents a JSON OBJECT as KQLiteJsonObject literal in a KQLite query.

JulianDayLiteral

class JulianDayLiteral(value: Double) : Literal<KQLiteJulianDay>

Represents a KQLiteJulianDay literal in a KQLite query.

KQLiteColumn

sealed class KQLiteColumn<T>(name: String, type: KQLiteType)

Represents a column in a KQLite database table (KQLiteTable).

KQLiteDate

interface KQLiteDate : DateTimeModifier

Represents com.kqlite.functions.DATE data stored within a KQLiteTable.dateColumn.

KQLiteDateTime

interface KQLiteDateTime : DateTimeModifier

Represents com.kqlite.functions.DATETIME data stored within a KQLiteTable.dateTimeColumn.

KQLiteJson

interface KQLiteJson

Represents com.kqlite.functions.JSON data stored within a KQLiteTable.jsonColumn.

KQLiteJsonArray

interface KQLiteJsonArray : KQLiteJson

Represents com.kqlite.functions.JSON_ARRAY data stored within a KQLiteTable.jsonArrayColumn.

KQLiteJsonObject

interface KQLiteJsonObject : KQLiteJson

Represents com.kqlite.functions.JSON_OBJECT data stored within a KQLiteTable.jsonObjectColumn.

KQLiteJulianDay

interface KQLiteJulianDay : DateTimeModifier

Represents com.kqlite.functions.JULIANDAY number stored within a KQLiteTable.julianDayColumn.

KQLiteTime

interface KQLiteTime : DateTimeModifier

Represents com.kqlite.functions.TIME data stored within a KQLiteTable.timeColumn.

KQLiteUnixEpoch

interface KQLiteUnixEpoch : DateTimeModifier

Represents com.kqlite.functions.UNIXEPOCH time stored within a KQLiteTable.unixEpochColumn.

Literal

sealed class Literal<T>(type: KQLiteType, value: Any) : KQLiteColumn<T>

Represents a literal value in a KQLite query.

LongLiteral

class LongLiteral(value: Long) : Literal<Long>

Represents standard INTEGER a 64-bit signed Long literal in a KQLite query.

OrderColumn

class OrderColumn @JvmOverloads constructor(column: KQLiteColumn<*>, collate: Collate? = null, sort: Sort? = null, nulls: Nulls? = null)

Represents a column used in an ORDER BY clause, specifying the sorting criteria.

ShortLiteral

class ShortLiteral(value: Short) : Literal<Short>

Represents a 16-bit signed Short literal in a KQLite query.

StringLiteral

class StringLiteral(value: String) : Literal<String>

Represents standard TEXT as String literal in a KQLite query.

TimeLiteral

class TimeLiteral(value: String) : Literal<KQLiteTime>

Represents a TIME as KQLiteTime literal in a KQLite query.

UByteLiteral

class UByteLiteral(value: UByte) : Literal<UByte>

Represents an 8-bit unsigned UByte literal in a KQLite query.

UIntLiteral

class UIntLiteral(value: UInt) : Literal<UInt>

Represents a 32-bit unsigned UInt literal in a KQLite query.

ULongLiteral

class ULongLiteral(value: ULong) : Literal<ULong>

Represents a 64-bit unsigned ULong literal in a KQLite query.

UnixEpochLiteral

class UnixEpochLiteral(value: Long) : Literal<KQLiteUnixEpoch>

Represents a KQLiteUnixEpoch literal in a KQLite query.

UShortLiteral

class UShortLiteral(value: UShort) : Literal<UShort>

Represents a 16-bit unsigned UShort literal in a KQLite query.

WhenBlock

interface WhenBlock

Represents a conditional branch within a CASE expression.

Properties

CURRENT_DATE

val CURRENT_DATE: KQLiteColumn<KQLiteDate>

Represents the SQL CURRENT_DATE function.

CURRENT_TIME

val CURRENT_TIME: KQLiteColumn<KQLiteTime>

Represents the SQL CURRENT_TIME function.

CURRENT_TIMESTAMP

val CURRENT_TIMESTAMP: KQLiteColumn<KQLiteDateTime>

Represents the SQL CURRENT_TIMESTAMP function.

Functions

auto

fun <T : DateTimeModifier?> KQLiteColumn<T>.auto(): KQLiteColumn<T>

Applies the auto modifier, allowing SQLite to automatically convert between date/time text representations and Julian day numbers as needed.

ceiling

fun <T : DateTimeModifier?> KQLiteColumn<T>.ceiling(): KQLiteColumn<T>

Applies ceiling modifier to a date/time value.

days

fun <T : DateTimeModifier?> KQLiteColumn<T>.days(days: Int): KQLiteColumn<T>

Applies NNN days modifier to a date/time value.

floor

fun <T : DateTimeModifier?> KQLiteColumn<T>.floor(): KQLiteColumn<T>

Applies floor modifier to a date/time value.

hours

fun <T : DateTimeModifier?> KQLiteColumn<T>.hours(hours: Int): KQLiteColumn<T>

Applies NNN hours modifier to a date/time value.

julianday

fun <T : DateTimeModifier?> KQLiteColumn<T>.julianday(): KQLiteColumn<T>

Applies julianday modifier to a date/time value.

localtime

fun <T : DateTimeModifier?> KQLiteColumn<T>.localtime(): KQLiteColumn<T>

Applies the localtime modifier to a date/time value, converting it from UTC to the local time zone.

minusDate

fun <T : DateTimeModifier?> KQLiteColumn<T>.minusDate(date: KQLiteColumn<out T>): KQLiteColumn<T>

Applies -YYYY-MM-DD modifier to a date/time value.

minutes

fun <T : DateTimeModifier?> KQLiteColumn<T>.minutes(minutes: Int): KQLiteColumn<T>

Applies NNN minutes modifier to a date/time value.

months

fun <T : DateTimeModifier?> KQLiteColumn<T>.months(months: Int): KQLiteColumn<T>

Applies NNN months modifier to a date/time value.

notNull

fun <T : Any> KQLiteColumn<T?>.notNull(): KQLiteColumn<T>

Adds a NOT NULL constraint to the column.

now

fun <T : DateTimeModifier?> KQLiteColumn<T>.now(): KQLiteColumn<T>

Applies the now modifier to a date/time function, representing the current UTC date and time. For local time, use localtime.

plusDate

fun <T : DateTimeModifier?> KQLiteColumn<T>.plusDate(date: KQLiteColumn<out T>): KQLiteColumn<T>

Applies +YYYY-MM-DD modifier to a date/time value.

seconds

fun <T : DateTimeModifier?> KQLiteColumn<T>.seconds(seconds: Int): KQLiteColumn<T>

Applies NNN seconds modifier to a date/time value.

startOfDay

fun <T : DateTimeModifier?> KQLiteColumn<T>.startOfDay(): KQLiteColumn<T>

Applies start of day modifier to a date/time value.

startOfMonth

fun <T : DateTimeModifier?> KQLiteColumn<T>.startOfMonth(): KQLiteColumn<T>

Applies start of month modifier to a date/time value.

startOfYear

fun <T : DateTimeModifier?> KQLiteColumn<T>.startOfYear(): KQLiteColumn<T>

Applies start of year modifier to a date/time value.

subsec

fun <T : DateTimeModifier?> KQLiteColumn<T>.subsec(): KQLiteColumn<T>

Applies the subsec modifier to a date/time value, enabling fractional second precision.

subsecond

fun <T : DateTimeModifier?> KQLiteColumn<T>.subsecond(): KQLiteColumn<T>

Applies the subsecond modifier to a date/time value, enabling fractional second precision.

unixepoch

fun <T : DateTimeModifier?> KQLiteColumn<T>.unixepoch(): KQLiteColumn<T>

Applies unixepoch modifier to a date/time value.

utc

fun <T : DateTimeModifier?> KQLiteColumn<T>.utc(): KQLiteColumn<T>

Applies the utc modifier to a date/time value, interpreting it as Coordinated Universal Time (UTC).

weekday

fun <T : DateTimeModifier?> KQLiteColumn<T>.weekday(weekday: Int): KQLiteColumn<T>

Applies weekday N modifier to a date/time value.

years

fun <T : DateTimeModifier?> KQLiteColumn<T>.years(years: Int): KQLiteColumn<T>

Applies NNN years modifier to a date/time value.