1. Search service

Search field handlers

Version:

The Search plugin pre-defines index field mappers and handlers listed in the following table.

For a list of search field handlers used for indexing catalog entities (catalogs, categories and sellable items), see catalog field handlers.

Field handlers/mappersDescription
AbstractIndexFieldHandlerDefines an abstract field hander class that synchronously composes the field value to be used in the index.
AbstractAsyncIndexFieldHandlerDefines an abstract field handler class that supports asynchronous calls.
Note

The Commerce Engine does not use this index field handler by default. Index field handlers that call pipelines asynchronously can have a negative impact on indexing performance in deployments with large catalogs or mapping tables. We recommend that you use the

AbstractIndexFieldHandler class in your custom field hander if possible.
ArtifactStoreIdFieldHandlerDefines the handler for the artifact store id field.
DataSourceFieldHandlerDefines the handler for the data source field
IndexFieldConfigurationDefines the configuration for an index field.
IndexFieldTypeMapperDefines an index field type mapper.
IndexNameFieldHandlerDefines the handler for the index name field.
ItemTypeFieldHandlerDefines the handler for the item type field.
LanguageFieldHandlerDefines the handler for the language field.
LatestVersionFieldHandlerDefines the handler for the latest version field.
NoopIndexFieldHandlerDefines a no operation index field handler.
Important

For internal use only. Do not use this handler or inherit from it.

If you have suggestions for improving this article, let us know!