Important

You are browsing the documentation for version 3.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Search Index¶

Search Index component is responsible for interaction with the separate search engine and search index storage inside it.

In Oro application, search engine can:

perform search quickly (in comparison with standard ORM search)
apply complicated filters to results
sort search results by relevancy or specific field
extract additional data from search index
calculate aggregated values

In this section, you will learn about the following concepts related to search index.

Note

For developer’s documentation, see implementation specifics of the Elasticsearch and ORM-based search index as well as Search Index Developer Guide. Keep reading for a more high-level conceptual overview.

Main Concepts¶

Search engine is the specialized software that provides ability to store data, index data and perform quick and relevant search. The biggest difference between the search engine and a conventional data storage is the fact that search engine performs search significantly faster, and can do overall full-text search in addition to search by the specific area. Examples of search engines - Elasticsearch, Lucene, Solr. To use an analogy to relational databases, search engine is similar to Database Management System (DBMS).

Search index (sometimes referred as just index) is an actual storage where specific scope of search data is stored. One search engine may work with several indexes. Search index is structured, i.e. provides ability to organize data in the complex multilevel structures; minimal amount of levels required to work with Oro application is two. Search index can validate data type of the data stored inside. Search index is a document based storage where each document represents one specific entity from the main relational database. Search index can be considered as a specialized reflection of the main relational database. To use an analogy to relational databases, search index is similar to database (DB).
Entity alias is a text representation of entity name stored inside the specific search index. Entity alias represents first level of search index structure. To use an analogy to relational databases, entity alias is similar to a table name.
Entity field is a text representation of entity property name assigned to a specific entity alias. Entity alias represents second level of search index structure. Entity field has assigned data type (text, integer, decimal, datetime) and search engine uses this information to validate data stored inside the index. To use an analogy to relational databases, entity field is similar to a column name.
Entity field value is an actual value of an entity property assigned to a specific entity field. To use an analogy to relational databases, entity field value is similar to a value of a column.
All-text field is a special entity field used to do overall full-text search. Value of this field is usually calculated automatically based on the text entity field values.
Search document is a combination of entity fields and entity field values and represents data of one specific entity from the main relational database. Search document has plain structure - i.e. field values must not contain other documents. To use an analogy to relational databases, search document is similar to a table row.
Indexation is a process of updating of a data in a search index - it might be extraction of the required data from an entities and saving it to search index, or removing of required documents from search index.
Search mapping is a combination of entity aliases and entity field definitions. To use an analogy to relational databases, search mapping is similar to a database schema.
Search placeholder is a variable part of entity alias or entity field which can be substituted with an actual value during the indexation or performing a search request.

Following diagram shows described structure:

Index Types¶

Oro applications use two typed of indexes which are using common interfaces.

Common Interfaces¶

Common interfaces are used at all index types to provide high-level abstraction for functionality that has to work with any type of search index (e.g. datagrids).

Search engine interface OroBundleSearchBundleEngineEngineInterface is used to perform search requests to a search index.
Search indexer interface OroBundleSearchBundleEngineIndexerInterface is used for indexation, i.e. to change state of a search index (save data, remove data, reset index).

Standard Index Type¶

Standard index type (sometimes referred as default index type or backend index type) is used at all applications based on OroPlatform. Each entity is represented by one plain entity alias, contains plain field names to represent data assigned directly to main entity or data from the related entities.

Standard index type triggers following events:

oro_search.mapping_config - during the mapping collection process, used to alter mapping information;
oro_search.prepare_entity_map - during the indexation process, triggered for each entity, used to change data stored inside the index;
oro_search.before_search - before the search request, used to change search request before its execution;
oro_search.prepare_result_item - after the extraction of documents from search index, used to populate additional information (entity objects, URLs etc).

Standard index type performs indexation on an entity level - i.e. indexation process is triggered for each entity. Search field values can be calculated automatically based on the defined search mapping. Each search document contains one all-text field value calculated automatically as a concatenation of all text entity field values. Each field might have several values. In this case, it will be represented as an array, and comparison operations will iterate over all of them. During reindexation the entities that are being reindexed are not available for search.

