Skip to content

Databases Documentation#3072

Open
atharvadeosthale wants to merge 11 commits into
stardustfrom
stardust-databases
Open

Databases Documentation#3072
atharvadeosthale wants to merge 11 commits into
stardustfrom
stardust-databases

Conversation

@atharvadeosthale

@atharvadeosthale atharvadeosthale commented Jun 29, 2026

Copy link
Copy Markdown
Member

Summary

Restructures the databases docs into per-database-type sections and adds complete documentation for four database types, plus draft announcement posts.

Restructure

  • Moved TablesDB to live within the databases section and set up redirects from the previous URLs.
  • Each database type now has its own sub-sidebar under Databases.

DocumentsDB

  • Full documentation section: collections, documents, queries, pagination, ordering, permissions, transactions, bulk operations, atomic numeric operations, timestamp overrides, backups, and JSON imports/exports.

VectorsDB

  • Full documentation section: collections with fixed dimension, documents (embeddings + metadata), built-in text embedding generation, HNSW vector search (cosine, dot product, Euclidean), queries, pagination, permissions, transactions, bulk operations, backups, and CSV imports/exports.

Native PostgreSQL

  • 12 core pages (overview with specifications and pricing, quick start, connections, connection pooling, extensions, backups and PITR, branches, high availability, scaling, network security, monitoring, maintenance).
  • 7 concept pages covering database fundamentals (tables and data types, querying rows, joins and relationships, indexes, transactions, data modeling and normalization, security and access control with roles and RLS), each self-contained with a shared example schema and real captured outputs, plus an index-lookup diagram (light and dark).
  • 17 integration guides: Node.js drivers, Prisma, Drizzle, Auth.js, Better Auth, Laravel, Rails, Django, FastAPI, Spring Boot, EF Core, GORM, Next.js, dbt, Metabase, Grafana, Retool.
  • Console screenshots (light and dark) for the create flow, credentials, SQL editor, monitor, connections, roles, and settings pages.

Native MySQL

  • 11 core pages mirroring the PostgreSQL structure (extensions are PostgreSQL-only).
  • 7 concept pages mirroring the PostgreSQL set, adapted to MySQL behavior where the engines differ (no FULL JOIN, no materialized views, statement-level error handling in transactions, REPEATABLE READ default, prefix/functional/invisible indexes, and an access-control page built around views and application-level scoping since MySQL has no row-level security).
  • The same 17 integration guides, converted to MySQL toolchains (mysql2, @prisma/adapter-mariadb, Drizzle mysql-core, mysqlclient, asyncmy, Connector/J, MySql.EntityFrameworkCore, gorm mysql driver, dbt-mysql, and more).
  • Create-flow Console screenshots (light and dark).

Blog

  • Four draft announcement posts (hidden from listings via draft: true, cover images to be added): DocumentsDB, VectorsDB, native PostgreSQL, and native MySQL.

Misc

  • Registered sql, pgsql, and prisma languages for code highlighting.

Verification

  • Every SDK code block on the native database pages was executed in Node and Rust against a live instance; remaining languages were checked against generated SDKs.
  • All SQL, shell, and driver examples were run against live PostgreSQL 18 and MySQL 8.4 databases, including the full integration-guide flows (migrations, ORM queries, BI tools).
  • Concept pages: every SQL block executed live on both engines; EXPLAIN plans, deadlocks, RLS denials, and error messages are real captured outputs. Data type catalogs, isolation levels, index types, and privilege boundaries enumerated from the running engines.
  • All internal links verified against the working tree; every page render-checked.

Split the Databases docs into a menu of database types. The /docs/products/databases
overview becomes a menu (Appwrite databases: TablesDB, DocumentsDB, VectorsDB;
Native databases: PostgreSQL, MySQL). Existing TablesDB content moves under
/tablesdb with its full sidebar; DocumentsDB, VectorsDB, PostgreSQL, and MySQL get
their own sections with placeholder overviews. Adds redirects for all moved pages.
Add DocumentsDB docs (concepts and journeys) under databases/documentsdb, move TablesDB within the databases section with redirects from the previous URLs, and align the backups and bulk operations pages.
@appwrite

appwrite Bot commented Jun 29, 2026

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Failed Failed View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Queued Queued View Logs Preview URL QR Code


Tip

Environment variable changes require redeployment to take effect

