Crate sqlite
Expand description
SQLite database driver.
§Note: linkage is semver-exempt.
This driver uses the libsqlite3-sys crate which links the native library for SQLite 3.
With the “sqlite” feature, we enable the bundled feature which builds and links SQLite from
source.
We reserve the right to upgrade the version of libsqlite3-sys as necessary to pick up new
3.x.y versions of SQLite.
Due to Cargo’s requirement that only one version of a crate that links a given native library
exists in the dependency graph at a time, using SQLx alongside another crate linking
libsqlite3-sys like rusqlite is a semver hazard.
If you are doing so, we recommend pinning the version of both SQLx and the other crate you’re
using to prevent a cargo update from breaking things, e.g.:
sqlx = { version = "=0.8.1", features = ["sqlite"] }
rusqlite = "=0.32.1"and then upgrade these crates in lockstep when necessary.
§Dynamic linking
To dynamically link to a system SQLite library, the “sqlite-unbundled” feature can be used instead.
This allows updating SQLite independently of SQLx or using forked versions, but you must have
SQLite installed on the system or provide a path to the library at build time (See
the rusqlite README
for details).
It may result in link errors if the SQLite version is too old. Version 3.20.0 or newer is
recommended. It can increase build time due to the use of bindgen.
Modules§
- types
- Conversions between Rust and SQLite types.
Structs§
- Locked
Sqlite Handle - Sqlite
- Sqlite database driver.
- Sqlite
Arguments - Sqlite
Column - Sqlite
Connect Options - Options and flags which can be used to configure a SQLite connection.
- Sqlite
Connection - A connection to an open Sqlite database.
- Sqlite
Error - Sqlite
Query Result - Sqlite
Row - Implementation of
Rowfor SQLite. - Sqlite
Statement - Sqlite
Transaction Manager - Implementation of [
TransactionManager] for SQLite. - Sqlite
Type Info - Type information for a SQLite type.
- Sqlite
Value - Sqlite
Value Ref - Update
Hook Result
Enums§
- Sqlite
Argument Value - Sqlite
Auto Vacuum - Sqlite
Journal Mode - Refer to SQLite documentation for the meaning of the database journaling mode.
- Sqlite
Locking Mode - Refer to SQLite documentation for the meaning of the connection locking mode.
- Sqlite
Operation - Sqlite
Synchronous - Refer to SQLite documentation for the meaning of various synchronous settings.
Traits§
- Sqlite
Executor - An alias for
Executor<'_, Database = Sqlite>.
Type Aliases§
- Sqlite
Pool - An alias for
Pool, specialized for SQLite. - Sqlite
Pool Options - An alias for
PoolOptions, specialized for SQLite. - Sqlite
Transaction - An alias for
Transaction, specialized for SQLite.