Filter Stage will generate the engine specific filters based on the configuration provided, specifically with the list of DynamicFilter in the aggs configuration parameter, and store them in the intermediate under the stage name.
Additionally, this stage can also generate the filters from the selected aggregations, which will look in the key aggs in the intermediate dictionary in the process function, the generated filters will be stored in the intermediate under the name provided in filters_name
| Property | Description | Default | Type | Required |
|---|---|---|---|---|
| filters | Filters to be applied within this stage | - | array of DynamicFilter | Yes (minItems: 1) |
| type | Stage class name | - | string | Yes (but only while working with the JSON Format) |
| enable | Enable stage for execution | true | boolean | No |
| name | Name for this specific stage. Used in the intermediate and final parameters | "filters" | string | No |
| save_to_intermediate | If true, the result of the stage will be stored in the intermediate instead of the final section. This makes the response of the stage unavailable for the final result | false | boolean | No |
| expand_result | Indicates if the result of this stage should be expanded into the final data dictionary instead of being appended as usual | false | boolean | No |
| ui_only | Section specific for UI configuration. This configuration will be retrieved when necessary and should affect the process of the stage | object | No | |
| halt_on_exception | Indicates if the pipeline should be interrupted in case of an exception | false | boolean | No |
| engine_name | Name of the engine to use for this query. If none is provided, the default engine will be used | string | No | |
| add_user_filter | If enabled, the stage will add a filter using the credentials in the request, using the user_value and user_filter_field | false | boolean | No |
| user_value | Field in the request's credentials to be used as the filter value | - | string | No |
| user_filter_field | Field in which the user_value must appear for the filter | string | No | |
| filter_keys | List of keys where filters are stored for compilation into a single filter entry | [] | array of strings | No |
Overview
Content Tools