Appwrite icon

Appwrite

Interact with Appwrite API

Actions181

Collection → Get

AI-generated

Overview

This node interacts with the Appwrite API to perform operations on various resources. Specifically, for the Collection resource with the Get operation, it retrieves details of a specific collection within a database. This is useful for scenarios where you need to fetch metadata or configuration of a collection in Appwrite, such as when managing database schemas or integrating Appwrite collections into workflows.

Use Case Examples

  1. Fetch details of a collection by providing the database ID and collection ID to manage or inspect the collection's properties.
  2. Use in automation workflows to dynamically retrieve collection information before performing further operations like document management.

Properties

Name Meaning
Database ID The ID of the database containing the collection, required to identify the database context for the collection.
Collection ID The ID of the collection to retrieve, required to specify which collection's details to fetch.

Output

JSON

  • collectionId - The unique identifier of the collection.
  • databaseId - The identifier of the database the collection belongs to.
  • name - The name of the collection.
  • permissions - Permissions associated with the collection.
  • attributes - Attributes or fields defined in the collection.
  • indexes - Indexes defined on the collection.

Dependencies

  • Appwrite API key credential for authentication

Troubleshooting

  • Ensure the provided Database ID and Collection ID are correct and exist in the Appwrite project.
  • Check that the API key has sufficient permissions to access the database and collection information.
  • Common errors include authentication failures due to invalid API keys or permission errors if the user lacks access rights to the specified collection.
  • Network issues or incorrect endpoint configuration can also cause failures; verify the endpoint URL and network connectivity.

Links

Discussion