The Search API in Drupal 8. Thomas Seidl (drunken monkey)

Transcription

1 The Search API in Drupal 8 Thomas Seidl (drunken monkey)

2 Disclaimer Everything shown here is still a work in progress. Details might change until 8.0 release.

3 Basic architecture Server Index Views Technical implementation Generic information Uses database/solr/ Item type Facets Search how? Fields Processing Search what?

4 Server Configuration entity Uses plugin service class for operations Stores class and specific settings

5 Service class Plugin for servers Implementation of server operations Indexing, deleting, searching Reaction to changed indexes Custom configuration form Connects to storage (DB, Solr, )

6 Index Configuration entity Main connection to other modules Uses datasource plugin

7 Datasource Index plugin providing the item types Loading, viewing, metadata for types Tracking of new/changed/deleted items Type-specific configuration

8 Processors Plugins attached to index Alter indexed items and search queries Configurable (Fused with D7 data alterations )

9 Index Indexing Datasource Processors Server 5. Extracts fields 1. Determines 4. Alter changed items 7. Sends items to server 2. Loads items 3. Provides metadata 10. Marks items as indexed metadata 6. Preprocess fields / items 8. Indexes items 9. Returns indexed items

10 Search Searching Query Processors Server 1. Creates query 2. Adds keywords 4. Adds filters, sort, etc. 3. Parses keywords 5. Checks input (partially) 7. Preprocess query 9. Postprocess search results 6. Executes query 8. Retrieves results 10. Displays results

11 Customizations

12 Service class Integrate new search services with Drupal /** * id = "MODULE_my_service", * label service"), * description cool!") * ) */ class MyService extends ServicePluginBase { function indexitems($index, $items) {} function deleteitems($index, $ids) {} function deleteallitems($index) {} function search($query) {} }

13 Service class Also available: Configuration form React to new/changed/removed indexes CRUD hooks supportsfeature(), supportsdatatype()

14 Features Add service-specific functionality Defined by contrib modules Using modules check for support Creation: No code, just documentation E.g.: facets, MLT, location, autocomplete, spellcheck

15 Data type Let services support non-default data types E.g., location coordinates, special text formats Services state support similar to features D7: hook_search_api_data_type_info() Documentation important

16 Datasource Support for custom item types /** * id = "MODULE_my_datasource", * name datasource"), * description great type.") * ) */ class MyDatasource extends DatasourcePluginBase { function getidfieldinfo() {} function getpropertydefinitions() {} function loaditems($ids) {} function getallitemids() {} }

17 Datasource Also available: Configuration form Viewing and view modes Get item's ID, label, URL Override tracking mechanism Call search_api_track_item_*()!

18 Processor Pre-/postprocess indexed items and results /** * id = "MODULE_my_processor", * label processor"), * description stuff.") * ) */ class MyProcessor extends ProcessorPluginBase { function alterpropertydefinitions(&$info) {} function preprocessindexitems(&$items) {} function preprocesssearchquery($query) {} function postprocesssearchresults(&$response, $query) {} }

19 Processor Also available: supportsindex() Configuration form Default implementation FieldsProcessorPluginBase process(), processfieldvalue(), processkey(), processfiltervalue(), testfield(), testtype()

20 Parse modes Interpretation of keywords By default: direct, single term, multiple terms Selection when creating search

21 Query D7: Pluggable in odd way D8: TBD

22 (Possible) D8 changes Support several item types per index More query functionality (like DB layer) Major changes for processors Possibly: query extenders / per-query processor config Loads of other stuff

23 Thank you!

24 What do you think?

25 Other questions?