Struct Sqlite 

pub struct Sqlite { /* private fields */ }

Available on crate feature services-sqlite only.

Capabilities

Depending on its configuration and the backing system, this service can expose:

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

Inspect the effective capability set with opendal_core::Operator::info and opendal_core::OperatorInfo::capability after building an operator.

Configuration

Use crate::SqliteConfig for serializable configuration and this builder’s methods for direct construction. The field and method documentation defines accepted values, defaults, and environment interaction.

Example

Via Builder

use opendal_core::Operator;
use opendal_core::Result;
use opendal_service_sqlite::Sqlite;

#[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)?;
    Ok(())
}

Implementations

impl SqliteBuilder

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

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) -> SqliteBuilder

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

default: “/”

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

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

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

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) -> SqliteBuilder

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

Default to value if not specified.

Trait Implementations

impl Builder for SqliteBuilder

type Config = SqliteConfig

Associated configuration.

fn build(self) -> Result<impl Service, Error>

Consume the builder to build a service.

impl Debug for SqliteBuilder

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

Formats the value using the given formatter.

impl Default for SqliteBuilder

fn default() -> SqliteBuilder

Returns the “default value” for a type.