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 → Delete
AI-generatedOverview
This node operation deletes a specified collection within a database in the Appwrite platform. It is useful for managing database schemas by removing collections that are no longer needed or relevant. For example, if a project requires cleaning up unused data structures, this operation can be used to delete a collection by providing its database ID and collection ID.
Use Case Examples
- Deleting a user data collection from a project database to free up resources.
- Removing a temporary collection used for testing purposes after tests are completed.
Properties
| Name | Meaning |
|---|---|
| Database ID | The ID of the database containing the collection to delete. |
| Collection ID | The ID of the collection to be deleted within the specified database. |
Output
JSON
json- The response from the Appwrite API after attempting to delete the collection, typically confirming deletion or providing error details.
Dependencies
- Requires an Appwrite API key credential with permissions to manage databases and collections.
Troubleshooting
- Ensure the provided Database ID and Collection ID are correct and exist in the Appwrite project.
- Check that the API key used has sufficient permissions to delete collections.
- Common errors include authorization failures or resource not found errors if IDs are incorrect.
Links
- Appwrite Database Delete Collection API - Official documentation for deleting a collection in Appwrite's database service.