Actions33
- Documents Actions
- General Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
General → Dumps
AI-generatedOverview
This node operation in the Meilisearch integration handles the 'Dumps' operation under the 'General' resource. It allows users to initiate and manage data dumps in Meilisearch. A key feature is the option to wait for the dump task to complete before the node returns, which is useful for workflows that depend on the completion of the dump process. The node supports polling the task status with configurable intervals and timeout settings, including an exponential backoff mechanism to reduce API calls over time.
Use Case Examples
- A user wants to create a dump of their Meilisearch data and needs to ensure the dump is complete before proceeding with further processing in the workflow. They enable 'Wait for Completion' and configure polling intervals and timeout to monitor the dump task status until it finishes.
- Another scenario is when a user wants to trigger a dump and immediately continue without waiting, useful for asynchronous workflows where dump completion is not critical to the next steps.
Properties
| Name | Meaning |
|---|---|
| Wait for Completion | Whether to wait for the dump task to complete before returning. If enabled, the node polls the task status until it succeeds, fails, or is canceled. |
| Use Exponential Backoff | If enabled, the polling interval increases gradually to reduce API calls during task status checks. |
| 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, which 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, defaulting to 5 minutes. |
Output
JSON
jsonstatus- The status of the dump task, indicating if it succeeded, failed, or was canceled.taskUid- The unique identifier of the dump task.details- Additional details about the dump task status and result.
Dependencies
- An API key credential for authenticating with the Meilisearch API.
Troubleshooting
- If the task does not complete within the specified timeout, the node throws an error indicating the timeout was reached. Users should increase the timeout or check the task status manually.
- Incorrect polling interval settings may cause excessive API calls or delayed status updates. Adjust polling intervals and consider enabling exponential backoff to optimize polling.
- If the node fails to authenticate, verify that the Meilisearch API credentials are correctly configured and valid.