Skip to main content

Module sqlite

Module sqlite 

Source
Available on crate feature __sqlite-shared only.
Expand description

Provides types and functions related to working with SQLite

Much of this module is re-exported from database agnostic locations. However, if you are writing code specifically to extend Diesel on SQLite, you may need to work with this module directly.

Re-exports§

pub use self::query_builder::SqliteQueryBuilder;

Modules§

authorizer
Types for the SQLite authorizer callback.
expression
Sqlite related query builder extensions.
query_builder
The SQLite query builder
sql_types
SQLite specific sql types

Structs§

CollationNeededContext
Context passed to the collation-needed callback.
SerializedDatabase
SerializedDatabase is a wrapper for a serialized database that is dynamically allocated by calling sqlite3_serialize. This RAII wrapper is necessary to deallocate the memory when it goes out of scope with sqlite3_free.
Sqlite
The SQLite backend
SqliteBindCollectori-implement-a-third-party-backend-and-opt-into-breaking-changes
The BindCollector used by the SQLite backend.
SqliteBindCollectorDatai-implement-a-third-party-backend-and-opt-into-breaking-changes
SQLite bind collector data that is movable across threads.
SqliteBindValue
This type represents a value bound to a sqlite prepared statement
SqliteChangeEvent
Describes a single row change event from SQLite.
SqliteChangeOps
A bitmask of SQLite change operations used for filtering which events a hook should receive.
SqliteConnection
Connections for the SQLite backend. Unlike other backends, SQLite supported connection URLs are:
SqliteFunctionBehavior
Flags controlling SQLite custom function behavior.
SqliteReadOnlyBlob
A read only SQLite Blob
SqliteTraceFlags
Trace event mask selecting which events the callback receives.
SqliteUpdateRouter
Routes SQLite row-change events to per-table callbacks, selected by typed table! markers.
SqliteValue
Raw sqlite value as received from the database
WalCheckpointOutcome
The result of a wal_checkpoint run.

Enums§

AuthorizerContext
Context information passed to the authorizer callback.
AuthorizerDecision
Authorizer callback decision.
AutoVacuumMode
The auto_vacuum mode of a database, controlling whether and when SQLite reclaims freed pages back to the file.
BusyDecision
The decision returned by an on_busy callback when the database is locked.
CommitDecision
The decision returned by an on_commit callback, controlling whether a pending commit completes.
JsonValidFlag
Flags for the json_valid function
OwnedSqliteBindValuei-implement-a-third-party-backend-and-opt-into-breaking-changes
An owned value bound to a SQLite prepared statement.
ProgressDecision
The decision returned by an on_progress callback, controlling whether a long-running query keeps executing.
SqliteBindValueRefi-implement-a-third-party-backend-and-opt-into-breaking-changes
The concrete bind value carried by a live SqliteBindCollector.
SqliteChangeOp
Identifies which kind of row change occurred.
SqliteLimit
SQLite resource limits that can be configured per-connection.
SqliteTextRep
Text encoding SQLite requested for a missing collation.
SqliteTraceEvent
Trace events delivered to the trace callback.
SqliteType
Determines how a bind parameter is given to SQLite
WalCheckpointMode
The mode of a wal_checkpoint run, matching the modes of sqlite3_wal_checkpoint_v2.

Traits§

SqliteAggregateFunction
Trait for the implementation of a SQLite aggregate function

Functions§

cancel_auto_extension
Removes a previously registered auto-extension, returning true if it was found (docs).
register_auto_extension
Registers an auto-extension that runs for every SQLite connection opened in this process, including non-Diesel ones.
reset_auto_extension
Clears all registered auto-extensions (docs).