Struct DatabaseClient 

pub struct DatabaseClient { /* private fields */ }

Async SurrealDB client with connection + retry management.

This is a thin wrapper over surrealdb::Surreal bound to the dynamic Any engine. All methods are async and cancellation-safe at the tokio level.

The client is Clone-able: every clone shares the same underlying connection (the surrealdb SDK holds its own Arc).

Implementations

impl DatabaseClient

pub fn new(config: ConnectionConfig) -> Result<Self>

Build a new client. Does not open a network connection; call DatabaseClient::connect for that.

pub fn config(&self) -> &ConnectionConfig

Borrow the underlying configuration.

pub fn inner(&self) -> &Surreal<Any>

Borrow the underlying SurrealDB SDK handle (advanced usage).

pub fn is_connected(&self) -> bool

Return true if DatabaseClient::connect has completed successfully.

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

Establish the connection and select the configured namespace / database.

Retries with exponential backoff up to ConnectionConfig::retry_max_attempts times; each attempt is bounded by ConnectionConfig::timeout.

pub async fn disconnect(&self) -> Result<()>

Close the underlying connection. Safe to call even if not connected.

pub async fn signin<C: Credentials + ?Sized>( &self, creds: &C, ) -> Result<TokenAuth>

Sign in using one of the four auth levels.

pub async fn signup(&self, creds: &ScopeCredentials) -> Result<TokenAuth>

Sign up a scope user (record access).

pub async fn authenticate(&self, token: &str) -> Result<()>

Authenticate using a previously-issued JWT.

pub async fn invalidate(&self) -> Result<()>

Invalidate the current session.

pub async fn query(&self, surql: &str) -> Result<Value>

Execute a raw SurrealQL query and return every statement’s result as a JSON array (one entry per statement).

pub async fn query_with_vars( &self, surql: &str, vars: BTreeMap<String, Value>, ) -> Result<Value>

Execute a raw SurrealQL query with bound variables.

pub async fn select<T: DeserializeOwned>(&self, target: &str) -> Result<Vec<T>>

Typed SELECT against a table or record ID ("user" / "user:alice").

Internally routes through raw SurrealQL + serde_json::Value so callers only need serde::de::DeserializeOwned; the 3.x SDK’s typed select would force a SurrealValue bound on T, which would be a breaking change for existing users.

pub async fn create<T>(&self, target: &str, data: T) -> Result<T>

where T: Serialize + DeserializeOwned + Send + Sync + 'static,

Typed CREATE. Returns the created record.

pub async fn update<T>(&self, target: &str, data: T) -> Result<T>

where T: Serialize + DeserializeOwned + Send + Sync + 'static,

Typed UPDATE. Returns the updated record.

pub async fn merge<D, T>(&self, target: &str, data: D) -> Result<T>

where D: Serialize + Send + Sync + 'static, T: DeserializeOwned + Send + Sync + 'static,

Typed MERGE. Returns the merged record.

The input (D) is a partial patch; the output (T) is the full merged record. Pass a serde_json::Value or a dedicated patch struct for D.

pub async fn delete<T: DeserializeOwned>(&self, target: &str) -> Result<Vec<T>>

Typed DELETE. Returns the deleted records.

pub async fn health(&self) -> Result<bool>

Server-side health check (wraps Surreal::health).

Trait Implementations

impl Clone for DatabaseClient

fn clone(&self) -> DatabaseClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseClient

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

Formats the value using the given formatter.