2014-11-05 00:32:06 +08:00
# Rusqlite
2018-02-13 01:37:03 +08:00
[](https://crates.io/crates/rusqlite)
2022-01-05 14:32:24 +08:00
[](https://docs.rs/rusqlite)
[](https://github.com/rusqlite/rusqlite/actions)
[](https://ci.appveyor.com/project/rusqlite/rusqlite)
[](https://codecov.io/gh/rusqlite/rusqlite)
[](https://deps.rs/repo/github/rusqlite/rusqlite)
2022-01-07 10:40:02 +08:00
[](https://discord.gg/nFYfGPB8g4)
2014-11-05 01:48:33 +08:00
2022-03-07 14:39:24 +08:00
Rusqlite is an ergonomic wrapper for using SQLite from Rust.
2022-03-11 04:30:02 +08:00
Historically, the API was based on the one from [`rust-postgres` ](https://github.com/sfackler/rust-postgres ). However, the two have diverged in many ways, and no compatibility between the two is intended.
2022-03-07 14:39:24 +08:00
## Usage
In your Cargo.toml:
```toml
[dependencies]
# `bundled` causes us to automatically compile and link in an up to date
2022-03-07 14:58:29 +08:00
# version of SQLite for you. This avoids many common build issues, and
# avoids depending on the version of SQLite on the users system (or your
# system), which may be old or missing. It's the right choice for most
# programs that control their own SQLite databases.
#
# That said, it's not ideal for all scenarios and in particular, generic
# libraries built around `rusqlite` should probably not enable it, which
# is why it is not a default feature -- it could become hard to disable.
2022-03-07 14:39:24 +08:00
rusqlite = { version = "0.27.0", features = ["bundled"] }
```
Simple example usage:
2014-11-05 00:32:06 +08:00
```rust
2022-03-07 14:39:24 +08:00
use rusqlite::{Connection, Result};
2014-11-05 00:32:06 +08:00
2015-02-04 07:59:58 +08:00
#[derive(Debug)]
2014-11-05 00:32:06 +08:00
struct Person {
id: i32,
name: String,
2018-10-24 18:22:54 +08:00
data: Option< Vec < u8 > >,
2014-11-05 00:32:06 +08:00
}
2019-02-09 14:16:05 +08:00
fn main() -> Result< ()> {
let conn = Connection::open_in_memory()?;
2014-11-05 00:32:06 +08:00
2018-10-24 18:22:54 +08:00
conn.execute(
"CREATE TABLE person (
2022-03-07 13:25:10 +08:00
id INTEGER PRIMARY KEY,
name TEXT NOT NULL,
data BLOB
)",
2022-03-07 14:39:24 +08:00
(), // empty list of parameters.
2019-02-09 14:16:05 +08:00
)?;
2014-11-05 00:32:06 +08:00
let me = Person {
id: 0,
name: "Steven".to_string(),
2018-10-24 18:22:54 +08:00
data: None,
2014-11-05 00:32:06 +08:00
};
2018-10-24 18:22:54 +08:00
conn.execute(
2020-03-25 00:22:50 +08:00
"INSERT INTO person (name, data) VALUES (?1, ?2)",
2022-03-07 14:39:24 +08:00
(& me.name, & me.data),
2019-02-09 14:16:05 +08:00
)?;
2014-11-05 00:32:06 +08:00
2020-03-25 00:22:50 +08:00
let mut stmt = conn.prepare("SELECT id, name, data FROM person")?;
2020-11-22 16:37:00 +08:00
let person_iter = stmt.query_map([], |row| {
2019-11-02 01:27:56 +08:00
Ok(Person {
2019-02-22 03:48:09 +08:00
id: row.get(0)?,
name: row.get(1)?,
2020-03-25 00:22:50 +08:00
data: row.get(2)?,
2019-11-02 01:27:56 +08:00
})
})?;
2015-05-07 21:36:29 +08:00
for person in person_iter {
println!("Found person {:?}", person.unwrap());
2014-11-05 00:32:06 +08:00
}
2019-02-09 14:16:05 +08:00
Ok(())
2014-11-05 00:32:06 +08:00
}
```
2017-02-10 09:12:24 +08:00
### Supported SQLite Versions
The base `rusqlite` package supports SQLite version 3.6.8 or newer. If you need
support for older versions, please file an issue. Some cargo features require a
newer SQLite version; see details below.
2015-12-13 05:04:11 +08:00
### Optional Features
Rusqlite provides several features that are behind [Cargo
2018-07-01 03:28:24 +08:00
features](https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section). They are:
2015-12-13 05:04:11 +08:00
2022-03-07 15:00:35 +08:00
* [`load_extension` ](https://docs.rs/rusqlite/~0/rusqlite/struct.LoadExtensionGuard.html )
2015-12-13 05:04:11 +08:00
allows loading dynamic library-based SQLite extensions.
2022-03-07 15:00:35 +08:00
* [`backup` ](https://docs.rs/rusqlite/~0/rusqlite/backup/index.html )
2017-02-10 09:12:24 +08:00
allows use of SQLite's online backup API. Note: This feature requires SQLite 3.6.11 or later.
2022-03-07 15:00:35 +08:00
* [`functions` ](https://docs.rs/rusqlite/~0/rusqlite/functions/index.html )
2015-12-13 05:04:11 +08:00
allows you to load Rust closures into SQLite connections for use in queries.
2017-02-09 10:41:34 +08:00
Note: This feature requires SQLite 3.7.3 or later.
2020-12-08 06:30:54 +08:00
* `window` for [window function ](https://www.sqlite.org/windowfunctions.html ) support (`fun(...) OVER ...`). (Implies `functions` .)
2022-03-07 15:00:35 +08:00
* [`trace` ](https://docs.rs/rusqlite/~0/rusqlite/trace/index.html )
2017-02-10 09:12:24 +08:00
allows hooks into SQLite's tracing and profiling APIs. Note: This feature
requires SQLite 3.6.23 or later.
2022-03-07 15:00:35 +08:00
* [`blob` ](https://docs.rs/rusqlite/~0/rusqlite/blob/index.html )
2017-02-08 11:10:31 +08:00
gives `std::io::{Read, Write, Seek}` access to SQL BLOBs. Note: This feature
requires SQLite 3.7.4 or later.
2022-03-07 15:00:35 +08:00
* [`limits` ](https://docs.rs/rusqlite/~0/rusqlite/struct.Connection.html#method.limit )
2017-02-08 08:47:59 +08:00
allows you to set and retrieve SQLite's per connection limits.
2022-03-07 15:00:35 +08:00
* `chrono` implements [`FromSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html )
and [`ToSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html ) for various
2016-05-20 09:20:58 +08:00
types from the [`chrono` crate ](https://crates.io/crates/chrono ).
2022-03-07 15:00:35 +08:00
* `serde_json` implements [`FromSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html )
and [`ToSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html ) for the
2016-05-20 09:20:58 +08:00
`Value` type from the [`serde_json` crate ](https://crates.io/crates/serde_json ).
2022-03-07 15:00:35 +08:00
* `time` implements [`FromSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html )
and [`ToSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html ) for the
2020-07-11 23:59:29 +08:00
`time::OffsetDateTime` type from the [`time` crate ](https://crates.io/crates/time ).
2022-03-07 15:00:35 +08:00
* `url` implements [`FromSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html )
and [`ToSql` ](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html ) for the
2019-03-10 11:16:37 +08:00
`Url` type from the [`url` crate ](https://crates.io/crates/url ).
2020-12-07 03:10:55 +08:00
* `bundled` uses a bundled version of SQLite. This is a good option for cases where linking to SQLite is complicated, such as Windows.
2021-06-03 03:07:56 +08:00
* `sqlcipher` looks for the SQLCipher library to link against instead of SQLite. This feature overrides `bundled` .
2021-10-06 13:57:00 +08:00
* `bundled-sqlcipher` uses a bundled version of SQLCipher. This searches for and links against a system-installed crypto library to provide the crypto implementation.
2021-06-03 03:07:56 +08:00
* `bundled-sqlcipher-vendored-openssl` allows using bundled-sqlcipher with a vendored version of OpenSSL (via the `openssl-sys` crate) as the crypto provider.
- As the name implies this depends on the `bundled-sqlcipher` feature, and automatically turns it on.
- If turned on, this uses the [`openssl-sys` ](https://crates.io/crates/openssl-sys ) crate, with the `vendored` feature enabled in order to build and bundle the OpenSSL crypto library.
2018-08-11 20:25:10 +08:00
* `hooks` for [Commit, Rollback ](http://sqlite.org/c3ref/commit_hook.html ) and [Data Change ](http://sqlite.org/c3ref/update_hook.html ) notification callbacks.
* `unlock_notify` for [Unlock ](https://sqlite.org/unlock_notify.html ) notification.
2020-07-29 17:00:03 +08:00
* `vtab` for [virtual table ](https://sqlite.org/vtab.html ) support (allows you to write virtual table implementations in Rust). Currently, only read-only virtual tables are supported.
2020-12-08 06:30:54 +08:00
* `series` exposes [`generate_series(...)` ](https://www.sqlite.org/series.html ) Table-Valued Function. (Implies `vtab` .)
2020-12-17 00:23:43 +08:00
* [`csvtab` ](https://sqlite.org/csv.html ), CSV virtual table written in Rust. (Implies `vtab` .)
2020-12-07 03:15:35 +08:00
* [`array` ](https://sqlite.org/carray.html ), The `rarray()` Table-Valued Function. (Implies `vtab` .)
Add a feature for storing i128 as blobs.
This is behind the `i128_blob` feature.
Blobs are stored as 16 byte big-endian values, with their most significant bit
flipped. This is so that sorting, comparison, etc all work properly, even with
negative numbers. This also allows the representation to be stable across
different computers.
It's possible that the `FromSql` implementation should handle the case that the
real value is stored in an integer. I didn't do this, but would be willing to
make the change. I don't think we should store them this way though, since I
don't think users would be able to sort/compare them sanely.
Support for `u128` is not implemented, as comparison with i128 values would work
strangely. This also is consistent with `u64` not being allowed, not that I
think that would be reason enough on it's own.
The `byteorder` crate is used if this feature is flipped, as it's quite small
and implements things more or less optimally. If/when `i128::{to,from}_be_bytes`
gets stabilized (https://github.com/rust-lang/rust/issues/52963), we should
probably use that instead.
2018-10-09 03:04:07 +08:00
* `i128_blob` allows storing values of type `i128` type in SQLite databases. Internally, the data is stored as a 16 byte big-endian blob, with the most significant bit flipped, which allows ordering and comparison between different blobs storing i128s to work as expected.
2019-04-11 08:04:39 +08:00
* `uuid` allows storing and retrieving `Uuid` values from the [`uuid` ](https://docs.rs/uuid/ ) crate using blobs.
2020-12-07 03:15:35 +08:00
* [`session` ](https://sqlite.org/sessionintro.html ), Session module extension. Requires `buildtime_bindgen` feature. (Implies `hooks` .)
2020-12-08 06:30:54 +08:00
* `extra_check` fail when a query passed to execute is readonly or has a column count > 0.
* `column_decltype` provides `columns()` method for Statements and Rows; omit if linking to a version of SQLite/SQLCipher compiled with `-DSQLITE_OMIT_DECLTYPE` .
* `collation` exposes [`sqlite3_create_collation_v2` ](https://sqlite.org/c3ref/create_collation.html ).
2015-12-13 05:04:11 +08:00
2017-03-04 04:37:15 +08:00
## Notes on building rusqlite and libsqlite3-sys
`libsqlite3-sys` is a separate crate from `rusqlite` that provides the Rust
2017-05-30 02:58:27 +08:00
declarations for SQLite's C API. By default, `libsqlite3-sys` attempts to find a SQLite library that already exists on your system using pkg-config, or a
2020-07-11 23:59:29 +08:00
[Vcpkg ](https://github.com/Microsoft/vcpkg ) installation for MSVC ABI builds.
2017-05-30 02:58:27 +08:00
You can adjust this behavior in a number of ways:
2017-03-04 04:37:15 +08:00
2021-06-03 03:07:56 +08:00
* If you use the `bundled` , `bundled-sqlcipher` , or `bundled-sqlcipher-vendored-openssl` features, `libsqlite3-sys` will use the
[cc ](https://crates.io/crates/cc ) crate to compile SQLite or SQLCipher from source and
2017-03-04 04:37:15 +08:00
link against that. This source is embedded in the `libsqlite3-sys` crate and
2022-02-28 01:41:10 +08:00
is currently SQLite 3.38.0 (as of `rusqlite` 0.27.0 / `libsqlite3-sys`
0.24.0). This is probably the simplest solution to any build problems. You can enable this by adding the following in your `Cargo.toml` file:
2020-03-08 22:36:56 +08:00
```toml
2017-05-02 15:36:41 +08:00
[dependencies.rusqlite]
2022-02-28 01:41:10 +08:00
version = "0.27.0"
2017-05-02 15:36:41 +08:00
features = ["bundled"]
```
2021-06-03 03:07:56 +08:00
* When using any of the `bundled` features, the build script will honor `SQLITE_MAX_VARIABLE_NUMBER` and `SQLITE_MAX_EXPR_DEPTH` variables. It will also honor a `LIBSQLITE_FLAGS` variable, which can have a format like `"-USQLITE_ALPHA -DSQLITE_BETA SQLITE_GAMMA ..."` . That would disable the `SQLITE_ALPHA` flag, and set the `SQLITE_BETA` and `SQLITE_GAMMA` flags. (The initial `-D` can be omitted, as on the last one.)
* When using `bundled-sqlcipher` (and not also using `bundled-sqlcipher-vendored-openssl` ), `libsqlite3-sys` will need to
link against crypto libraries on the system. If the build script can find a `libcrypto` from OpenSSL or LibreSSL (it will consult `OPENSSL_LIB_DIR` /`OPENSSL_INCLUDE_DIR` and `OPENSSL_DIR` environment variables), it will use that. If building on and for Macs, and none of those variables are set, it will use the system's SecurityFramework instead.
2020-12-08 09:24:47 +08:00
2021-06-03 03:07:56 +08:00
* When linking against a SQLite (or SQLCipher) library already on the system (so *not* using any of the `bundled` features), you can set the `SQLITE3_LIB_DIR` (or `SQLCIPHER_LIB_DIR` ) environment variable to point to a directory containing the library. You can also set the `SQLITE3_INCLUDE_DIR` (or `SQLCIPHER_INCLUDE_DIR` ) variable to point to the directory containing `sqlite3.h` .
2017-05-30 02:58:27 +08:00
* Installing the sqlite3 development packages will usually be all that is required, but
the build helpers for [pkg-config ](https://github.com/alexcrichton/pkg-config-rs )
and [vcpkg ](https://github.com/mcgoo/vcpkg-rs ) have some additional configuration
2019-02-17 19:03:19 +08:00
options. The default when using vcpkg is to dynamically link,
which must be enabled by setting `VCPKGRS_DYNAMIC=1` environment variable before build.
`vcpkg install sqlite3:x64-windows` will install the required library.
2021-06-03 03:07:56 +08:00
* When linking against a SQLite (or SQLCipher) library already on the system, you can set the `SQLITE3_STATIC` (or `SQLCIPHER_STATIC` ) environment variable to 1 to request that the library be statically instead of dynamically linked.
2020-07-11 23:59:29 +08:00
2020-12-08 09:24:47 +08:00
2017-03-04 04:37:15 +08:00
### Binding generation
We use [bindgen ](https://crates.io/crates/bindgen ) to generate the Rust
declarations from SQLite's C header file. `bindgen`
[recommends ](https://github.com/servo/rust-bindgen#library-usage-with-buildrs )
running this as part of the build process of libraries that used this. We tried
this briefly (`rusqlite` 0.10.0, specifically), but it had some annoyances:
* The build time for `libsqlite3-sys` (and therefore `rusqlite` ) increased
dramatically.
* Running `bindgen` requires a relatively-recent version of Clang, which many
systems do not have installed by default.
* Running `bindgen` also requires the SQLite header file to be present.
As of `rusqlite` 0.10.1, we avoid running `bindgen` at build-time by shipping
pregenerated bindings for several versions of SQLite. When compiling
`rusqlite` , we use your selected Cargo features to pick the bindings for the
minimum SQLite version that supports your chosen features. If you are using
`libsqlite3-sys` directly, you can use the same features to choose which
pregenerated bindings are chosen:
* `min_sqlite_version_3_6_8` - SQLite 3.6.8 bindings (this is the default)
* `min_sqlite_version_3_6_23` - SQLite 3.6.23 bindings
2018-09-05 00:58:17 +08:00
* `min_sqlite_version_3_7_7` - SQLite 3.7.7 bindings
2017-03-04 04:37:15 +08:00
2021-06-03 03:07:56 +08:00
If you use any of the `bundled` features, you will get pregenerated bindings for the
bundled version of SQLite/SQLCipher. If you need other specific pregenerated binding
2017-03-04 04:37:15 +08:00
versions, please file an issue. If you want to run `bindgen` at buildtime to
produce your own bindings, use the `buildtime_bindgen` Cargo feature.
2015-12-13 05:04:11 +08:00
2020-01-15 00:11:36 +08:00
If you enable the `modern_sqlite` feature, we'll use the bindings we would have
included with the bundled build. You generally should have `buildtime_bindgen`
enabled if you turn this on, as otherwise you'll need to keep the version of
SQLite you link with in sync with what rusqlite would have bundled, (usually the
2020-12-07 03:10:55 +08:00
most recent release of SQLite). Failing to do this will cause a runtime error.
2020-01-15 00:11:36 +08:00
2020-04-08 00:12:12 +08:00
## Contributing
Rusqlite has many features, and many of them impact the build configuration in
incompatible ways. This is unfortunate, and makes testing changes hard.
To help here: you generally should ensure that you run tests/lint for
2020-12-07 03:10:10 +08:00
`--features bundled` , and `--features "bundled-full session buildtime_bindgen"` .
2020-04-08 00:12:12 +08:00
If running bindgen is problematic for you, `--features bundled-full` enables
bundled and all features which don't require binding generation, and can be used
instead.
### Checklist
- Run `cargo fmt` to ensure your Rust code is correctly formatted.
2021-11-23 01:16:21 +08:00
- Ensure `cargo clippy --workspace --features bundled` passes without warnings.
- Ensure `cargo clippy --workspace --features "bundled-full session buildtime_bindgen"` passes without warnings.
- Ensure `cargo test --workspace --features bundled` reports no failures.
- Ensure `cargo test --workspace --features "bundled-full session buildtime_bindgen"` reports no failures.
2020-04-08 00:12:12 +08:00
2014-11-05 00:32:06 +08:00
## Author
2020-04-16 12:07:23 +08:00
Rusqlite is the product of hard work by a number of people. A list is available
here: https://github.com/rusqlite/rusqlite/graphs/contributors
2014-11-05 00:32:06 +08:00
2020-05-20 05:26:48 +08:00
## Community
2022-01-07 10:40:02 +08:00
Feel free to join the [Rusqlite Discord Server ](https://discord.gg/nFYfGPB8g4 ) to discuss or get help with `rusqlite` or `libsqlite3-sys` .
2020-05-20 05:26:48 +08:00
2014-11-05 00:32:06 +08:00
## License
2021-06-03 04:04:18 +08:00
Rusqlite and libsqlite3-sys are available under the MIT license. See the LICENSE file for more info.
### Licenses of Bundled Software
Depending on the set of enabled cargo `features` , rusqlite and libsqlite3-sys will also bundle other libraries, which have their own licensing terms:
- If `--features=bundled-sqlcipher` is enabled, the vendored source of [SQLcipher ](https://github.com/sqlcipher/sqlcipher ) will be compiled and statically linked in. SQLcipher is distributed under a BSD-style license, as described [here ](libsqlite3-sys/sqlcipher/LICENSE ).
- If `--features=bundled` is enabled, the vendored source of SQLite will be compiled and linked in. SQLite is in the public domain, as described [here ](https://www.sqlite.org/copyright.html ).
Both of these are quite permissive, have no bearing on the license of the code in `rusqlite` or `libsqlite3-sys` themselves, and can be entirely ignored if you do not use the feature in question.
