Search commands and pipelines
Version:
The following table describes the commands and pipelines for index and document management via the Search service:
| Command/Pipeline | Description |
|---|---|
CreateSearchIndexCommandCreateSearchIndexPipeline | Creates an index based on the IndexablePolicy and SearchScopePolicy. |
DeleteSearchIndexCommandDeleteSearchIndexPipeline | Deletes an index (specified by name). |
GetSearchIndexCommandGetSearchIndexPipeline | Retrieves an index (specified by name). |
InitializeSearchIndexCommandInitializeSearchIndexPipeline | Initializes an index (specified by name). |
ListSearchIndexesCommandListSearchIndexesPipeline | Lists all indexes in the system. |
SearchCommandSearchPipeline | Searches documents in an index. |
SearchEntitiesCommand | Searches Commerce entities using the provider agnostic generic search framework. Executes the IFindEntityPipeline pipeline. |
GenericSearchCommandGenericSearchPipeline | Executes a provider agnostic search. |
UpdateSearchIndexCommandUpdateSearchIndexPipeline | Updates an index based on the IndexablePolicy and SearchScopePolicy. |
AddDocumentsToIndexPipeline | Adds documents to an index. |
DeleteDocumentsFromIndexPipeline | Identifies documents to be deleted from index. |
CountDocumentsFromIndexPipeline | Counts the number of documents contained in the index. |
DeleteIndexDocumentsMinionPipeline | Removes documents from an index for entities that have been deleted from the system. Receives: SearchIndexMinionArgument Returns:Â IEnumerable<IndexingResult> |
FullIndexMinionPipeline | Used by the Full Index Minion to process entities. Receives: SearchIndexMinionArgument Returns: IEnumerable<IndexingResult> |
IncrementalIndexPipeline | Used by the Incremental Index Minion to process entities. Receives: SearchIndexMinionArgument Returns: IEnumerable<IndexingResult> |
PrepareDeleteIndexDocumentsMinionPipeline | Prepares for deletion of index documents. Receives: SearchIndexArgument Returns: bool |
PrepareFullIndexMinionPipeline | Before processing any entity, checks if the index exists. If the index exists, the pipeline deletes it, and then recreates it. If the index does not exist, it creates it. Receives: SearchIndexArgumentReturns: bool |
PrepareIncrementalIndexMinionPipeline | Before processing any entity, checks if the index exists. If the index exists, the pipeline deletes it, and then recreates it. If the index does not exist, it creates. Receives: SearchIndexArgument Returns: bool |
If you have suggestions for improving this article, let us know!