mirror of
https://github.com/isar/rusqlite.git
synced 2024-11-26 11:31:37 +08:00
101 lines
4.2 KiB
Markdown
101 lines
4.2 KiB
Markdown
# Rusqlite
|
|
|
|
[](https://travis-ci.org/jgallagher/rusqlite)
|
|
[](https://ci.appveyor.com/project/jgallagher/rusqlite) [](https://crates.io/crates/rusqlite)
|
|
|
|
Rusqlite is an ergonomic wrapper for using SQLite from Rust. It attempts to expose
|
|
an interface similar to [rust-postgres](https://github.com/sfackler/rust-postgres). View the full
|
|
[API documentation](http://jgallagher.github.io/rusqlite/rusqlite/index.html).
|
|
|
|
```rust
|
|
extern crate rusqlite;
|
|
extern crate time;
|
|
|
|
use time::Timespec;
|
|
use rusqlite::Connection;
|
|
|
|
#[derive(Debug)]
|
|
struct Person {
|
|
id: i32,
|
|
name: String,
|
|
time_created: Timespec,
|
|
data: Option<Vec<u8>>
|
|
}
|
|
|
|
fn main() {
|
|
let conn = Connection::open_in_memory().unwrap();
|
|
|
|
conn.execute("CREATE TABLE person (
|
|
id INTEGER PRIMARY KEY,
|
|
name TEXT NOT NULL,
|
|
time_created TEXT NOT NULL,
|
|
data BLOB
|
|
)", &[]).unwrap();
|
|
let me = Person {
|
|
id: 0,
|
|
name: "Steven".to_string(),
|
|
time_created: time::get_time(),
|
|
data: None
|
|
};
|
|
conn.execute("INSERT INTO person (name, time_created, data)
|
|
VALUES (?1, ?2, ?3)",
|
|
&[&me.name, &me.time_created, &me.data]).unwrap();
|
|
|
|
let mut stmt = conn.prepare("SELECT id, name, time_created, data FROM person").unwrap();
|
|
let person_iter = stmt.query_map(&[], |row| {
|
|
Person {
|
|
id: row.get(0),
|
|
name: row.get(1),
|
|
time_created: row.get(2),
|
|
data: row.get(3)
|
|
}
|
|
}).unwrap();
|
|
|
|
for person in person_iter {
|
|
println!("Found person {:?}", person.unwrap());
|
|
}
|
|
}
|
|
```
|
|
|
|
### 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.
|
|
|
|
### Optional Features
|
|
|
|
Rusqlite provides several features that are behind [Cargo
|
|
features](http://doc.crates.io/manifest.html#the-features-section). They are:
|
|
|
|
* [`load_extension`](http://jgallagher.github.io/rusqlite/rusqlite/struct.LoadExtensionGuard.html)
|
|
allows loading dynamic library-based SQLite extensions.
|
|
* [`backup`](http://jgallagher.github.io/rusqlite/rusqlite/backup/index.html)
|
|
allows use of SQLite's online backup API. Note: This feature requires SQLite 3.6.11 or later.
|
|
* [`functions`](http://jgallagher.github.io/rusqlite/rusqlite/functions/index.html)
|
|
allows you to load Rust closures into SQLite connections for use in queries.
|
|
Note: This feature requires SQLite 3.7.3 or later.
|
|
* [`trace`](http://jgallagher.github.io/rusqlite/rusqlite/trace/index.html)
|
|
allows hooks into SQLite's tracing and profiling APIs. Note: This feature
|
|
requires SQLite 3.6.23 or later.
|
|
* [`blob`](http://jgallagher.github.io/rusqlite/rusqlite/blob/index.html)
|
|
gives `std::io::{Read, Write, Seek}` access to SQL BLOBs. Note: This feature
|
|
requires SQLite 3.7.4 or later.
|
|
* [`limits`](http://jgallagher.github.io/rusqlite/rusqlite/struct.Connection.html#method.limit)
|
|
allows you to set and retrieve SQLite's per connection limits.
|
|
* `chrono` implements [`FromSql`](http://jgallagher.github.io/rusqlite/rusqlite/types/trait.FromSql.html)
|
|
and [`ToSql`](http://jgallagher.github.io/rusqlite/rusqlite/types/trait.ToSql.html) for various
|
|
types from the [`chrono` crate](https://crates.io/crates/chrono).
|
|
* `serde_json` implements [`FromSql`](http://jgallagher.github.io/rusqlite/rusqlite/types/trait.FromSql.html)
|
|
and [`ToSql`](http://jgallagher.github.io/rusqlite/rusqlite/types/trait.ToSql.html) for the
|
|
`Value` type from the [`serde_json` crate](https://crates.io/crates/serde_json).
|
|
* `bundled` uses a bundled version of sqlite3. This is a good option for cases where linking to sqlite3 is complicated, such as Windows.
|
|
|
|
## Author
|
|
|
|
John Gallagher, johnkgallagher@gmail.com
|
|
|
|
## License
|
|
|
|
Rusqlite is available under the MIT license. See the LICENSE file for more info.
|