Struct Collection 

pub struct Collection { /* private fields */ }

Cheap, cloneable, thread-safe handle to one collection.

Implementations

impl Collection

pub fn create_index(&self, field_name: &str, params: &IndexParams) -> Result<()>

pub fn drop_index(&self, field_name: &str) -> Result<()>

pub fn optimize(&self) -> Result<()>

pub fn rebuild_index(&self, field_name: &str) -> Result<()>

Rebuilds one configured in-memory index generation.

impl Collection

pub fn start_maintenance( &self, options: CollectionMaintenanceOptions, ) -> Result<CollectionMaintenanceRuntime>

Starts the collection’s single explicitly owned background scheduler.

The worker is opt-in and uses only standard threads. Each due run rebuilds the complete derived index registry and checkpoints the same authoritative revision. Read-only and closed collections reject it.

impl Collection

pub fn insert(&self, docs: &[&Doc]) -> Result<WriteResult>

pub fn update(&self, docs: &[&Doc]) -> Result<WriteResult>

pub fn upsert(&self, docs: &[&Doc]) -> Result<WriteResult>

pub fn delete(&self, pks: &[&str]) -> Result<WriteResult>

pub fn delete_by_filter(&self, filter: &str) -> Result<()>

impl Collection

pub fn query(&self, query: &SearchQuery) -> Result<Vec<Doc>>

pub fn multi_query(&self, query: &MultiQuery) -> Result<Vec<Doc>>

pub fn group_by( &self, query: &GroupBySearchQuery, ) -> Result<HashMap<String, Vec<Doc>>>

pub fn group_by_query( &self, query: &GroupBySearchQuery, ) -> Result<HashMap<String, Vec<Doc>>>

pub fn fetch(&self, pks: &[&str]) -> Result<Vec<Doc>>

pub fn fetch_with_options( &self, pks: &[&str], output_fields: Option<&[&str]>, include_vector: bool, ) -> Result<Vec<Doc>>

pub fn iter(&self) -> Result<DocIterator>

pub fn iter_with_options( &self, output_fields: Option<&[&str]>, include_vector: bool, ) -> Result<DocIterator>

impl Collection

pub async fn query_async(&self, query: &SearchQuery) -> Result<Vec<Doc>>

Executes a query on Tokio’s blocking pool.

This keeps positioned DiskANN reads and exact refinement off async runtime worker threads. The query still uses the same synchronous snapshot, planner, fallback, scoring, and telemetry path as Self::query. Once scheduled, dropping the returned future does not cancel the blocking query.

pub async fn multi_query_async(&self, query: &MultiQuery) -> Result<Vec<Doc>>

Executes every multi-query branch on Tokio’s blocking pool.

The full fusion operation runs in one blocking task so all branches use the same captured collection snapshot as Self::multi_query. Once scheduled, dropping the returned future does not cancel the task.

pub async fn group_by_async( &self, query: &GroupBySearchQuery, ) -> Result<HashMap<String, Vec<Doc>>>

Executes a grouped vector query on Tokio’s blocking pool.

Once scheduled, dropping the returned future does not cancel the task.

impl Collection

pub fn create_and_open( path: &str, schema: &CollectionSchema, options: Option<&CollectionOptions>, ) -> Result<Self>

pub fn create( path: &str, schema: &CollectionSchema, options: Option<&CollectionOptions>, ) -> Result<Self>

pub fn open(path: &str, options: Option<&CollectionOptions>) -> Result<Self>

pub fn path(&self) -> PathBuf

pub fn is_open(&self) -> bool

pub fn flush(&self) -> Result<()>

pub fn close(self) -> Result<()>

pub fn destroy(self) -> Result<()>

pub fn schema(&self) -> Result<CollectionSchema>

pub fn stats(&self) -> Result<CollectionStats>

pub fn health(&self) -> Result<CollectionHealth>

Assesses authoritative revision agreement and derived-index readiness.

A pending WAL is reported but remains healthy because interval/manual durability intentionally permits checkpoint lag. Unlike other data methods, health remains observable after the shared handle is closed.

pub fn stats_snapshot(&self) -> Result<StatsSnapshot>

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

pub fn add_column( &self, field_schema: &FieldSchema, default_expr: Option<&str>, ) -> Result<()>

pub fn add_column_with_options( &self, field_schema: &FieldSchema, default_expr: Option<&str>, option: AddColumnOption, ) -> Result<()>

pub fn drop_column(&self, name: &str) -> Result<()>

pub fn rename_column(&self, old_name: &str, new_name: &str) -> Result<()>

pub fn alter_column( &self, field_schema: &FieldSchema, option: AlterColumnOption, ) -> Result<()>

Trait Implementations

impl Clone for Collection

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 Collection

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

Formats the value using the given formatter.