Struct CollectionHandle 

pub struct CollectionHandle { /* private fields */ }

A named collection that is created with an inferred dimension on first use.

Implementations

impl CollectionHandle

pub fn upsert( &self, points: impl IntoIterator<Item = Point>, ) -> Result<WriteResult>

Adds or replaces points, creating a missing collection on first write.

The first write infers the collection dimension from its points. All vectors in that batch must be nonempty and have the same dimension.

Examples found in repository

examples/persistence.rs (line 8)

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 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("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 (lines 7-10)

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 (lines 7-10)

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 search( &self, vector: impl IntoIterator<Item = f32>, limit: usize, ) -> Result<Vec<ScoredPoint>>

Searches for the nearest points using the collection’s automatic mode.

Payload metadata is included in every returned winner. Use CollectionHandle::advanced for filters, stored vectors, immutable roots, execution statistics, or explicit search tuning.

Examples found in repository

examples/quickstart.rs (line 11)

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(())
}

pub fn query(&self, query: Query) -> Result<QueryResult>

Executes a detailed vector query without leaving the common facade.

pub fn query_batch( &self, queries: impl IntoIterator<Item = Query>, ) -> Result<Vec<QueryResult>>

Executes detailed vector queries in input order.

pub fn get(&self, request: GetRequest) -> Result<GetResult>

Retrieves records using IDs, filters, pagination, and include controls.

pub fn get_ids( &self, ids: impl IntoIterator<Item = PointId>, ) -> Result<Vec<Record>>

Retrieves points by typed ID with payload metadata included.

pub fn delete_ids( &self, ids: impl IntoIterator<Item = PointId>, ) -> Result<WriteResult>

Deletes points by typed ID. Missing IDs are ignored.

pub fn delete(&self, selector: DeleteSelector) -> Result<WriteResult>

Deletes records selected by IDs, a filter, or both.

pub fn apply( &self, mutations: impl IntoIterator<Item = SnapshotMutation>, ) -> Result<MutationResult>

Applies an ordered batch of upserts and deletions in one ref update.

pub fn count(&self) -> Result<usize>

Returns the number of points in the collection.

Examples found in repository

examples/persistence.rs (line 9)

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(())
}

pub fn count_where(&self, filter: Filter) -> Result<usize>

Returns the number of points matching a payload or ID filter.

pub fn root(&self) -> Result<ObjectId>

Returns the current immutable collection root.

pub fn restore(&self, revision: impl AsRef<str>) -> Result<WriteResult>

Restores a historical root as a new history-preserving commit.

pub fn peek(&self, limit: usize) -> Result<Vec<Record>>

Returns the first limit canonically ordered points with payloads.

pub fn advanced(&self) -> Result<Collection>

Opens the existing collection through the detailed named API.

Examples found in repository

examples/history.rs (line 8)

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/filtering.rs (line 11)

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(())
}

Trait Implementations

impl Clone for CollectionHandle

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 CollectionHandle

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

Formats the value using the given formatter.