KQLite/com.kqlite.column/KQLiteColumn

KQLiteColumn

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

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

This sealed class is the base for all specific column types (e.g., KQLiteTable.longColumn, KQLiteTable.textColumn). It encapsulates the properties of a database column, such as its name, data type, and constraints. Instances of this class are typically created within a KQLiteTable definition.

This class and its subclasses use a fluent API to define column constraints like KQLiteTable.primaryKey, KQLiteTable.unique, etc.

Author

MOHAMMAD AZIM ANSARI

Parameters

name

The name of the column as defined by the user stored in columnName. This name will be escaped to ensure it is a valid SQL identifier.

type

Underlying data type of the column.

Type Parameters

The Kotlin type that this column will hold (e.g., Int, String?, ByteArray).

Inheritors

CASE

Literal

Constructors

KQLiteColumn

protected constructor(name: String, type: KQLiteType)

Properties

columnName

val columnName: String

The escaped name of the column, safe for use in SQL statements.

Functions

infix fun <T> KQLiteColumn<T>.AS(alias: String): KQLiteColumn<T>

Creates an alias for a column using SQL AS.

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.

CONCAT

infix fun KQLiteColumn<*>.CONCAT(column: KQLiteColumn<*>): KQLiteColumn<String>

Concatenates this column with another column. This is an infix version of the CONCAT function, corresponding to the SQLite || operator.

infix fun KQLiteColumn<*>.CONCAT(literal: String): KQLiteColumn<String>

Concatenates two or more strings or columns together. This function corresponds to the SQLite CONCAT or || operator.

days

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

Applies NNN days modifier to a date/time value.

div

operator fun <T> KQLiteColumn<T>.div(literal: T): KQLiteColumn<T>

Represents the SQL / (division) operator between a column and a literal value.

operator fun <T> KQLiteColumn<T>.div(column: KQLiteColumn<out T>): KQLiteColumn<T>

Represents the SQL / (division) operator between two columns.

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.

minus

operator fun <T> KQLiteColumn<T>.minus(literal: T): KQLiteColumn<T>

Represents the SQL - (subtraction) operator between a column and a literal value.

operator fun <T> KQLiteColumn<T>.minus(column: KQLiteColumn<out T>): KQLiteColumn<T>

Represents the SQL - (subtraction) operator between two columns.

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.

plus

operator fun <T> KQLiteColumn<T>.plus(literal: T): KQLiteColumn<T>

Represents the SQL + (addition) operator between a column and a literal value.

operator fun <T> KQLiteColumn<T>.plus(column: KQLiteColumn<out T>): KQLiteColumn<T>

Represents the SQL + (addition) operator between two columns.

plusDate

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

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

rem

operator fun <T> KQLiteColumn<T>.rem(literal: T): KQLiteColumn<T>

Represents the SQL % (modulo) operator between a column and a literal value.

operator fun <T> KQLiteColumn<T>.rem(column: KQLiteColumn<out T>): KQLiteColumn<T>

Represents the SQL % (modulo) operator between two columns.

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.

times

operator fun <T> KQLiteColumn<T>.times(literal: T): KQLiteColumn<T>

Represents the SQL * (multiplication) operator between a column and a literal value.

operator fun <T> KQLiteColumn<T>.times(column: KQLiteColumn<out T>): KQLiteColumn<T>

Represents the SQL * (multiplication) operator between two columns.

toString

open override fun toString(): String

Returns a string representation of the column.

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.

KQLiteColumn

Author

Parameters

Type Parameters

See also

Inheritors

Constructors

Properties

Functions