You are here

README.txt in Acquia Search 3.x

Same filename and directory in other branches
  1. 2.x README.txt
Acquia Search Solr module
================================================================================

Provides integration between your Drupal site and Acquia's hosted search
service, Acquia Search [1]. Requires Search API Solr module.

[1] https://docs.acquia.com/acquia-search/

Notes on Acquia Search Solr data protection and core auto-switching
-------------------------------------------------------------------

Acquia Search Solr module attempts to auto-detect your environment and
automatically connect to the best-fit Acquia Search Solr core available. This is
done to attempt to protect your data in your production Solr instance.

Depending on the Solr cores already provisioned on your Acquia Subscription, the
module will follow these rules to connect to the proper core:

* If your site is running within Acquia Cloud, Acquia Search will connect to
  the Solr core whose name matches the current environment (dev/stage/prod) and
  current multi-site instance.
* If the module can't find an appropriate Solr core above, you then need to
  configure a proper search core using settings below.

The current state is noted on the Drupal UI's general status report at
/admin/reports/status, as well as when attempting to edit each connection.

You can override this behavior using code snippets or a Drupal variable. This,
however, poses risks to your data that you should be aware of.

Hidden settings
----------------
- acquia_search.settings.read_only
    Boolean value; if TRUE then there is enforcing of read-only mode.

    Example settings.php override:
    # $config['acquia_search.settings']['read_only'] = TRUE;

- acquia_search.settings.override_search_core
    String that contains the ID of an Acquia Search core. When provided (and if
    the core is available) this will force the connection to use that core
    instead of letting the module auto-switch.
    Valid use cases for setting this override is for testing locally, or
    sharing the same Solr core amongst different Acquia sites/environments.

    Here's an example for settings.php:

    # Override Acquia Search Solr search core.
    # $config['acquia_search.settings']['override_search_core'] =
      'ABCD-12345.prod.mysite';

- acquia_search.settings.extract_query_handler_option
    String that contains the extract query handler option. Default value is
    "update/extract"'.
    See SearchApiSolrSearchApiSolrAcquiaConnector::getExtractQuery() for details.

    Here's an example for settings.php:

    # Override Acquia Search Solr extract query handler option..
    # $config['acquia_search.settings']['extract_query_handler_option'] =
    # 'some/value';

File

README.txt
View source
  1. Acquia Search Solr module
  2. ================================================================================
  3. Provides integration between your Drupal site and Acquia's hosted search
  4. service, Acquia Search [1]. Requires Search API Solr module.
  5. [1] https://docs.acquia.com/acquia-search/
  6. Notes on Acquia Search Solr data protection and core auto-switching
  7. -------------------------------------------------------------------
  8. Acquia Search Solr module attempts to auto-detect your environment and
  9. automatically connect to the best-fit Acquia Search Solr core available. This is
  10. done to attempt to protect your data in your production Solr instance.
  11. Depending on the Solr cores already provisioned on your Acquia Subscription, the
  12. module will follow these rules to connect to the proper core:
  13. * If your site is running within Acquia Cloud, Acquia Search will connect to
  14. the Solr core whose name matches the current environment (dev/stage/prod) and
  15. current multi-site instance.
  16. * If the module can't find an appropriate Solr core above, you then need to
  17. configure a proper search core using settings below.
  18. The current state is noted on the Drupal UI's general status report at
  19. /admin/reports/status, as well as when attempting to edit each connection.
  20. You can override this behavior using code snippets or a Drupal variable. This,
  21. however, poses risks to your data that you should be aware of.
  22. Hidden settings
  23. ----------------
  24. - acquia_search.settings.read_only
  25. Boolean value; if TRUE then there is enforcing of read-only mode.
  26. Example settings.php override:
  27. # $config['acquia_search.settings']['read_only'] = TRUE;
  28. - acquia_search.settings.override_search_core
  29. String that contains the ID of an Acquia Search core. When provided (and if
  30. the core is available) this will force the connection to use that core
  31. instead of letting the module auto-switch.
  32. Valid use cases for setting this override is for testing locally, or
  33. sharing the same Solr core amongst different Acquia sites/environments.
  34. Here's an example for settings.php:
  35. # Override Acquia Search Solr search core.
  36. # $config['acquia_search.settings']['override_search_core'] =
  37. 'ABCD-12345.prod.mysite';
  38. - acquia_search.settings.extract_query_handler_option
  39. String that contains the extract query handler option. Default value is
  40. "update/extract"'.
  41. See SearchApiSolrSearchApiSolrAcquiaConnector::getExtractQuery() for details.
  42. Here's an example for settings.php:
  43. # Override Acquia Search Solr extract query handler option..
  44. # $config['acquia_search.settings']['extract_query_handler_option'] =
  45. # 'some/value';