JsonQueryElasticsearch
Description
A processor that allows the user to run a query (with aggregations) written with the Elasticsearch JSON DSL. It does not automatically paginate queries for the user. If an incoming relationship is added to this processor, it will use the flowfile's content for the query. Care should be taken on the size of the query because the entire response from Elasticsearch will be loaded into memory all at once and converted into the resulting flowfiles.
Tags
elasticsearch, elasticsearch5, elasticsearch6, elasticsearch7, elasticsearch8, get, json, query, read
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Query Definition Style * | el-rest-query-definition-style | FULL_QUERY |
| How the JSON Query will be defined for use by the processor. |
| Query | el-rest-query | A query in JSON syntax, not Lucene syntax. Ex: {"query":{"match":{"somefield":"somevalue"}}}. If this parameter is not set, the query will be read from the flowfile content. If the query (property and flowfile content) is empty, a default empty JSON Object will be used, which will result in a "match_all" query in Elasticsearch. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Query Clause | el-rest-query-clause | A "query" clause in JSON syntax, not Lucene syntax. Ex: {"match":{"somefield":"somevalue"}}. If the query is empty, a default JSON Object will be used, which will result in a "match_all" query in Elasticsearch. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Size | es-rest-size | The maximum number of documents to retrieve in the query. If the query is paginated, this "size" applies to each page of the query, not the "size" of the entire result set. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Sort | es-rest-query-sort | Sort results by one or more fields, in JSON syntax. Ex: [{"price" : {"order" : "asc", "mode" : "avg"}}, {"post_date" : {"format": "strict_date_optional_time_nanos"}}] Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Aggregations | es-rest-query-aggs | One or more query aggregations (or "aggs"), in JSON syntax. Ex: {"items": {"terms": {"field": "product", "size": 10}}} Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Fields | es-rest-query-fields | Fields of indexed documents to be retrieved, in JSON syntax. Ex: ["user.id", "http.response.*", {"field": "@timestamp", "format": "epoch_millis"}] Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Script Fields | es-rest-query-script-fields | Fields to created using script evaluation at query runtime, in JSON syntax. Ex: {"test1": {"script": {"lang": "painless", "source": "doc['price'].value * 2"}}, "test2": {"script": {"lang": "painless", "source": "doc['price'].value * params.factor", "params": {"factor": 2.0}}}} Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Query Attribute | el-query-attribute | If set, the executed query will be set on each result flowfile in the specified attribute. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Index * | el-rest-fetch-index | The name of the index to use. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Type | el-rest-type | The type of this document (used by Elasticsearch for indexing and searching). Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Max JSON Field String Length * | Max JSON Field String Length | 20 MB | The maximum allowed length of a string value when parsing a JSON document or attribute. | |
| Client Service * | el-rest-client-service | Controller Service: ElasticSearchClientService Implementations: ElasticSearchClientServiceImpl | An Elasticsearch client service to use for running queries. | |
| Search Results Split * | el-rest-split-up-hits | PER_RESPONSE |
| Output a flowfile containing all hits or one flowfile for each individual hit. |
| Search Results Format * | el-rest-format-hits | FULL |
| Format of Hits output. |
| Aggregation Results Split * | el-rest-split-up-aggregations | PER_RESPONSE |
| Output a flowfile containing all aggregations or one flowfile for each individual aggregation. |
| Aggregation Results Format * | el-rest-format-aggregations | FULL |
| Format of Aggregation output. |
| Output No Hits * | el-rest-output-no-hits | false |
| Output a "hits" flowfile even if no hits found for query. If true, an empty "hits" flowfile will be output even if "aggregations" are output. |
Dynamic Properties
| Name | Value | Description |
|---|---|---|
| The name of a URL query parameter to add | The value of the URL query parameter | Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing. These parameters will override any matching parameters in the query request body Supports Expression Language: Yes, evaluated using FlowFile Attributes and Environment variables. |
Relationships
| Name | Description |
|---|---|
| aggregations | Aggregations are routed to this relationship. |
| failure | All flowfiles that fail for reasons unrelated to server availability go to this relationship. |
| hits | Search hits are routed to this relationship. |
| original | All original flowfiles that don't cause an error to occur go to this relationship. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| aggregation.name | The name of the aggregation whose results are in the output flowfile |
| aggregation.number | The number of the aggregation whose results are in the output flowfile |
| elasticsearch.query.error | The error message provided by Elasticsearch if there is an error querying the index. |
| hit.count | The number of hits that are in the output flowfile |
| mime.type | application/json |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component allows an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.