Skip to content

Databases Documentation#3072

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

Databases Documentation#3072
atharvadeosthale wants to merge 9 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).
  • 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).
  • 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).
  • 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
Ready Ready 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 reorganises the Databases documentation section by nesting TablesDB under a new tablesdb/ path with a legacy/ sub-section for the old collections/documents API, and adds full DocumentsDB content plus placeholder sections for MySQL, PostgreSQL, and VectorsDB. Comprehensive redirects preserve all existing deep-links, and SQL/PGSQL syntax highlighting is added for the new native-database code samples.

  • TablesDB pages moved from /docs/products/databases/X to /docs/products/databases/tablesdb/X, with 30+ redirect entries added to src/redirects.json covering every affected path including legacy sub-pages.
  • Full DocumentsDB documentation added (15 new pages: quick start, databases, collections, documents, permissions, queries, order, pagination, transactions, bulk/atomic operations, timestamp overrides, JSON imports/exports, backups).
  • MySQL, PostgreSQL, and VectorsDB sections added as structured placeholders with navigation layouts, integration pages, and accompanying images; src/lib/utils/code.ts gains sql, pgsql, and prisma language aliases for use in those pages.

Confidence Score: 5/5

Safe to merge — this is a large but purely additive documentation restructure with no application logic changes beyond syntax highlighting registration.

All changes are documentation content, navigation layouts, and redirect configuration. The redirect coverage is comprehensive and the new content pages are well-structured. The only finding is a cosmetic sidebar label inconsistency across three new layout files.

The +layout.svelte files for mysql, postgresql, and vectorsdb each set parent.label to their own product name rather than 'Databases', which is worth a second look for consistency with the tablesdb layout.

Important Files Changed

Filename Overview
src/routes/docs/products/databases/documentsdb/+layout.svelte New DocumentsDB sidebar layout; parent.label inconsistency ('DocumentsDB' vs 'Databases') already flagged in a previous review thread.
src/routes/docs/products/databases/mysql/+layout.svelte New MySQL sidebar layout; parent.label set to 'MySQL' rather than 'Databases', inconsistent with tablesdb convention.
src/routes/docs/products/databases/postgresql/+layout.svelte New PostgreSQL sidebar layout; parent.label set to 'PostgreSQL' rather than 'Databases', same inconsistency as MySQL layout.
src/routes/docs/products/databases/vectorsdb/+layout.svelte New VectorsDB sidebar layout; parent.label set to 'VectorsDB' rather than 'Databases', same inconsistency as MySQL/PostgreSQL layouts.
src/routes/docs/products/databases/tablesdb/+layout.svelte Migrated TablesDB layout with legacy/new URL derivation logic; parent.label correctly set to 'Databases'.
src/redirects.json Comprehensive redirects added for all moved TablesDB pages; existing short-URL redirects updated to point to new tablesdb paths.
src/lib/utils/code.ts Added sql/pgsql syntax highlighting languages and a Prisma alias mapping to graphql grammar.
.optimize-cache.json New cache entries added for all new documentsdb, mysql, and postgresql images; all committed image files have corresponding entries.

Reviews (4): Last reviewed commit: "Add draft announcement posts for Documen..." | 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

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