Available on crate feature
vtab
only.Expand description
Create virtual tables.
Follow these steps to create your own virtual table:
- Write implementation of
VTab
andVTabCursor
traits. - Create an instance of the
Module
structure specialized forVTab
impl. from step 1. - Register your
Module
structure usingConnection::create_module
. - Run a
CREATE VIRTUAL TABLE
command that specifies the new module in theUSING
clause.
(See SQLite doc)
Modules§
- array
array
Array Virtual Table. - csvtab
csvtab
CSV Virtual Table. - series
series
Generate series virtual table.
Structs§
- Context is used by
VTabCursor::column
to specify the cell value. - WHERE clause constraint.
- Iterate on index constraint and its associated usage.
feature = "vtab"
- 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 byVTab::best_index
.
Enums§
- 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
- Create an eponymous only virtual table implementation.
- Escape double-quote (
"
) character occurrences by doubling them (""
). <param_name>=['"]?<param_value>['"]?
=>(<param_name>, <param_value>)
- The boolean can be one of:
- Create a read-only virtual table implementation.
- Create an modifiable virtual table implementation.