Search mapping can be stored inside any bundle at the file Resources/config/oro/search.yml. Engine-specific services have to be defined at file Resources/config/oro/search_engine/<engine>.yml. Main logic of this index type is stored inside the OroSearchBundle at platform package.

Website Index Type¶

Website index type (sometimes referred as frontend index type) is used only at the OroCommerce application - this application uses standard index type at backend part, and website index type at frontent part of the application. Each entity is represented by one alias with optional search placeholder (e.g. oro_product_WEBSITE_IT), so in fact each website might have its own entity alias (e.g. oro_product_1 and oro_product_2). Entity fields might contain search placeholders as well (e.g. name_LOCALIZATION_ID), so in fact each field might have several values depending on the provided placeholders (e.g. name_1, name_2 and name_3).

Website index type triggers following events:

oro_website_search.reindexation_request - triggers reindexation process for the specified scope of entities, here are examples of a triggering of this event;
oro_website_search.event.website_search_mapping.configuration - during the mapping collection process, used to alter mapping information;
oro_website_search.event.collect_context - before the indexation, used to collect context which will be used during the indexation;
oro_website_search.event.restrict_index_entity - during the indexation for all entities, used to decrease amount of entities that has to be indexed;
oro_website_search.event.restrict_index_entity.<alias> - during the indexation for the specific entity, used to decrease amount of specific entities that has to be indexed (pay attention that <alias> is a standard entity alias, not search entity alias);
oro_website_search.event.index_entity - during the indexation fro all entities, used to collect data to put into search index, here is example of a listener for this event;
oro_website_search.event.index_entity.<alias> - during the indexation for the specific entity, used to collect data for a specific entity to put into search index (pay attention that <alias> is a standard entity alias, not search entity alias);
oro_website_search.before_search - before the search request, used to change search request before its execution.

Website index type performs reindexation on an entity batch level - i.e. indexation process is triggered for batch of entities (default batch size is 100). Search field values have to be calculated and set manually at a listener to oro_website_search.event.index_entity event. Each search document contains all-text fields for each available localization (all_text_LOCALIZATION_ID) and one all-text field that includes values from all localizations, values are calculated automatically based on a flag set during the indexation (i.e. developer may specify what exact values should be in all-text field value). Each field without placeholder must have ony one value. During reindexation, entities that are being reindexed are available with the old (outdated) data.

Placeholders are defined in code in classes that implement Oro\Bundle\WebsiteSearchBundle\Placeholder\PlaceholderInterface. Here are the most commonly used placeholders (pay attention that there are more of them in a code):

WEBSITE_ID - integer identifier of a current website
LOCALIZATION_ID - integer identifier of a current localization
CUSTOMER_ID - integer identifier of a current customer user
CURRENCY - string identifier of a current currency
CPL_ID - integer identifier of a current combined price list

Search mapping can be stored inside any bundle at the file Resources/config/oro/website_search.yml. Engine-specific services have to be defined at file Resources/config/oro/website_search_engine/<engine>.yml. Main logic of this index type is stored inside the OroWebsiteSearchBundle at commerce package.

Supported Search Engines¶

ORM Search Engine¶

ORM search engine doesn’t use actual document-based storage - instead it emulates such storage inside application relational database using EAV model. As a consequence, performance of ORM engine is not very good and because of that it is recommended only for small applications - with a couple thousands of entities. ORM search engine uses separate Entity Manager and connection called “search” - this way search requests can be processes independently from default DB connection. ORM search engine for standard index type is implemented at the OroSearchBundle at platform package, for website index type - at the OroWebsiteSearchBundle at commerce package.

See detailed information about the implementation of ORM search engine in the Manage Search in Oro Applications (ORM) topic.

Elasticsearch Search Engine¶

Elasticsearch search engine allows to store big amount of data and perform fast search queries. Performance of Elasticsearch engine is quite good and it is recommended for bigger applications, with hundereds of thousands and millions of entities.

Note

The Elasticsearch feature is only available in the Enterprise edition.

Elasticsearch search engine requires credentials to connect to actual index. Credentials include optional WWW-auth parameters and SSH connection support. Elasticsearch search engine for standard index type is implemented in OroElasticSearchBundle in the platform-enterprise package, for website index type it is implemented in OroWebsiteElasticSearchBundle in the commerce-enterprise package. Current implementation supports only Elasticsearch 2.* versions.

