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.
Additional Details...
Tags:
elasticsearch, elasticsearch5, elasticsearch6, elasticsearch7, elasticsearch8, query, read, get, json
Properties:
In the list below, the names of required properties appear in bold. Any other properties (not in bold) 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 | 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.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Query Attribute | el-query-attribute | | | If set, the executed query will be set on each result flowfile in the specified attribute.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Index | el-rest-fetch-index | | | The name of the index to use.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Type | el-rest-type | | | The type of this document (used by Elasticsearch for indexing and searching).
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Client Service | el-rest-client-service | | Controller Service API:
ElasticSearchClientService
Implementation: ElasticSearchClientServiceImpl | An Elasticsearch client service to use for running queries. |
| Search Results Split | el-rest-split-up-hits | PER_RESPONSE | - PER_HIT
 - PER_RESPONSE
| Output a flowfile containing all hits or one flowfile for each individual hit. |
| Search Results Format | el-rest-format-hits | FULL | - FULL
- SOURCE_ONLY
- METADATA_ONLY
| Format of Hits output. |
| Aggregation Results Split | el-rest-split-up-aggregations | PER_RESPONSE | - PER_HIT
- PER_RESPONSE
| Output a flowfile containing all aggregations or one flowfile for each individual aggregation. |
| Aggregation Results Format | el-rest-format-aggregations | FULL | - FULL
- BUCKETS_ONLY
- METADATA_ONLY
| 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:
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| 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: true (will be evaluated using flow file attributes and variable registry) |
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. |
| original | All original flowfiles that don't cause an error to occur go to this relationship. |
| hits | Search hits are routed to this relationship. |
Reads Attributes:
None specified.Writes Attributes:
| Name | Description |
|---|
| mime.type | application/json |
| 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 |
| hit.count | The number of hits that are in the output flowfile |
| elasticsearch.query.error | The error message provided by Elasticsearch if there is an error querying the index. |
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:
None specified.