@atharvadeosthale
atharvadeosthale changed the base branch from main to stardust June 29, 2026 14:43
@greptile-apps

greptile-apps Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR restructures the Databases documentation section into per-database-type sub-trees (TablesDB, DocumentsDB, VectorsDB, PostgreSQL, MySQL), migrates TablesDB pages under their new tablesdb/ path with full redirects for the old URLs, and adds complete documentation for four database types plus draft announcement blog posts.

  • Routing and redirects: All old /docs/products/databases/* URLs are covered by new redirect rules pointing at the TablesDB subtree, and a new (overview) route group serves the hub page at the existing /docs/products/databases URL without breaking any old links.
  • Legacy API support: A dedicated tablesdb/legacy/ sub-tree with a deprecation banner and a computed link back to the modernised page handles the old Collections-API terminology.
  • New database docs: DocumentsDB, VectorsDB, PostgreSQL, and MySQL each get a full layout with sidebar navigation, concept pages, integration guides, and console screenshots; four draft blog posts (hidden via draft: true) accompany the launch.

Confidence Score: 5/5

Safe to merge — the changes are purely documentation content, routing, and sidebar configuration with no runtime logic that could break existing features.

The restructure is a large but mechanical documentation change: new Markdoc pages, layout components, and redirect entries. All old URLs are accounted for in redirects.json, the TablesDB legacy sub-tree correctly maps old slugs to new ones, and the new layouts follow the established Svelte component patterns used across the rest of the docs. The only notable issue is a two-hop redirect chain in the legacy index page, which still resolves to the correct destination.

No files require special attention. The tablesdb/legacy/+page.ts redirect target could be tightened, but it resolves correctly today.

Important Files Changed

Filename Overview
src/lib/utils/code.ts Registers sql, pgsql highlight.js languages and aliases prisma to graphql grammar — straightforward additions with no side-effects.
src/redirects.json Updates old /docs/products/databases/* URLs to point at the new tablesdb/ subtree; coverage appears complete for all pages that existed before the restructure.
src/routes/docs/products/databases/tablesdb/legacy/+page.ts Redirects /tablesdb/legacy to /docs/products/databases/databases (which is itself a redirect target), creating a double-hop instead of going directly to /tablesdb/databases.
src/routes/docs/products/databases/tablesdb/legacy/+layout.svelte Shows a 'Deprecated API' alert with a computed link back to the updated docs; URL transformation logic correctly handles all legacy page slugs.
src/routes/docs/products/databases/tablesdb/+layout.svelte Full sidebar navigation for TablesDB with correct parent.label: 'Databases'; 'New API' banner and legacy URL derivation look correct.
src/routes/docs/products/databases/documentsdb/+layout.svelte Sidebar layout for DocumentsDB; parent.label is set to 'DocumentsDB' (previously flagged in review thread).
src/routes/docs/products/databases/vectorsdb/+layout.svelte Sidebar layout for VectorsDB; parent.label set to 'VectorsDB', inconsistent with TablesDB which uses 'Databases'.
src/routes/docs/products/databases/postgresql/+layout.svelte Full sidebar for PostgreSQL with integrations and manage sections; parent.label set to 'PostgreSQL' rather than 'Databases'.
src/routes/docs/products/databases/mysql/+layout.svelte Full sidebar for MySQL mirroring the PostgreSQL layout; parent.label set to 'MySQL' rather than 'Databases'.
src/routes/docs/products/databases/(overview)/+layout.svelte New Databases hub layout listing all five database types with correct parent pointing to /docs.
src/routes/docs/products/databases/(overview)/+page.markdoc Databases overview page with cards for all five database types; content is clear and links are accurate.

Reviews (5): Last reviewed commit: "Add connective prose between adjacent co..." | Re-trigger Greptile

Comment thread src/routes/docs/products/databases/documentsdb/+layout.svelte
Comment thread src/routes/docs/products/databases/tablesdb/+page.markdoc
Comment thread src/routes/docs/products/databases/documentsdb/backups/+page.markdoc Outdated
Comment thread src/routes/docs/products/databases/documentsdb/bulk-operations/+page.markdoc Outdated
@atharvadeosthale

Copy link
Copy Markdown
Member Author

WIP - console screenshots & import / export

Seven concept pages per engine (tables, queries, joins, indexes,
transactions, data modeling, access control) with a new Concepts
sidebar group. All SQL verified against live databases; index
lookup diagram in light and dark variants.
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