Struct Store 

pub struct Store { /* private fields */ }

A persistent embedded vector database with lazy collection handles.

Implementations

impl Store

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Opens or safely creates a database at path.

pub fn collection(&self, name: impl Into<String>) -> CollectionHandle

Returns a lazy handle for a named collection.

This method performs no repository write. A missing collection is created by its first nonempty CollectionHandle::upsert.

Examples found in repository

examples/persistence.rs (line 7)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let path = temporary.path().join("vectors.git");
    open(&path)?
        .collection("docs")
        .upsert([Point::new("stable-id", [1.0, 0.0])])?;
    assert_eq!(open(&path)?.collection("docs").count()?, 1);
    Ok(())
}

examples/history.rs (line 5)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let docs = open(temporary.path().join("vectors.git"))?.collection("docs");
    docs.upsert([Point::new("v1", [1.0, 0.0])])?;
    docs.upsert([Point::new("v2", [0.0, 1.0])])?;
    assert_eq!(docs.advanced()?.history(10)?.len(), 3);
    Ok(())
}

examples/quickstart.rs (line 6)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let db = open(temporary.path().join("vectors.git"))?;
    let docs = db.collection("docs");
    docs.upsert([
        Point::new("east", [1.0, 0.0]),
        Point::new("north", [0.0, 1.0]),
    ])?;
    let hits = docs.search([0.9, 0.1], 1)?;
    assert_eq!(hits[0].id.to_string(), "east");
    Ok(())
}

examples/filtering.rs (line 6)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let docs = open(temporary.path().join("vectors.git"))?.collection("docs");
    docs.upsert([
        Point::new("guide", [1.0, 0.0]).with_metadata(json!({"kind": "docs"}))?,
        Point::new("code", [0.9, 0.1]).with_metadata(json!({"kind": "source"}))?,
    ])?;
    let result = docs.advanced()?.query(
        Query::new([1.0, 0.0], 5)
            .with_filter(Filter::must([Condition::matches("kind", "docs")]))
            .with_payload(),
    )?;
    assert_eq!(result.points[0].id.to_string(), "guide");
    Ok(())
}

pub fn list_collections(&self) -> Result<Vec<String>>

Returns collection names in canonical ascending order.

pub fn advanced(&self) -> &Database

Returns the advanced named-database API.

impl Store

pub fn text_collection<E: Embedder>( &self, name: impl Into<String>, embedder: E, ) -> Result<TextCollection<E>>

Opens a text collection bound to the embedder’s stable model identity.

Examples found in repository

examples/text.rs (line 28)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let db = open(temporary.path().join("documents.git"))?;
    let docs = db.text_collection("docs", ExampleEmbedder)?;
    docs.upsert_documents([
        Document::new("east", "A document about the east"),
        Document::new("north", "A document about the north"),
    ])?;
    assert_eq!(
        docs.search_text("north wind", 1)?[0].id.to_string(),
        "north"
    );
    Ok(())
}

examples/text_fastembed.rs (line 8)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let db = open(temporary.path().join("documents.git"))?;
    let docs = db.text_collection("docs", FastEmbedder::try_new()?)?;
    docs.upsert_documents([
        Document::new("git", "Git-native vector search"),
        Document::new("fruit", "Fresh fruit at the market"),
    ])?;
    let hits = docs.search_text("versioned database search", 1)?;
    println!("{}", hits[0].id);
    Ok(())
}

Trait Implementations

impl Clone for Store

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 Store

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

Formats the value using the given formatter.