blob: 4f2a39f642b067e5c8f054d61a202c7e492a7cb0 [file] [log] [blame] [view]
<!---
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Special Functions
## Expansion Functions
- [unnest](#unnest)
- [unnest(struct)](#unnest-struct)
### `unnest`
Expands an array or map into rows.
#### Arguments
- **array**: Array expression to unnest.
Can be a constant, column, or function, and any combination of array operators.
#### Examples
```sql
> select unnest(make_array(1, 2, 3, 4, 5)) as unnested;
+----------+
| unnested |
+----------+
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
+----------+
```
```sql
> select unnest(range(0, 10)) as unnested_range;
+----------------+
| unnested_range |
+----------------+
| 0 |
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 6 |
| 7 |
| 8 |
| 9 |
+----------------+
```
### `unnest (struct)`
Expand a struct fields into individual columns.
Each field of the struct will be prefixed with `__unnest_placeholder` and could be accessed via `"__unnest_placeholder(<struct>).<field>"`.
#### Arguments
- **struct**: Object expression to unnest.
Can be a constant, column, or function, and any combination of object operators.
#### Examples
```sql
> create table foo as values ({a: 5, b: 'a string'}), ({a:6, b: 'another string'});
> create view foov as select column1 as struct_column from foo;
> select * from foov;
+---------------------------+
| struct_column |
+---------------------------+
| {a: 5, b: a string} |
| {a: 6, b: another string} |
+---------------------------+
> select unnest(struct_column) from foov;
+--------------------------------------------+--------------------------------------------+
| __unnest_placeholder(foov.struct_column).a | __unnest_placeholder(foov.struct_column).b |
+--------------------------------------------+--------------------------------------------+
| 5 | a string |
| 6 | another string |
+--------------------------------------------+--------------------------------------------+
```