DeleteByQueryElasticsearch

Description:

Delete from an ElasticSearch index using a query. The query can be loaded from a flowfile body or from the Query parameter.

Additional Details...

Tags:

elastic, elasticsearch, delete, query

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.

Relationships:

NameDescription
successIf the delete by query succeeds, and a flowfile was read, it will be sent to this relationship.
failureIf the delete by query fails, and a flowfile was read, it will be sent to this relationship.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
elasticsearch.delete.tookThe amount of time that it took to complete the delete operation in ms.
elasticsearch.delete.errorThe error message provided by ElasticSearch if there is an error running the delete.

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.