Struct libsql::Database

pub struct Database { /* private fields */ }

A struct that knows how to build Connection’s, this type does not do much work until the Database::connect fn is called.

Implementations

impl Database

pub fn open_in_memory() -> Result<Self>

Available on crate feature core only.

Open an in-memory libsql database.

pub fn open(db_path: impl Into<String>) -> Result<Database>

Available on crate feature core only.

Open a file backed libsql database.

pub fn open_with_flags( db_path: impl Into<String>, flags: OpenFlags ) -> Result<Database>

Available on crate feature core only.

Open a file backed libsql database with flags.

impl Database

pub async fn open_with_local_sync( db_path: impl Into<String> ) -> Result<Database>

Available on crate feature replication only.

Open a local database file with the ability to sync from snapshots from local filesystem.

pub async fn open_with_remote_sync( db_path: impl Into<String>, url: impl Into<String>, token: impl Into<String> ) -> Result<Database>

Available on crate feature replication only.

Open a local database file with the ability to sync from a remote database.

pub async fn open_with_remote_sync_consistent( db_path: impl Into<String>, url: impl Into<String>, token: impl Into<String> ) -> Result<Database>

Available on crate feature replication only.

Open a local database file with the ability to sync from a remote database in consistent mode.

Consistent mode means that when a write happens it will not complete until that write is visible in the local db.

pub async fn open_with_remote_sync_connector<C>( db_path: impl Into<String>, url: impl Into<String>, token: impl Into<String>, connector: C, read_your_writes: bool ) -> Result<Database>

where C: Service<Uri> + Send + Clone + Sync + 'static, C::Response: Socket, C::Future: Send + 'static, C::Error: Into<Box<dyn Error + Send + Sync>>,

Available on crate feature replication only.

Connect an embedded replica to a remote primary with a custom http connector.

pub async fn sync(&self) -> Result<Option<FrameNo>>

Available on crate feature replication only.

Sync database from remote, and returns the committed frame_no after syncing, if applicable.

pub async fn sync_frames(&self, frames: Frames) -> Result<Option<FrameNo>>

Available on crate feature replication only.

Apply a set of frames to the database and returns the committed frame_no after syncing, if applicable.

pub async fn flush_replicator(&self) -> Result<Option<FrameNo>>

Available on crate feature replication only.

Force buffered replication frames to be applied, and return the current commit frame_no if applicable.

pub async fn replication_index(&self) -> Result<Option<FrameNo>>

Available on crate feature replication only.

Returns the database currently committed replication index

impl Database

pub fn open_remote( url: impl Into<String>, auth_token: impl Into<String> ) -> Result<Self>

Available on crate feature remote only.

Open a remote based HTTP database using libsql’s hrana protocol.

pub fn open_remote_with_connector<C>( url: impl Into<String>, auth_token: impl Into<String>, connector: C ) -> Result<Self>

where C: Service<Uri> + Send + Clone + Sync + 'static, C::Response: Socket, C::Future: Send + 'static, C::Error: Into<Box<dyn Error + Send + Sync>>,

Available on crate feature remote only.

Connect to a remote libsql using libsql’s hrana protocol with a custom connector.

impl Database

pub fn connect(&self) -> Result<Connection>

Connect to the database this can mean a few things depending on how it was constructed:

• When constructed with open/open_with_flags/open_in_memory this will call into the libsql C ffi and create a connection to the libsql database.
• When constructed with open_remote and friends it will not call any C ffi and will lazily create a HTTP connection to the provided endpoint.
• When constructed with open_with_remote_sync_ and friends it will attempt to perform a handshake with the remote server and will attempt to replicate the remote database locally.