You are here

Home » API reference » Search API 8

README.txt in Search API 8

Same filename in this branch
  1. 8 modules/search_api_db/README.txt
  2. 8 modules/search_api_db/search_api_db_defaults/README.txt
Database Search
---------------

This module provides a database-based implementation of the Search API. The
database and target to use for storing and accessing the indexes can be selected
when creating a new server.

All Search API data types are supported by using appropriate SQL data types for
their respective columns.

The "direct" parse mode for queries will result in a simple splitting of the
query string into keys. Additionally, search keys containing whitespace will be
split for all parse modes, as searching for phrases is currently not supported.

Supported optional features
---------------------------

- search_api_autocomplete
  Introduced by module: search_api_autocomplete
  Lets you add autocompletion capabilities to search forms on the site. (See
  also "Hidden variables" below for backend-specific customization.)
  NOTE: Due to internal database restrictions, this will perform significantly
  better if only a single field is used for autocompletion.
- search_api_facets
  Introduced by module: facets
  Allows you to create faceted searches for dynamically filtering search
  results.
- search_api_facets_operator_or
  Introduced by module: facets
  Allows the use of the "OR" operator for facets.

If you feel some backend option is missing, or have other ideas for improving
this implementation, please file a feature request in the project's issue queue,
at [1], using the "Database search" component.

[1] http://drupal.org/project/issues/search_api

Known problems
--------------

Using facets and autocomplete suggestions with a database server will only work
if the database user Drupal is using has the "CREATE TEMPORARY TABLES"
permission (or similar, in DBMSs other than MySQL).

Developer information
---------------------

Database queries for searches with this module are tagged with
"search_api_db_search" to allow easy altering. As metadata, such database
queries will have the Search API query object set as "search_api_query", and the
field settings of the server for the corresponding search index as
"search_api_db_fields".

Hidden configuration
--------------------

- search_api_db.settings.autocomplete_max_occurrences (default: 0.9)
  By default, keywords that occur in more than 90% of results are ignored for
  autocomplete suggestions. This setting lets you modify that behavior by
  providing your own ratio. Use 1 or greater to use all suggestions.

File

modules/search_api_db/README.txt
View source 
  1. Database Search

  2. ---------------

  3. 

  4. This module provides a database-based implementation of the Search API. The

  5. database and target to use for storing and accessing the indexes can be selected

  6. when creating a new server.

  7. 

  8. All Search API data types are supported by using appropriate SQL data types for

  9. their respective columns.

  10. 

  11. The "direct" parse mode for queries will result in a simple splitting of the

  12. query string into keys. Additionally, search keys containing whitespace will be

  13. split for all parse modes, as searching for phrases is currently not supported.

  14. 

  15. Supported optional features

  16. ---------------------------

  17. 

  18. - search_api_autocomplete

  19.   Introduced by module: search_api_autocomplete

  20.   Lets you add autocompletion capabilities to search forms on the site. (See

  21.   also "Hidden variables" below for backend-specific customization.)

  22.   NOTE: Due to internal database restrictions, this will perform significantly

  23.   better if only a single field is used for autocompletion.

  24. - search_api_facets

  25.   Introduced by module: facets

  26.   Allows you to create faceted searches for dynamically filtering search

  27.   results.

  28. - search_api_facets_operator_or

  29.   Introduced by module: facets

  30.   Allows the use of the "OR" operator for facets.

  31. 

  32. If you feel some backend option is missing, or have other ideas for improving

  33. this implementation, please file a feature request in the project's issue queue,

  34. at [1], using the "Database search" component.

  35. 

  36. [1] http://drupal.org/project/issues/search_api

  37. 

  38. Known problems

  39. --------------

  40. 

  41. Using facets and autocomplete suggestions with a database server will only work

  42. if the database user Drupal is using has the "CREATE TEMPORARY TABLES"

  43. permission (or similar, in DBMSs other than MySQL).

  44. 

  45. Developer information

  46. ---------------------

  47. 

  48. Database queries for searches with this module are tagged with

  49. "search_api_db_search" to allow easy altering. As metadata, such database

  50. queries will have the Search API query object set as "search_api_query", and the

  51. field settings of the server for the corresponding search index as

  52. "search_api_db_fields".

  53. 

  54. Hidden configuration

  55. --------------------

  56. 

  57. - search_api_db.settings.autocomplete_max_occurrences (default: 0.9)

  58.   By default, keywords that occur in more than 90% of results are ignored for

  59.   autocomplete suggestions. This setting lets you modify that behavior by

  60.   providing your own ratio. Use 1 or greater to use all suggestions.