Actions33
- Documents Actions
- General Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Documents → Delete All Document
AI-generatedOverview
This node operation deletes all documents from a specified index in Meilisearch. It is useful when you want to clear an entire index of its documents, for example, to reset the data or prepare the index for a fresh batch of documents. The node supports waiting for the deletion task to complete, with options for polling intervals and exponential backoff to efficiently check the task status.
Use Case Examples
- Deleting all documents from a product catalog index before uploading a new product dataset.
- Clearing user data documents from an index as part of a data privacy compliance workflow.
Properties
| Name | Meaning |
|---|---|
| Index UID | The unique identifier (name) of the index from which all documents will be deleted. |
| Wait for Completion | Whether to wait for the deletion task to complete before returning. If enabled, the node will poll the task status until it succeeds, fails, or is canceled. |
| Use Exponential Backoff | If enabled, the polling interval for checking task status will gradually increase to reduce API calls. If disabled, a fixed polling interval is used. |
| Polling Interval (ms) | Fixed interval between polling requests in milliseconds, used when exponential backoff is disabled. |
| Initial Polling Interval (ms) | Starting interval between polling requests in milliseconds. The interval increases by 1.5x every 5 attempts when exponential backoff is enabled. |
| Max Polling Interval (ms) | Maximum interval between polling requests. Exponential backoff will not exceed this value. |
| Timeout (seconds) | Maximum time to wait for task completion in seconds (default is 5 minutes). |
Output
JSON
jsontaskUid- The unique identifier of the deletion task.status- The status of the deletion task (e.g., succeeded, failed, canceled).type- The type of the task performed.details- Additional details about the task execution.
Dependencies
- Meilisearch API key credential
Troubleshooting
- If the node times out waiting for task completion, increase the Timeout parameter or disable waiting for completion.
- Ensure the Index UID is correct and exists in the Meilisearch instance to avoid errors.
- If the task status returns 'failed' or 'canceled', check the Meilisearch server logs for more details on the failure cause.