NAppwriteInstall

Overview

This node integrates with the Appwrite API to perform various operations on different resources such as documents, functions, storage, and users. Specifically, for the Document - Delete operation, it deletes a document from a specified collection within a database in Appwrite.

Common scenarios where this node is beneficial include:

• Automating cleanup of outdated or irrelevant documents in an Appwrite database.
• Integrating document deletion into workflows triggered by external events (e.g., deleting user data upon account closure).
• Managing document lifecycle programmatically without manual intervention.

Example use case:

• A workflow that deletes a specific document identified by its ID from a collection when a certain condition is met, such as after processing or archiving the document's data elsewhere.

Properties

Output

The output JSON contains a single field response which holds the result of the delete operation. This typically confirms whether the deletion was successful.

Example output structure:

[
  {
    "response": {
      // Response details from Appwrite API confirming deletion
    }
  }
]

No binary data is output by this operation.

Dependencies

• Requires an active connection to an Appwrite server via its REST API.
• Needs credentials including the Appwrite endpoint URL, project ID, and an API key credential with permissions to delete documents.
• The node depends on the node-appwrite SDK internally to interact with Appwrite services.

Troubleshooting

• Common issues:

  • Invalid or missing Database ID, Collection ID, or Document ID parameters will cause the operation to fail.
  • Insufficient permissions or incorrect API key may result in authorization errors.
  • Network connectivity problems can prevent communication with the Appwrite server.

• Error messages:

  • Errors returned from the Appwrite API will be propagated. For example, "Document not found" if the specified document ID does not exist.
  • Authentication errors indicating invalid credentials or lack of access rights.

• Resolution tips:

  • Verify all IDs are correct and correspond to existing resources.
  • Ensure the API key has appropriate permissions for document deletion.
  • Check network connectivity and Appwrite server availability.
  • Use the node’s "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

• Appwrite Official Documentation
• Appwrite API Reference - Databases
• n8n Documentation