1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
//! Interface to [SQLite][1].
//!
//! ## Example
//!
//! Open a connection, create a table, and insert a few rows:
//!
//! ```
//! let connection = sqlite_bindings_lunatic::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 connection = sqlite_bindings_lunatic::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();
//! 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_bindings_lunatic::State;
//! # let connection = sqlite_bindings_lunatic::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();
//!
//! 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 connection = sqlite_bindings_lunatic::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();
//!
//! 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"));
//! }
//! ```
//!
//! [1]: https://www.sqlite.org
extern crate libc;
extern crate sqlite3_sys as ffi;
macro_rules! c_str_to_str(
($string:expr) => (::std::str::from_utf8(::std::ffi::CStr::from_ptr($string).to_bytes()));
);
macro_rules! c_str_to_string(
($string:expr) => (
String::from_utf8_lossy(::std::ffi::CStr::from_ptr($string as *const _).to_bytes())
.into_owned()
);
);
macro_rules! path_to_cstr(
($path:expr) => (
match $path.to_str() {
Some(path) => {
match ::std::ffi::CString::new(path) {
Ok(string) => string,
_ => raise!("failed to process a path"),
}
}
_ => raise!("failed to process a path"),
}
);
);
macro_rules! str_to_cstr(
($string:expr) => (
match ::std::ffi::CString::new($string) {
Ok(string) => string,
_ => raise!("failed to process a string"),
}
);
);
#[macro_use]
mod error;
mod value;
mod connection;
mod cursor;
mod statement;
pub use error::{Error, Result};
pub use value::{Type, Value};
pub use connection::{Connection, ConnectionWithFullMutex, OpenFlags};
pub use cursor::{Cursor, CursorWithOwnership, Row, RowIndex};
pub use statement::{
Bindable, BindableWithIndex, ColumnIndex, ParameterIndex, ReadableWithIndex, State, Statement,
};
/// Open a read-write connection to a new or existing database.
#[inline]
pub fn open<T: AsRef<std::path::Path>>(path: T) -> Result<Connection> {
Connection::open(path)
}
/// Return the version number of SQLite.
///
/// For instance, the version `3.8.11.1` corresponds to the integer `3008011`.
#[inline]
pub fn version() -> usize {
unsafe { ffi::sqlite3_libversion_number() as usize }
}