Solr compatibility table

Expand all | Collapse all

  • Description

    Collapse

    This table presents the compatibility of different Sitecore CMS/XP versions with different Solr versions.

    Solr CMS 7.0 – XP 8.0 XP 8.1 XP 8.2
    		 XP 9.0
    		  XP 9.1
    1.1 – 4.0 –
    		 –
    		 – –
    		  –
    4.1 ✓ * * –
    		  –
    4.2 – 4.7 * * * –
    		  –
    4.8 – 4.9 *[1] * * –
    		  –
    4.10 *[1] ✓ * –
    		  –
    5.0 [6] *[1] * * –
    		  –
    5.1 [6] *[1] * ✓
    		 –
    		  –
    5.2 – 5.4 [6] *[1] * * –
    		  –
    5.5 [6] –[3]
    		 –[3]
    		 –[3]
    		 –
    		  –
    5.5.1,
    6.0 – 6.1 [6]    		 *[1][2] *[2] *[2]
    		 –
    		  –
    6.6.1 [6] –
    		 –
    		 ✓[4][5]
    		 ✓[4]
    		  –
    6.6.2,
    6.6.3 [6]    		 – – ✓[5]
    		 ✓
    		  –
    7.2.1  –
    		  –
    		  –
    		  –
    		  ✓

    Legend:

    ✓ officially tested, recommended
    * not officially tested, but expected to work
    –
    		 no compatibility information or does not work

    This table presents the support status of the SolrCloud feature for different Sitecore CMS/XP versions:


    		 CMS 7.0 – XP 8.1 XP 8.2 – XP 9.0 Update-1
    		 XP 9.0 Update-2 and newer
    Support status Not supported Under Experimental Support
    		 Officially tested and supported

    For information about Experimental Support, read the Sitecore Product Support Lifecycle article.

    The Solr Index replication feature is not supported. The SolrCloud feature can be used as a replacement.

  • Notes

    Collapse

    • [1] Changes in the default schema.xml file shipped with Solr 4.8 and later can cause the following issues:

      • Sitecore cannot be initialized due to the following error: 
        [NullReferenceException: Object reference not set to an instance of an object.]
   SolrNet.Schema.SolrSchemaParser.Parse(XDocument solrSchemaXml) +425
   SolrNet.Impl.SolrBasicServer`1.GetSchema() +207
   Sitecore.ContentSearch.SolrProvider.SolrSearchIndex.Initialize() +1125
   Sitecore.ContentSearch.SolrProvider.SolrContentSearchManager.Initialize() +168
   Sitecore.ContentSearch.SolrProvider.CastleWindsorIntegration.WindsorSolrStartUp.Initialize() +757
      • The Build Solr Schema wizard successfully completes building the schema, but the resulting schema.xml file lacks a Sitecore-specific configuration.

      To resolve the issue, apply the corresponding solution 1 described in the following Solution section.

    • [2] Starting from Solr 6, the default Config Sets are distributed without the schema.xml file.

      To resolve the issue, apply the corresponding solution 2 described in the following Solution section.

    • [3] Known issues for Solr 5.5 (https://issues.apache.org/jira/browse/SOLR-8793) result in the following Sitecore error:

      WARN  Unable to connect to Solr: [http://{hostname}:{port}/solr], the [SolrNet.Exceptions.SolrConnectionException] was caught.
Exception: SolrNet.Exceptions.SolrConnectionException
Message: Error handling 'status' action
      org.apache.solr.common.SolrException: Error handling 'status' action

      To resolve the issue, upgrade Solr to 5.5.1 or a later version.

    • [4] Solr server can try to initialize a Solr core twice, resulting in the following error:

      org.apache.solr.common.SolrException: Unable to create core [core_name]
...
Caused by: org.apache.lucene.store.LockObtainFailedException: Lock held by this virtual machine: C:\solr-6.6.1\server\solr\core_name\data\index\write.lock

      The error is caused by a Solr bug: SOLR-11297

      The issue does not affect Sitecore functionality and you can ignore it. To resolve the issue, upgrade Solr to 6.6.2.

    • [5] For Sitecore XP 8.2 Update-6 (rev. 171121) and 8.2 Update-7 (rev. 180406).

    • [6] Solr versions 5.0–5.5.5, 6.0–6.6.5 are affected by a security vulnerability CVE-2019-0192 (SOLR-13301). Available solutions are:
      • Upgrade to Sitecore XP 9.1 and use Apache Solr 7.2.1.
      • Disable the Config API by running Solr with the system property disable.configEdit=true.
      • If upgrading or disabling the Config API are not viable options, apply SOLR-13301.patch and re-compile Solr.
      • Ensure your network settings are configured so that only trusted traffic is allowed to ingress/egress your hosts running Solr.

  • Solution [1]

    Collapse

    Note:  If both solutions apply to your specific SXP and Solr version combination, you must implement Solution [2]  before Solution [1].

    To resolve the issue:

    1. Make the following changes in the default schema.xml file distributed with Solr:
      • Enclose all <field> and <dynamicField> elements in the <fields> tag.
      • Enclose all <fieldType> elements in the <types> tag.
    2. To add Sitecore-specific configuration, pass the modified schema.xml file to the Build Solr Schema wizard.
    3. Put the resulting file in the configuration folder of the Solr core.
    4. Find the following dynamic field definition in the schema.xml file:
      5. <dynamicField name="*_pi" type="pint" indexed="true" stored="true" />
      Change the mapping type from "pint" to "tint".
      <dynamicField name="*_pi" type="tint" indexed="true" stored="true" />
    5. Reload the core to apply the schema changes.
    6. Restart the application pool of the website to initialize Sitecore indexes using the updated schema.xml file.

  • Solution [2]

    Collapse

    To resolve the issue:

    1. Create a schema.xml file by duplicating and renaming the managed-schema file.
    2. Switch to the ClassicIndexSchemaFactory setting by adding the following line to the SolrConfig.xml file:
      3. <schemaFactory class="ClassicIndexSchemaFactory" />
    3. If the SolrConfig.xml file contains the following UpdateRequestProcessorChain 
      <updateRequestProcessorChain name="add-unknown-fields-to-the-schema">
      then find and comment out its AddSchemaFieldsUpdateProcessorFactory processor.

Applies to:

CMS 7+

November 21, 2014
April 04, 2019

Reference number:

410401, 416201, 95044, 95246, 110841

Keywords: 

  • Search and Indexing