Struct libsql_client::spin::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(url: impl Into<String>, token: impl Into<String>) -> Self

Creates a database client with JWT authentication.

Arguments

• url - URL of the database endpoint
• token - auth token

pub fn from_credentials( url: impl Into<String>, username: impl Into<String>, pass: impl Into<String> ) -> Self

Creates a database client with Basic HTTP authentication.

Arguments

• url - URL of the database endpoint
• username - database username
• pass - user’s password

pub fn from_config(config: Config) -> Self

Creates a database client from a Config object.

pub fn from_url<T: TryInto<Url>>(url: T) -> Result<Client>where <T as TryInto<Url>>::Error: Display,

Creates a database client, given a Url

Arguments

• url - Url object of the database endpoint. This cannot be a relative URL;

Examples

use url::Url;

let url  = Url::parse("https://foo:bar@localhost:8080").unwrap();
let db = Client::from_url(url).unwrap();

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

impl Client

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

Executes a single SQL statement.

pub fn batch( &self, stmts: impl IntoIterator<Item = impl Into<Statement>> ) -> 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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.