Solr Search Engine Bundle for use with:
- v1.5+: eZ Platform 1.7+ (bundled out of the box) with Solr 4.10.4 or 6.x (recommended: 6.x)
- v1.0.x: eZ Publish Platform Enterprise 5.4.5+ (optional, not as feature rich but helpful for scaling filtering queries) with Solr 4.10.4
Feature | Solr Search Engine | Legacy Search Engine (SQL) |
---|---|---|
Filtering | Yes | Yes, but limited* |
Query (filter with scoring) | Yes | Only filters, no scoring |
Fulltext | Yes, incl advance features | Partly** |
Faceting | Partly as of v1.4 | No |
Spellchecking | Planned (TBD when) | No |
Highlighting | Planned (TBD when) | No |
Index time boosting | Yes, as of v1.4 | No |
* Usage of Criterion and SortClause for Fields does not perform well on medium to larger amount of data with Legacy Search Engine (SQL), use Solr for this.
** Does not include full set of full text features includes: Scoring/Ranking (Solr Search Engine does sorting on scoring
by default, for location search available as of v1.3 with Solr 6.x), and as of Solr Search Engine v1.5
supports advanced full text capabilities such as word "phrase" (group) +mandatory -prohibited AND && OR || NOT !
For how to install and configure see:
- eZ Platform: https://doc.ezplatform.com/en/latest/guide/solr/
- eZ Publish Platform 5.4.x: https://doc.ez.no/display/EZP/Solr+Search+Engine+Bundle
For Contributing to this Bundle, you should make sure to run both unit and integration tests (from ezpublish-kernel repo).
-
Setup this repository locally
git clone git@github.com:ezsystems/ezplatform-solr-search-engine.git solr cd solr composer install
At this point you should be able to run unit tests:
php vendor/bin/phpunit --bootstrap tests/bootstrap.php
-
Get & extract Solr
E.g. one of the following:
-
Configure Solr (single core)
Note: See .travis.yml and bin/.travis/init_solr.sh for multi core setups
# Solr 4.10 cd solr-4.10.4/example mkdir -p multicore/collection1/conf cp -R <ezplatform-solr-search-engine>/lib/Resources/config/solr/* multicore/collection1/conf cp solr/collection1/conf/{currency.xml,stopwords.txt,synonyms.txt} multicore/collection1/conf ## Remove default cores configuration and add core configuration sed -i.bak 's/<core name=".*" instanceDir=".*" \/>//g' multicore/solr.xml sed -i.bak "s/<shardHandlerFactory/<core name=\"collection1\" instanceDir=\"collection1\" \/><shardHandlerFactory/g" multicore/solr.xml cp multicore/core0/conf/solrconfig.xml multicore/collection1/conf sed -i.bak s/core0/collection1/g multicore/collection1/conf/solrconfig.xml # Solr 6 cd solr-6.6.5 mkdir -p server/ez/template cp -R <ezplatform-solr-search-engine>/lib/Resources/config/solr/* server/ez/template cp server/solr/configsets/basic_configs/conf/{currency.xml,solrconfig.xml,stopwords.txt,synonyms.txt,elevate.xml} server/ez/template cp server/solr/solr.xml server/ez ## Modify solrconfig.xml to remove section that doesn't agree with our schema sed -i.bak '/<updateRequestProcessorChain name="add-unknown-fields-to-the-schema">/,/<\/updateRequestProcessorChain>/d' server/ez/template/solrconfig.xml
Note that Solr Bundle does not commit changes directly on repository updates, which can lead to issues of content not showing up in the index. You can control this by adjusting
autoSoftCommit
(visibility of change to search index) andautoCommit
(hard commit, for durability and replication) values insolrconfig.xml
.Example of working
solrconfig.xml
settings that you can use to tune for your needs, change from defaults is onautoSoftCommit
from-1
(disabled) to20
ms:<autoCommit> <maxTime>${solr.autoCommit.maxTime:15000}</maxTime> <openSearcher>false</openSearcher> </autoCommit> <autoSoftCommit> <maxTime>${solr.autoSoftCommit.maxTime:20}</maxTime> </autoSoftCommit>
You may also use the command line tool
bin/generate-solr-config.sh
to generate the Solr 6 configuration instead of these instructions. This is particular convenient if deploying to eZ Platform Cloud (Platform.sh), but can also be used for on-premise installs.The script should be executed from the eZ Platform root directory, run the following for more info:
./vendor/ezsystems/ezplatform-solr-search-engine/bin/generate-solr-config.sh --help
-
Start Solr
# Solr 4.10 cd solr-4.10.4/example java -Djetty.port=8983 -Dsolr.solr.home=multicore -jar start.jar # Solr 6 cd solr-6.6.5 bin/solr -s ez ## You'll also need to add cores on Solr 6, this adds single core setup: bin/solr create_core -c collection1 -d server/ez/template
-
Run integration tests
export CORES_SETUP="single" php -d memory_limit=-1 vendor/bin/phpunit --bootstrap tests/bootstrap.php -vc vendor/ezsystems/ezpublish-kernel/phpunit-integration-legacy-solr.xml
Copyright eZ Systems AS, for copyright and license details see provided LICENSE file.