Skip to main content

surrealdb

9 configuration options · available in Rust, Python

Quick start
use opendal::Operator;

let op = Operator::via_iter("surrealdb", [
])?;
All configuration options (copy & trim)
Full reference
use opendal::Operator;

let op = Operator::via_iter("surrealdb", [
// The connection string for surrealdb.
// ("connection_string".to_string(), "...".to_string()),

// The username for surrealdb.
// ("username".to_string(), "...".to_string()),

// The password for surrealdb.
// ("password".to_string(), "...".to_string()),

// The namespace for surrealdb.
// ("namespace".to_string(), "...".to_string()),

// The database for surrealdb.
// ("database".to_string(), "...".to_string()),

// The table for surrealdb.
// ("table".to_string(), "...".to_string()),

// The key field for surrealdb.
// ("key_field".to_string(), "...".to_string()),

// The value field for surrealdb.
// ("value_field".to_string(), "...".to_string()),

// The root for surrealdb.
// ("root".to_string(), "...".to_string()),

])?;

Every option is passed as a string key; OpenDAL parses it into the right type. Some services may require building the binding with the matching services-* feature enabled.

Configuration reference

General9
KeyTypeRequiredDescription
connection_stringstringnoThe connection string for surrealdb.
usernamestringnoThe username for surrealdb.
passwordstringnoThe password for surrealdb.
namespacestringnoThe namespace for surrealdb.
databasestringnoThe database for surrealdb.
tablestringnoThe table for surrealdb.
key_fieldstringnoThe key field for surrealdb.
value_fieldstringnoThe value field for surrealdb.
rootstringnoThe root for surrealdb.