Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,7 @@
*** xref:sql:query-data/redpanda-catalogs.adoc[Redpanda Catalogs]
*** xref:sql:query-data/query-streaming-topics.adoc[Query Streaming Topics]
*** xref:sql:query-data/query-iceberg-topics.adoc[Query Iceberg Topics]
*** xref:sql:query-data/query-nested-fields.adoc[Query Topics with Nested Fields]
** xref:sql:manage/index.adoc[Manage Redpanda SQL]
** xref:sql:troubleshoot/index.adoc[Troubleshoot]
*** xref:sql:troubleshoot/degraded-state-handling.adoc[]
Expand Down
146 changes: 145 additions & 1 deletion modules/reference/pages/sql/sql-data-types/row.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: The ROW data type represents a composite value containing one or more fields of different types.
:page-topic-type: reference

The `ROW` data type represents a composite value (also known as a struct or record) containing one or more fields of different types.
The `ROW` data type represents a composite value (also known as a struct or record) containing one or more fields of different types. ROW values support field access, lexicographic comparison, NULL checks, conversion to text, and use in `GROUP BY`, `ORDER BY`, and `JOIN` clauses.

== Syntax

Expand Down Expand Up @@ -75,3 +75,147 @@ SELECT ROW();
()
(1 row)
----

== Access fields

=== Access by position

For anonymous ROW expressions, fields are accessed by the positional names `f1`, `f2`, and so on, in declaration order:

[source,sql]
----
SELECT (ROW(1, 'hello', 3.14)).f1, (ROW(1, 'hello', 3.14)).f2;
----

[source,sql]
----
f1 | f2
----+-------
1 | hello
(1 row)
----

The parentheses around the ROW expression are required when accessing a field.

=== Access by name

For composite columns with declared field names — for example, columns mapped from a topic with `struct_mapping_policy = 'COMPOUND'` (see xref:reference:sql/sql-statements/create-table.adoc[CREATE TABLE]) — access fields by their declared names:

[source,sql]
----
SELECT (record).customer_id, (record).order_total FROM orders;
----

=== Expand all fields with a wildcard

To project every field of a ROW value as a separate result column, use the `.*` form:

[source,sql]
----
SELECT (ROW(1, 'hello', 3.14)).*;
----

[source,sql]
----
f1 | f2 | f3
----+-------+------
1 | hello | 3.14
(1 row)
----

The wildcard form also works inside a `ROW(...)` constructor to copy fields from one composite into another.

== Compare ROW values

ROW values support the standard comparison operators `=`, `<>`, `<`, `\<=`, `>`, and `>=`. Comparison is *lexicographic*: fields are compared in order, left to right, and the first differing field determines the result.

[source,sql]
----
SELECT ROW(1, 'a') < ROW(1, 'b');
----

[source,sql]
----
?column?
----------
t
(1 row)
----

Both ROW values must have the same number of fields, and corresponding fields must have comparable types.

== Check for NULL

ROW values support `IS NULL` and `IS NOT NULL`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The behavior of IS NULL/IS NOT NULL is a bit different for structs than it is for "scalar" columns, there is a short description here https://redpandadata.atlassian.net/wiki/spaces/OXLA/pages/1481413789/Structures+-+implementation+overview#2.5.-IS-NULL-%2F-IS-NOT-NULL

I think it's worth noting it.


[source,sql]
----
SELECT ROW(1, 'a') IS NULL;
----

[source,sql]
----
?column?
----------
f
(1 row)
----

To check whether a specific field within a ROW is NULL, access the field directly and test that.

== Convert to text

Cast a ROW value to `text` to produce the standard PostgreSQL composite literal form:

[source,sql]
----
SELECT ROW(1, 'hello', 3.14)::text;
----

[source,sql]
----
row
-----------------
(1,"hello",3.14)
(1 row)
----

== Use ROW in queries

ROW values can be used in `GROUP BY`, `ORDER BY`, and `JOIN` clauses with lexicographic comparison semantics.

=== Group by a ROW field

[source,sql]
----
SELECT (customer).region, COUNT(*)
FROM orders
GROUP BY (customer).region;
----

=== Order by a whole ROW

[source,sql]
----
SELECT * FROM orders ORDER BY customer;
----

The rows are sorted lexicographically by the fields of the `customer` composite column, in their declared order.

=== Join on a multi-column key

