Module table

Defining virtual tables and table functions on sqlite3 database connections.

Structs

Constraint

Wraps the raw sqlite3_index_constraint and sqlite3_index_constraint_usage C structs for ergonomic use in Rust.

IndexInfo

Wraps the raw sqlite3_index_info C struct, which represents the possible constraints and outputs the xBestIndex method should use and return. https://www.sqlite.org/c3ref/index_info.html

OrderBy

VTabArguments

Represents all the arguments given to the virtual table implementation during xCreate, from the underlying argv/argc strings. Parsed to be more easily readable.

Enums

BestIndexError

Possible errors to return in xBestIndex.

ConstraintOperator

Possible operators for a given constraint, found and used in xBestIndex and xFilter. https://www.sqlite.org/c3ref/c_index_constraint_eq.html TODO EQ=Equals, GT=GreaterThan, etc.

OrderByDirection

UpdateOperation

Traits

VTab

VTabCursor

VTabWriteable

VTabWriteableNestedTransactions

VTabWriteableWithTransactions

Functions

define_table_function

Define a table function on the given sqlite3 database. “Table function” is the same as “eponymous-only” virtual table described at https://www.sqlite.org/vtab.html#eponymous_only_virtual_tables

define_virtual_table

Define a virtual table on the sqlite3 database connection. Optionally pass in an auxillary object, which

define_virtual_table_writeable

define_virtual_table_writeable_with_transactions

define_virtual_table_writeablex

operator

Return the ConstraintOperator for the given raw operator, usually from sqlite3_index_info.sqlite3_index_constraint.op . Values from https://www.sqlite.org/c3ref/c_index_constraint_eq.html