Struct Collection 

pub struct Collection {
    pub name: String,
    pub change_sender: Arc<Sender<ChangeEvent>>,
    /* private fields */
}

Represents a collection of documents backed by RocksDB

Fields

name: String

Collection name (column family name)

change_sender: Arc<Sender<ChangeEvent>>

Broadcast channel for real-time change events

Implementations

impl Collection

pub fn put_blob_chunk( &self, key: &str, chunk_index: u32, data: &[u8], ) -> DbResult<()>

Store a blob chunk

pub fn get_blob_chunk( &self, key: &str, chunk_index: u32, ) -> DbResult<Option<Vec<u8>>>

Get a blob chunk

pub fn delete_blob_data(&self, key: &str) -> DbResult<()>

Delete all blob chunks for a document

pub fn blob_stats(&self) -> DbResult<(usize, u64)>

Get blob statistics for this collection

impl Collection

pub fn new(name: String, db: Arc<DB>) -> Self

Create a new collection handle

pub fn get_type(&self) -> String

Get collection type

pub fn set_type(&self, type_: &str) -> DbResult<()>

Set collection type (persists to disk)

pub fn flush_stats(&self)

Flush count to disk if dirty (call periodically or on shutdown)

pub fn flush_stats_throttled(&self)

Flush count to disk if dirty AND at least 1 second has passed since last flush Use this during bulk operations to avoid excessive disk writes

pub fn compact(&self)

Compact the collection to remove tombstones and reclaim space

pub fn stats(&self) -> CollectionStats

Get usage statistics

pub fn disk_usage(&self) -> DiskUsage

Get disk usage statistics for this collection

pub fn set_shard_config(&self, config: &CollectionShardConfig) -> DbResult<()>

Set sharding configuration for this collection

pub fn get_shard_config(&self) -> Option<CollectionShardConfig>

Get sharding configuration for this collection (None if not sharded)

pub fn set_shard_table(&self, table: &ShardTable) -> DbResult<()>

Save shard table to storage (persisting assignments)

pub fn get_stored_shard_table(&self) -> Option<ShardTable>

Load shard table from storage

pub fn is_sharded(&self) -> bool

Check if this collection is sharded

pub fn doc_key(key: &str) -> Vec<u8>

Generate a document key: “doc:”

pub fn idx_meta_key(name: &str) -> Vec<u8>

Generate an index metadata key: “idx_meta:”

pub fn idx_entry_key( index_name: &str, values: &[Value], doc_key: &str, ) -> Vec<u8>

Generate an index entry key: “idx:::<doc_key>”

pub fn geo_meta_key(name: &str) -> Vec<u8>

Generate a geo metadata key: “geo_meta:”

pub fn geo_entry_key(index_name: &str, doc_key: &str) -> Vec<u8>

Generate a geo entry key: “geo::<doc_key>”

pub fn ft_meta_key(name: &str) -> Vec<u8>

Generate a fulltext index metadata key: “ft_meta:”

pub fn ft_term_key(index_name: &str, term: &str, doc_key: &str) -> Vec<u8>

Generate a fulltext term mapping key: “ft_term:::<doc_key>”

pub fn ft_ngram_key(index_name: &str, ngram: &str, doc_key: &str) -> Vec<u8>

Generate a fulltext n-gram mapping key: “ft:::<doc_key>”

pub fn blo_chunk_key(key: &str, chunk_index: usize) -> Vec<u8>

Generate a blob chunk key: “blo::<chunk_index>”

pub fn ttl_meta_key(name: &str) -> Vec<u8>

Build a TTL index metadata key: “ttl_meta:”

pub fn ttl_expiry_key( ttl_index_name: &str, expiry_timestamp: u64, doc_key: &str, ) -> Vec<u8>

Build a TTL expiry index key: “ttl_exp:<ttl_index_name>:<expiry_ts>:<doc_key>” Sorted by (ttl_index_name, expiry_timestamp) for efficient range queries

pub fn ttl_expiry_prefix(ttl_index_name: &str) -> Vec<u8>

Build a TTL expiry index prefix for a specific index: “doc:ttl_exp:<ttl_index_name>:”

pub fn ttl_expiry_prefix_until( ttl_index_name: &str, max_timestamp: u64, ) -> Vec<u8>

Build a TTL expiry index prefix for scanning up to a timestamp: “doc:ttl_exp:<ttl_index_name>:<max_ts>:”

pub fn vec_meta_key(name: &str) -> Vec<u8>

Create vector index metadata key: “vec_meta:”

pub fn vec_data_key(name: &str) -> Vec<u8>

Create vector index data key: “vec_data:”

impl Collection

