Struct summa_server::apis::index::IndexApiImpl

pub struct IndexApiImpl { /* private fields */ }

Implementations

impl IndexApiImpl

pub fn new( server_config: &Arc<dyn ConfigProxy<Config>>, index_service: &Index ) -> SummaServerResult<IndexApiImpl>

impl IndexApiImpl

pub async fn get_index_description( &self, index_holder: &Handler<IndexHolder> ) -> IndexDescription

Trait Implementations

impl Clone for IndexApiImpl

fn clone(&self) -> IndexApiImpl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IndexApi for IndexApiImpl

fn attach_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<AttachIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<AttachIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Attaches index to Summa server. Attaching allows to incorporate and start using of downloaded or network indices

fn commit_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<CommitIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<CommitIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Committing all collected writes to the index

fn copy_documents<'life0, 'async_trait>( &'life0 self, proto_request: Request<CopyDocumentsRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<CopyDocumentsResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Copy documents from one index to another

fn create_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<CreateIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<CreateIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates new index from scratch

fn copy_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<CopyIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<CopyIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates new index from scratch

fn delete_documents<'life0, 'async_trait>( &'life0 self, request: Request<DeleteDocumentsRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<DeleteDocumentsResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes single document from the index by its primary key (therefore, index must have primary key)

fn delete_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<DeleteIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<DeleteIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes index and physically removes file in the case of FileEngine

type documentsStream = ReceiverStream<Result<DocumentsResponse, Status>>

Server streaming response type for the documents method.

fn documents<'life0, 'async_trait>( &'life0 self, proto_request: Request<DocumentsRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<Self::documentsStream>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stream of all documents from the index

fn get_indices_aliases<'life0, 'async_trait>( &'life0 self, __arg1: Request<GetIndicesAliasesRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<GetIndicesAliasesResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets all existing index aliases

fn get_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<GetIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<GetIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets index description

fn get_indices<'life0, 'async_trait>( &'life0 self, __arg1: Request<GetIndicesRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<GetIndicesResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets all existing index descriptions

fn index_document_stream<'life0, 'async_trait>( &'life0 self, request: Request<Streaming<IndexDocumentStreamRequest>> ) -> Pin<Box<dyn Future<Output = Result<Response<IndexDocumentStreamResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds document to the index in a streaming way

fn index_document<'life0, 'async_trait>( &'life0 self, request: Request<IndexDocumentRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<IndexDocumentResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds document to the index

fn merge_segments<'life0, 'async_trait>( &'life0 self, proto_request: Request<MergeSegmentsRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<MergeSegmentsResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Merges multiple segments into a single one. Used for service purposes

fn set_index_alias<'life0, 'async_trait>( &'life0 self, proto_request: Request<SetIndexAliasRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<SetIndexAliasResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets or replaces existing index alias

fn vacuum_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<VacuumIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<VacuumIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes deletions from all segments

fn warmup_index<'life0, 'async_trait>( &'life0 self, proto_request: Request<WarmupIndexRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<WarmupIndexResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Loads all hot parts of the index into the memory