Skip to content

SQL: Fix reserved vs non-reserved keywords - #667

Open
kbatuigas wants to merge 1 commit into
mainfrom
DOC-2269-fix-documentation-sql-reserved-non-reserved-key
Open

SQL: Fix reserved vs non-reserved keywords#667
kbatuigas wants to merge 1 commit into
mainfrom
DOC-2269-fix-documentation-sql-reserved-non-reserved-key

Conversation

@kbatuigas

Copy link
Copy Markdown
Contributor

What

Corrects the reserved / non-reserved classification for Redpanda SQL keywords on the
xref:reference:sql/sql-statements/keywords.adoc[Keywords reference page], and fixes the
intro examples that the reclassification invalidated.

Resolves https://redpandadata.atlassian.net/browse/DOC-2269

Why

About half the keyword rows were marked with the wrong reserved/non-reserved status.
ENG verified the correct classification empirically against the
engine — looping every keyword through CREATE TABLE tbl1 (<keyword> INTEGER); DROP TABLE tbl1;
— and attached the corrected full table to the ticket. Docs that misreport which keywords
need quoting lead users to write queries y quote identifiers).

Changes

Table (`modules/reference/pages/sql/sql-s regenerated from the
reporter's corrected table and reconciled against his two diff lists:

  • 164 keywords: non-reserved → reserved
  • 82 keywords: reserved → **non-reser
  • 1 alphabetization fix: CURRENT_ROLE / CURRENT_USER were transposed
  • 0 changes to the Notes column — ad
  • Row set unchanged: 457 keywords, exactly one per row

Intro prose (was inconsistent with the corrected table):

  • Reserved examples SELECT, INSERT, UPDATESELECT, FROM, WHERE
    (INSERT and UPDATE are now non-rese
  • Non-reserved example DB (not a keyword) → ACTION (a real non-reserved keyword)

Verification

  • Regenerated table parses to a byte-exact match of the reporter's oxla-keywords.md.
  • Change set reconciles to the attached dFERRED` below).
  • Structure validated: metadata, [cols] spec, header, and closing intact; no trailing whitespace.

Review deadline:

Page previews

Checks

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

@kbatuigas
kbatuigas requested a review from a team as a code owner August 8, 2026 00:25
@netlify

netlify Bot commented Aug 8, 2026

Copy link
Copy Markdown

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit f410427
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a7677910ec6a50008f7497d
😎 Deploy Preview https://deploy-preview-667--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: c6d050fb-26af-4034-aa3e-5d505c9293e8

📥 Commits

Reviewing files that changed from the base of the PR and between 694eca1 and f410427.

📒 Files selected for processing (1)
  • modules/reference/pages/sql/sql-statements/keywords.adoc

📝 Walkthrough

Walkthrough

The SQL keyword documentation now uses SELECT, FROM, and WHERE as reserved-keyword examples. It uses ACTION as the non-reserved example. The table reclassifies numerous keywords across data types, statement terms, functions, procedural syntax, JSON, transactions, control flow, utility syntax, and XML-related syntax.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: michelerp

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change to SQL keyword classifications.
Description check ✅ Passed The description clearly explains the issue, changes, and verification, with an issue link and completed checks; review deadline and page previews are not provided.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2269-fix-documentation-sql-reserved-non-reserved-key

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

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.

1 participant