Rotate the column values into rows values.For unpivot details and examples, see Unpivot.
For limitations, see
Unpivot Limitations.Unpivot is used to normalize tables that are built for cross tabular reporting
purposes. The unpivot operator rotates the column values for all the pivoted
columns. A variable column, value column and all columns from the source table
except the unpivot columns are projected into the result table. The variable
column and value columns in the result table indicate the pivoted column name
and values respectively.The response is returned as a dynamic schema. For details see:
dynamic schemas documentation.
Input Parameter Description
string
Name of the table on which the operation will be performed. Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules.
array of strings
List of column names or expressions. A wildcard ’*’ can be used to include all the non-pivoted columns from the source table.
string
Specifies the variable/parameter column name.The default value is ”.
string
Specifies the value column name.The default value is ”.
array of strings
List of one or more values typically the column names of the input table. All the columns in the source table must have the same data type.
string
Specifies the encoding for returned records.The default value is binary.
binary: Indicates that the returned records should be binary encoded.
json: Indicates that the returned records should be JSON-encoded.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name.The default value is false.The supported values are:
true
false
[DEPRECATED—please specify the containing schema as part of result_table and use /create/schema to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema is non-existent, it will be automatically created.
The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise.The default value is false.The supported values are:
true
false
Filter expression to apply to the table prior to unpivot processing.
Comma-separated list of the columns to be sorted by; e.g. ‘timestamp asc, x desc’. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name.The default value is ”.
Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result_table option.
Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result_table option.
The number of records to keep.The default value is ”.
Sets the TTL of the table specified in result_table.
View this result table is part of.The default value is ”.
Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option.The default value is false.The supported values are:
true
false
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘aggregate_unpivot_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /aggregate/unpivot endpoint:
Show data_str
string
Typically shows the result-table name if provided in the request (Ignore otherwise).
string
Avro schema of output parameter binary_encoded_response or output parameter json_encoded_response.
bytes
Avro binary encoded response.
string
Avro JSON encoded response.
long
Total/Filtered number of records.
boolean
Too many records. Returned a partial set.
map of string to strings
Additional information.The default value is an empty map ( {} ).
Show info
The fully qualified name of the table (i.e. including the schema) used to store the results.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.