Docs: Add plan limits for bulk operations

[ebenezerdon]

What does this PR do?

Adds plan limits for bulk operations to the docs

Summary by CodeRabbit

• Documentation
  • Added “Important notes” clarifying bulk operations don’t trigger Functions, Webhooks, or Realtime, and aren’t supported for collections with relationship attributes; recommends individual operations for those.
  • Introduced “Plan limits” with per-plan caps (Free: 100, Pro: 1,000 documents per request) applying to all bulk actions, plus a contact option for custom needs.
  • Added “Custom timestamps” guidance for setting $createdAt and $updatedAt (ISO 8601) in bulk payloads; automatically set if omitted.
  • Atomic behavior description unchanged.

[coolify-appwrite-org]

The preview deployment failed. 🔴

Open Build Logs

Last updated at: 2025-08-20 19:12:34 CET

[appwrite]

appwrite.io

Project ID: 684969cb000a2f6c0a02

Sites (1)

Site	Status	Logs	Preview	QR
website 68496a17000f03d62013	Failed	View Logs	Preview URL

Note

Cursor pagination performs better than offset pagination when loading further pages.

[Copilot]

Pull Request Overview

This PR adds documentation about plan limits for bulk operations in the Appwrite databases section. The change provides clear information about the document limits per request for different subscription tiers.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[ItzNotABug]

@ebenezerdon tests failing for -

[vite-plugin-svelte] [plugin vite-plugin-svelte] Error while preprocessing /home/runner/work/website/website/src/routes/docs/products/ai/tutorials/music-generation/+page.markdoc - Node 'section' is missing closing
file: /home/runner/work/website/website/src/routes/docs/products/ai/tutorials/music-generation/+page.markdoc

[coderabbitai]

Walkthrough

Updated docs at src/routes/docs/products/databases/bulk-operations/+page.markdoc. Inserted an “Important notes” box stating bulk operations don’t trigger Functions, Webhooks, or Realtime events, and that collections with relationship attributes aren’t supported via bulk operations; advises using individual document operations for such collections. Added a “Plan limits” section with limits (Free: 100; Pro: 1,000) applying to create/update/upsert/delete, plus a support contact link for custom plans. Added a “Custom timestamps” note in Create documents allowing $createdAt and $updatedAt per document (ISO 8601) or auto-set if omitted. No other content changes; atomic behavior unchanged.

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly summarizes the key addition of a plan limits section to the bulk operations documentation, aligning directly with the PR objective and branch name. It employs the clear scope prefix “Docs:” and uses an imperative verb form. It avoids unnecessary detail or vague language while remaining concise. This makes it immediately understandable for anyone scanning the project history.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bulk-operations-plan-limits

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

src/routes/docs/products/databases/bulk-operations/+page.markdoc (1)

29-39: Plan limits section looks good; correct support link.

Table is clear and uses the right enterprise contact URL, addressing prior feedback.

🧹 Nitpick comments (2)

src/routes/docs/products/databases/bulk-operations/+page.markdoc (2)

13-16: Confirm event behavior; consider minor copy edit.

Please confirm with the product team that bulk ops truly suppress Functions, Webhooks, and Realtime events. If confirmed, we should keep this as a prominent callout. Also add terminal periods for consistency.

 {% info title="Important notes" %}
-- Bulk operations do not trigger Functions, Webhooks, or Realtime events
-– Collections that contain relationship attributes are not supported via bulk operations. Use individual document operations for collections with relationships
+- Bulk operations do not trigger Functions, Webhooks, or Realtime events.
+- Collections that contain relationship attributes are not supported via bulk operations. Use individual document operations for collections with relationships.
 {% /info %}

---

59-72: Unify placeholder style: use <COLLECTION_ID> (not [COLLECTION_ID]) in Node examples.

Python blocks use angle brackets; Node blocks should match to avoid user confusion.

-    '[COLLECTION_ID]',
+    '<COLLECTION_ID>',

Apply the same change in createDocuments, updateDocuments, upsertDocuments, and deleteDocuments Node snippets.

Also applies to: 124-133, 181-194, 246-252

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 29289e2 and 7beb385.

📒 Files selected for processing (1)

• src/routes/docs/products/databases/bulk-operations/+page.markdoc (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: format
• GitHub Check: tests

🔇 Additional comments (2)

src/routes/docs/products/databases/bulk-operations/+page.markdoc (2)

44-46: Verify “Custom timestamps” capability.

Allowing $createdAt/$updatedAt to be set is atypical for system fields. Please confirm this is supported for bulk ops and server SDKs, and note any constraints (e.g., server-only, ISO 8601 UTC, validation/rounding).

---

1-5: Fix unbalanced Markdoc section tags in music-generation tutorial
The CI failure is caused by an unmatched {% section %} in src/routes/docs/products/ai/tutorials/music-generation/+page.markdoc. Ensure every {% section %} has a corresponding {% /section %} in that file.

[stnguyen90]

Can you double check if this is still the case? Some of this might work now after 1.8 was released.

[ItzNotABug]

relationships are not supported via bulk afaik. also this terminology needs an update. All legacy ones should go in the databases/legacy routes.

[ebenezerdon]

Updated

[stnguyen90]

@ItzNotABug sorry, i meant the triggering of functions, webhooks, and realtime events.

[stnguyen90]

Comment for @ItzNotABug : #2285 (comment)