Delete by Query
Delete by query provides a powerful method for removing a large number of documents in a single operation.
The operation removes an entire subject where there is a match on the query. That is, if even a single entry for a subject matches the query, then all entries, as well as the subject itself, will be removed from the index.
This is similar to the result of performing a query: the set of subjects deleted will exactly match the set of subjects returned by the query used for delete by query.
You may want to test delete by query operations by first executing the query as a search.
Due to the broad capability of delete by query to change the state of the index, it can only be executed by a user with 'owner' or 'admin' permissions on the index.
Delete By Query is submitted as an asynchronous Task, which can then be monitored using the Get Task API. Once your task is complete, the data will be removed from the search index and will no longer appear in query results.
Method |
POST |
URL |
/v1/index/<index_id>/delete_by_query |
Authentication required? |
Yes |
Required Roles |
You must have |
Request Body |
A [GSearchRequest] See note below. |
Response Body |
Delete by query uses the same input structure as a normal query, GSearchRequest, but only makes use of the q, advanced_query, and filters fields.
All other fields, including those related to pagination, do not change the full set of subjects which match a query, and are therefore ignored by the delete by query operation.
This allows the same GSearchRequest to be used with delete by query as may have been used for a testing or regular query request without need for alteration.