See detailed information about the implementation of ElasticSearch engine in Oro applications.

Data Structure¶

General Information¶

Search index stores documents grouped by entity alias. Each document contain scalar fields with values, one of the fields is all-text field used to perform overall search. Data from the related entities might be stored as well, but in this case it has to be denormalized to a plain structure. There are four supported entity field value data types:

text
integer (used to represent boolean values)
decimal
datetime (used to represent date values)

ORM Search Engine¶

ORM search engine stores data using EAV model to store attributes. There is one main entity and four related entities used to store data for each of the supported field data types. One main entity contains main information about the document - entity class, entity ID, entity alias, default title, flag that indicates whether entity was changes and createdAt/updatedAt fields. All four related entities have similar structure - they store name of the entity field and actual entity field value. Here is diagram that shows this structure:

../../../../_images/op_structure_search_orm.png

Each of the supported index types uses its own set of entities - i.e. 5 entities for standard index type and 5 more entities for website index type.

Elasticsearch Search Engine¶

Elasticsearch search engine is document based from the very beginning, so index data structure is pretty straight forward. Search index is represented by the Elasticsearch index.

Search aliases are represented by the Elasticsearch types. Search field values are stored inside the Elasticsearch document. Search mapping is defined at the Elasticsearch mapping, it is generated automatically during the index creation. Here is diagram that shows this structure:

../../../../_images/op_structure_search_elastic.png

Each of the supported index types uses its own Elasticsearch index.

Example of Standard Index Type Document¶

Here is example of the document from the standard index type under oro_user entity alias.

{
"username":"admin",
"all_text":"admin admin@example.com example com John Doe",
"email":"admin@example.com",
"firstName":"John",
"lastName":"Doe",
"assigned_organization_id":[
   1
],
"organization":1,
"oro_user_owner":1
}

Pay attention to the following facts:

all_text field combines data from all other text fields
assigned_organization_id field contains array of values

Example of Website Index Type Document¶

Here is example of the document from the website index type under oro_product_WEBSITE_ID (WEBSITE_ID = 1) entity alias.

