a!queryColumn() Function

Creates a Column object for use inside a Selection object.

Syntax

a!queryColumn( field, alias, visible )

  • field (Text): The field of the data type you want to retrieve. The fields available depend on the source of the data and the data type of that source.
  • alias (Text): (Optional) The short name by which the result of the Column value can be referenced in other areas of the Query value. Values are case-sensitive.
  • visible (Boolean): (Optional) Determines whether the column should be visible to end users. If false, the data for the column will not be retrieved, but it can be used for sorting. Default value is true.

Returns

Selection

Notes

  • The field parameter is required.

  • Fields that are children of a multiple cannot be selected.

  • If no alias is given, the alias for the column will be inferred as the field value.

  • If the alias is not provided and the field name collides with another existing alias, the field name will be suffixed with an incremented digit appended to the end when returned in the result.

See Also

Column: The Column data type defines an individual column selection configuration to be applied when querying data.

Selection: The Selection data type defines a set of column selection configurations to be applied when querying data.

Query: The Query data type defines the grouping, aggregation, filtering, paging, and sorting configuration to be applied when querying data.

Open in Github Built: Thu, Feb 23, 2023 (02:59:22 PM)

On This Page

FEEDBACK