Skip to content

SQL: Expand virtual tables reference, add SHOW/DESCRIBE for new objects#590

Open
kbatuigas wants to merge 3 commits into
rp-sqlfrom
DOC-2134-document-feature-add-system-iceberg_tables-virtua
Open

SQL: Expand virtual tables reference, add SHOW/DESCRIBE for new objects#590
kbatuigas wants to merge 3 commits into
rp-sqlfrom
DOC-2134-document-feature-add-system-iceberg_tables-virtua

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented May 19, 2026

Description

This pull request significantly expands and clarifies the Redpanda SQL documentation around catalogs, Iceberg integration, and system metadata access. The updates introduce new SQL statements for listing and describing catalogs, provide detailed documentation for the information_schema and system virtual tables, and improve clarity around privileges and filtering. The most important changes are grouped below:

New SQL Statements and Catalog Management:

  • Added documentation for the SHOW CATALOGS, SHOW REDPANDA CATALOGS, SHOW KAFKA CATALOGS, and SHOW ICEBERG CATALOGS statements, including syntax, filtering behavior, and privilege requirements. (modules/reference/pages/sql/sql-statements/show-catalogs.adoc, modules/ROOT/nav.adoc) [1] [2]
  • Expanded ALTER REDPANDA CATALOG to cover linking and unlinking with Iceberg catalogs, including new syntax and detailed examples. (modules/reference/pages/sql/sql-statements/alter-redpanda-catalog.adoc)
  • Enhanced DESCRIBE statement documentation to support DESCRIBE ICEBERG CATALOG, clarifying output and usage. (modules/reference/pages/sql/sql-statements/describe.adoc) [1] [2]

Tables and Metadata Visibility:

  • Updated SHOW TABLES documentation to distinguish between Redpanda and Iceberg tables, introduce new variants (SHOW REDPANDA TABLES, SHOW ICEBERG TABLES), and explain filtering by catalog and schema. (modules/reference/pages/sql/sql-statements/show-tables.adoc) [1] [2] [3]
  • Added a new page documenting the information_schema namespace, including the role_external_relation_grants view and its columns, visibility rules, and usage examples. (modules/reference/pages/sql/information-schema.adoc, modules/ROOT/nav.adoc) [1] [2]

System Virtual Tables Enhancements:

  • Greatly expanded documentation for system virtual tables, including new tables for catalogs, Iceberg catalogs, Iceberg tables, Redpanda connections, and topic mappings. Each table now has a detailed schema, description, and example queries. Privilege filtering is clarified for each table. (modules/reference/pages/sql/system-virtual-tables.adoc)

These changes provide users with clearer guidance and more powerful tools for managing and querying Redpanda and Iceberg catalogs, as well as understanding metadata and permissions across the system.

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)

@kbatuigas kbatuigas requested a review from a team as a code owner May 19, 2026 03:32
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 19, 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: 63a92659-1ee5-44eb-a2e1-0ef3ba2a86c8

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-2134-document-feature-add-system-iceberg_tables-virtua

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

@netlify
Copy link
Copy Markdown

netlify Bot commented May 19, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 32b19b4
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a0befb1b751ce0008e3df93
😎 Deploy Preview https://deploy-preview-590--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.

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