Struct libsql_client::client::SyncClient

pub struct SyncClient { /* private fields */ }

A synchronous flavor of Client. All its public methods are synchronous, to make it usable in environments that don’t support async/await.

Implementations

impl SyncClient

pub fn in_memory() -> Result<Self>

Creates an in-memory database

Examples

let db = libsql_client::SyncClient::in_memory().unwrap();

pub fn from_config(config: Config) -> Result<Self>

Establishes a database client based on Config struct

Examples

let config = Config { url: url::Url::parse("file:////tmp/example.db").unwrap(), auth_token: None };
let db = libsql_client::SyncClient::from_config(config).unwrap();

pub fn from_env() -> Result<Self>

Establishes a database client based on environment variables

Env

• LIBSQL_CLIENT_URL - URL of the database endpoint - e.g. a https:// endpoint for remote connections (with specified credentials) or local file:/// path for a local database
• (optional) LIBSQL_CLIENT_TOKEN - authentication token for the database. Skip if your database does not require authentication

Examples

let db = libsql_client::SyncClient::from_env().unwrap();

pub fn from_workers_env(env: &Env) -> Result<Self>

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

Executes a batch of independent SQL statements.

For a version in which statements execute transactionally, see SyncClient::batch()

Arguments

• stmts - SQL statements

Examples

let db = libsql_client::SyncClient::in_memory().unwrap();
let res = db.raw_batch([
  "select * from foo",
  "insert into foo(bar) values ('bar')"
]).unwrap();

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

where <I as IntoIterator>::IntoIter: Send,

Transactionally executes a batch of SQL statements.

For a version in which statements can fail or succeed independently, see SyncClient::raw_batch()

Arguments

• stmts - SQL statements

Examples

let db = libsql_client::SyncClient::in_memory().unwrap();
let res = db.batch([
  "select * from foo",
  "insert into foo(bar) values ('bar')"
]).unwrap();
assert_eq!(res.len(), 2)

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

Executes a single SQL statement

Arguments

• stmt - SQL statements

Examples

let db = libsql_client::SyncClient::in_memory().unwrap();
db.execute("select * from foo").unwrap();

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

Creates an interactive transaction

Examples

let db = libsql_client::SyncClient::in_memory().unwrap();
let tx = db.transaction().unwrap();
tx.execute("select * from foo").unwrap();
tx.commit();