pub fn get(&self, key: &str) -> DbResult<Document>

Get a document by key

pub fn get_many(&self, keys: &[String]) -> Vec<Document>

Get multiple documents by keys

pub fn insert(&self, data: Value) -> DbResult<Document>

Insert a new document

pub fn insert_no_index(&self, data: Value) -> DbResult<Document>

Insert a new document without updating indexes (for bulk loads)

pub fn update(&self, key: &str, data: Value) -> DbResult<Document>

Update a document with atomic document + index writes

pub fn update_with_rev( &self, key: &str, expected_rev: &str, data: Value, ) -> DbResult<Document>

Update a document with revision check (optimistic concurrency control)

pub fn delete(&self, key: &str) -> DbResult<()>

Delete a document with atomic document + index removal

pub fn upsert_batch(&self, documents: Vec<(String, Value)>) -> DbResult<usize>

Batch upsert (insert or update) multiple documents - optimized for replication

pub fn delete_batch(&self, keys: Vec<String>) -> DbResult<usize>

Batch delete documents with atomic document + index removal

pub fn update_batch( &self, updates: &[(String, Value)], ) -> DbResult<Vec<Document>>

Batch update multiple documents with atomic document + index writes

pub fn insert_batch(&self, documents: Vec<Value>) -> DbResult<Vec<Document>>

Insert multiple documents with atomic batched write

pub fn all(&self) -> Vec<Document>

Get all documents

pub fn scan(&self, limit: Option<usize>) -> Vec<Document>

Scan documents with an optional limit

pub fn recalculate_count(&self) -> usize

Recalculate document count from storage

pub fn count(&self) -> usize

Count documents in the collection

pub fn recount_documents(&self) -> usize

Recount documents from actual RocksDB data (slow but accurate)

pub fn truncate(&self) -> DbResult<usize>

Truncate collection (delete all documents)

pub fn prune_older_than(&self, timestamp_ms: u64) -> DbResult<usize>

Prune documents older than timestamp (for timeseries) The timestamp is in milliseconds since Unix epoch. This extracts the timestamp from UUIDv7 keys and deletes matching documents.

impl Collection

pub fn get_all_fulltext_indexes(&self) -> Vec<FulltextIndex>

Get all fulltext indexes

pub fn get_fulltext_index_for_field(&self, field: &str) -> Option<FulltextIndex>

Get a fulltext index that covers a specific field

pub fn create_fulltext_index( &self, name: String, fields: Vec<String>, min_length: Option<usize>, ) -> DbResult<()>

Create a fulltext index

pub fn drop_fulltext_index(&self, name: &str) -> DbResult<()>

Drop a fulltext index

pub fn list_fulltext_indexes(&self) -> Vec<FulltextIndex>

List fulltext indexes

pub fn fulltext_search( &self, query: &str, fields: Option<Vec<String>>, limit: usize, ) -> DbResult<Vec<FulltextMatch>>

Perform a fulltext search

impl Collection

pub fn get_all_geo_indexes(&self) -> Vec<GeoIndex>

Get all geo index metadata

pub fn create_geo_index( &self, name: String, field: String, ) -> DbResult<GeoIndexStats>

Create a geospatial index

pub fn drop_geo_index(&self, name: &str) -> DbResult<()>

Drop a geo index

pub fn list_geo_indexes(&self) -> Vec<GeoIndexStats>

List all geo indexes

pub fn geo_near( &self, field: &str, lat: f64, lon: f64, limit: usize, ) -> Option<Vec<(Document, f64)>>

Find documents near a point

pub fn geo_within( &self, field: &str, lat: f64, lon: f64, radius: f64, ) -> Option<Vec<(Document, f64)>>

Find documents within a radius

impl Collection

pub fn get_all_indexes(&self) -> Vec<Index>

Get all index metadata

pub fn create_index( &self, name: String, fields: Vec<String>, index_type: IndexType, unique: bool, ) -> DbResult<IndexStats>

Create an index on a field

pub fn drop_index(&self, name: &str) -> DbResult<()>

Drop an index

pub fn list_indexes(&self) -> Vec<IndexStats>

List all indexes

pub fn rebuild_all_indexes(&self) -> DbResult<usize>

Rebuild all indexes from existing documents Call this after bulk imports using insert_no_index()

pub fn index_documents(&self, docs: &[Document]) -> DbResult<usize>

Index only the provided documents (for incremental indexing)

pub fn get_index_stats(&self, name: &str) -> Option<IndexStats>

Get index statistics

pub fn get_index_for_field(&self, field: &str) -> Option<Index>

Get an index for a field

pub fn index_lookup_gt( &self, field: &str, value: &Value, ) -> Option<Vec<Document>>

