Struct Connection

pub struct Connection { /* private fields */ }

A connection to a SQLite database.

All operations on an Archive must happen within the context of a Transaction. You can use this connection to begin a transaction. Typically, you’ll use Connection::exec to execute a closure within a transaction.

You can open a connection to a SQLite archive using one of these methods:

• Connection::open
• Connection::create
• Connection::create_new
• Connection::open_readonly
• Connection::open_in_memory

Implementations

impl Connection

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a connection to the SQLite archive at path.

This does not create a new SQLite archive if one does not already exist.

Errors

• CannotOpen: The database could not be opened because it does not exist.
• NotADatabase: The file at path is not a SQLite database.

pub fn create<P: AsRef<Path>>(path: P) -> Result<Self>

Create or open the SQLite archive at path.

This creates the SQLite archive if it does not already exist.

Errors

• NotADatabase: The file at path exists but is not a SQLite database.

pub fn create_new<P: AsRef<Path>>(path: P) -> Result<Self>

Create a new SQLite archive at path.

This fails if the SQLite archive does not already exist.

Errors

• SqlarAlreadyExists: A SQLite archive already exists at path.

pub fn open_readonly<P: AsRef<Path>>(path: P) -> Result<Self>

Open a read-only connection to the SQLite archive at path.

This does not create a new SQLite archive if one does not already exist.

Errors

• CannotOpen: The database could not be opened because it does not exist.
• NotADatabase: The file at path is not a SQLite database.

pub fn open_in_memory() -> Result<Self>

Create a new in-memory SQLite archive.

pub fn transaction(&mut self) -> Result<Transaction<'_>>

Start a new transaction.

pub fn transaction_with( &mut self, behavior: TransactionBehavior, ) -> Result<Transaction<'_>>

Start a new transaction with the given TransactionBehavior.

pub fn exec<T, E, F>(&mut self, f: F) -> Result<T, E>

where F: FnOnce(&mut Archive<'_>) -> Result<T, E>, E: From<Error>,

Execute the given function within a new transaction.

See Transaction::exec.

pub fn exec_with<T, E, F>( &mut self, behavior: TransactionBehavior, f: F, ) -> Result<T, E>

where F: FnOnce(&mut Archive<'_>) -> Result<T, E>, E: From<Error>,

Execute the given function within a new transaction with the given TransactionBehavior.,

See Transaction::exec.

Trait Implementations

impl Debug for Connection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.