Delete a document from Elasticsearch 5.0 by document id. If the cluster has been configured for authorization and/or secure transport (SSL/TLS), and the X-Pack plugin is available, secure connections can be made.


elasticsearch, elasticsearch 5, delete, remove


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, whether a property supports the NiFi Expression Language, and whether a property is considered “sensitive”, meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the file has an entry for the property nifi.sensitive.props.key.


Default Value

Allowable Values


Cluster Name

elasticsearch Name of the ES cluster (for example, elasticsearch_brew). Defaults to 'elasticsearch'

Supports Expression Language: true

ElasticSearch Hosts

ElasticSearch Hosts, which should be comma separated and colon for hostname/port host1:port,host2:port,.... For example, testcluster:9300. This processor uses the Transport Client to connect to hosts. The default transport client port is 9300.

Supports Expression Language: true

SSL Context Service

Controller Service API:



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.
X-Pack Transport Location Specifies the path to the JAR(s) for the Elasticsearch X-Pack Transport feature. If the Elasticsearch cluster has been secured with the X-Pack plugin, then the X-Pack Transport JARs must also be available to this processor. Note: Do NOT place the X-Pack JARs into NiFi's lib/ directory, doing so will prevent the X-Pack Transport JARs from being loaded.

Supports Expression Language: true

Username Username to access the Elasticsearch cluster

Supports Expression Language: true

Password Password to access the Elasticsearch cluster

Sensitive Property: true

ElasticSearch Ping Timeout

5s The ping timeout used to determine when a node is unreachable. For example, 5s (5 seconds). If non-local recommended is 30s

Supports Expression Language: true

Sampler Interval

5s How often to sample / ping the nodes listed and connected. For example, 5s (5 seconds). If non-local recommended is 30s.

Supports Expression Language: true

Document Identifier

The identifier for the document to be deleted

Supports Expression Language: true


The name of the index to delete the document from

Supports Expression Language: true


The type of this document to be deleted

Supports Expression Language: true




retry A FlowFile is routed to this relationship if the document cannot be deleted because or retry able exception like timeout or node not available
success All FlowFile corresponding to the deleted document from Elasticsearch are routed to this relationship
failure All FlowFile corresponding to delete document that failed from Elasticsearch are routed to this relationship
not found A FlowFile is routed to this relationship if the specified document was not found in elasticsearch.

Reads Attributes:

None specified.

Writes Attributes:



es.error.message The message attribute in case of error
filename The filename attribute which is set to the document identifier
es.index The Elasticsearch index containing the document
es.type The Elasticsearch document type The filename attribute with rest status

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

See Also:

FetchElasticsearch5, PutElasticsearch5