Struct DatabaseConfig 

pub struct DatabaseConfig {
    pub url: String,
    pub namespace: String,
    pub database: String,
    pub username: Option<String>,
    pub password: Option<String>,
    pub auth_level: AuthLevel,
}

Where to connect and how to sign in.

Fields

url: String

ws://host:port or wss://host (SurrealDB Cloud).

namespace: String

database: String

username: Option<String>

Signs in when set; a server started with --unauthenticated needs none.

password: Option<String>

auth_level: AuthLevel

Implementations

impl DatabaseConfig

pub fn from_env() -> Result<Self>

Reads SURREAL_URL (default DEFAULT_URL), SURREAL_NS and SURREAL_DB (default main), SURREAL_USER and SURREAL_PASS, and SURREAL_AUTH_LEVEL (root, namespace or database; default root).

pub fn envs(&self) -> Vec<(&'static str, String)>

The settings as environment variables, for child processes.

pub fn describe(&self) -> String

url ns/db, for logs; never includes the password.

Trait Implementations

impl Clone for DatabaseConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatabaseConfig

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

Formats the value using the given formatter.