2016-11-05 11:34:15 +01:00

81 lines
2.2 KiB
Markdown

# SQLite [![Version][version-img]][version-url] [![Status][status-img]][status-url]
The package provides an interface to [SQLite][1].
## [Documentation][documentation]
## Example
Open a connection, create a table, and insert some rows:
```rust
let connection = sqlite::open(":memory:").unwrap();
connection.execute("
CREATE TABLE users (name TEXT, age INTEGER);
INSERT INTO users (name, age) VALUES ('Alice', 42);
INSERT INTO users (name, age) VALUES ('Bob', 69);
").unwrap();
```
Select some rows and process them one by one as plain text:
```rust
connection.iterate("SELECT * FROM users WHERE age > 50", |pairs| {
for &(column, value) in pairs.iter() {
println!("{} = {}", column, value.unwrap());
}
true
}).unwrap();
```
The same query using a prepared statement, which is much more efficient than the
previous technique:
```rust
use sqlite::State;
let mut statement = connection.prepare("
SELECT * FROM users WHERE age > ?
").unwrap();
statement.bind(1, 50).unwrap();
while let State::Row = statement.next().unwrap() {
println!("name = {}", statement.read::<String>(0).unwrap());
println!("age = {}", statement.read::<i64>(1).unwrap());
}
```
The same query using a cursor, which is a wrapper around a prepared statement
providing the concept of row and featuring all-at-once binding:
```rust
use sqlite::Value;
let mut cursor = connection.prepare("
SELECT * FROM users WHERE age > ?
").unwrap().cursor();
cursor.bind(&[Value::Integer(50)]).unwrap();
while let Some(row) = cursor.next().unwrap() {
println!("name = {}", row[0].as_string().unwrap());
println!("age = {}", row[1].as_integer().unwrap());
}
```
## Contribution
Your contribution is highly appreciated. Do not hesitate to open an issue or a
pull request. Note that any contribution submitted for inclusion in the project
will be licensed according to the terms given in [LICENSE.md](LICENSE.md).
[1]: https://www.sqlite.org
[documentation]: https://docs.rs/sqlite
[status-img]: https://travis-ci.org/stainless-steel/sqlite.svg?branch=master
[status-url]: https://travis-ci.org/stainless-steel/sqlite
[version-img]: https://img.shields.io/crates/v/sqlite.svg
[version-url]: https://crates.io/crates/sqlite