From c11aa01857ac48a46bac5a879b3c4de5d7eb0470 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Wed, 13 May 2026 21:49:40 -0700 Subject: [PATCH] Add bytea reference --- modules/ROOT/nav.adoc | 1 + .../pages/sql/sql-data-types/bytea.adoc | 134 ++++++++++++++++++ .../pages/sql/sql-data-types/index.adoc | 1 + 3 files changed, 136 insertions(+) create mode 100644 modules/reference/pages/sql/sql-data-types/bytea.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index f93d23547..715ad9b4f 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -586,6 +586,7 @@ **** xref:reference:sql/sql-data-types/interval.adoc[] **** xref:reference:sql/sql-data-types/bool.adoc[] **** xref:reference:sql/sql-data-types/text.adoc[] +**** xref:reference:sql/sql-data-types/bytea.adoc[] **** xref:reference:sql/sql-data-types/json.adoc[] **** xref:reference:sql/sql-data-types/array.adoc[] **** xref:reference:sql/sql-data-types/row.adoc[] diff --git a/modules/reference/pages/sql/sql-data-types/bytea.adoc b/modules/reference/pages/sql/sql-data-types/bytea.adoc new file mode 100644 index 000000000..58cf98116 --- /dev/null +++ b/modules/reference/pages/sql/sql-data-types/bytea.adoc @@ -0,0 +1,134 @@ += Bytea +: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 Kafka records. + +== Syntax + +[source,sql] +---- +variable_name BYTEA +---- + +== Examples + +Create a table with a bytea column and insert binary data using the hex literal form: + +[source,sql] +---- +CREATE TABLE binary_data ( + id INT, + payload BYTEA +); +INSERT INTO binary_data (id, payload) +VALUES (1, '\xDEADBEEF'), + (2, '\x00FF'); +---- + +== Literal formats + +You can write a bytea literal in either of two PostgreSQL-compatible forms: + +[cols="<20%,<25%,<55%",options="header"] +|=== +| Format | Example | Notes + +| Hex +| `'\xDEADBEEF'` +| `\x` prefix followed by an even number of hexadecimal digits. Case-insensitive. + +| Escape (octal) +| `'\336\255'` +| Each `\` is followed by exactly three octal digits in the range `0`-`7`. Use `\\` for a literal backslash. Other characters are taken literally. +|=== + +To cast a string literal to bytea explicitly, append `::bytea`: + +[source,sql] +---- +SELECT '\xDEADBEEF'::bytea; +---- + +== Output format + +When a bytea value is returned to a client over the text wire format, Redpanda SQL hex-encodes it with the `\x` prefix, regardless of which literal format was used as input: + +[source,sql] +---- +SELECT '\336\255'::bytea; +---- + +[source,sql] +---- ++---------+ +| bytea | ++---------+ +| \xdead | ++---------+ +---- + +Over the binary wire format, Redpanda SQL returns bytea values as raw bytes without transformation. + +== Supported operations + +[cols="<30%,<70%",options="header"] +|=== +| Operation | Example + +| Equality and inequality +| `payload = '\xDEADBEEF'::bytea`, `payload <> '\x00'::bytea` + +| Sorting +| `SELECT * FROM binary_data ORDER BY payload` + +| Distinct +| `SELECT DISTINCT payload FROM binary_data` + +| Group by +| `SELECT payload, COUNT(*) FROM binary_data GROUP BY payload` + +| Cast from a string literal +| `'\xDEADBEEF'::bytea` + +| `length(payload)` +| Returns the byte count as `INT`. Distinct from `length(text)`, which returns the codepoint count. + +| `octet_length(payload)` +| Returns the byte count as `INT`. Equivalent to `length()` on a bytea value. +|=== + +== Unsupported operations + +// TODO: SME — confirm whether any of these are planned for follow-up releases so the doc can phrase them as current limitations rather than implying permanence. + +The following operations are not supported on bytea values: + +* Ordering operators (`<`, `>`, `\<=`, `>=`) +* Aggregates such as `SUM`, `AVG`, `MAX`, `MIN` +* Pattern matching (`LIKE`, `ILIKE`) and regular expression operators +* Binary string functions such as `substring`, `position`, `overlay`, and `trim` +* Implicit or explicit casting between `text` and `bytea`. The only supported cast is from a string literal, using `'...'::bytea`. + +== Read bytea from external sources + +Redpanda SQL maps binary fields from external sources to bytea automatically: + +[cols="<25%,<75%",options="header"] +|=== +| Source | Maps to bytea + +| Iceberg +| Columns of type `BinaryType` or `FixedType`. + +| Protobuf (Kafka topic schemas) +| Fields declared as `bytes`. + +| Avro (Kafka topic schemas) +| Fields declared as `bytes` or `fixed`. + +| Kafka record metadata +| `redpanda.key`, `redpanda.headers[].value`, and the raw key and value bytes exposed through `redpanda_raw`. +|=== + +For more on querying a topic alongside its Iceberg-translated history, see xref:sql:query-data/query-iceberg-topics.adoc[Query Iceberg topics]. diff --git a/modules/reference/pages/sql/sql-data-types/index.adoc b/modules/reference/pages/sql/sql-data-types/index.adoc index 9d21e1fa6..caa066036 100644 --- a/modules/reference/pages/sql/sql-data-types/index.adoc +++ b/modules/reference/pages/sql/sql-data-types/index.adoc @@ -20,6 +20,7 @@ The following table summarizes the data types supported by Redpanda SQL: |xref:reference:sql/sql-data-types/interval.adoc[INTERVAL] |Encodes a span of time |`year-month (YYYY-MM); day-time (DD HH:MM:SS)` |xref:reference:sql/sql-data-types/bool.adoc[BOOL] |Boolean value |`True` or `False` |xref:reference:sql/sql-data-types/text.adoc[TEXT] |UTF8 encoded string with Unicode support |'`text`' +|xref:reference:sql/sql-data-types/bytea.adoc[BYTEA] |Arbitrary binary data (raw bytes) |`'\xDEADBEEF'` or `'\336\255'` |xref:reference:sql/sql-data-types/json.adoc[JSON] |A value in JSON standard format |`variable_name JSON` |xref:reference:sql/sql-data-types/array.adoc[ARRAY] |An array of a specific data type |`'{value1, value2, value3}'::data_type[]` |xref:reference:sql/sql-data-types/row.adoc[ROW] |A composite value containing fields of different types |`ROW(value1, value2, ...)`