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.

Additional Details...

Tags:

elasticsearch, elasticsearch 5, 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.

NameDefault ValueAllowable ValuesDescription
QueryA 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 AttributeIf 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)
IndexThe name of the index to use.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
TypeThe 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 ServiceController Service API:
ElasticSearchClientService
Implementation: ElasticSearchClientServiceImpl
An ElasticSearch client service to use for running queries.
Split up search resultssplitUp-no
  • No Don't split up results.
  • Yes Split up results.
Split up search results into one flowfile per result.
Split up aggregation resultssplitUp-no
  • No Don't split up results.
  • Yes Split up results.
Split up aggregation results into one flowfile per result.

Relationships:

NameDescription
aggregationsAggregations are routed to this relationship.
failureAll FlowFiles that cannot be read from Elasticsearch are routed to this relationship
originalAll original flowfiles that don't cause an error to occur go to this relationship. This applies even if you select the "split up hits" option to send individual hits to the "hits" relationship.
hitsSearch hits are routed to this relationship.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
mime.typeapplication/json
aggregation.nameThe name of the aggregation whose results are in the output flowfile

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.