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
Document → Batch Update
AI-generatedOverview
This node performs batch updates on documents within a specified database and collection in the Appwrite platform. It is useful for scenarios where multiple documents need to be updated simultaneously, such as bulk editing records or synchronizing data across multiple entries. For example, updating user profiles or inventory items in bulk can be efficiently handled with this operation.
Use Case Examples
- Updating multiple user documents in a database collection with new profile information.
- Bulk updating product details in an inventory management system.
Properties
| Name | Meaning |
|---|---|
| Database ID | The ID of the database where the documents reside. |
| Collection ID | The ID of the collection containing the documents to update. |
| Batch Items | An array of documents to update, each with a documentId, data for the update, and optional permissions. |
| Continue on Error | Whether to continue processing remaining items if some updates fail. |
| Batch Size | Number of items to process in each batch, ranging from 1 to 100. |
| Parallel Processing | Whether to process items in parallel for faster execution, with a risk of rate limiting. |
Output
JSON
documentId- The ID of the updated document.data- The updated data of the document.permissions- The permissions applied to the updated document, if any.error- Error details for any failed update when continue on error is enabled.
Dependencies
- Appwrite API key credential for authentication
Troubleshooting
- Common issues include rate limiting when parallel processing is enabled; reducing batch size or disabling parallel processing can help.
- Errors may occur if document IDs are invalid or missing in batch items; ensure each item has a valid documentId.
- If the API key or project credentials are incorrect, authentication errors will occur; verify credentials in node settings.
Links
- Appwrite Documents Update API - Official documentation for updating documents in Appwrite databases.