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 Into<String>) -> 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 sync(&self) -> Result<usize>

pub 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)"]);

pub fn batch( &self, stmts: impl IntoIterator<Item = impl Into<Statement> + Send> + Send ) -> Result<Vec<ResultSet>>

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

Arguments

• stmts - SQL statements

pub fn execute(&self, stmt: impl Into<Statement> + Send) -> Result<ResultSet>

Arguments

• stmt - the SQL statement

pub fn execute_in_transaction( &self, _tx_id: u64, stmt: Statement ) -> Result<ResultSet>

pub fn commit_transaction(&self, _tx_id: u64) -> Result<()>

pub fn rollback_transaction(&self, _tx_id: u64) -> Result<()>

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.