Struct opendal::services::Surrealdb

pub struct Surrealdb { /* private fields */ }

Available on crate feature services-surrealdb 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 of surrealdb server
• username: set the username of surrealdb
• password: set the password of surrealdb
• namespace: set the namespace of surrealdb
• database: set the database of surrealdb
• table: Set the table of surrealdb
• key_field: Set the key field of surrealdb
• value_field: Set the value field of surrealdb

Example

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Surrealdb::default()
        .root("/")
        .connection_string("ws://127.0.0.1:8000")
        .username("username")
        .password("password")
        .namespace("namespace")
        .database("database")
        .table("table")
        .key_field("key")
        .value_field("value");

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

Implementations

impl SurrealdbBuilder

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

Set the connection_string of the surrealdb service.

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

Url

• ws://ip:port
• wss://ip:port
• http://ip:port
• https://ip:port

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 surrealdb service for read/write.

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

Set the username of the surrealdb service for signin.

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

Set the password of the surrealdb service for signin.

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

Set the namespace of the surrealdb service for read/write.

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

Set the database of the surrealdb service for read/write.

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

Set the key field name of the surrealdb service for read/write.

Default to key if not specified.

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

Set the value field name of the surrealdb service for read/write.

Default to value if not specified.

Trait Implementations

impl Builder for SurrealdbBuilder

const SCHEME: Scheme = Scheme::Surrealdb

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

type Config = SurrealdbConfig

Associated configuration for this builder.

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

Consume the accessor builder to build a service.

impl Debug for SurrealdbBuilder

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

Formats the value using the given formatter.

impl Default for SurrealdbBuilder

fn default() -> SurrealdbBuilder

Returns the “default value” for a type.