Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)Index | | | The name of the index to use. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
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) |
Batch Size | 100 | | The preferred number of FlowFiles to send over in a single batch. Supports Expression Language: true (will be evaluated using variable registry only) |
Character Set | UTF-8 | | Specifies the character set of the document data. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Client Service | | Controller Service API: ElasticSearchClientService Implementation: ElasticSearchClientServiceImpl | An Elasticsearch client service to use for running queries. |
Log Error Responses | false | | If this is enabled, errors will be logged to the NiFi logs at the error log level. Otherwise, they will only be logged if debug logging is enabled on NiFi as a whole. The purpose of this option is to give the user the ability to debug failed operations without having to turn on debug logging. |
Output Error Documents | false | | If this configuration property is true, the response from Elasticsearch will be examined for failed documents and the FlowFile(s) associated with the failed document(s) will be sent to the "errors" relationship. |
Treat "Not Found" as Error | true | | If true, "not_found" Elasticsearch Document associated FlowFiles will be routed to the "success" relationship, otherwise to the "errors" relationship.
This Property is only considered if the <Output Error Documents> Property has a value of "true". |
Dynamic Properties:
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 _bulk request body. If FlowFiles are batched, only the first FlowFile in the batch is used to evaluate property values. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Relationships:
Name | Description |
---|
retry | All flowfiles that fail due to server/cluster availability go to this relationship. |
success | All flowfiles that succeed in being transferred into Elasticsearch go here. Documents received by the Elasticsearch _bulk API may still result in errors on the Elasticsearch side. The Elasticsearch response will need to be examined to determine whether any Document(s)/Record(s) resulted in errors. |
failure | All flowfiles that fail for reasons unrelated to server availability go to this relationship. |
errors | If a "Output Error Documents" is set, any FlowFile(s) corresponding to Elasticsearch document(s) that resulted in an "error" (within Elasticsearch) will be routed here. |
Reads Attributes:
None specified.Writes Attributes:
Name | Description |
---|
elasticsearch.put.error | The error message provided by Elasticsearch if there is an error indexing the document. |
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 | The Batch of FlowFiles will be stored in memory until the bulk operation is performed. |