Skip to main content

struct function

Applies to: check marked yes Databricks SQL check marked yes Databricks Runtime

Creates a STRUCT with the specified field values.

Syntax​

struct(expr1 [[AS] alias1] ) [, ...] )

Arguments​

  • exprN: An expression of any type.
  • aliasN: An optional alias for the field.

Returns​

A struct with fieldN matching the type of exprN.

The field names are determined by the following rules:

  • If aliasN is specified, the field is named aliasN.
  • If exprN is a named reference, such as a column name, the field name is that name.
  • Otherwise, the fields are named colN, where N is the position of the field in the struct.

Examples​

SQL
> SELECT struct(c1, c2, c3) FROM VALUES(1, 2, 3) AS T(c1, c2, c3);
 {"c1":1,"c2":2,"c3":3}

> SELECT struct(1, 2 AS two, 3);
 {"col1":1,"two":2,"col3":3}
Last updated on