diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 142049a66..906616f82 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -536,70 +536,109 @@ * xref:reference:index.adoc[Reference] ** xref:reference:sql/index.adoc[Redpanda SQL Reference] +*** xref:reference:sql/sql-statements/keywords.adoc[] *** xref:reference:sql/sql-statements/index.adoc[Statements] -**** xref:reference:sql/sql-statements/keywords.adoc[] **** xref:reference:sql/sql-statements/alter-redpanda-catalog.adoc[] **** xref:reference:sql/sql-statements/alter-storage.adoc[] **** xref:reference:sql/sql-statements/alter-table.adoc[] +**** xref:reference:sql/sql-statements/copy-to.adoc[] **** xref:reference:sql/sql-statements/create-redpanda-catalog.adoc[] **** xref:reference:sql/sql-statements/create-storage.adoc[] **** xref:reference:sql/sql-statements/create-table.adoc[] +**** xref:reference:sql/sql-statements/describe.adoc[] **** xref:reference:sql/sql-statements/drop-redpanda-catalog.adoc[] **** xref:reference:sql/sql-statements/drop-storage.adoc[] **** xref:reference:sql/sql-statements/drop-table.adoc[] **** xref:reference:sql/sql-statements/select.adoc[] -**** xref:reference:sql/sql-statements/copy-to.adoc[] -**** xref:reference:sql/sql-statements/describe.adoc[] **** xref:reference:sql/sql-statements/set-show.adoc[] -**** xref:reference:sql/sql-statements/show-tables.adoc[] **** xref:reference:sql/sql-statements/show-execs.adoc[] **** xref:reference:sql/sql-statements/show-nodes.adoc[] +**** xref:reference:sql/sql-statements/show-tables.adoc[] *** xref:reference:sql/sql-clauses/index.adoc[Clauses] +**** xref:reference:sql/sql-clauses/set-operations/index.adoc[Set Operations] +***** xref:reference:sql/sql-clauses/set-operations/except.adoc[] +***** xref:reference:sql/sql-clauses/set-operations/intersect.adoc[] +***** xref:reference:sql/sql-clauses/set-operations/union.adoc[] **** xref:reference:sql/sql-clauses/from/index.adoc[FROM] ***** xref:reference:sql/sql-clauses/from/from.adoc[] ***** xref:reference:sql/sql-clauses/from/join.adoc[] ***** xref:reference:sql/sql-clauses/from/left-join.adoc[] ***** xref:reference:sql/sql-clauses/from/outer-join.adoc[] ***** xref:reference:sql/sql-clauses/from/right-join.adoc[] -**** xref:reference:sql/sql-clauses/where.adoc[] **** xref:reference:sql/sql-clauses/group-by.adoc[] **** xref:reference:sql/sql-clauses/having.adoc[] -**** xref:reference:sql/sql-clauses/order-by.adoc[] **** xref:reference:sql/sql-clauses/limit.adoc[] **** xref:reference:sql/sql-clauses/offset.adoc[] -**** xref:reference:sql/sql-clauses/set-operations/index.adoc[Set Operations] -***** xref:reference:sql/sql-clauses/set-operations/except.adoc[] -***** xref:reference:sql/sql-clauses/set-operations/intersect.adoc[] -***** xref:reference:sql/sql-clauses/set-operations/union.adoc[] -**** xref:reference:sql/sql-clauses/with.adoc[] +**** xref:reference:sql/sql-clauses/order-by.adoc[] **** xref:reference:sql/sql-clauses/over-window.adoc[] +**** xref:reference:sql/sql-clauses/where.adoc[] +**** xref:reference:sql/sql-clauses/with.adoc[] *** xref:reference:sql/sql-data-types/index.adoc[Data Types] -**** xref:reference:sql/sql-data-types/numeric-type/index.adoc[Numeric] -***** xref:reference:sql/sql-data-types/numeric-type/numeric.adoc[] -***** xref:reference:sql/sql-data-types/numeric-type/numeric-data-type-aliases.adoc[] -**** xref:reference:sql/sql-data-types/timestamp-without-time-zone.adoc[] -**** xref:reference:sql/sql-data-types/timestamp-with-time-zone.adoc[] +**** xref:reference:sql/sql-data-types/array.adoc[] +**** xref:reference:sql/sql-data-types/bool.adoc[] +**** xref:reference:sql/sql-data-types/bytea.adoc[] **** xref:reference:sql/sql-data-types/date.adoc[] -**** xref:reference:sql/sql-data-types/time-type/index.adoc[Time] -***** xref:reference:sql/sql-data-types/time-type/time.adoc[] -***** xref:reference:sql/sql-data-types/time-type/time-operators.adoc[] +**** xref:reference:sql/sql-data-types/geography.adoc[] +**** xref:reference:sql/sql-data-types/geometry.adoc[] **** 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/json.adoc[] -**** xref:reference:sql/sql-data-types/array.adoc[] +**** xref:reference:sql/sql-data-types/numeric-type/numeric.adoc[] +**** xref:reference:sql/sql-data-types/numeric-type/numeric-data-type-aliases.adoc[] **** xref:reference:sql/sql-data-types/row.adoc[] -**** xref:reference:sql/sql-data-types/geometry.adoc[] -**** xref:reference:sql/sql-data-types/geography.adoc[] +**** xref:reference:sql/sql-data-types/text.adoc[] +**** xref:reference:sql/sql-data-types/time-type/time.adoc[] +**** xref:reference:sql/sql-data-types/time-type/time-operators.adoc[] +**** xref:reference:sql/sql-data-types/timestamp-with-time-zone.adoc[] +**** xref:reference:sql/sql-data-types/timestamp-without-time-zone.adoc[] *** xref:reference:sql/sql-functions/index.adoc[Functions] +**** xref:reference:sql/sql-functions/aggregate-functions/index.adoc[Aggregate] +***** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/index.adoc[Ordered-Set] +****** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/mode.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/percentile-cont.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/percentile-disc.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/statistics/index.adoc[Statistics] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/corr.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/covar-pop.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/covar-samp.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-avgx.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-avgy.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-count.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-intercept.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-r2.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-slope.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-sxx.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-sxy.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-syy.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/stddev.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/stddev-pop.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/stddev-samp.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/var-pop.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/var-samp.adoc[] +****** xref:reference:sql/sql-functions/aggregate-functions/statistics/variance.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/avg.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/bool-and.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/bool-or.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/count.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/distinct.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/for-max.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/for-min.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/max.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/min.adoc[] +***** xref:reference:sql/sql-functions/aggregate-functions/sum.adoc[] **** xref:reference:sql/sql-functions/boolean-functions/index.adoc[Boolean] ***** xref:reference:sql/sql-functions/boolean-functions/if-function.adoc[] ***** xref:reference:sql/sql-functions/boolean-functions/is-distinct-from-operator.adoc[] ***** xref:reference:sql/sql-functions/boolean-functions/is-not-distinct-from-operator.adoc[] +**** xref:reference:sql/sql-functions/json-functions/index.adoc[JSON] +***** xref:reference:sql/sql-functions/json-functions/json-array-extract.adoc[] +***** xref:reference:sql/sql-functions/json-functions/json-array-length.adoc[] +***** xref:reference:sql/sql-functions/json-functions/json-extract-path.adoc[] +***** xref:reference:sql/sql-functions/json-functions/json-extract-path-text.adoc[] **** xref:reference:sql/sql-functions/math-functions/index.adoc[Math] ***** xref:reference:sql/sql-functions/math-functions/abs.adoc[] ***** xref:reference:sql/sql-functions/math-functions/cbrt.adoc[] ***** xref:reference:sql/sql-functions/math-functions/ceil.adoc[] +***** xref:reference:sql/sql-functions/math-functions/cosh.adoc[] ***** xref:reference:sql/sql-functions/math-functions/exp.adoc[] ***** xref:reference:sql/sql-functions/math-functions/floor.adoc[] ***** xref:reference:sql/sql-functions/math-functions/greatest.adoc[] @@ -612,10 +651,36 @@ ***** xref:reference:sql/sql-functions/math-functions/sign.adoc[] ***** xref:reference:sql/sql-functions/math-functions/sin.adoc[] ***** xref:reference:sql/sql-functions/math-functions/sinh.adoc[] -***** xref:reference:sql/sql-functions/math-functions/cosh.adoc[] ***** xref:reference:sql/sql-functions/math-functions/sqrt.adoc[] ***** xref:reference:sql/sql-functions/math-functions/to-char-from-number.adoc[] +**** xref:reference:sql/sql-functions/other-functions/index.adoc[Other] +***** xref:reference:sql/sql-functions/other-functions/coalesce.adoc[] +***** xref:reference:sql/sql-functions/other-functions/col-description.adoc[] +***** xref:reference:sql/sql-functions/other-functions/current-database.adoc[] +***** xref:reference:sql/sql-functions/other-functions/current-schema.adoc[] +***** xref:reference:sql/sql-functions/other-functions/generate-series.adoc[] +***** xref:reference:sql/sql-functions/other-functions/has-schema-privilege.adoc[] +***** xref:reference:sql/sql-functions/other-functions/nullif.adoc[] +***** xref:reference:sql/sql-functions/other-functions/obj-description.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-backend-pid.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-encoding-to-char.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-get-constraintdef.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-get-expr.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-get-indexdef.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-get-statisticsobjdef-columns.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-get-userbyid.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-relation-is-publishable.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-size-pretty.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-table-is-visible.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-table-size.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-total-relation-size.adoc[] +***** xref:reference:sql/sql-functions/other-functions/pg-typeof.adoc[] +***** xref:reference:sql/sql-functions/other-functions/shobj-description.adoc[] **** xref:reference:sql/sql-functions/string-functions/index.adoc[String] +***** xref:reference:sql/sql-functions/string-functions/regex/index.adoc[Regex] +****** xref:reference:sql/sql-functions/string-functions/regex/posix-regular-expressions.adoc[] +****** xref:reference:sql/sql-functions/string-functions/regex/regexp-match.adoc[] +****** xref:reference:sql/sql-functions/string-functions/regex/regexp-replace.adoc[] ***** xref:reference:sql/sql-functions/string-functions/concat.adoc[] ***** xref:reference:sql/sql-functions/string-functions/ends-with.adoc[] ***** xref:reference:sql/sql-functions/string-functions/length.adoc[] @@ -627,10 +692,6 @@ ***** xref:reference:sql/sql-functions/string-functions/substr.adoc[] ***** xref:reference:sql/sql-functions/string-functions/substring.adoc[] ***** xref:reference:sql/sql-functions/string-functions/upper.adoc[] -***** xref:reference:sql/sql-functions/string-functions/regex/index.adoc[Regex] -****** xref:reference:sql/sql-functions/string-functions/regex/regexp-replace.adoc[] -****** xref:reference:sql/sql-functions/string-functions/regex/regexp-match.adoc[] -****** xref:reference:sql/sql-functions/string-functions/regex/posix-regular-expressions.adoc[] **** xref:reference:sql/sql-functions/timestamp-functions/index.adoc[Timestamp] ***** xref:reference:sql/sql-functions/timestamp-functions/current-timestamp.adoc[] ***** xref:reference:sql/sql-functions/timestamp-functions/date-trunc.adoc[] @@ -645,45 +706,6 @@ ***** xref:reference:sql/sql-functions/timestamp-functions/unix-micros.adoc[] ***** xref:reference:sql/sql-functions/timestamp-functions/unix-millis.adoc[] ***** xref:reference:sql/sql-functions/timestamp-functions/unix-seconds.adoc[] -**** xref:reference:sql/sql-functions/json-functions/index.adoc[JSON] -***** xref:reference:sql/sql-functions/json-functions/json-array-extract.adoc[] -***** xref:reference:sql/sql-functions/json-functions/json-array-length.adoc[] -***** xref:reference:sql/sql-functions/json-functions/json-extract-path.adoc[] -***** xref:reference:sql/sql-functions/json-functions/json-extract-path-text.adoc[] -**** xref:reference:sql/sql-functions/aggregate-functions/index.adoc[Aggregate] -***** xref:reference:sql/sql-functions/aggregate-functions/avg.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/bool-and.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/bool-or.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/count.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/distinct.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/for-max.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/for-min.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/max.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/min.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/sum.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/index.adoc[Ordered-Set] -****** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/mode.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/percentile-cont.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/ordered-set-aggregate-functions/percentile-disc.adoc[] -***** xref:reference:sql/sql-functions/aggregate-functions/statistics/index.adoc[Statistics] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/corr.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/covar-pop.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/covar-samp.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-avgx.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-avgy.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-count.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-intercept.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-r2.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-slope.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-sxx.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-sxy.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/regr-syy.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/stddev.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/stddev-pop.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/stddev-samp.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/variance.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/var-pop.adoc[] -****** xref:reference:sql/sql-functions/aggregate-functions/statistics/var-samp.adoc[] **** xref:reference:sql/sql-functions/window-functions/index.adoc[Window] ***** xref:reference:sql/sql-functions/window-functions/avg.adoc[] ***** xref:reference:sql/sql-functions/window-functions/bool-and.adoc[] @@ -703,36 +725,9 @@ ***** xref:reference:sql/sql-functions/window-functions/rank.adoc[] ***** xref:reference:sql/sql-functions/window-functions/row-number.adoc[] ***** xref:reference:sql/sql-functions/window-functions/sum.adoc[] -**** xref:reference:sql/sql-functions/other-functions/index.adoc[Other] -***** xref:reference:sql/sql-functions/other-functions/coalesce.adoc[] -***** xref:reference:sql/sql-functions/other-functions/col-description.adoc[] -***** xref:reference:sql/sql-functions/other-functions/current-database.adoc[] -***** xref:reference:sql/sql-functions/other-functions/current-schema.adoc[] -***** xref:reference:sql/sql-functions/other-functions/has-schema-privilege.adoc[] -***** xref:reference:sql/sql-functions/other-functions/nullif.adoc[] -***** xref:reference:sql/sql-functions/other-functions/obj-description.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-backend-pid.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-encoding-to-char.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-get-constraintdef.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-get-expr.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-get-indexdef.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-get-statisticsobjdef-columns.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-get-userbyid.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-relation-is-publishable.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-size-pretty.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-table-is-visible.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-table-size.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-total-relation-size.adoc[] -***** xref:reference:sql/sql-functions/other-functions/pg-typeof.adoc[] -***** xref:reference:sql/sql-functions/other-functions/shobj-description.adoc[] -***** xref:reference:sql/sql-functions/other-functions/generate-series.adoc[] *** xref:reference:sql/sql-operators/index.adoc[Operators] **** xref:reference:sql/sql-operators/bitwise-shift-left.adoc[] **** xref:reference:sql/sql-operators/bitwise-shift-right.adoc[] -*** xref:reference:sql/schema.adoc[] -*** xref:reference:sql/comment-support.adoc[] -*** xref:reference:sql/transactions.adoc[] -*** xref:reference:sql/system-virtual-tables.adoc[] *** xref:reference:sql/system-catalogs/index.adoc[System Catalogs] **** xref:reference:sql/system-catalogs/catalogs/pg_attrdef.adoc[] **** xref:reference:sql/system-catalogs/catalogs/pg_attribute.adoc[] @@ -752,6 +747,10 @@ **** xref:reference:sql/system-catalogs/catalogs/pg_statio_user_tables.adoc[] **** xref:reference:sql/system-catalogs/catalogs/pg_type.adoc[] **** xref:reference:sql/system-catalogs/catalogs/pg_user.adoc[] +*** xref:reference:sql/comment-support.adoc[] +*** xref:reference:sql/schema.adoc[] +*** xref:reference:sql/system-virtual-tables.adoc[] +*** xref:reference:sql/transactions.adoc[] ** xref:reference:tiers/index.adoc[Cloud Tiers and Regions] *** xref:reference:tiers/serverless-regions.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..40c10424f --- /dev/null +++ b/modules/reference/pages/sql/sql-data-types/bytea.adoc @@ -0,0 +1,115 @@ += 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 Redpanda Streaming 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 + +The bytea data type supports a narrow set of operations. Operations not listed are not supported. + +[cols="<30%,<70%",options="header"] +|=== +| Operation | Example + +| Equality and inequality +| `payload = '\xDEADBEEF'::bytea`, `payload <> '\x00'::bytea` + +| 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. +|=== + +== 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 (topic schemas) +| Fields declared as `bytes`. + +| Avro (topic schemas) +| Fields declared as `bytes` or `fixed`. + +| 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[]. 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, ...)` diff --git a/modules/reference/pages/sql/sql-data-types/interval.adoc b/modules/reference/pages/sql/sql-data-types/interval.adoc index d8ed544c0..a33f4694f 100644 --- a/modules/reference/pages/sql/sql-data-types/interval.adoc +++ b/modules/reference/pages/sql/sql-data-types/interval.adoc @@ -3,6 +3,7 @@ :page-topic-type: reference The Interval data type represents periods between dates or times, which can be precisely calculated and expressed through various units. Those can be combined and include additional options for different interval calculations. + == Syntax The syntax for specifying an interval is as follows: diff --git a/modules/reference/pages/sql/sql-data-types/numeric-type/index.adoc b/modules/reference/pages/sql/sql-data-types/numeric-type/index.adoc deleted file mode 100644 index 1951c000e..000000000 --- a/modules/reference/pages/sql/sql-data-types/numeric-type/index.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Numeric Types -:description: Reference for numeric data types in Redpanda SQL. -:page-layout: index diff --git a/modules/reference/pages/sql/sql-data-types/time-type/index.adoc b/modules/reference/pages/sql/sql-data-types/time-type/index.adoc deleted file mode 100644 index a96a32040..000000000 --- a/modules/reference/pages/sql/sql-data-types/time-type/index.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Time Types -:description: Reference for time data types and operators in Redpanda SQL. -:page-layout: index