Struct SurrealConfig 

pub struct SurrealConfig {
    pub max_retries: u32,
    pub mode: SurrealModeConfig,
    pub namespace: Option<String>,
    pub database: Option<String>,
    pub username: Option<String>,
    pub password: Option<Password>,
}

SurrealDB-specific backend configuration.

Text-search field selection is request-owned through ScopedQuery::text_field on the request’s text options; this config does not provide a text-field fallback. The default permits two retries for confirmed rolled-back native transaction conflicts within the common operation deadline.

Examples

let config = storage_kit::database::config::SurrealConfig::default();
assert!(matches!(config.mode, storage_kit::database::config::SurrealModeConfig::Mem));
assert_eq!(config.namespace.as_deref(), Some("test"));
assert_eq!(config.max_retries, 2);
let request = storage_kit::database::query::TextSearchRequest {
    query: storage_kit::database::query::ScopedQuery::text(
        storage_kit::database::StorageLocator::new("documents"),
    ).text_field("body"),
    text: "rust".to_owned(),
};
assert_eq!(request.query.options.text_field.as_deref(), Some("body"));

Fields

max_retries: u32

Maximum retries after confirmed rollback of a native transaction conflict.

mode: SurrealModeConfig

Deployment mode used to connect to SurrealDB.

namespace: Option<String>

Default native namespace used when the locator does not provide one.

database: Option<String>

Default database used when the locator does not provide one.

username: Option<String>

Optional root username for remote or embedded engines that require auth.

password: Option<Password>

Optional root password for remote or embedded engines that require auth.

Trait Implementations

impl Clone for SurrealConfig

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 SurrealConfig

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

Formats the value using the given formatter.

impl Default for SurrealConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SurrealConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SurrealConfig> for DatabaseConfig

fn from(config: SurrealConfig) -> Self

Converts to this type from the input type.

impl Serialize for SurrealConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.