Query Rules
List of methods
| Save rule |
Create or update a single rule. |
| Batch rules |
Create or update a specified set of rules, or all rules. |
| Get rule |
Get the object/definition of a specific rule. |
| Delete rule |
Delete a specific rule using its id. |
| Clear rules |
Delete all rules in an index. |
| Search rules |
Search for rules matching various criteria. |
| Replace all rules |
Push a new set of rules and erase all previous ones. |
| Copy rules |
Copy the rules of an index to another index on the same app. |
| Export rules |
Retrieve an index’s full list of rules using an iterator. |
Overview
Query Rules allows performing pre- and post-processing on queries matching specific patterns. For more details, please refer to our Rules guide.
Miscellaneous
As its name implies, Query Rules is applied at query time. Therefore, some search parameters can be used to control how the rules are applied.
Most of the methods manipulate queryRule objects, as described in detail in the different Query Rules methods.
Just like for objects or synonyms, write methods for rules are asynchronous: they return a taskID that can be used by Wait for operations.
