a!queryFilter() Function

Creates a value of type QueryFilter for use with defining filter options for expression-backed records or filtering a queryrecord() function call before any grouping or aggregation is computed.

Syntax

a!queryFilter( field, operator, value )

  • field (Text): The dot notation to the field that you want to apply the filter to.
  • operator (Text): The operator to apply to the filter. Valid values include =, <>, >, >=, <, <=, between, in, not in, is null, not null, starts with, not starts with, ends with, not ends with, includes, not includes.
  • value (Text): The value to compare to the given field using the given operator. Can be entered as an expression. Optional if the operator value is is null or not null.
  • applyWhen (Boolean): Determines whether the filter is applied on the query. When set to false, the filter is not evaluated. Default: true.

Returns

QueryFilter

Examples

1
2
3
4
5
	=a!queryFilter(
	  field: "status",
	  operator: "=",
	  value: "active"
	)

Notes

  • If the operator value is between, the value must be a list of only two elements with the lower bound as the first element and the upper bound as the second.

See Also

a!facetOption(): use the a!queryfilter() function to create a value for the filter parameter of this function.

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

queryfilter: this is the data type the a!queryfilter() function returns.

queryrecord(): Use the queryrecord() function to execute a user-defined query on a given record type and return the results.

FEEDBACK