Crate sqlite

source ·
Expand description

Interface to SQLite.

Example

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

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

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

Select some rows and process them one by one as plain text:

connection
    .iterate("SELECT * FROM users WHERE age > 50", |pairs| {
        for &(column, value) in pairs.iter() {
            println!("{} = {}", column, 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 mut statement = connection.prepare("SELECT * FROM users WHERE age > ?").unwrap();
statement.bind(1, 50).unwrap();

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

Run the same query but using a cursor, which is a wrapper around a prepared statement providing the notion of row and featuring all-at-once binding:

use sqlite::Value;

let cursor = connection
    .prepare("SELECT * FROM users WHERE age > ?")
    .unwrap()
    .into_cursor()
    .bind(&[50.into()])
    .unwrap();

for row in cursor.map(|row| row.unwrap()) {
    println!("name = {}", row.get::<String, _>("name"));
    println!("age = {}", row.get::<i64, _>("age"));
}

Structs

A database connection.
A thread-safe database connection.
An iterator over rows.
An error.
Flags for opening a database connection.
A row.
A prepared statement.

Enums

A state of a prepared statement.
A data type.
A value of a specific type.

Traits

A type suitable for binding to a prepared statement.
A type suitable for indexing columns.
A type suitable for reading from a prepared statement.
A type that values can be converted into.

Functions

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

Type Definitions

A result.