README.txt 2.6 KB
Newer Older
1
Acquia Search Solr module
dmitrii's avatar
dmitrii committed
2
3
================================================================================

4
5
Provides integration between your Drupal site and Acquia's hosted search
service, Acquia Search [1]. Requires Search API Solr module.
dmitrii's avatar
dmitrii committed
6

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

9
10
Notes on Acquia Search Solr data protection and core auto-switching
-------------------------------------------------------------------
11
12

Acquia Search Solr module attempts to auto-detect your environment and
13
14
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.
15

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

* If your site is running within Acquia Cloud, Acquia Search will connect to
20
  the Solr core whose name matches the current environment (dev/stage/prod) and
21
  current multi-site instance.
22
23
* If the module can't find an appropriate Solr core above, you then need to
  configure a proper search core using settings below.
24
25
26
27
28
29
30
31
32

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
----------------
33
- acquia_search.settings.read_only
34
    Boolean value; if TRUE then there is enforcing of read-only mode.
35

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

39
- acquia_search.settings.override_search_core
40
41
42
43
44
    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.
45
46
47
48

    Here's an example for settings.php:

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

52
- acquia_search.settings.extract_query_handler_option
53
    String that contains the extract query handler option. Default value is
54
    "update/extract"'.
55
    See SearchApiSolrSearchApiSolrAcquiaConnector::getExtractQuery() for details.
56
57
58
59

    Here's an example for settings.php:

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