Struct DatabaseConnection

pub struct DatabaseConnection { /* private fields */ }

A connection to a sqlite3 database.

Implementations

impl DatabaseConnection

pub fn new<A: Access>(access: A) -> SqliteResult<DatabaseConnection>

Given explicit access to a database, attempt to connect to it.

Note SqliteError code is accompanied by (copy) of sqlite3_errmsg().

pub fn ignore_detail(&mut self)

Opt out of copies of error message details.

pub fn in_memory() -> SqliteResult<DatabaseConnection>

Create connection to an in-memory database.

• TODO: integrate sqlite3_errmsg()

pub fn prepare<'db: 'st, 'st>( &'db self, sql: &str, ) -> SqliteResult<PreparedStatement>

Prepare/compile an SQL statement.

pub fn prepare_with_offset<'db: 'st, 'st>( &'db self, sql: &str, ) -> SqliteResult<(PreparedStatement, usize)>

Prepare/compile an SQL statement and give offset to remaining text.

TODO: give caller a safe way to use the offset. Perhaps return a &’x str?

pub fn errmsg(&mut self) -> String

Return a copy of the latest error message.

Return "" in case of ill-formed utf-8 or null.

TODO: represent error state in types: “If a prior API call failed but the most recent API call succeeded, the return value from sqlite3_errcode() is undefined.”

cf ffi::sqlite3_errmsg.

pub fn exec(&mut self, sql: &str) -> SqliteResult<()>

One-Step Query Execution Interface

cf [sqlite3_exec][exec] [exec]: http://www.sqlite.org/c3ref/exec.html

• TODO: callback support?
• TODO: errmsg support

pub fn changes(&self) -> u64

Return the number of database rows that were changed or inserted or deleted by the most recently completed SQL statement.

cf sqlite3_changes.

pub fn busy_timeout(&mut self, d: Duration) -> SqliteResult<()>

Set a busy timeout and clear any previously set handler. If duration is zero or negative, turns off busy handler.

pub fn last_insert_rowid(&self) -> i64

Return the rowid of the most recent successful INSERT into a rowid table or virtual table.

cf sqlite3_last_insert_rowid

pub unsafe fn expose(&mut self) -> *mut sqlite3

Expose the underlying sqlite3 struct pointer for use with the ffi module.