Struct DocEngine 

pub struct DocEngine { /* private fields */ }

Document engine with collection-local dictionaries and packed docs.

Implementations

impl DocEngine

pub fn new() -> Self

Create a document engine with packed format version 1.

pub fn create_collection( &mut self, name: &str, config: CollectionConfig, ) -> Result<CollectionId, DocError>

Create a collection.

pub fn drop_collection(&mut self, name: &str) -> bool

Drop a collection and all its documents.

pub fn collection_info(&self, name: &str) -> Option<CollectionInfo>

Return collection info when present.

pub fn dictionary_info(&self, name: &str) -> Result<DictionaryInfo, DocError>

Return dictionary statistics for one collection.

pub fn storage_info(&self, name: &str) -> Result<StorageInfo, DocError>

Return packed storage statistics for one collection.

pub fn create_index( &mut self, collection: &str, field_path: &str, index_type: IndexType, ) -> Result<(), DocError>

Create a secondary index on a collection field.

Backfills all existing documents. For Unique indexes, if a duplicate value is detected during backfill the index is rolled back and an error is returned.

pub fn drop_index( &mut self, collection: &str, field_path: &str, ) -> Result<(), DocError>

Remove a secondary index from a collection field.

pub fn indexes( &self, collection: &str, ) -> Result<Vec<(String, IndexType)>, DocError>

Return all configured indexes for a collection.

pub fn set( &mut self, collection: &str, external_doc_id: &str, json: &Value, ) -> Result<SetResult, DocError>

Insert or replace one JSON document.

pub fn insert( &mut self, collection: &str, json: &Value, ) -> Result<InsertResult, DocError>

Insert a document with an auto-generated ID.

Returns the generated ID and whether the document was newly created.

pub fn get( &self, collection: &str, external_doc_id: &str, projection: Option<&[&str]>, ) -> Result<Option<Value>, DocError>

Get a full document or a projected subset of fields.

pub fn update( &mut self, collection: &str, external_doc_id: &str, mutations: &[DocMutation], ) -> Result<bool, DocError>

Apply field-level mutations to an existing document.

Returns Ok(true) when the document existed and was rewritten, Ok(false) when the target document does not exist.

pub fn del( &mut self, collection: &str, external_doc_id: &str, ) -> Result<bool, DocError>

Delete a document by external ID.

pub fn exists( &self, collection: &str, external_doc_id: &str, ) -> Result<bool, DocError>

Check whether a document exists.

pub fn find( &self, collection: &str, where_clause: &str, projection: Option<&[&str]>, limit: Option<usize>, offset: usize, order_by: Option<&str>, order_desc: bool, ) -> Result<Vec<Value>, DocError>

Execute a WHERE query and return matching documents.

pub fn count( &self, collection: &str, where_clause: &str, ) -> Result<u64, DocError>

Count documents matching a WHERE clause.

Trait Implementations

impl Debug for DocEngine

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

Formats the value using the given formatter.

impl Default for DocEngine

fn default() -> Self

Returns the “default value” for a type.