Compare implicit tuples to match multi-column keys without spelling out each field in a `WHERE` clause:

[source,sql]
----
SELECT *
FROM table_a a
JOIN table_b b
ON (a.col1, a.col2) = (b.col1, b.col2);
----

// TODO: SME — confirm whether nested array-of-struct access (for example, `(arr_of_rows[1]).field_name`) works at GA, and whether wildcard expansion on an empty ROW (`(ROW()).*`) is supported. Both are tracked under OXLA-9444 and OXLA-9431 respectively and remain open as of 2026-05-13.

== See also

* xref:reference:sql/sql-statements/create-table.adoc[CREATE TABLE]: maps a Redpanda topic to a SQL table. Use `struct_mapping_policy = 'COMPOUND'` to surface nested topic fields as ROW columns.
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,10 @@ a|How to handle records that fail deserialization.
|`struct_mapping_policy`
|STRING
|No
a|How to map nested structures to SQL columns.
a|How to map nested structures from the topic schema to SQL columns.

* `JSON` (default): Stores nested data as JSON.
* `FLATTEN`: Expands nested fields into top-level columns.
* `COMPOUND`: Maps to ROW types.
* `VARIANT`: Stores as a variant type.
* `JSON` (default): Stores each nested structure as a JSON value. Required for recursive (cyclic) types.
* `COMPOUND`: Maps each nested structure to a SQL xref:reference:sql/sql-data-types/row.adoc[ROW] value with named fields, queryable using `(column).field_name` syntax. Cyclic types are not supported in `COMPOUND` mode — use `JSON` for recursive schemas.

|`output_schema_message_full_name`
|STRING
Expand Down
134 changes: 134 additions & 0 deletions modules/sql/pages/query-data/query-nested-fields.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
= Query topics with nested fields
:description: Map a topic with nested Protobuf or Avro fields to SQL ROW columns, then query those fields directly.
:page-topic-type: how-to
:personas: app_developer, data_engineer
:learning-objective-1: Map a topic with a nested schema as a SQL table using struct_mapping_policy = 'COMPOUND'
:learning-objective-2: Query nested fields using ROW field-access syntax
:learning-objective-3: Recognize and resolve cyclic-reference errors

When a glossterm:topic[]'s schema includes nested Protobuf or Avro message types, you can map those nested structures as SQL `ROW` columns instead of opaque JSON. This makes nested fields queryable by name, includable in projections, and usable in `WHERE`, `GROUP BY`, and `ORDER BY` clauses, without parsing JSON at query time.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

That may be a nitpick, but stating that we are mapping as SQL ROW columns is not entirely true.

In PostgreSQL, a ROW is an anonymous record, in which you cannot explicitly set the sub-field names (they contain some generic f1, f2, f<n>... names that you cannot change).

What we do in the COMPOUND mapping is we actually create a User-Defined type, and set the names of the fields according to the schema.

Not sure if that's something that we want to explicitly state here, or maybe the ROW meaning here is something other than PostgreSQL ROW.


After reading this page, you will be able to:

* [ ] {learning-objective-1}
* [ ] {learning-objective-2}
* [ ] {learning-objective-3}

== Prerequisites

Before you query a topic with nested fields:

* Enable Redpanda SQL on your Redpanda Bring Your Own Cloud (BYOC) cluster. See xref:sql:get-started/deploy-sql-cluster.adoc[Enable Redpanda SQL].
* Connect to Redpanda SQL with `psql` or another PostgreSQL client. See xref:sql:connect-to-sql/index.adoc[Connect to Redpanda SQL].
* The topic has a schema (Protobuf or Avro) registered in glossterm:schema-registry[Schema Registry]. The schema includes one or more nested message types.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Here, it is mentioned that Protobuf or Avro schema must be used, but it should work for JSON schemas as well.

* You have a Redpanda catalog connection. See xref:reference:sql/sql-statements/create-redpanda-catalog.adoc[CREATE REDPANDA CATALOG].

== Map the topic as a SQL table

Create the SQL table with `struct_mapping_policy = 'COMPOUND'` to surface each nested message as a SQL `ROW` column:

[source,sql]
----
CREATE TABLE default_redpanda_catalog=>orders WITH (
topic = 'orders',
schema_subject = 'orders-value',
struct_mapping_policy = 'COMPOUND'
);
----

