Struct summa_server::services::Index

pub struct Index { /* private fields */ }

services::Index is responsible for indices lifecycle. Here lives indices creation and deletion as well as committing and indexing new documents.

Implementations

impl Index

The main entry point for managing Summa indices

pub fn index_registry(&self) -> &IndexRegistry

pub async fn get_index_holder( &self, index_alias: &str ) -> SummaServerResult<Handler<IndexHolder>>

pub fn consumer_manager(&self) -> &Arc<RwLock<ConsumerManager>>

Returns ConsumerManager

pub fn server_config(&self) -> &Arc<dyn ConfigProxy<Config>>

Returns server config

pub fn new( server_config_holder: &Arc<dyn ConfigProxy<Config>> ) -> SummaServerResult<Index>

Creates new IndexService with ConfigHolder

pub async fn attach_index( &self, attach_index_request: AttachIndexRequest ) -> SummaServerResult<Handler<IndexHolder>>

Create consumer and insert it into the consumer registry. Add it to the IndexHolder afterwards.

pub async fn copy_documents( &self, copy_documents_request: CopyDocumentsRequest ) -> SummaServerResult<u32>

pub async fn create_index( &self, create_index_request: CreateIndexRequest ) -> SummaServerResult<Handler<IndexHolder>>

Create consumer and insert it into the consumer registry. Add it to the IndexHolder afterwards.

pub async fn delete_index( &self, delete_index_request: DeleteIndexRequest ) -> SummaServerResult<DeleteIndexResult>

Delete index, optionally with all its aliases and consumers

pub async fn get_consumers(&self) -> HashMap<String, Config>

Returns all existent consumers for all indices

pub async fn create_consumer( &self, create_consumer_request: CreateConsumerRequest ) -> SummaServerResult<String>

Create consumer and insert it into the consumer registry. Add it to the IndexHolder afterwards.

pub async fn delete_consumer( &self, delete_consumer_request: DeleteConsumerRequest ) -> SummaServerResult<DeleteConsumerResponse>

Delete consumer from the consumer registry and from IndexHolder afterwards.

pub async fn stop(&mut self, force: bool) -> SummaServerResult<()>

Stopping index holders

pub async fn commit_and_restart_consumption( &self, index_holder: &Handler<IndexHolder>, with_hotcache: bool ) -> SummaServerResult<()>

Commits all and restarts consuming threads

pub async fn try_commit_and_restart_consumption( &self, index_holder: &Handler<IndexHolder> ) -> SummaServerResult<()>

Commits everything and restarts consuming threads

pub async fn commit( &self, index_holder: &Handler<IndexHolder>, with_hotcache: bool ) -> SummaServerResult<Option<PreparedConsumption>>

Commits all without restarting consuming threads

pub async fn rollback( &self, index_holder: &Handler<IndexHolder> ) -> SummaServerResult<Option<PreparedConsumption>>

Rollbacks everything without restarting consuming threads

pub async fn try_commit( &self, index_holder: &Handler<IndexHolder> ) -> SummaServerResult<Option<PreparedConsumption>>

Commits immediately or returns all without restarting consuming threads

pub async fn start_threads(&mut self)

Starts autocommitting thread

pub async fn stop_threads(&mut self) -> SummaServerResult<()>

Stops autocommitting thread

pub async fn open_index_from_config( &self, index_engine_config: IndexEngineConfig ) -> SummaServerResult<Index>

Opens index and sets it up via setup

pub async fn copy_index( &self, copy_index_request: CopyIndexRequest ) -> SummaServerResult<Handler<IndexHolder>>

Copies index with changing engine

pub async fn search( &self, search_request: SearchRequest ) -> SummaServerResult<Vec<CollectorOutput>>

Search documents

pub async fn constrained_search( &self, search_request: SearchRequest ) -> SummaServerResult<Vec<CollectorOutput>>

Search documents

pub async fn merge_segments( &self, merge_segments_request: MergeSegmentsRequest ) -> SummaServerResult<Option<SegmentId>>

Merge several segments into a single one

pub async fn vacuum_index( &self, vacuum_index_request: VacuumIndexRequest ) -> SummaServerResult<u64>

Merges segments and removes tombstones

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.