Struct Collection 

pub struct Collection<T: Doc> { /* private fields */ }

A typed document collection stored in SpireDB.

Documents are stored as JSON in a SpireDB table, with vector embeddings in a separate vector index for semantic search.

Implementations

impl<T: Doc> Collection<T>

pub fn table_name(&self) -> String

The internal table name used in SpireDB.

pub fn index_name(&self) -> String

The internal vector index name used in SpireDB.

pub async fn ensure(&self) -> Result<()>

Ensure the backing table and vector index exist.

Creates them if they don’t exist. Safe to call multiple times.

pub async fn insert(&self, doc: &T) -> Result<String>

Insert a document. Automatically generates embedding if embed_text() is non-empty.

pub async fn insert_many(&self, docs: &[T]) -> Result<Vec<String>>

Insert multiple documents in a batch.

pub async fn upsert(&self, doc: &T) -> Result<String>

Upsert a document (insert or replace).

pub async fn delete(&self, id: &str) -> Result<bool>

Delete a document by ID.

pub async fn get(&self, id: &str) -> Result<Option<T>>

Get a document by ID.

Checks the in-memory cache first, then falls back to a GetPayload RPC to retrieve the payload from SpireDB.

pub async fn get_many(&self, ids: &[&str]) -> Result<Vec<T>>

Get multiple documents by IDs.

pub async fn all(&self) -> Result<Vec<T>>

List all documents in the collection.

Performs a broad vector search to retrieve all stored documents. Use filter for SQL-based filtering once implemented.

pub fn search(&self, query: &str) -> Search<T>

Start a semantic search.

pub fn similar(&self, id: &str) -> Search<T>

Find documents similar to an existing document.

pub fn similar_vec(&self, vec: &[f32]) -> Search<T>

Find documents similar to a raw vector.

pub fn filter(&self, sql_where: &str) -> Filter<T>

Filter documents using SQL WHERE clause (no vector search).

pub async fn watch(&self) -> Result<WatchStream<T>>

Watch for changes to this collection via CDC.

Trait Implementations

impl<T: Doc> Clone for Collection<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.