Support for Solr Search Engine Bundle when used in eZ Publish 5.4 with legacy is limited, as the legacy integration is done by Netgen's ezplatformsearch, a third party community-supported extension.
Version 1.0.x of Solr Bundle primarily aims to be drop in replacement for Legacy (SQL based) search engine for better scalability and performance (mainly with field criteria and sort clauses). And while it also provides better full text search thanks to Solr, more advance search features like Faceting, Spellchecking, plugin system, .. will come in later releases, most for for newer versions of eZ Platform only. See 5.4.5 Release Notes for further info.
What is Solr Search Engine Bundle?
ezplatform-solr-search-engine as the package is called, aims to be a transparent drop in replacement for the SQL based "Legacy" search engine powering Search API by default. By enabling Solr and re-indexing your content, all your exising Search queries using SearchService, will be powered by Solr automatically. This allows you to scale up your eZ Publish Platform installation and be able to continue development locally against SQL engine, and have test infrastructure, Staging and Prod powered by Solr. Thus remove considerable load from your database so it can focus on more important things, like publishing .
Se Architecture page for further information on the architecture of eZ Publish Platform and eZ Platform.
How to setup Solr Search engine
Step 1: Enabling Bundle
In this step you'll enable the Solr Search Engine Bundle which handles indexing on all updates to Platform stack API, and to handle all search queries going to Search Service.
EzPublishSolrSearchEngineBundleby adding the following lines to your
Step 2: Enabling Legacy extension
Being on 5.x, you'll need to also make sure searches in legacy (like in admin interface) is using the new solr search engine, this functionality is provided by ezplatformsearch extension made by NetGen.
Add/Update composer dependencies:
Activate extension in
Step 3: Configuring & Starting Solr
First download and extract Solr, we currently support Solr 4.10.4:
Secondly, copy configuration files needed for eZ Solr Search Engine bundle, here from root of your project to the place you extracted Solr:
Thirdly, Solr Bundle does not commit solr index changes directly on repository updates, leaving it up to you to tune this using
solrconfig.xml as best practice suggests, example config:
Step 4: Configuring bundle
The Solr search engine bundle can be configured many ways, here are some examples
Before further configuration, make sure that the file
parameters.yml contains line:
Single Core example (default)
Out of the box in eZ Platform the following is enabled for simple setup:
Shared Core example
In the following example we have decided to separate one language as install contains several similar languages, and one very different language that should be recive proper language analysis for proper stemming and sorting behavior by Solr:
Multi Core example
If full language analysis features are preferred, then each language can be configured to separate cores.
Note: Please make sure to test this setup against single core as it might perform worse then single core if your project uses a lot for language fallbacks per SiteAccess as queries will then be performed across several cores at once.
Step 5: Configuring repository with the specific search engine
The following is an example of configuring Solr Search Engine, where
connection name is the same as in the example above, and engine is set to
Config in 5.4.5 and eZ Platform
In eZ Publish 5.4.5 when installed via composer create-project, the example above is in default config with one small difference (same as on eZ Platform). There
search.engine is set to
%search_engine%, which is a parameter that needs to be set in parameters.yml, and for use with Solr it will needs to be set to
"solr" as described in parameters.yml.dist, and as described above.
Step 6: Clear prod cache
While Symfony dev environment keeps track of changes to yml files, prod does not, so to make sure Symfony reads the new config we clear cache:
Step 7: Run CLI indexing command
Last step is to execute initial indexation of data:
If you have issues using the indexing command there are some known issues and how you resolve them listed in the 5.4.5 Release Notes.
After completing the installation you are now free to use your site as usual. If you get any excpetions for missing features, have feedback on performance, or want to discuss, join our community slack channel at https://ezcommunity.slack.com/messages/ezplatform-use/