Enum DatabaseConfig 

pub enum DatabaseConfig {
    Lance {
        config: LanceConfig,
        common: CommonConfig,
    },
    Surreal {
        config: SurrealConfig,
        common: CommonConfig,
    },
}

Selects and configures one built-in database implementation.

Shared portable connection policy is carried directly by each variant, so construction has one configuration owner rather than a wrapper around a second backend-selection enum.

LanceDB is always available. SurrealDB requires surrealdb. Configuration values do not open backend resources. These constructors create data only; crate::Database::connect opens it.

Examples

use storage_kit::database::config::{DatabaseConfig, LanceConfig};
let config = DatabaseConfig::lance(LanceConfig::embedded_path("memory://"));
config.validate()?;
assert_eq!(config.common().request_timeout_ms, 30_000);

Variants

Lance

Opens LanceDB.

Fields

config: LanceConfig

LanceDB-specific settings.

common: CommonConfig

Shared portable connection policy.

Surreal

Opens SurrealDB.

Fields

config: SurrealConfig

SurrealDB-specific settings.

common: CommonConfig

Shared portable connection policy.

Implementations

impl DatabaseConfig

pub fn lance(config: LanceConfig) -> Self

Selects LanceDB with default shared connection policy.

Examples

use storage_kit::database::config::{DatabaseConfig, LanceConfig};
let config = DatabaseConfig::lance(LanceConfig::embedded_path("memory://"));
config.validate()?;

pub fn surreal(config: SurrealConfig) -> Self

Selects SurrealDB with default shared connection policy.

Examples

use storage_kit::database::config::{DatabaseConfig, SurrealConfig};
let config = DatabaseConfig::surreal(SurrealConfig::default());
config.validate()?;

pub fn with_common(self, common: CommonConfig) -> Self

Replaces the shared connection policy carried by this variant.

Examples

use storage_kit::database::config::{CommonConfig, DatabaseConfig, LanceConfig};
let config = DatabaseConfig::lance(LanceConfig::embedded_path("memory://"))
    .with_common(CommonConfig { read_only: true, ..Default::default() });
assert!(config.common().read_only);

pub fn common(&self) -> &CommonConfig

Borrows the shared connection policy.

Examples

use storage_kit::database::config::{DatabaseConfig, LanceConfig};
let config = DatabaseConfig::lance(LanceConfig::embedded_path("memory://"));
assert_eq!(config.common().connect_timeout_ms, 15_000);

pub fn validate(&self) -> Result<(), StorageError>

Validates shared policy and backend-specific settings.

This checks configuration without opening a connection or proving service availability or request-specific capability support.

Errors

Returns StorageError::InvalidConfig for zero timeouts, invalid default locator fragments, or invalid selected backend settings, such as an empty embedded path, unsupported URI route, or wrong remote URL scheme.

Examples

use storage_kit::database::config::{DatabaseConfig, LanceConfig};
let valid = DatabaseConfig::lance(LanceConfig::embedded_path("memory://"));
valid.validate()?;
let invalid = DatabaseConfig::lance(LanceConfig::embedded_path("s3://bucket/data"));
assert!(invalid.validate().is_err());

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.

impl<'de> Deserialize<'de> for DatabaseConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<LanceConfig> for DatabaseConfig

fn from(config: LanceConfig) -> Self

Converts to this type from the input type.

impl From<SurrealConfig> for DatabaseConfig

fn from(config: SurrealConfig) -> Self

Converts to this type from the input type.

impl Serialize for DatabaseConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.