/aggregate/unpivot

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/aggregate/unpivot

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

NameTypeDescription
table_namestringName 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.
column_namesarray of stringsList of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table.
variable_column_namestringSpecifies the variable/parameter column name. The default value is ''.
value_column_namestringSpecifies the value column name. The default value is ''.
pivoted_columnsarray of stringsList 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.
encodingstring

Specifies the encoding for returned records. The default value is binary.

Supported ValuesDescription
binaryIndicates that the returned records should be binary encoded.
jsonIndicates that the returned records should be json encoded.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
collection_name[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.
result_tableThe 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.
result_table_persist

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
expressionFilter expression to apply to the table prior to unpivot processing.
order_byComma-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 ''.
chunk_sizeIndicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
limitThe number of records to keep. The default value is ''.
ttlSets the TTL of the table specified in result_table.
view_idview this result table is part of. The default value is ''.
materialize_on_gpu

No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. The default value is false. The supported values are:

  • true
  • false
create_indexesComma-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.
result_table_force_replicated

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 GPUdb 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'aggregate_unpivot_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /aggregate/unpivot endpoint:

NameTypeDescription
table_namestringTypically shows the result-table name if provided in the request (Ignore otherwise).
response_schema_strstringAvro schema of output parameter binary_encoded_response or output parameter json_encoded_response.
binary_encoded_responsebytesAvro binary encoded response.
json_encoded_responsestringAvro JSON encoded response.
total_number_of_recordslongTotal/Filtered number of records.
has_more_recordsbooleanToo many records. Returned a partial set.
infomap of string to strings

Additional information. The default value is an empty map ( {} ).

Possible Parameters (keys)Parameter Description
qualified_result_table_nameThe fully qualified name of the table (i.e. including the schema) used to store the results.

Empty string in case of an error.