Struct SqliteConnection 

pub struct SqliteConnection { /* private fields */ }

A Limbo-backed SQLite connection implementing Connection.

Create via SqliteConnection::open (file path) or SqliteConnection::open_memory (:memory:).

Statement cache

Each SqliteConnection maintains an LRU cache of compiled limbo::Statement objects (capacity: STMT_CACHE_CAPACITY = 128). The cache is shared across clones of the same connection (the clones share the underlying limbo::Connection) and is updated on every DML/DDL execution. Cache hits save the per-statement parse-and-compile round-trip inside Limbo.

Implementations

impl SqliteConnection

pub async fn open(path: &str) -> Result<Self, OxiSqlError>

Open a Limbo database at the given file path.

Pass ":memory:" for an in-memory database, or use open_memory for clarity.

Errors

Returns OxiSqlError if the file cannot be opened or created.

pub async fn open_memory() -> Result<Self, OxiSqlError>

Open a fresh in-memory Limbo database.

Errors

Returns OxiSqlError if the engine cannot be initialised.

pub async fn open_from_bytes(bytes: &[u8]) -> Result<Self, OxiSqlError>

Open a Limbo-backed connection from an in-memory SQLite database image.

The bytes are copied into an in-memory page store; no temporary file is ever created, so this works on WASI, in the browser, and on read-only filesystems. Mirrors SQLite’s sqlite3_deserialize() / rusqlite’s Connection::deserialize. See limbo::Database::open_from_bytes.

Example

use oxisql_core::Connection;
use oxisql_sqlite_compat::SqliteConnection;

// `image` is a complete SQLite database file loaded into memory,
// e.g. `include_bytes!("../data/app.db")`.
let image: &[u8] = get_database_image();
let conn = SqliteConnection::open_from_bytes(image).await?;
let rows = conn.query("SELECT count(*) FROM sqlite_master", &[]).await?;

Errors

Returns OxiSqlError if bytes is not a valid SQLite database image (too short, wrong magic header, or an invalid page size). Never panics on malformed input.

pub fn path(&self) -> &str

Return the path this connection was opened with.

Trait Implementations

impl Clone for SqliteConnection

fn clone(&self) -> SqliteConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Connection for SqliteConnection

fn execute<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, sql: &'life1 str, params: &'life2 [&'life3 dyn ToSqlValue], ) -> Pin<Box<dyn Future<Output = Result<u64, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Execute a DML/DDL statement and return the number of rows affected.

fn query<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, sql: &'life1 str, params: &'life2 [&'life3 dyn ToSqlValue], ) -> Pin<Box<dyn Future<Output = Result<Vec<Row>, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Execute a SELECT statement and return the result rows.

fn transaction<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Transaction + '_>, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Begin a transaction, returning a handle that can be committed or rolled back.

fn execute_batch<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<u64, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute multiple semicolon-separated SQL statements in a single call.

fn ping<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lightweight connectivity check.

fn prepare<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn PreparedStatement + '_>, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compile a SQL statement for repeated execution with different parameters.

fn tables<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<TableInfo>, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List all tables visible to the current connection.

fn columns<'life0, 'life1, 'async_trait>( &'life0 self, table: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ColumnInfo>, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List all columns of the named table.

fn indexes<'life0, 'life1, 'async_trait>( &'life0 self, table: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<IndexInfo>, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List all indexes defined on the named table.

fn foreign_keys<'life0, 'life1, 'async_trait>( &'life0 self, table: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ForeignKeyInfo>, OxiSqlError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List all foreign-key constraints on the named table.

fn execute_named<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, sql: &'life1 str, params: &'life2 [(&'life3 str, &'life4 dyn ToSqlValue)], ) -> Pin<Box<dyn Future<Output = Result<u64, OxiSqlError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, Self: 'async_trait,

Execute a SQL statement with named parameters.

fn query_named<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, sql: &'life1 str, params: &'life2 [(&'life3 str, &'life4 dyn ToSqlValue)], ) -> Pin<Box<dyn Future<Output = Result<Vec<Row>, OxiSqlError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, Self: 'async_trait,

Execute a SQL query with named parameters and return the result rows.

fn last_warnings(&self) -> Vec<SqlWarning>

Return any SQL warnings generated by the most recently executed statement.

fn query_stream<'a>( &'a self, sql: &'a str, params: &'a [&'a dyn ToSqlValue], ) -> Pin<Box<dyn Stream<Item = Result<Row, OxiSqlError>> + Send + 'a>>

Execute a SELECT and return rows as an async stream.

impl Debug for SqliteConnection

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

Formats the value using the given formatter.