Struct opendal::services::Libsql

pub struct Libsql { /* private fields */ }

Available on crate feature services-libsql only.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• presign
• blocking

Configuration

• root: Set the working directory of OpenDAL
• connection_string: Set the connection string for libsql server
• auth_token: Set the authentication token for libsql server
• table: Set the table of libsql
• key_field: Set the key field of libsql
• value_field: Set the value field of libsql

Example

Via Builder

use anyhow::Result;
use opendal::services::Libsql;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Libsql::default()
        .root("/")
        .connection_string("https://example.com/db")
        .auth_token("secret")
        .table("your_table")
        // key field type in the table should be compatible with Rust's &str like text
        .key_field("key")
        // value field type in the table should be compatible with Rust's Vec<u8> like bytea
        .value_field("value");

    let op = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl LibsqlBuilder

pub fn connection_string(self, v: &str) -> Self

Set the connection_string of the libsql service.

This connection string is used to connect to the libsql service. There are url based formats:

Url

This format resembles the url format of the libsql client.

for a remote database connection:

• http://example.com/db
• https://example.com/db
• libsql://example.com/db

pub fn auth_token(self, auth_token: &str) -> Self

set the authentication token for libsql service.

default: no authentication token

pub fn root(self, root: &str) -> Self

set the working directory, all operations will be performed under it.

default: “/”

pub fn table(self, table: &str) -> Self

Set the table name of the libsql service to read/write.

pub fn key_field(self, key_field: &str) -> Self

Set the key field name of the libsql service to read/write.

Default to key if not specified.

pub fn value_field(self, value_field: &str) -> Self

Set the value field name of the libsql service to read/write.

Default to value if not specified.

Trait Implementations

impl Builder for LibsqlBuilder

const SCHEME: Scheme = Scheme::Libsql

Associated scheme for this builder. It indicates what underlying service is.

type Config = LibsqlConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access>

Consume the accessor builder to build a service.

impl Debug for LibsqlBuilder

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

Formats the value using the given formatter.

impl Default for LibsqlBuilder

fn default() -> LibsqlBuilder

Returns the “default value” for a type.