Struct summa_core::components::IndexWriterHolder

pub struct IndexWriterHolder { /* private fields */ }

Managing write operations to index

Implementations

impl IndexWriterHolder

pub fn create( index: &Index, writer_threads: WriterThreads, writer_heap_size_bytes: usize, merge_policy: Arc<dyn MergePolicy> ) -> SummaResult<IndexWriterHolder>

Creates new IndexWriterHolder from Index and core::Config

pub fn index_document( &self, document: TantivyDocument, conflict_strategy: ConflictStrategy ) -> SummaResult<()>

Put document to the index. Before comes searchable it must be committed

pub fn merge( &self, segment_ids: &[SegmentId], segment_attributes: Option<SummaSegmentAttributes> ) -> SummaResult<Option<SegmentMeta>>

Merge segments into one.

Also cleans deleted documents and do recompression. Possible to pass the only segment in segment_ids to do recompression or clean up. It is heavy operation that also blocks on .await so should be spawned if non-blocking behaviour is required

pub fn commit(&mut self) -> SummaResult<Opstamp>

Commits already indexed documents

Committing makes indexed documents visible It is heavy operation that also blocks on .await so should be spawned if non-blocking behaviour is required

pub fn rollback(&mut self) -> SummaResult<()>

pub fn vacuum( &self, segment_attributes: Option<SummaSegmentAttributes>, excluded_segments: Vec<String> ) -> SummaResult<()>

pub fn wait_merging_threads(&mut self)

pub fn commit_and_prepare( &mut self, with_hotcache: bool ) -> SummaResult<Opstamp>

Locking index files for executing operation on them