Getting started

Before installing

In order to use this module, you must have a running instance of the Redis + RediSearch module on your or a remote server.

You can follow the steps explained on RediSearch official website.

Installation

• Install Search API module
• Install Search API RediSearch module

Configurations

• Go to Configuration > Search api
• Click on Add server and fill in the configurations according to your Redis instance

Now you can create an index by clicking on Add index and follow the steps below:

• Give the index a name
• Under Datasources, choose which content type you want to be indexed and select bundles and languages for each datasource
• In the server section, choose the server you just created in the above step
• You can choose whether you want to items to be indexed immediately or manually later
• Choose how many items you want to be indexed in a batch. Keep in mind this step has a bit of performance impact
• In the Fields submenu, configure the list of fields from each entity type by giving them a label, machine name, data type, and (if full text) a boost value
• Under Processors submenu, enable, re-arrange and configure processors (In the other sections of documentation, each processor will be explained in detail)
• Now you can save the Index settings

Indexing

In the /admin/config/search/search-api click on the Index name. Here you can see the status of your index. Now you can clear indexed data, then click on the Index now button, then all your items will be indexed.