Appwrite icon

Appwrite

A comprehensive node for the Appwrite API
Join our community

Actions44

Overview

This node integrates with the Appwrite API to manage indexes within a specified database collection. The "List" operation for the "Index" resource retrieves all indexes defined on a particular collection inside a given database. This is useful when you want to audit, display, or programmatically handle the indexing structure of your Appwrite collections to optimize queries or maintain schema consistency.

Practical examples:

  • Fetching all indexes on a collection before adding a new one to avoid duplicates.
  • Displaying existing indexes in a dashboard for database optimization.
  • Automating index management workflows by listing and then conditionally updating or deleting indexes.

Properties

Name Meaning
Database ID The unique identifier of the database that contains the target collection.
Collection ID The unique identifier of the collection whose indexes you want to list.

Output

The output is a JSON array where each element represents an index object associated with the specified collection. Each index object typically includes details such as the index key, type, attributes, and order, reflecting how data is indexed in the collection.

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to connect securely to the Appwrite API.
  • Depends on the Appwrite client library internally to communicate with the Appwrite backend.
  • The node expects valid databaseId and collectionId parameters to identify the scope of indexes.

Troubleshooting

  • Common issues:

    • Providing incorrect or non-existent databaseId or collectionId will result in errors or empty results.
    • Missing or invalid API credentials will cause authentication failures.
    • Network connectivity problems can prevent communication with the Appwrite server.

  • Error messages:

    • Authentication errors indicate issues with the provided API key or token; verify and update credentials.
    • Not found errors suggest the specified database or collection does not exist; double-check IDs.
    • Permission denied errors mean the API key lacks rights to access the requested resource; ensure proper permissions are granted.

Links and References

Discussion