Crate sqlite

Interface to SQLite.

Example

Open a connection, create a table, and insert a few rows:

let connection = sqlite::open(":memory:").unwrap();

let query = "
    CREATE TABLE users (name TEXT, age INTEGER);
    INSERT INTO users VALUES ('Alice', 42);
    INSERT INTO users VALUES ('Bob', 69);
";
connection.execute(query).unwrap();

Select some rows and process them one by one as plain text, which is generally not efficient:

let query = "SELECT * FROM users WHERE age > 50";

connection
    .iterate(query, |pairs| {
        for &(name, value) in pairs.iter() {
            println!("{} = {}", name, value.unwrap());
        }
        true
    })
    .unwrap();

Run the same query but using a prepared statement, which is much more efficient than the previous technique:

use sqlite::State;

let query = "SELECT * FROM users WHERE age > ?";
let mut statement = connection.prepare(query).unwrap();
statement.bind((1, 50)).unwrap();

while let Ok(State::Row) = statement.next() {
    println!("name = {}", statement.read::<String, _>("name").unwrap());
    println!("age = {}", statement.read::<i64, _>("age").unwrap());
}

Run the same query but using a cursor, which is iterable:

let query = "SELECT * FROM users WHERE age > ?";

for row in connection
    .prepare(query)
    .unwrap()
    .into_iter()
    .bind((1, 50))
    .unwrap()
    .map(|row| row.unwrap())
{
    println!("name = {}", row.read::<&str, _>("name"));
    println!("age = {}", row.read::<i64, _>("age"));
}

Re-exports

• pub extern crate sqlite3_sys as ffi;

Structs

• Connection
  A connection.
• ConnectionThreadSafe
  A thread-safe connection.
• Cursor
  An iterator for a prepared statement.
• CursorWithOwnership
  An iterator for a prepared statement with ownership.
• Error
  An error.
• OpenFlags
  Flags for opening a connection.
• Row
  A row.
• Statement
  A prepared statement.

Enums

• State
  The state of a prepared statement.
• Type
  The type of a value.
• Value
  A value.

Traits

• Bindable
  A type suitable for binding to a prepared statement.
• BindableWithIndex
  A type suitable for binding to a prepared statement given a parameter index.
• ColumnIndex
  A type suitable for indexing columns in a prepared statement.
• ParameterIndex
  A type suitable for indexing parameters in a prepared statement.
• ReadableWithIndex
  A type suitable for reading from a prepared statement given a column index.
• RowIndex
  A type suitable for indexing columns in a row.

Functions

• open
  Open a read-write connection to a new or existing database.
• version
  Return the version number of SQLite.

Type Aliases

• Result
  A result.