Replace `orders` with your topic name and `orders-value` with the Schema Registry subject that holds the topic's value schema.

For a topic schema with this Protobuf definition:

[source,proto]
----
message Order {
string order_id = 1;
Customer customer = 2;
double amount = 3;
}

message Customer {
string customer_id = 1;
string name = 2;
string region = 3;
}
----

Redpanda SQL maps the table with three columns: `order_id` (text), `customer` (a `ROW` with fields `customer_id`, `name`, and `region`), and `amount` (double precision).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

ditto here:

a ROW with fields

We may also say something along the lines of:

a structure/UDT with fields


TIP: To map nested structures as JSON instead, use `struct_mapping_policy = 'JSON'`. `JSON` is the default, and it is the only option that supports recursive (cyclic) types. See <<handle-recursive-cyclic-schemas, Handle recursive (cyclic) schemas>>.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I believe JSON will not be the default. That's something that is being changed right now, and we want COMPUND to be the default.


== Query nested fields

Access a nested field by its declared name using the `(column).field` form. You must wrap the column in parentheses:

[source,sql]
----
SELECT order_id, (customer).name, (customer).region, amount
FROM default_redpanda_catalog=>orders
WHERE (customer).region = 'EMEA';
----

To project every field of a nested structure as separate result columns, use the wildcard `.*` form:

[source,sql]
----
SELECT order_id, (customer).*
FROM default_redpanda_catalog=>orders
LIMIT 10;
----

For schemas with multiple levels of nesting, chain the parenthesized field access. For example, if `Customer` itself contained a nested `address` message with a `zip_code` field, you would query the zip code as:

[source,sql]
----
SELECT ((customer).address).zip_code FROM default_redpanda_catalog=>orders;
----

For the full `ROW` reference, including comparison operators, NULL handling, and `::text` casting, see xref:reference:sql/sql-data-types/row.adoc[ROW].

[[handle-recursive-cyclic-schemas]]
== Handle recursive (cyclic) schemas

Topic schemas can include recursive structures, such as a `Comment` message that references itself or two messages that reference each other. Mapping such a schema with `COMPOUND` fails at table-creation time with the following error:

[source,text]
----
Cyclic reference at '<parent>.<field>' → '<type>'. Cyclic types are not supported in COMPOUND struct mapping policy; use struct_mapping_policy=JSON for recursive types.
----

The error message tells you the resolution: re-create the table with `struct_mapping_policy = 'JSON'`. In JSON mode, Redpanda SQL stores each nested structure as a JSON value:

[source,sql]
----
CREATE TABLE default_redpanda_catalog=>comments WITH (
topic = 'comments',
schema_subject = 'comments-value',
struct_mapping_policy = 'JSON'
);
----

Query JSON-mapped fields with standard JSON functions instead of ROW field access. See xref:reference:sql/sql-data-types/json.adoc[JSON].

== Choose between COMPOUND and JSON

[cols="<20%,<40%,<40%",options="header"]
|===
| Policy | Use when | Trade-offs

| `COMPOUND`
| The topic schema has nested structures that are not recursive, and you want to query nested fields directly by name.
| Typed access; usable in `WHERE`, `GROUP BY`, `ORDER BY`. Required if you also plan to run xref:sql:query-data/query-iceberg-topics.adoc[bridge queries] against an Iceberg catalog, so that nested fields align as typed `ROW` columns on both sides of the union.

| `JSON` (default)
| The topic schema is recursive, or you prefer flexible access through JSON functions.
| Recursive types supported; fields are untyped until extracted with JSON functions. Bridge queries that compare nested fields across the Kafka topic and the linked Iceberg table do not align cleanly, because Iceberg always exposes nested structures as `ROW` columns.
|===

== Next steps

* xref:sql:query-data/query-streaming-topics.adoc[Query streaming topics]: query a topic without Iceberg history.
* xref:sql:query-data/query-iceberg-topics.adoc[Query Iceberg topics]: query the Iceberg-translated history of a topic. Use `struct_mapping_policy = 'COMPOUND'` so nested fields align between the Redpanda topic and the linked Iceberg table.
* xref:reference:sql/sql-data-types/row.adoc[ROW]: full reference for the `ROW` data type, including comparisons, NULL semantics, and conversion to text.
* xref:reference:sql/sql-statements/create-table.adoc[CREATE TABLE]: complete option list for mapping a Redpanda topic to a SQL table.