Skip to content

Databases -> TablesDB in realtime docs & more#2784

Merged
atharvadeosthale merged 2 commits intomainfrom
fix-realtime-events
Mar 4, 2026
Merged

Databases -> TablesDB in realtime docs & more#2784
atharvadeosthale merged 2 commits intomainfrom
fix-realtime-events

Conversation

@atharvadeosthale
Copy link
Member

@atharvadeosthale atharvadeosthale commented Mar 4, 2026

Summary by CodeRabbit

  • Documentation
    • Event namespace changed from databases.* to tablesdb.* across platform events docs and examples.
    • Event paths and related return references updated to match the new namespace (including table, row, column, and index events).
    • Added deprecation notices: collections → tables, documents → rows, attributes → columns; plus minor wording and formatting fixes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0aecfcc7-b3ba-40aa-82ff-c0c49a161bab

📥 Commits

Reviewing files that changed from the base of the PR and between d9db30f and 43ace8c.

📒 Files selected for processing (1)
  • src/routes/docs/apis/realtime/+page.markdoc

Walkthrough

The pull request updates documentation to migrate event namespaces from databases.* to tablesdb.*. It renames nested event paths (e.g., databases.*.tables.*tablesdb.*.tables.*), updates event categories and create/update/delete mappings, changes some index-related return type references to columnIndex, adds a deprecation notice about terminology (collections→tables, documents→rows, attributes→columns), updates example JSON events and channels, and applies minor grammar and formatting tweaks.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately reflects the main change: updating documentation from 'Databases' to 'TablesDB' namespace across realtime docs and related files. It is concise, specific, and clearly summarizes the primary objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-realtime-events

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/partials/databases-events.md (1)

8-10: Move the migration note into this shared partial for better cross-page clarity

This partial is reused outside the Events page, so readers can see tablesdb.* without the deprecation context currently shown only in src/routes/docs/advanced/platform/events/+page.markdoc. Consider adding a short note at the top of this partial itself.

💡 Suggested doc tweak
+{% info title="Terminology update" %}
+The `databases.*` event prefix has been replaced by `tablesdb.*`. Collections, documents, and attributes are now tables, rows, and columns.
+{% /info %}
+
 {% table %}

Based on learnings: In Appwrite website documentation (appwrite/website), the standard terminology is now "rows" and "columns" (not "documents" and "collections"), and it should be used consistently across documentation.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/partials/databases-events.md` around lines 8 - 10, Add the
migration/deprecation note into the shared partial that documents the
`tablesdb.*` event so the context appears wherever this partial is reused;
update the heading of the partial to include a short migration note, move the
existing migration text from the Events page into this partial, and ensure any
occurrences use the new standard terminology "rows" and "columns" instead of
"documents" and "collections" (search for the `tablesdb.*` text and the previous
migration note to copy and remove the original).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/routes/docs/advanced/platform/events/`+page.markdoc:
- Around line 25-26: The page claims the `databases.*` event prefix has been
replaced by `tablesdb.*`, but the Realtime examples still use `databases.*`;
update the Realtime examples to use the new `tablesdb.*` event prefix (search
for occurrences of `databases.*` in the Realtime +page.markdoc examples and
replace them with `tablesdb.*`, keeping event payloads and semantics identical),
or alternatively soften the sentence on the advanced/platform/events page to
state that `tablesdb.*` is the preferred/new prefix while legacy `databases.*`
remains supported for compatibility.

---

Nitpick comments:
In `@src/partials/databases-events.md`:
- Around line 8-10: Add the migration/deprecation note into the shared partial
that documents the `tablesdb.*` event so the context appears wherever this
partial is reused; update the heading of the partial to include a short
migration note, move the existing migration text from the Events page into this
partial, and ensure any occurrences use the new standard terminology "rows" and
"columns" instead of "documents" and "collections" (search for the `tablesdb.*`
text and the previous migration note to copy and remove the original).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2c5d138a-24b7-4809-8eb8-2062d84a99da

📥 Commits

Reviewing files that changed from the base of the PR and between 7f0f6af and d9db30f.

📒 Files selected for processing (2)
  • src/partials/databases-events.md
  • src/routes/docs/advanced/platform/events/+page.markdoc

@atharvadeosthale atharvadeosthale merged commit 592e07a into main Mar 4, 2026
10 of 11 checks passed
@atharvadeosthale atharvadeosthale deleted the fix-realtime-events branch March 4, 2026 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants