on

abstract fun on(vararg column: KQLiteColumn<*>): Index

Represents the ON clause of the INDEX in a com.kqlite.table.KQLiteTable.

This function defines which columns of the table will be indexed. At least one column is required. on must be specified.

Example:

 // Inside KQLiteTable
override val indexes: (IndexBuilder.() -> Unit)? = {
        createIndex("idx_name").on(name).where { status eq "active" }
        createUniqueIndex("idx_email_phone").on(email, phone)
    }

Return

The Index instance to allow for further chaining, such as adding a where clause.

Author

MOHAMMAD AZIM ANSARI

Parameters

column

The columns to be indexed.

Throws

androidx.sqlite.SQLiteException

if on column is not given