Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
The "Clear objects" operation in the Records resource of this Algolia node allows users to delete all records from a specified index while preserving the index's settings, synonyms, and rules. This is useful when you want to reset the data within an index without losing its configuration or search behavior customizations.
Common scenarios include:
- Clearing outdated or irrelevant records before re-importing fresh data.
- Resetting an index's content during development or testing phases.
- Removing all user-generated content while keeping the search setup intact.
For example, if you have an index containing product listings that need to be refreshed entirely, you can use this operation to clear all existing product records without affecting the search ranking rules or synonyms configured for that index.
Properties
| Name | Meaning |
|---|---|
| Index Name | The name of the Algolia index from which all records will be cleared. This is a required field. |
Output
The output JSON contains the response from the Algolia API after the clear operation is performed. Typically, this includes information about the task status or confirmation that the records were cleared successfully. The node does not output binary data.
Dependencies
- Requires an Algolia application with appropriate API credentials (API key and Application ID).
- The node must be configured with valid Algolia API authentication credentials.
- The target index must exist in the Algolia application.
Troubleshooting
- Rate Limits: Clearing objects is a resource-intensive operation subject to Algolia's indexing rate limits. If you encounter rate limit errors, consider retrying after some time or contacting Algolia support.
- Index Not Found: If the specified index does not exist, the operation may fail. Ensure the index name is correct and exists in your Algolia application.
- Authentication Errors: Ensure that the API key used has sufficient permissions to perform write operations on the index.
- Operation Timeout: Large indices might take longer to clear; ensure your workflow timeout settings accommodate this.