KQLite/com.kqlite.table

Package-level declarations

Example KQLite table

object Todo : KQLiteTable("todo") {
    val id = longColumn("id").notNull().primaryKey().autoIncrement()
    val title = textColumn("title").notNull()
    val description = textColumn("description")
    val createdDateTime = dateTimeColumn("created_date_time").notNull().default(CURRENT_TIMESTAMP)
    val modifiedDateTime = dateTimeColumn("modified_date_time")
    val type = enumColumn("type", TodoType.entries)
    val tags = jsonArrayColumn("tags").default(JsonArrayLiteral("[]"))
    val isDone = booleanColumn("is_done").default(false)
    val completedDate = dateColumn("completed_date")
}

Types

Action

enum Action : Enum<Action>

Specifies the ON CONFLICT action to be taken when a constraint violation occurs.

AliasTable

sealed class AliasTable(original: KQLiteTable, tblAlias: String) : KQLiteTable

Represents a table with an alias in a SQL query.

Collate

enum Collate : Enum<Collate>

Specifies the COLLATE sequence to be used for text comparisons in a column.

ForeignKeyAction

enum ForeignKeyAction : Enum<ForeignKeyAction>

Represents the set of actions that can be specified for an ON DELETE or ON UPDATE clause of a foreign key constraint in a database. These actions determine how the database should behave when a referenced key is deleted or updated.

JoinOp

enum JoinOp : Enum<JoinOp>

Represents the comparison operators used in a JOIN clause in SELECT statement.

JSON_EACH

class JSON_EACH @JvmOverloads constructor(json: KQLiteColumn<*>, path: String? = null) : JsonColumns

Represents the SQLite json_each() table-valued function.

JSON_TREE

class JSON_TREE @JvmOverloads constructor(json: KQLiteColumn<*>, path: String? = null) : JsonColumns

Represents the SQLite json_tree() table-valued function.

JsonColumns

sealed class JsonColumns(name: String, alias: KQLiteColumn<String>) : KQLiteTable

Represents the structure of the virtual table returned by SQLite's JSON table-valued functions, specifically json_each() and json_tree(). This sealed class defines the common columns available in the result set of these functions.

KQLiteAdapter

interface KQLiteAdapter<T>

An adapter responsible for converting between a database row and a Kotlin object of type T.

KQLiteTable

abstract class KQLiteTable @JvmOverloads constructor(name: String, temp: Boolean = false, ifNotExists: Boolean = true, strict: Boolean = false, withoutRowId: Boolean = false)

Represents a database table definition in KQLite.

MasterColumns

sealed class MasterColumns(name: String) : KQLiteTable

Represents the schema of the special SQLite master tables (sqlite_schema, sqlite_master, etc.). These tables are read-only and contain the schema for all other tables and indices in the database.

SQLiteMaster

class SQLiteMaster @JvmOverloads constructor(temp: Boolean = false) : MasterColumns

Represents the sqlite_master table in a SQLite database.

SQLiteSchema

class SQLiteSchema @JvmOverloads constructor(temp: Boolean = false) : MasterColumns

Represents the sqlite_schema table in a SQLite database.

SQLiteSequence

class SQLiteSequence : KQLiteTable

Represents the internal sqlite_sequence table in SQLite.