Struct opendal::services::Sqlite

pub struct Sqlite { /* private fields */ }

Available on crate feature services-sqlite only.

Capabilities

This service can be used to:

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

Configuration

• root: Set the working directory of OpenDAL
• connection_string: Set the connection string of sqlite database
• table: Set the table of sqlite
• key_field: Set the key field of sqlite
• value_field: Set the value field of sqlite

Example

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Sqlite::default()
        .root("/")
        .connection_string("file//abc.db")
        .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 SqliteBuilder

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

Set the connection_string of the sqlite service.

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

Url

This format resembles the url format of the sqlite client:

• sqlite::memory:
• sqlite:data.db
• sqlite://data.db

For more information, please visit https://docs.rs/sqlx/latest/sqlx/sqlite/struct.SqliteConnectOptions.html.

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 sqlite service to read/write.

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

Set the key field name of the sqlite 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 sqlite service to read/write.

Default to value if not specified.

Trait Implementations

impl Builder for SqliteBuilder

const SCHEME: Scheme = Scheme::Sqlite

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

type Config = SqliteConfig

Associated configuration for this builder.

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

Consume the accessor builder to build a service.

impl Debug for SqliteBuilder

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

Formats the value using the given formatter.

impl Default for SqliteBuilder

fn default() -> SqliteBuilder

Returns the “default value” for a type.