1# Rusqlite
2
3[![Latest Version](https://img.shields.io/crates/v/rusqlite.svg)](https://crates.io/crates/rusqlite)
4[![Documentation](https://docs.rs/rusqlite/badge.svg)](https://docs.rs/rusqlite)
5[![Build Status (GitHub)](https://github.com/rusqlite/rusqlite/workflows/CI/badge.svg)](https://github.com/rusqlite/rusqlite/actions)
6[![Build Status (AppVeyor)](https://ci.appveyor.com/api/projects/status/github/rusqlite/rusqlite?branch=master&svg=true)](https://ci.appveyor.com/project/rusqlite/rusqlite)
7[![Code Coverage](https://codecov.io/gh/rusqlite/rusqlite/branch/master/graph/badge.svg)](https://codecov.io/gh/rusqlite/rusqlite)
8[![Dependency Status](https://deps.rs/repo/github/rusqlite/rusqlite/status.svg)](https://deps.rs/repo/github/rusqlite/rusqlite)
9[![Discord Chat](https://img.shields.io/discord/927966344266256434.svg?logo=discord)](https://discord.gg/nFYfGPB8g4)
10
11Rusqlite is an ergonomic wrapper for using SQLite from Rust.
12
13Historically, 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.
14
15## Usage
16
17In your Cargo.toml:
18
19```toml
20[dependencies]
21# `bundled` causes us to automatically compile and link in an up to date
22# version of SQLite for you. This avoids many common build issues, and
23# avoids depending on the version of SQLite on the users system (or your
24# system), which may be old or missing. It's the right choice for most
25# programs that control their own SQLite databases.
26#
27# That said, it's not ideal for all scenarios and in particular, generic
28# libraries built around `rusqlite` should probably not enable it, which
29# is why it is not a default feature -- it could become hard to disable.
30rusqlite = { version = "0.29.0", features = ["bundled"] }
31```
32
33Simple example usage:
34
35```rust
36use rusqlite::{Connection, Result};
37
38#[derive(Debug)]
39struct Person {
40    id: i32,
41    name: String,
42    data: Option<Vec<u8>>,
43}
44
45fn main() -> Result<()> {
46    let conn = Connection::open_in_memory()?;
47
48    conn.execute(
49        "CREATE TABLE person (
50            id    INTEGER PRIMARY KEY,
51            name  TEXT NOT NULL,
52            data  BLOB
53        )",
54        (), // empty list of parameters.
55    )?;
56    let me = Person {
57        id: 0,
58        name: "Steven".to_string(),
59        data: None,
60    };
61    conn.execute(
62        "INSERT INTO person (name, data) VALUES (?1, ?2)",
63        (&me.name, &me.data),
64    )?;
65
66    let mut stmt = conn.prepare("SELECT id, name, data FROM person")?;
67    let person_iter = stmt.query_map([], |row| {
68        Ok(Person {
69            id: row.get(0)?,
70            name: row.get(1)?,
71            data: row.get(2)?,
72        })
73    })?;
74
75    for person in person_iter {
76        println!("Found person {:?}", person.unwrap());
77    }
78    Ok(())
79}
80```
81
82### Supported SQLite Versions
83
84The base `rusqlite` package supports SQLite version 3.14.0 or newer. If you need
85support for older versions, please file an issue. Some cargo features require a
86newer SQLite version; see details below.
87
88### Optional Features
89
90Rusqlite provides several features that are behind [Cargo
91features](https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section). They are:
92
93* [`load_extension`](https://docs.rs/rusqlite/~0/rusqlite/struct.LoadExtensionGuard.html)
94  allows loading dynamic library-based SQLite extensions.
95* [`backup`](https://docs.rs/rusqlite/~0/rusqlite/backup/index.html)
96  allows use of SQLite's online backup API. Note: This feature requires SQLite 3.6.11 or later.
97* [`functions`](https://docs.rs/rusqlite/~0/rusqlite/functions/index.html)
98  allows you to load Rust closures into SQLite connections for use in queries.
99  Note: This feature requires SQLite 3.7.3 or later.
100* `window` for [window function](https://www.sqlite.org/windowfunctions.html) support (`fun(...) OVER ...`). (Implies `functions`.)
101* [`trace`](https://docs.rs/rusqlite/~0/rusqlite/trace/index.html)
102  allows hooks into SQLite's tracing and profiling APIs. Note: This feature
103  requires SQLite 3.6.23 or later.
104* [`blob`](https://docs.rs/rusqlite/~0/rusqlite/blob/index.html)
105  gives `std::io::{Read, Write, Seek}` access to SQL BLOBs. Note: This feature
106  requires SQLite 3.7.4 or later.
107* [`limits`](https://docs.rs/rusqlite/~0/rusqlite/struct.Connection.html#method.limit)
108  allows you to set and retrieve SQLite's per connection limits.
109* `chrono` implements [`FromSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html)
110  and [`ToSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html) for various
111  types from the [`chrono` crate](https://crates.io/crates/chrono).
112* `serde_json` implements [`FromSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html)
113  and [`ToSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html) for the
114  `Value` type from the [`serde_json` crate](https://crates.io/crates/serde_json).
115* `time` implements [`FromSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html)
116   and [`ToSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html) for the
117   `time::OffsetDateTime` type from the [`time` crate](https://crates.io/crates/time).
118* `url` implements [`FromSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.FromSql.html)
119  and [`ToSql`](https://docs.rs/rusqlite/~0/rusqlite/types/trait.ToSql.html) for the
120  `Url` type from the [`url` crate](https://crates.io/crates/url).
121* `bundled` uses a bundled version of SQLite.  This is a good option for cases where linking to SQLite is complicated, such as Windows.
122* `sqlcipher` looks for the SQLCipher library to link against instead of SQLite. This feature overrides `bundled`.
123* `bundled-sqlcipher` uses a bundled version of SQLCipher. This searches for and links against a system-installed crypto library to provide the crypto implementation.
124* `bundled-sqlcipher-vendored-openssl` allows using bundled-sqlcipher with a vendored version of OpenSSL (via the `openssl-sys` crate) as the crypto provider.
125  - As the name implies this depends on the `bundled-sqlcipher` feature, and automatically turns it on.
126  - 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.
127* `hooks` for [Commit, Rollback](http://sqlite.org/c3ref/commit_hook.html) and [Data Change](http://sqlite.org/c3ref/update_hook.html) notification callbacks.
128* `unlock_notify` for [Unlock](https://sqlite.org/unlock_notify.html) notification.
129* `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.
130* `series` exposes [`generate_series(...)`](https://www.sqlite.org/series.html) Table-Valued Function. (Implies `vtab`.)
131* [`csvtab`](https://sqlite.org/csv.html), CSV virtual table written in Rust. (Implies `vtab`.)
132* [`array`](https://sqlite.org/carray.html), The `rarray()` Table-Valued Function. (Implies `vtab`.)
133* `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.
134* `uuid` allows storing and retrieving `Uuid` values from the [`uuid`](https://docs.rs/uuid/) crate using blobs.
135* [`session`](https://sqlite.org/sessionintro.html), Session module extension. Requires `buildtime_bindgen` feature. (Implies `hooks`.)
136* `extra_check` fail when a query passed to execute is readonly or has a column count > 0.
137* `column_decltype` provides `columns()` method for Statements and Rows; omit if linking to a version of SQLite/SQLCipher compiled with `-DSQLITE_OMIT_DECLTYPE`.
138* `collation` exposes [`sqlite3_create_collation_v2`](https://sqlite.org/c3ref/create_collation.html).
139* `winsqlite3` allows linking against the SQLite present in newer versions of Windows
140
141## Notes on building rusqlite and libsqlite3-sys
142
143`libsqlite3-sys` is a separate crate from `rusqlite` that provides the Rust
144declarations 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
145[Vcpkg](https://github.com/Microsoft/vcpkg) installation for MSVC ABI builds.
146
147You can adjust this behavior in a number of ways:
148
149* If you use the `bundled`, `bundled-sqlcipher`, or `bundled-sqlcipher-vendored-openssl` features, `libsqlite3-sys` will use the
150  [cc](https://crates.io/crates/cc) crate to compile SQLite or SQLCipher from source and
151  link against that. This source is embedded in the `libsqlite3-sys` crate and
152  is currently SQLite 3.41.2 (as of `rusqlite` 0.29.0 / `libsqlite3-sys`
153  0.26.0).  This is probably the simplest solution to any build problems. You can enable this by adding the following in your `Cargo.toml` file:
154  ```toml
155  [dependencies.rusqlite]
156  version = "0.29.0"
157  features = ["bundled"]
158  ```
159* 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 `LIBSQLITE3_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.)
160* When using `bundled-sqlcipher` (and not also using `bundled-sqlcipher-vendored-openssl`), `libsqlite3-sys` will need to
161  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.
162
163* 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`.
164* Installing the sqlite3 development packages will usually be all that is required, but
165  the build helpers for [pkg-config](https://github.com/alexcrichton/pkg-config-rs)
166  and [vcpkg](https://github.com/mcgoo/vcpkg-rs) have some additional configuration
167  options. The default when using vcpkg is to dynamically link,
168  which must be enabled by setting `VCPKGRS_DYNAMIC=1` environment variable before build.
169  `vcpkg install sqlite3:x64-windows` will install the required library.
170* 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.
171
172
173### Binding generation
174
175We use [bindgen](https://crates.io/crates/bindgen) to generate the Rust
176declarations from SQLite's C header file. `bindgen`
177[recommends](https://github.com/servo/rust-bindgen#library-usage-with-buildrs)
178running this as part of the build process of libraries that used this. We tried
179this briefly (`rusqlite` 0.10.0, specifically), but it had some annoyances:
180
181* The build time for `libsqlite3-sys` (and therefore `rusqlite`) increased
182  dramatically.
183* Running `bindgen` requires a relatively-recent version of Clang, which many
184  systems do not have installed by default.
185* Running `bindgen` also requires the SQLite header file to be present.
186
187As of `rusqlite` 0.10.1, we avoid running `bindgen` at build-time by shipping
188pregenerated bindings for several versions of SQLite. When compiling
189`rusqlite`, we use your selected Cargo features to pick the bindings for the
190minimum SQLite version that supports your chosen features. If you are using
191`libsqlite3-sys` directly, you can use the same features to choose which
192pregenerated bindings are chosen:
193
194* `min_sqlite_version_3_14_0` - SQLite 3.14.0 bindings (this is the default)
195
196If you use any of the `bundled` features, you will get pregenerated bindings for the
197bundled version of SQLite/SQLCipher. If you need other specific pregenerated binding
198versions, please file an issue. If you want to run `bindgen` at buildtime to
199produce your own bindings, use the `buildtime_bindgen` Cargo feature.
200
201If you enable the `modern_sqlite` feature, we'll use the bindings we would have
202included with the bundled build. You generally should have `buildtime_bindgen`
203enabled if you turn this on, as otherwise you'll need to keep the version of
204SQLite you link with in sync with what rusqlite would have bundled, (usually the
205most recent release of SQLite). Failing to do this will cause a runtime error.
206
207## Contributing
208
209Rusqlite has many features, and many of them impact the build configuration in
210incompatible ways. This is unfortunate, and makes testing changes hard.
211
212To help here: you generally should ensure that you run tests/lint for
213`--features bundled`, and `--features "bundled-full session buildtime_bindgen"`.
214
215If running bindgen is problematic for you, `--features bundled-full` enables
216bundled and all features which don't require binding generation, and can be used
217instead.
218
219### Checklist
220
221- Run `cargo fmt` to ensure your Rust code is correctly formatted.
222- Ensure `cargo clippy --workspace --features bundled` passes without warnings.
223- Ensure `cargo clippy --workspace --features "bundled-full session buildtime_bindgen"` passes without warnings.
224- Ensure `cargo test --workspace --features bundled` reports no failures.
225- Ensure `cargo test --workspace --features "bundled-full session buildtime_bindgen"` reports no failures.
226
227## Author
228
229Rusqlite is the product of hard work by a number of people. A list is available
230here: https://github.com/rusqlite/rusqlite/graphs/contributors
231
232## Community
233
234Feel free to join the [Rusqlite Discord Server](https://discord.gg/nFYfGPB8g4) to discuss or get help with `rusqlite` or `libsqlite3-sys`.
235
236## License
237
238Rusqlite and libsqlite3-sys are available under the MIT license. See the LICENSE file for more info.
239
240### Licenses of Bundled Software
241
242Depending on the set of enabled cargo `features`, rusqlite and libsqlite3-sys will also bundle other libraries, which have their own licensing terms:
243
244- 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).
245
246- 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).
247
248Both 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.
249