docs: add databases content#3018
Conversation
Add the docs, blog post, and changelog entry for the dedicated databases launch. Covers managed PostgreSQL, MySQL, MariaDB, and MongoDB engines on Appwrite Cloud, with high availability, point-in-time recovery, branching, extensions, a connection pooler, and a managed SQL API. * 11 docs pages under products/databases/dedicated (overview, specifications, connect, high-availability, backups, branches, extensions, pooler, sql-api, network, monitoring) wired into the databases sidebar. * Cross-link callout from the main databases overview to the new section. * Hide the "new TablesDB API" banner on the dedicated routes since it's scoped to the document store. * Announcement blog post with 8 FAQs. * Changelog entry for 2026-05-21. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Appwrite WebsiteProject ID: Website (appwrite/website)Project ID: Tip Sites auto-generate unique domains with the pattern https://randomstring.appwrite.network |
There was a problem hiding this comment.
Pull request overview
Launches the customer-facing documentation and announcement content for Appwrite Cloud Dedicated databases (managed PostgreSQL/MySQL/MariaDB/MongoDB), and wires the new docs section into the existing Databases documentation navigation.
Changes:
- Adds a new Dedicated databases docs section (overview + 10 feature pages) under
docs/products/databases/dedicated/. - Updates Databases docs landing + sidebar layout to surface Dedicated databases and hide the TablesDB “New API” banner on dedicated routes.
- Adds an announcement blog post and a changelog entry linking to the blog + docs.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/routes/docs/products/databases/dedicated/+page.markdoc | Adds Dedicated databases overview (engines, regions, feature cards, limits, billing). |
| src/routes/docs/products/databases/dedicated/specifications/+page.markdoc | Adds specs/pricing, free tier caps, overage/add-ons, resize behavior guidance. |
| src/routes/docs/products/databases/dedicated/connect/+page.markdoc | Documents credential retrieval, connecting via CLIs/drivers, password rotation, extra users. |
| src/routes/docs/products/databases/dedicated/high-availability/+page.markdoc | Documents HA modes, enabling HA, auto/manual failover behavior, limits. |
| src/routes/docs/products/databases/dedicated/backups/+page.markdoc | Documents backups, retention, PITR, restore/verify flows, encryption/storage targets. |
| src/routes/docs/products/databases/dedicated/branches/+page.markdoc | Documents branching from snapshots + CI preview workflow example. |
| src/routes/docs/products/databases/dedicated/extensions/+page.markdoc | Documents PostgreSQL extension management endpoints and limits. |
| src/routes/docs/products/databases/dedicated/pooler/+page.markdoc | Documents per-DB pooler config, modes, read/write splitting, sizing guidance. |
| src/routes/docs/products/databases/dedicated/sql-api/+page.markdoc | Documents SQL API enablement/config, execution, bindings, errors, audit behavior. |
| src/routes/docs/products/databases/dedicated/network/+page.markdoc | Documents hostname/TLS/IP allowlist/connection limits + security guidance. |
| src/routes/docs/products/databases/dedicated/monitoring/+page.markdoc | Documents metrics/usage/slow queries/explain/insights/audit/events endpoints. |
| src/routes/docs/products/databases/+page.markdoc | Adds callout linking users to Dedicated databases from the document-store landing page. |
| src/routes/docs/products/databases/+layout.svelte | Adds Dedicated databases section to the docs sidebar + hides TablesDB subtitle/banner on dedicated routes. |
| src/routes/blog/post/announcing-dedicated-databases/+page.markdoc | Adds announcement post (with FAQs) for Dedicated databases launch. |
| src/routes/changelog/(entries)/2026-05-21.markdoc | Adds changelog entry linking to announcement + docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile SummaryThis PR adds 11 new documentation pages for dedicated databases, an announcement blog post, and a changelog entry, plus the necessary sidebar wiring and a
Confidence Score: 3/5The infrastructure changes are safe but several content pages contain code snippets and factual claims that will mislead users who copy them. The Go connection snippet in the connect page panics on any connection error; the CI workflow example hardcodes a single region endpoint; the SQL API page claims all four engines are supported while providing only SQL examples; the monitoring page omits the subscription-path format for lifecycle events like failover.completed; the network page MongoDB TLS table contradicts the prose beneath it; and the changelog contradicts the blog post FAQ on region selection. connect/+page.markdoc, branches/+page.markdoc, sql-api/+page.markdoc, monitoring/+page.markdoc, network/+page.markdoc, changelog/2026-05-21.markdoc Important Files Changed
Reviews (14): Last reviewed commit: "docs(databases): use appwrite.center for..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
…onnect page `nodejs` is not a registered highlight.js language alias — only `server-nodejs` (which maps to `js`) works. The SSR pass blew up with "Unknown language: nodejs" on every request, so the page 500'd and the sidebar link looked like it did nothing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Switch '125m CPU' / '125 mCPU' / '125m – 16000m' to '0.125 vCPU' / '0.125 – 16 vCPU'. mCPU is a Kubernetes/internal unit; users think in fractional vCPUs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
50% per replica is not sustainable at the higher specifications — at $860/mo the underlying infrastructure cost per replica is close to the full spec price. Raising to 75% matches the cross-region replica rate and preserves margin on Business+ tiers. Applied to cloud config and tests in a separate change. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
All replica-style add-ons (HA replicas, cross-region replicas, and the cross-region standby) now bill at 75% of the underlying specification. The standby is just a cross-region replica configured for automatic failover, so they price identically. Removes the separate "Cross-region standby" row from the add-on table and adds a one-liner explaining that the standby is a special-case cross-region replica. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The endpoint mutates an existing resource (the primary user's password), which is what PATCH is for. POST was the wrong verb. Updated the docs example to use PATCH. The same change ships in cloud (endpoint, e2e tests, internal docs). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replace the bare CURL examples in the Connect page with multicode blocks covering all server SDKs (Node.js, Deno, PHP, Python, Ruby, .NET, Dart, Kotlin, Swift, Go, Rust) plus CURL as the last entry, matching the pattern used elsewhere in the docs and blog posts. SDK calls go through the Compute service since the endpoint lives at /v1/compute/... Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…lover steps - Replace every em-dash with a comma in the new docs and blog post (12 files). - 'Appwrite's internal regional network' becomes 'the Appwrite network'. - Reduce the automatic-failover numbered list to a two-sentence summary. The engine-specific promote commands and per-step accounting belonged in the internal docs, not the user-facing page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Convert every API curl example in the dedicated databases docs to a
{% multicode %} block. Server SDKs (Node.js, Deno, PHP, Python, Ruby,
.NET, Dart, Kotlin, Swift, Go, Rust) come first, with curl as the last
tab. ~32 endpoints converted across high-availability, backups,
branches, extensions, pooler, sql-api, network, and monitoring pages.
Mark cross-region failover and cross-region replicas as 'coming soon'
in the HA and specifications pages. Replace 'quiesce' on the branches
page with 'pause writes', since the term reads as jargon to anyone who
isn't a DB engineer.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The branches page had two adjacent identical {% multicode %} blocks
calling listDatabaseBranches. Drop the one in the 'Create a branch'
section in favour of a sentence that links to the canonical 'List
branches' section below.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
abnegate
changed the title
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| cover: /images/blog/announcing-dedicated-databases/cover.avif | ||
| --- | ||
|
|
||
| Appwrite Cloud now supports [**Dedicated databases**](/docs/products/databases/dedicated), managed PostgreSQL, MySQL, MariaDB, and MongoDB engines running next to your existing Functions, Sites, and Storage. Pick an engine (Postgres 17/18, MySQL 8.0/8.4, MariaDB 10.11/11.4, MongoDB 7.0/8.0), pick a region (Frankfurt, New York, San Francisco, Singapore, Sydney, Toronto), pick a specification from `s-1vcpu-1gb` at $13/mo to `s-8vcpu-64gb` at $699/mo, and connect with `psql`, `mysql`, `mongosh`, or any standard driver. |
There was a problem hiding this comment.
The changelog entry tells readers they can "pick a region (Frankfurt, New York, San Francisco, Singapore, Sydney, Toronto)" when creating a dedicated database. The blog post FAQ in the same PR explicitly states the opposite: "there's no per-database region selector" and "A dedicated database lives in the same region as the project that owns it." A user who reads the changelog first will arrive at the Console expecting a region dropdown and be confused when one doesn't exist — or will open a support ticket asking why they can't move the database to a different region from their project. One of the two needs to align with the actual product behaviour.
| description: Execute parameterised SQL against a dedicated database over HTTPS without opening a TCP connection. Useful from edge runtimes, serverless functions, and CI scripts. | ||
| --- | ||
|
|
||
| The **SQL API** is a managed HTTP endpoint that executes one parameterised SQL statement against a dedicated database and returns the result as JSON. It runs alongside the database itself, so it sees the same latency as a local connection, but you call it from anywhere a TCP database connection isn't practical (edge runtimes, serverless functions on cold starts, CI scripts, internal admin tools). |
There was a problem hiding this comment.
The introduction states "The SQL API is opt-in per database and supports all four engines," yet the entire page uses SQL-only concepts: SELECT/INSERT/UPDATE/DELETE statement types, sqlApiAllowedStatements, positional $1/$2 bindings, and schema-altering SQL DDL restrictions. MongoDB uses MQL, not SQL — a MongoDB user who enables the SQL API and POSTs a standard MongoDB query will receive a parse error with no guidance on what format is actually expected. If the API genuinely translates SQL to MQL for MongoDB, the page needs at least one MongoDB-specific example and a note on syntax differences; if it doesn't, the "supports all four engines" claim should be corrected or scoped explicitly to SQL engines.
| compute.WithUpdateDatabaseSqlApiAllowedStatements([]string{"SELECT"}), | ||
| compute.WithUpdateDatabaseSqlApiMaxRows(10000), | ||
| compute.WithUpdateDatabaseSqlApiMaxBytes(10485760), | ||
| compute.WithUpdateDatabaseSqlApiTimeoutSeconds(30), | ||
| ) | ||
| if err != nil { |
There was a problem hiding this comment.
The configuration table says sqlApiMaxBytes is a "Hard payload cap; truncates beyond," implying the response is always truncated with truncated: true. But the error table says dedicated_database_sql_api_result_too_large is "returned as 200 with truncated: true if soft-truncating, 400 if rejecting outright." There is no explanation of when a request is soft-truncated versus hard-rejected: a user who relies on truncated: true to page through results and receives an unexpected 400 will have no way to understand what changed or what threshold triggers rejection rather than truncation.
Registers the Compute service in the API reference sidebar, landing grid, and service description, and bumps @appwrite.io/specs to a console spec carrying the current compute database API (PATCH credential rotation, database specifications, and backup policy endpoints). Per-endpoint rendering of the console-only spec is left as follow-up for the UI work. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Updates connect and network pages to the connection-string parameters the credentials endpoint actually returns (ssl=true for MySQL/MariaDB, sslmode=require for PostgreSQL), notes MySQL 8.x caching_sha2_password requires TLS, flags that MongoDB is not yet TLS-terminated at the proxy, and documents the longer provisioning window. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
| | Engine | Connection string parameter | | ||
| |------------|--------------------------------------------------------------------------------------| | ||
| | PostgreSQL | `sslmode=require` | | ||
| | MySQL | `ssl=true` | | ||
| | MariaDB | `ssl=true` | | ||
| | MongoDB | `ssl=true`, alongside `authSource=admin`, `directConnection=true`, and `retryWrites=true` | | ||
|
|
||
| Proxy TLS termination currently covers PostgreSQL, MySQL, and MariaDB. MongoDB connections are not yet TLS-terminated at the proxy and return `ssl=false`. |
There was a problem hiding this comment.
The TLS parameter table lists ssl=true for MongoDB, but the very next sentence says "MongoDB connections are not yet TLS-terminated at the proxy and return ssl=false." A user who manually builds a MongoDB connection string from the table will include ssl=true; if the proxy forwards a non-TLS stream, the driver may either reject the connection (TLS handshake failure) or silently downgrade — both of which are hard to diagnose. The MongoDB row in the table should reflect the actual behaviour (ssl=false with a "(TLS not yet supported)" note) until the proxy gains MongoDB TLS support.
The dedicated database endpoints live on the appwrite.center domain, not appwrite.network. Update the region table, connection strings, CLI and driver examples, branch/pooler hostnames, and the launch blog post. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
| # Webhooks & realtime {% #events %} | ||
|
|
||
| Every database lifecycle transition emits an event that fans out through Appwrite's standard event system. Subscribe with webhooks, realtime channels, or function triggers to react in your own systems: | ||
|
|
||
| | Event | When | | ||
| |------------------------------------------------|-----------------------------------------------| | ||
| | `databases.<id>.create` | Provisioning completed | | ||
| | `databases.<id>.update` | Any update applied (resize, HA, backups, etc.)| | ||
| | `databases.<id>.delete` | Database removed | | ||
| | `databases.<id>.backups.<bId>.create` | A backup completed (scheduled or manual) | | ||
| | `databases.<id>.restore` | A restore (full or PITR) completed | | ||
|
|
||
| Lifecycle events emitted by the edge, `spindown`, `storage.autoscaled`, `failover.completed`, also fan out through this same channel. |
There was a problem hiding this comment.
The table (lines 908–914) lists CRUD events in full databases.<id>.* notation so a webhook author knows exactly what path to subscribe to. The three lifecycle events in the closing prose — spindown, storage.autoscaled, failover.completed — are listed as bare names with no indication of whether they follow the same databases.<id>.<event> pattern or a flat top-level namespace. The blog post FAQ confirms failover.completed is the literal emitted name, which does not follow the table's pattern. A developer who subscribes to databases.<id>.failover.completed based on the table's convention will never receive the event.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Summary
Content for databases
products/databases/dedicated/: overview, specifications, connect, high-availability, backups, branches, extensions, pooler, sql-api, network, monitoring.