Skip to content

SQL: Query topics#574

Open
kbatuigas wants to merge 9 commits into
rp-sqlfrom
DOC-1990-document-feature-query-redpanda-topics
Open

SQL: Query topics#574
kbatuigas wants to merge 9 commits into
rp-sqlfrom
DOC-1990-document-feature-query-redpanda-topics

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented May 4, 2026

Description

This pull request updates and expands the Redpanda SQL documentation to clarify table mapping, schema requirements, and streaming topic queries. It refines the CREATE TABLE reference, introduces new how-to guides for querying topics, and streamlines catalog documentation.

Documentation improvements for querying and mapping topics:

  • Added a new "Query streaming topics" how-to guide (query-streaming-topics.adoc) that walks users through mapping a Redpanda topic to a SQL table and running analytical queries directly on live data. This guide covers prerequisites, table creation, querying, and links to further resources.
  • Introduced a new index page for querying data (query-data/index.adoc) to provide an entry point for users learning to query Redpanda topics with SQL.

Enhancements and clarifications in the SQL reference:

  • Updated the CREATE TABLE documentation to clarify that schema_subject is required and that Redpanda SQL needs a schema to query a topic. Improved the explanation of struct_mapping_policy, especially regarding handling of nested and recursive types, and added documentation for the confluent_wire_protocol option. [1] [2]
  • Improved and updated SQL usage examples to demonstrate required options and multi-message Protobuf schema usage in table creation.

Catalog documentation simplification:

  • Replaced the detailed "Redpanda Catalogs" reference page with a stub, likely to be reworked or replaced by more focused documentation elsewhere.

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline: 21 May

Page previews

Checks

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

@netlify
Copy link
Copy Markdown

netlify Bot commented May 4, 2026

Deploy Preview for rp-cloud ready!

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

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
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1f78cdfd-4a3a-4e79-9a07-f85f18903758

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-1990-document-feature-query-redpanda-topics

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

@kbatuigas kbatuigas force-pushed the DOC-1990-document-feature-query-redpanda-topics branch 2 times, most recently from 4d7b551 to 20ad041 Compare May 11, 2026 20:00
@kbatuigas kbatuigas force-pushed the DOC-1990-document-feature-query-redpanda-topics branch from 20ad041 to ddefdad Compare May 14, 2026 02:01
kbatuigas and others added 7 commits May 18, 2026 20:28
Renames modules/sql/pages/query/ to modules/sql/pages/query-data/ and
renames the streaming-topic how-to from query-redpanda-topics.adoc to
query-streaming-topics.adoc to match the SQL GA IA. Retitles the page
"Query streaming topics" and reframes the description and learning
objectives around live streaming data; bridge-query and Iceberg content
stays out of this page (DOC-2006 owns the Iceberg-topics how-to).

Adds a pointer to the Iceberg topics how-to under the intro and lists
it under Next steps. Updates the enable-prereq xref to point to the
Enable Redpanda SQL page. Drops the CREATE REDPANDA CATALOG link from
Next steps to align with the v1 framing that users do not typically
create their own Redpanda catalog. Reframes the Query data index page
description for v1 Iceberg scope (live and historical data in Redpanda
topics; no external Iceberg lakehouse).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
# Conflicts:
#	modules/sql/pages/query-data/redpanda-catalogs.adoc
@kbatuigas kbatuigas force-pushed the DOC-1990-document-feature-query-redpanda-topics branch from 75ae890 to 48ead8c Compare May 19, 2026 03:30
@kbatuigas kbatuigas marked this pull request as ready for review May 19, 2026 23:39
@kbatuigas kbatuigas requested a review from a team as a code owner May 19, 2026 23:39
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