SQL Editor

[kbatuigas]

Description

This pull request adds documentation for the new SQL Editor feature in the Redpanda Cloud Console, allowing users to write and run SQL queries directly from the browser without needing an external SQL client. The changes update navigation, quickstart, and getting started guides to reference the SQL Editor, and introduce a comprehensive new page detailing its use.

Key changes:

New SQL Editor documentation:

• Added a new page, sql-editor.adoc, describing how to use the built-in SQL Editor in the Redpanda Cloud Console, including browsing catalogs, writing and running queries, viewing results, exporting data, and adding topics to the catalog.

Navigation and discoverability:

• Updated the navigation file (nav.adoc) to include a link to the SQL Editor documentation under the "Query Data" section.
• Added the SQL Editor as a next step in the SQL cluster deployment guide and the SQL quickstart guide, making it easier for users to discover and access the feature. [1] [2]
• Included a tip in the quickstart guide about querying data directly in the Cloud Console using the SQL Editor.
• Added the SQL Editor to the main "Get started" section of the SQL documentation landing page.

Resolves DOC-2211
Review deadline: 19 Jun

Page previews

• Use the SQL Editor (new)
• What's New in Redpanda Cloud (updated)
• Enable Redpanda SQL on a BYOC Cluster (updated)
• Redpanda SQL Quickstart (updated)
• Redpanda SQL (updated)

Checks

• New feature
• Content gap
• Support Follow-up
• Small fix (typos, links, copyedits, etc)

[netlify]

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit	2320a7e
🔍 Latest deploy log	https://app.netlify.com/projects/rp-cloud/deploys/6a4d4c3bdfcf9600080d23d2
😎 Deploy Preview	https://deploy-preview-619--rp-cloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds a new documentation page (sql-editor.adoc) covering the built-in SQL Editor in the Redpanda Cloud Console. The page documents prerequisites, catalog browsing, query authoring (SELECT-only), result viewing, pagination, Iceberg bridge indicators, CSV/JSON export, and the wizard for adding topics to the SQL catalog. The new page is registered in nav.adoc under Redpanda SQL → Query Data and linked from the SQL module index, the deploy-sql-cluster Next steps, and the sql-quickstart tip and Next steps sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

• simonlord
• Feediver1

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title is concise and directly names the main change: the SQL Editor documentation.
Description check	✅ Passed	The description covers the required sections and page previews, but uses a DOC issue reference instead of the template's GitHub issue link.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch DOC-2211-document-feature-sql-editor-ui-for-oxla

---

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

[Feediver1]

Final-pass review (docs-team-standards)

Overall: Well-executed, SME-reviewed feature doc that's nearly ready to merge. All inline SME threads are resolved in the final state (verified against the file, not just the replies). One unresolved reviewer question should be answered before merge; the rest is suggestion-level.

Jira ticket alignment

DOC-2211 (SQL Editor UI for Oxla, epic ENG-904 — Shipped) — ✅ fully addressed: editor how-to plus all discovery surfaces (nav, What's New, landing page, quickstart, deploy guide).

SME thread verification (all resolved ✅)

Verified each thread against the final file state: column sort removed, lock icon removed, offset-lag wording matches c-julin's spec ("how many offsets are not yet in Iceberg"), external Iceberg catalog list removed, LOs updated for the Add-topic wizard, What's New has "SQL-enabled environments" + enable link, and the SELECT-only rationale now explains why (read-only engine, consistent with overview.adoc).

Must resolve before merge

1. [deploy-sql-cluster.adoc:209] Open question: default database name. @kbatuigas asked whether the default DB changed from oxla to default; @grzebiel was pinged but no answer landed in the thread. The connection string still reads dbname=oxla — if the DB was renamed, this copy-paste command fails for every user. Please confirm and either update dbname= (and audit the quickstart psql examples) or resolve the thread.

Suggestions

1. Backlinks: query-streaming-topics.adoc and query-iceberg-topics.adoc don't link back to the new SQL editor page — readers on the psql-based pages never learn there's a no-client option. Consider adding it to their next steps.
2. [sql-editor.adoc: Suggested reading] The blurb "How bridge queries mesh live and Iceberg-tiered data" points to query-iceberg-topics.adoc, but that page never uses the term "bridge query". Reword the blurb, or add the term to the target page in a follow-up.
3. [sql-editor.adoc: LOs vs. prerequisites] LO1 (Add a topic via the wizard) requires the Admin role per the section NOTE, but Prerequisites only list SQL: Access/SQL: Manage. Mention the Admin-role requirement in Prerequisites, or order LOs so universally-achievable ones come first.

What works well

• SME feedback loop fully closed, with fixes verified in the final text
• Correct glossterm keys (RBAC, Iceberg topic) and kbd:[] macros throughout
• Heading capitalization follows team rules; no cross-page drift on the read-only framing
• query-data/index.adoc uses page-layout: index, so no manual listing update needed; all xref targets verified on the branch

🤖 Automated final-pass review via docs-team-standards pr-review.

[Feediver1]

Final-pass delta review (docs-team-standards)

Scope: Changes since the previous final-pass review posted 2026-07-07 19:44 UTC.

Overall: No content has changed since the last review — the PR head is still 2320a7e, the same commit set that review covered. The only activity is a reply that resolves the single must-fix item, so the PR is clear from my side.

What changed since the last review

• No new commits or force-pushes. All six files are identical to what was reviewed on 2026-07-07.
• One new comment (2026-07-08, @kbatuigas): on the deploy-sql-cluster.adoc default-database thread — "Default database for connection is still oxla, no changes required here."

Status of the previous review's findings

1. Must-fix: default database name — ✅ resolved. The author confirmed the default DB is still oxla, so the dbname=oxla connection string is correct as written. No file change needed.
2. Suggestions 1–3 — not addressed, non-blocking. Backlinks from the psql-based pages, the "bridge query" terminology mismatch in Suggested reading, and the Admin-role gap between LO1 and Prerequisites stand as optional follow-ups.

Merge readiness

Approvals from @mattschumpert and @c-julin are in, CodeRabbit and the Netlify deploy preview are green, and the branch is mergeable. With the default-database question answered, no open items remain from the final-pass review.

🤖 Automated final-pass review via docs-team-standards pr-review.