Delete from an Elasticsearch index using a query. The query can be loaded from a flowfile body or from the Query parameter.
elastic, elasticsearch, elasticsearch5, elasticsearch6, elasticsearch7, elasticsearch8, delete, query
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.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Query | el-rest-query | A 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 Attribute | el-query-attribute | If 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) | ||
| Index | el-rest-fetch-index | The name of the index to use. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Type | el-rest-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) | ||
| Client Service | el-rest-client-service | Controller Service API: ElasticSearchClientService Implementation: ElasticSearchClientServiceImpl | An Elasticsearch client service to use for running queries. |
Supports Sensitive Dynamic Properties: No
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 query request body Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Name | Description |
|---|---|
| retry | All flowfiles that fail due to server/cluster availability go to this relationship. |
| success | If the "by query" operation succeeds, and a flowfile was read, it will be sent to this relationship. |
| failure | If the "by query" operation fails, and a flowfile was read, it will be sent to this relationship. |
| Name | Description |
|---|---|
| elasticsearch.delete.took | The amount of time that it took to complete the delete operation in ms. |
| elasticsearch.delete.error | The error message provided by Elasticsearch if there is an error running the delete. |