Struct SurrealConnection 

pub struct SurrealConnection {
    pub url: Option<String>,
    /* private fields */
}

Connection builder for SurrealDB

Fields

url: Option<String>

URL to connect to

Implementations

impl SurrealConnection

pub fn new() -> Self

Create a new connection builder

pub fn dsn(dsn: impl AsRef<str>) -> Result<Self>

Parse connection from DSN string

pub fn url(self, url: impl Into<String>) -> Self

Set the URL to connect to

pub fn namespace(self, namespace: impl Into<String>) -> Self

Set the namespace

pub fn database(self, database: impl Into<String>) -> Self

Set the database

pub fn auth_root( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Set root authentication

pub fn auth_namespace( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Set namespace authentication

pub fn auth_database( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Set database authentication

pub fn auth_scope( self, namespace: impl Into<String>, database: impl Into<String>, scope: impl Into<String>, params: Value, ) -> Self

Set scope authentication

pub fn auth_token(self, token: impl Into<String>) -> Self

Set JWT token authentication

pub fn version_check(self, check: bool) -> Self

Set version check flag

pub fn with_debug(self, enabled: bool) -> Self

Enable debug mode for query logging

pub async fn connect(self) -> Result<SurrealClient>

Connect to SurrealDB and return an immutable client

Trait Implementations

impl Clone for SurrealConnection

fn clone(&self) -> SurrealConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurrealConnection

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

Formats the value using the given formatter.

impl Default for SurrealConnection

fn default() -> SurrealConnection

Returns the “default value” for a type.