Module rusqlite::vtab

source · [−]

Available on crate feature vtab only.

Expand description

Create virtual tables.

Follow these steps to create your own virtual table:

Write implementation of VTab and VTabCursor traits.
Create an instance of the Module structure specialized for VTab impl. from step 1.
Register your Module structure using Connection::create_module.
Run a CREATE VIRTUAL TABLE command that specifies the new module in the USING clause.

(See SQLite doc)

Modules

arrayarray

Array Virtual Table.

csvtabcsvtab

CSV Virtual Table.

seriesseries

Generate series virtual table.

Structs

Context is used by VTabCursor::column to specify the cell value.

IndexConstraint

WHERE clause constraint.

IndexConstraintAndUsageIter

Iterate on index constraint and its associated usage.

IndexConstraintIter

feature = "vtab"

IndexConstraintUsage

Information about what parameters to pass to VTabCursor::filter.

Virtual table scan flags See Function Flags for details.

Pass information into and receive the reply from the VTab::best_index method.

Virtual table module

A column of the ORDER BY clause.

feature = "vtab"

feature = "vtab"

Values iterator.

Wrapper to VTabCursor::filter arguments, the values requested by VTab::best_index.

sqlite3_vtab_cursor

Enums

IndexConstraintOp

Index constraint operator. See Virtual Table Constraint Operator Codes for details.

Virtual table configuration options

Virtual table kind

Traits

Read-only virtual table instance trait.

Writable virtual table instance trait.

Eponymous-only virtual table instance trait.

Virtual table cursor trait.

Functions

Dequote string

eponymous_only_module

Create an eponymous only virtual table implementation.

escape_double_quote

Escape double-quote (") character occurrences by doubling them ("").

<param_name>=['"]?<param_value>['"]? => (<param_name>, <param_value>)

The boolean can be one of:

read_only_module

Create a read-only virtual table implementation.

Create an modifiable virtual table implementation.