{
"assigned_to_variant_31":1,
"assigned_to_variant_25":1,
"assigned_to_variant_19":1,
"assigned_to_variant_11":1,
"newArrival":1,
"inventory_status_priority":2,
"product_id":2,
"category_id":8,
"visibility_anonymous":1,
"visibility_new":1,
"is_visible_by_default":1,
"all_text_1":"Retail Supplies Credit Card Pin Pad Reader Choosing the right credit card processing terminal to fit your business needs can help you increase your profits and reduce your processing costs. This credit card reader helps you do just that. Its' easy-to-use ATM style interface accepts PIN-based debit card transactions and swipes traditional payment cards. It also accepts chip cards and features a built-in receipt printer Product Information & Features: Catalog Page: 2976 Performs PIN based debit card transactions Accepts chip cards Prints transaction receipts Connectivity: USB (not included) Large, backlit display Supports all magnetic stripe cards Color: Purple Technical Specs: Width: 6\u201d Height: 3\u201d Weight: .6 lb. ACME defaultMetaDescription defaultMetaKeywords 1AB92",
"sku":"1AB92",
"all_text":"1AB92 Retail Supplies Credit Card Pin Pad Reader Choosing the right credit card processing terminal to fit your business needs can help you increase your profits and reduce your processing costs. This credit card reader helps you do just that. Its' easy-to-use ATM style interface accepts PIN-based debit card transactions and swipes traditional payment cards. It also accepts chip cards and features a built-in receipt printer Product Information & Features: Catalog Page: 2976 Performs PIN based debit card transactions Accepts chip cards Prints transaction receipts Connectivity: USB (not included) Large, backlit display Supports all magnetic stripe cards Color: Purple Technical Specs: Width: 6\u201d Height: 3\u201d Weight: .6 lb. ACME defaultMetaDescription defaultMetaKeywords",
"names_1":"Credit Card Pin Pad Reader",
"shortDescriptions_1":"Choosing the right credit card processing terminal to fit your business needs can help you increase your profits and reduce your processing costs. This credit card reader helps you do just that. Its' easy-to-use ATM style interface accepts PIN-based debit card transactions and swipes traditional payment cards. It also accepts chip cards and features a built-in receipt printer",
"inventory_status":"out_of_stock",
"sku_uppercase":"1AB92",
"status":"enabled",
"type":"simple",
"image_product_large":"\/media\/cache\/attachment\/resize\/11\/product_large\/59d20f5ae821f060277950.jpeg",
"image_product_medium":"\/media\/cache\/attachment\/resize\/11\/product_medium\/59d20f5ae821f060277950.jpeg",
"product_units":"a:2:{s:4:\"item\";i:0;s:3:\"set\";i:0;}",
"category_path":"1_8",
"category_title_1":"Retail Supplies",
"minimal_price_3_EUR_item":"60.8000",
"minimal_price_7_EUR_item":"60.8000",
"minimal_price_2_USD_item":"60.8000",
"minimal_price_6_USD_item":"60.8000",
"minimal_price_4_EUR_item":"60.8000",
"minimal_price_1_EUR_item":"76.0000",
"minimal_price_5_EUR_item":"60.8000",
"minimal_price_5_USD_item":"60.8000",
"minimal_price_1_USD_item":"76.0000",
"minimal_price_4_USD_item":"60.8000",
"minimal_price_6_EUR_item":"60.8000",
"minimal_price_2_EUR_item":"60.8000",
"minimal_price_7_USD_item":"60.8000",
"minimal_price_3_USD_item":"60.8000",
"minimal_price_7_EUR":"60.8000",
"minimal_price_3_EUR":"60.8000",
"minimal_price_1_EUR":"76.0000",
"minimal_price_6_USD":"60.8000",
"minimal_price_4_EUR":"60.8000",
"minimal_price_4_USD":"60.8000",
"minimal_price_6_EUR":"60.8000",
"minimal_price_1_USD":"76.0000",
"minimal_price_3_USD":"60.8000",
"minimal_price_7_USD":"60.8000",
"minimal_price_5_EUR":"60.8000",
"minimal_price_2_USD":"60.8000",
"minimal_price_2_EUR":"60.8000",
"minimal_price_5_USD":"60.8000",
"tmp_alias":"oro_product_1_website_search59d7a947de6e69.38892637"
}

Pay attention to the following facts:

multiple values are denormalized to a one level structure according to passed placeholder values - assigned_to_ASSIGN_TYPE_ASSIGN_ID, minimal_price_CPL_ID_CURRENCY_UNIT etc
localized values are related to specific locale (LOCALIZATION_ID = 1) - names_LOCALIZATION_ID, shortDescriptions_LOCALIZATION_ID etc
standard and localized all-text fields (LOCALIZATION_ID = 1) - all_text and all_text_LOCALIZATION_ID
tmp_alias field is used to maintain outdated data during the reindexation and understand which entities has to be removed after the reindexation

Search Request¶

To perform search request developer has to build a query to search index. There are two representations of search query - string represenation and object represenation.

String Representation¶

String representation is pretty similar to standard SQL query - this string may contain keywords select, from, where, aggregate, order_by, offset and max_results. String represenation is used mostly at the API where user can request specific data with specific condition. During the processing of string representation it is converted to object representation.

Object Representation¶

Object representation has two levels - low and high. Low-level object (OroBundleSearchBundleQueryQuery, sometime called search query builder) represents a query and has parts similar to string represenation (select, where etc). Low-level query is not aware about specific search engine. It is used by all search engines as a main query representation. Low-level object is in fact a Data transfer object. High-level object (implementation of OroBundleSearchBundleQuerySearchQueryInterface) is used to hide search engine specific logic from a developer. It embeds low-level object and proxies most of the calls. High-level objects are created by the query factory (implementation of OroBundleSearchBundleQueryFactoryQueryFactoryInterface). Each index type has its own implementation of high-level object which encapsulates the way this query has to be executed, and its own implementation of query factory responsible for creation of high-level object. High-level object is in fact a Facade. Following diagram demonstrates connection between low-level object, high-level object, query factory and search engine:

How to Trigger Search Request¶

