PaginatedJsonQueryElasticsearch

Description:

A processor that allows the user to run a paginated query (with aggregations) written with the Elasticsearch JSON DSL. It will use the flowfile's content for the query unless the QUERY attribute is populated. Search After/Point in Time queries must include a valid "sort" field.

Additional Details...

Tags:

elasticsearch, elasticsearch5, elasticsearch6, elasticsearch7, elasticsearch8, query, scroll, page, read, 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 Definition Style	el-rest-query-definition-style	FULL_QUERY	FULL_QUERY BUILD_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: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Query Definition Style] Property has a value of "FULL_QUERY".
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: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Query Definition Style] Property has a value of "BUILD_QUERY".
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: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Query Definition Style] Property has a value of "BUILD_QUERY".
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: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Query Definition Style] Property has a value of "BUILD_QUERY".
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: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Query Definition Style] Property has a value of "BUILD_QUERY".
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: true (will be evaluated using flow file attributes and variable registry)* This Property is only considered if the [Query Definition Style] Property has a value of "BUILD_QUERY".
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: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Query Definition Style] Property has a value of "BUILD_QUERY".
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 PER_QUERY	Output a flowfile containing all hits or one flowfile for each individual hit or one flowfile containing all hits from all paged responses.
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	true 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.
Pagination Type	el-rest-pagination-type	SCROLL	SCROLL SEARCH_AFTER POINT_IN_TIME	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.
Pagination Keep Alive	el-rest-pagination-keep-alive	10 mins		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).

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. For SCROLL type queries, these parameters are only used in the initial (first page) query as the Elasticsearch Scroll API does not support the same query parameters for subsequent pages of data. 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
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.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

Resource	Description
MEMORY	Care should be taken on the size of each page because each response from Elasticsearch will be loaded into memory all at once and converted into the resulting flowfiles.