Actions181
- Account Actions
- Get Account
- Create Account
- Update Email
- Update Name
- Update Password
- Update Phone
- Update Status
- Get Preferences
- Update Preferences
- List Sessions
- Delete Sessions
- Get Session
- Update Session
- Delete Session
- Create Anonymous Session
- Create Email/Password Session
- Create Magic URL Session
- Create OAuth2 Session
- Create Phone Session
- Create Session from Token
- Create JWT
- Create Magic URL
- Create Phone Token
- Create Email Verification
- Update Email Verification
- Create Phone Verification
- Update Phone Verification
- Create Password Recovery
- Update Password Recovery
- Create Recovery
- Update Recovery
- Update MFA
- Create MFA Authenticator
- Update MFA Authenticator
- Delete MFA Authenticator
- Create MFA Challenge
- Update MFA Challenge
- Attribute Actions
- Avatars Actions
- Collection Actions
- Database Actions
- Document Actions
- Functions Actions
- Index Actions
- Locale Actions
- Messaging Actions
- Sites Actions
- Storage Actions
- Teams Actions
- Users Actions
Collection → List Attributes
AI-generatedOverview
This node interacts with the Appwrite API to perform operations related to collections within a database. Specifically, the 'List Attributes' operation retrieves the attributes of a specified collection in a given database. This is useful for scenarios where you need to understand or manipulate the schema of a collection, such as dynamically generating forms, validating data structures, or managing database schemas programmatically.
Use Case Examples
- Listing all attributes of a collection to display its schema in a user interface.
- Retrieving collection attributes before updating or migrating database schemas.
- Automating database documentation by extracting collection attribute details.
Properties
| Name | Meaning |
|---|---|
| Database ID | The ID of the database containing the collection. This is required to identify which database's collection attributes to list. |
| Collection ID | The ID of the collection whose attributes are to be listed. This is required to specify the target collection within the database. |
Output
JSON
attributes- An array or list of attributes belonging to the specified collection, detailing the schema or structure of the collection.
Dependencies
- Appwrite API key credential for authentication and access to the Appwrite backend service.
Troubleshooting
- Ensure that the provided Database ID and Collection ID are correct and exist in the Appwrite project to avoid errors related to resource not found.
- Verify that the API key credential has sufficient permissions to access the database and collection attributes.
- Common error messages may include authentication failures, resource not found, or permission denied. Resolving these typically involves checking credentials, IDs, and user permissions.