OpenSearch clusters can contain large volumes of data that can be intensive to search through. In order to assist with searches performed in this scenario, the Asynchronous Search plugin allows you to submit a query to run in the background and optional persist for. Over its lifetime you can query the status of the search and retrieve updated results as they are found.
Enabling the Plugin
When choosing the eligible OpenSearch version (OpenSearch 1.3.7 and 2.4.0 onwards respectively), the options will be available on the Console and the API to provision clusters with the Asynchronous Search plugin. Existing clusters that satisfy these version requirements can also have the SQL plugin enabled through making a request to support.
Via the Instaclustr Console, you can enable the Asynchronous Search plugin within the OpenSearch Setup step when creating a new cluster.
API and Terraform
Support for API and Terraform V1 provisioning are also available, in order to utilise these provisioning routes, see the Terraform Provider repository and API Documentation respectively.
The Asynchronous Search plugin is only accessible via the REST API. It provides new endpoints for you to submit queries and check back on their status as when you desire. For further information on the usage and behaviour of the Asynchronous Search plugin, more information can be found on the official OpenSearch documentation.