Lookup documents where field > value

pub fn index_lookup_gte( &self, field: &str, value: &Value, ) -> Option<Vec<Document>>

Lookup documents where field >= value

pub fn index_lookup_lt( &self, field: &str, value: &Value, ) -> Option<Vec<Document>>

Lookup documents where field < value

pub fn index_lookup_lte( &self, field: &str, value: &Value, ) -> Option<Vec<Document>>

Lookup documents where field <= value

pub fn index_lookup_eq( &self, field: &str, value: &Value, ) -> Option<Vec<Document>>

Lookup documents using index (equality)

pub fn index_lookup_eq_limit( &self, field: &str, value: &Value, limit: usize, ) -> Option<Vec<Document>>

Lookup documents using index (equality) with limit

pub fn index_sorted( &self, field: &str, ascending: bool, limit: Option<usize>, ) -> Option<Vec<Document>>

Get documents sorted by indexed field

pub fn bloom_check(&self, index_name: &str, item: &str) -> bool

pub fn cuckoo_insert(&self, index_name: &str, item: &str)

pub fn cuckoo_delete(&self, index_name: &str, item: &str)

pub fn cuckoo_check(&self, index_name: &str, item: &str) -> bool

impl Collection

pub fn get_cached_schema_validator( &self, ) -> Result<Option<SchemaValidator>, DbError>

Get or create cached schema validator

pub fn set_json_schema(&self, schema: CollectionSchema) -> DbResult<()>

Set JSON schema for collection validation Set JSON schema for collection validation

pub fn get_json_schema(&self) -> Option<CollectionSchema>

Get JSON schema

pub fn remove_json_schema(&self) -> DbResult<()>

Remove JSON schema

impl Collection

pub fn get_all_ttl_indexes(&self) -> Vec<TtlIndex>

Get all TTL indexes

pub fn get_ttl_index(&self, name: &str) -> Option<TtlIndex>

Get a TTL index by name

pub fn create_ttl_index( &self, name: String, field: String, expire_after_seconds: u64, ) -> DbResult<TtlIndexStats>

Create a TTL index

pub fn drop_ttl_index(&self, name: &str) -> DbResult<()>

Drop a TTL index

pub fn list_ttl_indexes(&self) -> Vec<TtlIndexStats>

List all TTL indexes

pub fn cleanup_expired_documents_for_ttl_index( &self, index: &TtlIndex, ) -> DbResult<usize>

Cleanup expired documents for a specific TTL index using expiry index This is O(n) where n = expired documents (not all documents)

pub fn cleanup_all_expired_documents(&self) -> DbResult<usize>

Cleanup all expired documents across all TTL indexes

impl Collection

pub fn insert_tx( &self, tx: &mut Transaction, _wal: &Arc<WalWriter>, data: Value, ) -> DbResult<Document>

Insert a document within a transaction

pub fn update_tx( &self, tx: &mut Transaction, _wal: &Arc<WalWriter>, key: &str, data: Value, ) -> DbResult<Document>

Update a document within a transaction

pub fn delete_tx( &self, tx: &mut Transaction, _wal: &Arc<WalWriter>, key: &str, ) -> DbResult<()>

Delete a document within a transaction

pub fn apply_transaction_operations( &self, operations: Vec<Operation>, ) -> DbResult<()>

Apply operations from a committed transaction with atomic document + index writes

impl Collection

pub fn get_all_vector_index_configs(&self) -> Vec<VectorIndexConfig>

Get all vector index configurations

pub fn get_vector_index(&self, name: &str) -> DbResult<Arc<VectorIndex>>

Get vector index (loading it if necessary)

pub fn create_vector_index( &self, config: VectorIndexConfig, ) -> DbResult<VectorIndexStats>

Create a vector index

pub fn drop_vector_index(&self, name: &str) -> DbResult<()>

Drop a vector index

pub fn list_vector_indexes(&self) -> Vec<VectorIndexStats>

List vector indexes

pub fn vector_search( &self, name: &str, query: &[f32], k: usize, ef_search: Option<usize>, ) -> DbResult<Vec<VectorSearchResult>>

Search similar vectors

pub fn vector_similarity( &self, name: &str, query: Vec<f32>, ) -> DbResult<Vec<(String, f32)>>

Calculate similarity between a vector and documents

pub fn quantize_vector_index( &self, name: &str, quantization: VectorQuantization, ) -> DbResult<QuantizationStats>

Quantize a vector index

pub fn dequantize_vector_index(&self, _name: &str) -> DbResult<()>

Dequantize a vector index

pub fn persist_vector_indexes(&self) -> DbResult<()>

Persist all in-memory vector indexes to disk

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.