SearchElasticsearch 2.3.0¶
BUNDLE¶
org.apache.nifi | nifi-elasticsearch-restapi-nar
DESCRIPTION¶
A processor that allows the user to repeatedly run a paginated query (with aggregations) written with the Elasticsearch JSON DSL. Search After/Point in Time queries must include a valid “sort” field. The processor will retrieve multiple pages of results until either no more results are available or the Pagination Keep Alive expiration is reached, after which the query will restart with the first page of results being retrieved.
INPUT REQUIREMENT¶
FORBIDDEN
Supports Sensitive Dynamic Properties¶
false
PROPERTIES¶
Property |
Description |
|---|---|
Max JSON Field String Length |
The maximum allowed length of a string value when parsing a JSON document or attribute. |
el-query-attribute |
If set, the executed query will be set on each result flowfile in the specified attribute. |
el-rest-client-service |
An Elasticsearch client service to use for running queries. |
el-rest-fetch-index |
The name of the index to use. |
el-rest-format-aggregations |
Format of Aggregation output. |
el-rest-format-hits |
Format of Hits output. |
el-rest-output-no-hits |
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. |
el-rest-pagination-keep-alive |
Pagination “keep_alive” period. Period Elasticsearch will keep the scroll/pit cursor alive in between requests (this is not the time expected for all pages to be returned, but the maximum allowed time for requests between page retrievals). |
el-rest-pagination-type |
Pagination method to use. Not all types are available for all Elasticsearch versions, check the Elasticsearch docs to confirm which are applicable and recommended for your service. |
el-rest-query |
A query in JSON syntax, not Lucene syntax. Ex: {“query”:{“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. |
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. |
el-rest-query-definition-style |
How the JSON Query will be defined for use by the processor. |
el-rest-split-up-aggregations |
Output a flowfile containing all aggregations or one flowfile for each individual aggregation. |
el-rest-split-up-hits |
Output a flowfile containing all hits or one flowfile for each individual hit or one flowfile containing all hits from all paged responses. |
el-rest-type |
The type of this document (used by Elasticsearch for indexing and searching). |
es-rest-query-aggs |
One or more query aggregations (or “aggs”), in JSON syntax. Ex: {“items”: {“terms”: {“field”: “product”, “size”: 10}}} |
es-rest-query-fields |
Fields of indexed documents to be retrieved, in JSON syntax. Ex: [“user.id”, “http.response.*”, {“field”: “@timestamp”, “format”: “epoch_millis”}] |
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}}}} |
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”}}] |
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. |
STATE MANAGEMENT¶
SCOPES |
DESCRIPTION |
|---|---|
LOCAL |
The pagination state (scrollId, searchAfter, pitId, hitCount, pageCount, pageExpirationTimestamp) is retained in between invocations of this processor until the Scroll/PiT has expired (when the current time is later than the last query execution plus the Pagination Keep Alive interval). |
RELATIONSHIPS¶
NAME |
DESCRIPTION |
|---|---|
aggregations |
Aggregations are routed to this relationship. |
hits |
Search hits are routed to this relationship. |
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 |
page.number |
The number of the page (request), starting from 1, in which the results were returned that 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. |