Appwrite icon

Appwrite

Interact with Appwrite API

Actions181

Document → Delete

AI-generated

Overview

This node interacts with the Appwrite API to perform operations on documents within a specified database and collection. Specifically, the 'Delete' operation under the 'Document' resource allows users to delete a document by providing the database ID, collection ID, and document ID. This is useful for workflows that require automated removal of documents from Appwrite databases, such as cleaning up outdated records or managing data lifecycle.

Use Case Examples

  1. Deleting a user profile document from a user database when the user account is deactivated.
  2. Removing a log entry document from a collection after it has been processed.

Properties

Name Meaning
Database ID The ID of the database where the document resides.
Collection ID The ID of the collection within the database containing the document.
Document ID The ID of the document to be deleted.

Output

JSON

  • json - The response from the Appwrite API after attempting to delete the document, typically confirming deletion or providing error details.

Dependencies

  • Requires an Appwrite API key credential for authentication, including endpoint URL, project ID, and API key.

Troubleshooting

  • Ensure that the provided Database ID, Collection ID, and Document ID are correct and exist in the Appwrite project to avoid 'document not found' errors.
  • Verify that the API key has sufficient permissions to delete documents in the specified database and collection.
  • Common errors include authentication failures due to invalid API keys or insufficient permissions, and resource not found errors if IDs are incorrect.

Links

Discussion