Skip to content

SQL: bytea support#585

Open
kbatuigas wants to merge 5 commits into
rp-sqlfrom
DOC-2189-bytea-type-for-sql-engine
Open

SQL: bytea support#585
kbatuigas wants to merge 5 commits into
rp-sqlfrom
DOC-2189-bytea-type-for-sql-engine

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented May 14, 2026

Description

This pull request adds documentation for the new BYTEA data type in Redpanda SQL, which allows storage and querying of arbitrary binary data. The changes include a new reference page for BYTEA, updates to the SQL data types summary table, and navigation updates to include the new documentation.

Documentation for BYTEA data type:

  • Added a new reference page bytea.adoc describing the BYTEA data type, its syntax, usage examples, supported and unsupported operations, literal formats, and how it maps to binary fields from external sources such as Iceberg, Protobuf, Avro, and Kafka record metadata.

Documentation navigation and summary updates:

  • Updated the SQL data types summary table in index.adoc to include BYTEA, describing its purpose and example literal formats.
  • Added a navigation entry for the new bytea.adoc page in nav.adoc so it appears in the reference documentation menu.

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

Page previews

https://deploy-preview-585--rp-cloud.netlify.app/redpanda-cloud/reference/sql/sql-data-types/bytea/

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 14, 2026 04:50
@netlify
Copy link
Copy Markdown

netlify Bot commented May 14, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit a6c772d
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a0e0afe29943800084f25d4
😎 Deploy Preview https://deploy-preview-585--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 14, 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: 40d5bbaf-6467-4a63-a715-5ba755309f65

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-2189-bytea-type-for-sql-engine

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

@kbatuigas kbatuigas requested a review from Greketrotny May 14, 2026 18:05
Comment thread modules/reference/pages/sql/sql-data-types/bytea.adoc Outdated
Comment thread modules/reference/pages/sql/sql-data-types/bytea.adoc Outdated
Comment thread modules/reference/pages/sql/sql-data-types/bytea.adoc Outdated
Comment thread modules/reference/pages/sql/sql-data-types/bytea.adoc Outdated
Comment thread modules/reference/pages/sql/sql-data-types/bytea.adoc Outdated
@kbatuigas kbatuigas force-pushed the DOC-2189-bytea-type-for-sql-engine branch from 39a00c4 to b0aa26e Compare May 19, 2026 03:29
@kbatuigas kbatuigas requested a review from Greketrotny May 19, 2026 04:05
@micheleRP
Copy link
Copy Markdown
Contributor

@kbatuigas shouldn't we alphabetize the data types in nav.adoc, like:

  • Array
  • Bool
  • Bytea
  • Date

:description: The bytea data type stores arbitrary binary data such as raw key and value bytes from Redpanda topics or binary columns from Iceberg tables.
:page-topic-type: reference

The bytea data type stores arbitrary binary data as a sequence of bytes. Unlike `text`, bytea values are not UTF-8 validated and can contain any byte value. Redpanda SQL uses bytea to surface binary fields from external sources, including Iceberg tables, Protobuf and Avro topic schemas, and the raw key and value bytes of Redpanda Streaming records.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all data types: some are put in backticks and some are not (like here with bytea and text, but also throughout pages). We should be consistent.

Copy link
Copy Markdown
Contributor Author

@kbatuigas kbatuigas May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll cut a new branch from rp-sql to do some of these alphabetization/consistency fixes, plus add some content on the SQL index page per Joyce's comment in redpanda-data/docs-site#173 (comment)

@micheleRP
Copy link
Copy Markdown
Contributor

micheleRP commented May 19, 2026

Could you also fix the Syntax heading in this other file in this PR?

Comment thread modules/reference/pages/sql/sql-data-types/bytea.adoc Outdated
Comment thread modules/reference/pages/sql/sql-data-types/bytea.adoc Outdated
@kbatuigas kbatuigas requested a review from micheleRP May 20, 2026 19:42
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving but reminder to check the link and backticks noted here after other PRs merge!

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.

3 participants