Ksqlite Kotlin API/ksqlite.kapi.vtab/VirtualTableBestIndexScope

VirtualTableBestIndexScope

interface VirtualTableBestIndexScope(source)

Scope to use with VirtualTable.bestIndex.

Properties

distinct

abstract val distinct: Int

Integer between 0 and 3 that helps determine whether the query is distinct.

Functions

collation

abstract fun collation(index: Int): String

Returns the name of the collation sequence to use for text comparisons on the constraint at index of the received SqliteIndexInfo.

isIn

abstract fun isIn(index: Int, handle: Int): Boolean

Declares to SQLite whether the indexth constraint is an IN() constraint, and if handle is non-zero, that this virtual table intends to iterate its right-hand-side values one at a time through VirtualTableFilterScope.inFirst and VirtualTableFilterScope.inNext instead of having SQLite expand them upfront. Returns true if the constraint is indeed an IN() constraint.

rhsValue

abstract fun rhsValue(index: Int): ProtectedValue?

Returns the right-hand-side value of the indexth constraint, or null if it is not known yet.