Actions44
- User Actions
- Database Actions
- Collection Actions
- Document Actions
- Index Actions
- Function Actions
- Storage Actions
Overview
This node integrates with the Appwrite API to manage indexes within a specified database collection. Specifically, the "Delete" operation under the "Index" resource allows users to remove an existing index identified by a unique key from a given collection in a database.
Common scenarios for this node include:
- Cleaning up unused or obsolete indexes to optimize database performance.
- Managing schema changes where certain indexed fields are no longer relevant.
- Automating maintenance tasks that involve dynamic index management.
For example, if you have a collection of documents indexed by a specific key and you want to remove that index programmatically as part of a workflow, this node can perform that deletion securely using your configured API credentials.
Properties
| Name | Meaning |
|---|---|
| Database ID | ID of the database containing the collection where the index exists. |
| Collection ID | ID of the collection on which the index is defined. |
| Key | A unique key identifying the index to be deleted. |
Output
The output JSON object after a successful delete operation contains a single field:
{
"success": true
}
This indicates that the index was successfully deleted. No additional data about the deleted index is returned.
If the operation fails, the node throws an error with details about the failure.
Dependencies
- Requires an API authentication token credential configured in n8n to connect to the Appwrite API.
- The node depends on the Appwrite client library internally to communicate with the Appwrite backend.
- Proper permissions on the Appwrite project are necessary to delete indexes.
Troubleshooting
Common issues:
- Providing incorrect or non-existent Database ID, Collection ID, or Key will cause the operation to fail.
- Insufficient permissions or invalid API credentials will result in authorization errors.
- Network connectivity problems may cause timeouts or connection errors.
Error messages:
- Errors from the Appwrite API are propagated and include response details when available.
- Typical error messages might indicate "index not found," "unauthorized," or "invalid parameters."
Resolution tips:
- Verify that the Database ID, Collection ID, and Key values are correct and exist in your Appwrite project.
- Ensure the API key or authentication token has sufficient rights to delete indexes.
- Check network connectivity and retry if transient errors occur.