Struct libsql_client::local::Client

pub struct Client { /* private fields */ }

Database client. This is the main structure used to communicate with the database.

Implementations

impl Client

pub fn new(path: impl AsRef<Path>) -> Result<Self>

Establishes a database client.

Arguments

• path - path of the local database

pub fn in_memory() -> Result<Self>

Establishes a new in-memory database and connects to it.

pub fn from_env() -> Result<Self>

pub async fn raw_batch( &self, stmts: impl IntoIterator<Item = impl Into<Statement>> ) -> Result<BatchResult>

Executes a batch of SQL statements. Each statement is going to run in its own transaction, unless they’re wrapped in BEGIN and END

Arguments

• stmts - SQL statements

Examples

let db = libsql_client::local::Client::new("/tmp/example321.db").unwrap();
let result = db
    .raw_batch(["CREATE TABLE t(id)", "INSERT INTO t VALUES (42)"])
    .await;

Trait Implementations

impl DatabaseClient for Client

fn raw_batch<'life0, 'async_trait>( &'life0 self, stmts: impl 'async_trait + IntoIterator<Item = impl 'async_trait + Into<Statement>> ) -> Pin<Box<dyn Future<Output = Result<BatchResult>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Executes a batch of SQL statements. Each statement is going to run in its own transaction, unless they’re wrapped in BEGIN and END

fn execute<'life0, 'async_trait>( &'life0 self, stmt: impl 'async_trait + Into<Statement> ) -> Pin<Box<dyn Future<Output = Result<ResultSet>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Executes a single SQL statement

fn batch<'life0, 'async_trait>( &'life0 self, stmts: impl 'async_trait + IntoIterator<Item = impl 'async_trait + Into<Statement>> ) -> Pin<Box<dyn Future<Output = Result<Vec<ResultSet>>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Executes a batch of SQL statements, wrapped in “BEGIN”, “END”, transaction-style. Each statement is going to run in its own transaction, unless they’re wrapped in BEGIN and END

fn transaction<'a, 'async_trait>( &'a self ) -> Pin<Box<dyn Future<Output = Result<Transaction<'a, Self>>> + 'async_trait>>where Self: 'async_trait, 'a: 'async_trait,

Starts an interactive transaction and returns a Transaction object. The object can be later used to execute(), commit() or rollback() the interactive transaction.

fn execute_in_transaction<'life0, 'async_trait>( &'life0 self, _tx_id: u64, stmt: Statement ) -> Pin<Box<dyn Future<Output = Result<ResultSet>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn commit_transaction<'life0, 'async_trait>( &'life0 self, _tx_id: u64 ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn rollback_transaction<'life0, 'async_trait>( &'life0 self, _tx_id: u64 ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

impl Debug for Client

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

Formats the value using the given formatter.