FilterParam uses ConstantsTrait

Table of Contents

Constants

AGG  : string = 'agg'

The aggregator name of an aggregate facet (`avg`, `sum`, `min`, `max`, `count`).

ALL  : string = 'all'

The 'all' parameter or value.

ALT  : string = 'alt'

Alter the attribute to filter.

AT  : string = 'at'

Defines the specific index in an array key to filter.

EXP  : string = 'exp'

The exponent attribute to filter a key with the POW(base,exp) method.

FIELD  : string = 'field'

The related field aggregated by an aggregate facet.

FORMAT  : string = 'format'

The format attribute.

KEY  : string = 'key'

The key of the attribute to filter.

LENGTH  : string = 'length'

The length attribute.

MATCH  : string = 'match'

The match attribute.

MAX  : string = 'max'

The upper bound of a `between` range filter.

METHOD  : string = 'method'

The method attribute.

MIN  : string = 'min'

The lower bound of a `between` range filter.

OP  : string = 'op'

The operator of the condition.

POS  : string = 'pos'

The position attribute.

QUANT  : string = 'quant'

The element-axis quantifier of an array filter: how many elements must satisfy the condition. Values: `any` (default) / `all` / `none` / an integer `n` (= at least `n`). Works on scalar arrays (array comparison operator, e.g. `doc.scores ALL >= @v`) and on object arrays (question-mark operator, e.g. `doc.reviews[? AT LEAST (3) FILTER CURRENT.rating >= @v]`).

SCOPE  : string = 'scope'

The scope of the attribute.

START  : string = 'start'

The start attribute.

TYPE  : string = 'type'

The type of the attribute to filter.

TZ  : string = 'tz'

The timezone value to set a date condition.

UNIT  : string = 'unit'

The unit of the attribute to filter.

VAL  : string = 'val'

The value to evaluates to filter an attribute.