Struct Connection

pub struct Connection { /* private fields */ }

A connection to some libsql database, this can be a remote one or a local one.

Implementations

impl Connection

pub async fn execute(&self, sql: &str, params: impl IntoParams) -> Result<u64>

Execute sql query provided some type that implements IntoParams returning on success the number of rows that were changed.

Example

conn.execute("INSERT INTO foo (id) VALUES (?1)", [42]).await.unwrap();
conn.execute("INSERT INTO foo (id, name) VALUES (?1, ?2)", params![42, "baz"]).await.unwrap();

For more info on how to pass params check IntoParams’s docs.

pub async fn execute_batch(&self, sql: &str) -> Result<BatchRows>

Execute a batch set of statements.

Return

This returns a BatchRows currently only the remote and local connection supports this feature and all other connection types will return an empty set always.

pub async fn execute_transactional_batch(&self, sql: &str) -> Result<BatchRows>

Execute a batch set of statements atomically in a transaction.

Return

This returns a BatchRows currently only the remote and local connection supports this feature and all other connection types will return an empty set always.

pub async fn query(&self, sql: &str, params: impl IntoParams) -> Result<Rows>

Execute sql query provided some type that implements IntoParams returning on success the Rows.

Example

conn.query("SELECT foo FROM bar WHERE id = ?1", [42]).await.unwrap();
conn.query("SELECT foo FROM bar WHERE id = ?1 AND name = ?2", params![42, "baz"]).await.unwrap();

For more info on how to pass params check IntoParams’s docs and on how to extract values out of the rows check the Rows docs.

pub async fn prepare(&self, sql: &str) -> Result<Statement>

Prepares a cached statement.

pub async fn transaction(&self) -> Result<Transaction>

Begin a new transaction in DEFERRED mode, which is the default.

pub async fn transaction_with_behavior( &self, tx_behavior: TransactionBehavior, ) -> Result<Transaction>

Begin a new transaction in the given TransactionBehavior.

pub fn interrupt(&self) -> Result<()>

Cancel ongoing operations and return at earliest opportunity.

pub fn busy_timeout(&self, timeout: Duration) -> Result<()>

pub fn is_autocommit(&self) -> bool

Check whether libsql is in autocommit or not.

pub fn changes(&self) -> u64

Check the amount of changes the last query created.

pub fn total_changes(&self) -> u64

Check the total amount of changes the connection has done.

pub fn last_insert_rowid(&self) -> i64

Check the last inserted row id.

pub async fn reset(&self)

pub fn load_extension_enable(&self) -> Result<()>

Enable loading SQLite extensions from SQL queries and Rust API.

See load_extension documentation for more details.

pub fn load_extension_disable(&self) -> Result<()>

Disable loading SQLite extensions from SQL queries and Rust API.

See load_extension documentation for more details.

pub fn load_extension<P: AsRef<Path>>( &self, dylib_path: P, entry_point: Option<&str>, ) -> Result<()>

Load a SQLite extension from a dynamic library at dylib_path, specifying optional entry point entry_point.

Security

Loading extensions from dynamic libraries is a potential security risk, as it allows arbitrary code execution. Only load extensions that you trust.

Extension loading is disabled by default. Please use the load_extension_enable method to enable it. It’s recommended to disable extension loading after you’re done loading extensions to avoid SQL injection attacks from loading extensions.

See SQLite’s documentation on sqlite3_load_extension for more information: https://sqlite.org/c3ref/load_extension.html

pub fn authorizer(&self, hook: Option<AuthHook>) -> Result<()>

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.