The recommended way to trigger search request is to get instance of high-level object, build a query, execute it and get results. It’s also recommended to isolate all search requests in a search repository (see Best Practices section) to separate storage logic from business logic. However, if you really need to work on a lower level (e.g. to write functional test) then you can get instance of an appropriate search engine type. All following engines implement standard search engine interface Oro\Bundle\SearchBundle\Engine\EngineInterface:

standard ORM engine - OroBundleSearchBundleEngineOrm, service ID is oro_search.search.engine;
standard Elasticsearch engine - OroBundleElasticSearchBundleEngineElasticSearch, service ID is oro_search.search.engine;
website ORM engine - OroBundleWebsiteSearchBundleEngineORMOrmEngine, service ID is oro_website_search.engine;
website Elasticsearch engine - OroBundleWebsiteElasticSearchBundleEngineElasticSearchEngine, service ID is oro_website_search.engine.

All these engines accept low-level query and execution context as an arguments, and return result object with list of found entities, total number of results and requested aggregated data.

Indexation Process¶

Asynchronous Indexation¶

Most of the indexation operations are performed asynchronously using a message queue. Advantage of this approach is that user should not wait while indexation is finished to see response from the application, also asynchronous indexations might be perfromed in parallel to speed up overall indexation process. Disadvantage is that indexation may happen with a delay - delay time depends on number of consumers, server hardware and queue length. Every time some entity which should be represented by a document in a search index is changed new message that contains entity class and entity identifier is generated and sent to message queue. Then message queue consumer receives this message and runs appropriate message processor that performs real indexation and does real change in search index. Please, remember, that parallel indexation is possible only if there are several message queue consumers running - each consumer is able to run indexation, so the bigger amount of consumers running the more indexations can be performed in parallel. All automatically triggered reindexations are processed asynchronously.

Synchronous Indexation¶

Despite the fact, that asynchronous processing is very convenient for a user, sometimes it might be required to track process manually and make sure that indexation is finished right away. In this case synchronous indexation should be used instead of the asynchronous one. Advantage of this approach that indexation will happen right now without any delay. Disadvantage is that it might be slower and UX is worse than in case of asynchronous indexations.

How to Trigger Reindexation¶

Both standard and website index types automatically trigger reindexation process when entity data or related configuration is changed.

Standard search index type provides CLI command oro:search:reindex that can be used to manually trigger full reindexation of all entities, or only entities of a specific class. It has flag called scheduled to run indexation asynchronously. Here are examples of a work with this command.

Website search index type provides similar CLI command called oro:website-search:reindex which used to manually tirgger full reindexation of all entities, only entities of a specific class or entitie for a specific website. It also has flag called scheduled to run indexation asynchronously. Here are examples of a work with oro:website-search:reindex command.

Website search index type provides an event called oro_website_search.reindexation_request to manually trigger reindexation process for the specified scope of entities. It uses event class Oro\Bundle\WebsiteSearchBundle\Event\ReindexationRequestEvent which accepts boolean parameter $scheduled to specify whether indexation has to be asynchronous (default behaviour) or synchronous. Here are examples of a triggering of this event.

Both standard and website search index types have synchronous and asynchronous indexers which trigger corresponding type of indexation. All following indexers implement the same standard indexer interface Oro\Bundle\SearchBundle\Engine\IndexerInterface:

standard asynchronous indexer - OroBundleSearchBundleAsyncIndexer, service ID is oro_search.async.indexer
standard synchronous ORM indexer - OroBundleSearchBundleEngineOrmIndexer, service ID is oro_search.search.engine.indexer
standard synchronous Elasticsearch - OroBundleElasticSearchBundleEngineElasticSearchIndexer, service ID is oro_search.search.engine.indexer
website asynchronous indexer - OroBundleWebsiteSearchBundleEngineAsyncIndexer, service ID is oro_website_search.async.indexer
website ORM indexer - OroBundleWebsiteSearchBundleEngineORMOrmIndexer, service ID is oro_website_search.indexer
website Elasticsearch indexer - OroBundleWebsiteElasticSearchBundleEngineElasticSearchIndexer, service ID is oro_website_search.indexer

All these indexers accept entities of entity class that has to be reindexed.