Description:

Queries Elasticsearch using the specified connection properties. Note that the full body of each page of documents will be read into memory before being written to Flow Files for transfer. Also note that the Elasticsearch max_result_window index setting is the upper bound on the number of records that can be retrieved using this query. To retrieve more records, use the ScrollElasticsearchHttp processor.

Tags:

elasticsearch, query, read, get, http

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 Expression Language Guide.

Name Default Value Allowable Values Description
Elasticsearch URL Elasticsearch URL which will be connected to, including scheme (http, e.g.), host, and port. The default port for the REST API is 9200.
Supports Expression Language: true
SSL Context Service Controller Service API:
SSLContextService
Implementation:
StandardSSLContextService
The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.
Username Username to access the Elasticsearch cluster
Supports Expression Language: true
Password Password to access the Elasticsearch cluster
Sensitive Property: true
Supports Expression Language: true
Connection Timeout 5 secs Max wait time for the connection to the Elasticsearch REST API.
Supports Expression Language: true
Response Timeout 15 secs Max wait time for a response from the Elasticsearch REST API.
Supports Expression Language: true
Query The Lucene-style query to run against ElasticSearch (e.g., genre:blues AND -artist:muddy)
Supports Expression Language: true
Page Size 20 Determines how many documents to return per page during scrolling.
Supports Expression Language: true
Index 20 The name of the index to read from. If the property is set to _all, the query will match across all indexes.
Supports Expression Language: true
Type The (optional) type of this query, used by Elasticsearch for indexing and searching. If the property is empty, the the query will match across all types.
Supports Expression Language: true
Fields 20 A comma-separated list of fields to retrieve from the document. If the Fields property is left blank, then the entire document's source will be retrieved.
Supports Expression Language: true
Sort A sort parameter (e.g., timestamp:asc). If the Sort property is left blank, then the results will be retrieved in document order.
Supports Expression Language: true
Limit If set, limits the number of results that will be returned.
Supports Expression Language: true
Target Flow file content *Flow file content *Flow file attributes Indicates where the results should be placed. In the case of 'Flow file content', the JSON response will be written as the content of the flow file. In the case of 'Flow file attributes', the original flow file (if applicable) will be cloned for each result, and all return fields will be placed in a flow file attribute of the same name, but prefixed by 'es.result.'

Relationships:

Name Description
retry A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed. Note that if the processor has no incoming connections, flow files may still be sent to this relationship based on the processor properties and the results of the fetch operation.
failure All FlowFiles that cannot be read from Elasticsearch are routed to this relationship. Note that only incoming flow files will be routed to failure.
success All FlowFiles that are read from Elasticsearch are routed to this relationship.

Reads Attributes:

None specified.

Writes Attributes:

Name Description
filename The filename attribute is set to the document identifier
es.id The Elasticsearch document identifier
es.index The Elasticsearch index containing the document
es.type The Elasticsearch document type
es.result.* If Target is 'Flow file attributes', the JSON attributes of each result will be placed into corresponding attributes with this prefix.

State management:

This component does not store state.

Restricted:

This component is not restricted.