Actions44
- User Actions
- Database Actions
- Collection Actions
- Document Actions
- Index Actions
- Function Actions
- Storage Actions
Overview
This node interacts with the Appwrite API to manage databases. Specifically, the Get Database operation retrieves detailed information about a single database by its unique ID. This is useful when you want to fetch metadata or configuration details of an existing database within your Appwrite project.
Common scenarios:
- Fetching database details before performing further operations like updating collections or documents.
- Verifying the existence and properties of a database in automation workflows.
- Integrating Appwrite database info into dashboards or reports.
Example:
You have multiple databases in your Appwrite backend and want to retrieve the schema or settings of a specific one by its ID to display or use in subsequent workflow steps.
Properties
| Name | Meaning |
|---|---|
| Database ID | The unique identifier of the database to retrieve. This must be provided to specify which database to get. |
Output
The output is a JSON object representing the database's details as returned by the Appwrite API. It typically includes fields such as the database ID, name, creation date, and other metadata describing the database.
If the operation succeeds, the output will contain the full database information in the json field of the node's output data.
No binary data is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Appwrite API.
- The node uses the Appwrite client library internally to communicate with the Appwrite server.
- Proper configuration of the Appwrite API credentials in n8n is necessary.
Troubleshooting
- Missing or invalid Database ID: Ensure that the "Database ID" property is correctly set and corresponds to an existing database in your Appwrite project.
- Authentication errors: Verify that the API key credential used has sufficient permissions to access the database resource.
- Network or connectivity issues: Confirm that the Appwrite server URL and network settings allow communication from n8n.
- Error messages containing response details: These usually indicate API-level errors; check the error message for specifics such as "database not found" or permission denied.
To resolve errors:
- Double-check input parameters.
- Validate credentials.
- Review Appwrite server logs if accessible.