Ksqlite Kotlin API/ksqlite.kapi.vtab/VirtualTableCursor

VirtualTableCursor

abstract class VirtualTableCursor : SqliteVtabCursor(source)

Represents a VirtualTable cursor used to read and/or write the virtual table.

If an error is detected in a function exposed by this interface, and if error raising is allowed by SQLite, it is allowed to raise an SQLiteException that is then reported to SQLite.

Constructors

VirtualTableCursor

constructor()

Functions

abstract fun close()

Closes the cursor. It is not allowed to throw an SQLiteException here.

column

abstract fun VirtualTableColumnScope.column(index: Int)

Returns the value of the indexth column by using one of the VirtualTableColumnScope.setResult overload.

eof

abstract fun eof(): Boolean

Returns false if this cursor currently points to a valid row of data, of true otherwise.

filter

abstract fun VirtualTableFilterScope.filter(idxNum: Int, idxStr: String?, arguments: Array<ProtectedValue>)

Begins a search on a virtual table.

abstract fun next()

Advances this cursor to the next row of a result set initiated by filter.

rowid

abstract fun rowid(): Long

Returns the rowid this cursor is currently pointing at.