Struct LanceConfig 

pub struct LanceConfig {
    pub path: PathBuf,
    pub default_vector_column: Option<String>,
}

LanceDB embedded configuration.

This configuration accepts local filesystem directories and memory://. Native remote routes and file: URLs are rejected at validation. Construction does not open the database or create a directory.

Examples

use storage_kit::database::config::{DatabaseConfig, LanceConfig};
let config = LanceConfig::embedded_path("memory://");
assert_eq!(config.default_vector_column.as_deref(), Some("vector"));
DatabaseConfig::lance(config).validate()?;

Fields

path: PathBuf

Filesystem directory used for embedded tables, or memory://. Native remote and file: URI routes are not accepted.

default_vector_column: Option<String>

Default vector column used when a query omits its vector field.

Implementations

impl LanceConfig

pub fn embedded_path(path: impl Into<PathBuf>) -> Self

Builds an embedded LanceDB configuration rooted at path.

The default vector column is vector. The path is checked by DatabaseConfig::validate and crate::Database::connect, not by this infallible constructor.

Examples

use storage_kit::database::config::{DatabaseConfig, LanceConfig};
let config = LanceConfig::embedded_path("data/documents");
assert_eq!(config.path, std::path::PathBuf::from("data/documents"));
DatabaseConfig::lance(config).validate()?;

Trait Implementations

impl Clone for LanceConfig

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 LanceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LanceConfig

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 Serialize for LanceConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.