Skip to main content

  • Returns all the unique values from a particular column (specified by column_name) of a particular table or view (specified by table_name). If column_name is a numeric column, the values will be in binary_encoded_response. Otherwise if column_name is a string column, the values will be in json_encoded_response. The results can be paged via offset and limit parameters.

    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

    If a result_table name is specified in the options, the results are stored in a new table with that name—no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table’s shard key is used as the column_name, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of column_name is an unrestricted-length string.

    ​
    Parameters

    • table_name: string

      Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.

    • column_name: string

      Name of the column or an expression containing one or more column names on which the unique function would be applied.

    • Optionaloffset: number

      A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

    • Optionallimit: number

      A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    ​
    Returns Promise<AggregateUniqueResponse>

    Promise<Types.AggregateUniqueResponse> - Promise resolving to the response

  • Returns all the unique values from a particular column (specified by column_name) of a particular table or view (specified by table_name). If column_name is a numeric column, the values will be in binary_encoded_response. Otherwise if column_name is a string column, the values will be in json_encoded_response. The results can be paged via offset and limit parameters.

    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

    If a result_table name is specified in the options, the results are stored in a new table with that name—no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table’s shard key is used as the column_name, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of column_name is an unrestricted-length string.

    ​
    Parameters

    ​
    Returns Promise<AggregateUniqueResponse>

    Promise<Types.AggregateUniqueResponse> - Promise resolving to the response