elasticsearch/docs/reference/ingest/processors
Pete Gillin 6ec7a3439d
Add a terminate ingest processor (#114157) (#114343)
This processor simply causes any remaining processors in the pipeline
to be skipped. It will normally be executed conditionally using the
`if` option. (If this pipeline is being called from another pipeline,
the calling pipeline is *not* terminated.)

For example, this:

```
POST /_ingest/pipeline/_simulate
{
  "pipeline":
  {
    "description": "Appends just 'before' to the steps field if the number field
 is present, or both 'before' and 'after' if not",
    "processors": [
      {
        "append": {
          "field": "steps",
          "value": "before"
        }
      },
      {
        "terminate": {
          "if": "ctx.error != null"
        }
      },
      {
        "append": {
          "field": "steps",
          "value": "after"
        }
      }
    ]
  },
  "docs": [
    {
      "_index": "index",
      "_id": "doc1",
      "_source": {
        "name": "okay",
        "steps": []
      }
    },
    {
      "_index": "index",
      "_id": "doc2",
      "_source": {
        "name": "bad",
        "error": "oh no",
        "steps": []
      }
    }
  ]
}
```

returns something like this:

```
{
  "docs": [
    {
      "doc": {
        "_index": "index",
        "_version": "-3",
        "_id": "doc1",
        "_source": {
          "name": "okay",
          "steps": [
            "before",
            "after"
          ]
        },
        "_ingest": {
          "timestamp": "2024-10-04T16:25:20.448881Z"
        }
      }
    },
    {
      "doc": {
        "_index": "index",
        "_version": "-3",
        "_id": "doc2",
        "_source": {
          "name": "bad",
          "error": "oh no",
          "steps": [
            "before"
          ]
        },
        "_ingest": {
          "timestamp": "2024-10-04T16:25:20.448932Z"
        }
      }
    }
  ]
}
```
2024-10-09 16:44:57 +01:00
..
append.asciidoc Configurable media_type for mustache template encoding on append processor (#76210) 2021-08-10 15:13:36 -05:00
attachment.asciidoc Deprecate 'remove_binary' default of false for ingest attachment processor (#90460) 2022-10-04 01:04:40 +10:30
bytes.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
circle.asciidoc Geo_grid ingest processor docs (#93507) 2023-02-06 16:17:00 +01:00
common-options.asciidoc [DOCS] Fix xref for conditionally running ingest processor (#82001) 2021-12-21 11:37:20 -05:00
community-id.asciidoc fix: support all allowed protocol numbers (#111528) 2024-08-26 08:37:40 +03:00
convert.asciidoc [DOCS] IP type for convert processor (#70599) 2021-03-22 11:36:50 -05:00
csv.asciidoc Fix ignore_missing docs for a couple of Ingest processors (#95244) 2023-04-13 16:34:40 -04:00
date-index-name.asciidoc [DOCS] Remove redirect pages (#88738) 2023-05-24 12:32:46 +01:00
date.asciidoc Add some information on locale database to the ES docs (#113587) 2024-09-30 09:28:13 +01:00
dissect.asciidoc [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 2023-11-27 10:56:48 +01:00
dot-expand.asciidoc Add an example of dot_expander's path option (#94291) 2023-03-06 09:26:40 -05:00
drop.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
enrich.asciidoc [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
fail.asciidoc [DOCS] Use HTML-unescaped Mustache variables in ingest pipelines (#71360) 2021-04-06 15:33:10 -04:00
fingerprint.asciidoc Ingest: IngestDocument requires non-null version (#87665) 2022-06-15 07:50:45 -05:00
foreach.asciidoc [DOCS] Fixes a link that breaks the docs build. (#88111) 2022-06-28 10:22:23 +02:00
geo-grid.asciidoc Geo_grid ingest processor docs (#93507) 2023-02-06 16:17:00 +01:00
geoip.asciidoc Ingest download databases docs (#111688) 2024-08-08 09:23:56 -05:00
grok.asciidoc Ingest: IngestDocument requires non-null version (#87665) 2022-06-15 07:50:45 -05:00
gsub.asciidoc [DOCS] Fix Gsub processor snippet (#61720) 2020-08-31 10:14:54 -04:00
html_strip.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
inference.asciidoc [DOCS] Adds DeBERTA v2 to the tokenizers list in API docs (#112752) (#114203) 2024-10-07 19:48:43 +11:00
join.asciidoc [DOCS] Fix field def for join processor (#61395) 2020-08-21 08:35:56 -04:00
json.asciidoc Making JsonProcessor stricter so that it does not silently drop data (#93179) 2023-01-24 18:43:35 -05:00
kv.asciidoc Add template snippets support for KV ingest processor (#73758) 2021-06-22 16:32:11 -05:00
lowercase.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
network-direction.asciidoc Ingest: IngestDocument requires non-null version (#87665) 2022-06-15 07:50:45 -05:00
pipeline.asciidoc Allow pipeline processor to ignore missing pipelines (#87354) 2022-06-07 07:02:18 -04:00
redact.asciidoc Tag redacted document in ingest pipeline (#113552) (#113750) 2024-10-04 06:26:23 +10:00
registered-domain.asciidoc Ingest: IngestDocument requires non-null version (#87665) 2022-06-15 07:50:45 -05:00
remove.asciidoc [Docs] Update remove processor with 'keep' option (#92836) 2023-01-11 12:52:35 -05:00
rename.asciidoc [elasticsearch][processors] - Added support for override flag in rename processor (#103565) 2024-01-11 16:00:02 +05:30
reroute.asciidoc Make reroute processor GA (#99531) 2023-09-20 13:22:36 +02:00
script.asciidoc Ingest: IngestDocument requires non-null version (#87665) 2022-06-15 07:50:45 -05:00
set-security-user.asciidoc Expose API Key metadata to SetSecurityUser ingest processor (#72137) 2021-04-29 14:47:36 +10:00
set.asciidoc Update documentation for Set Processor (#99191) 2023-09-07 14:47:07 -04:00
sort.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
split.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
terminate.asciidoc Add a terminate ingest processor (#114157) (#114343) 2024-10-09 16:44:57 +01:00
trim.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
uppercase.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
uri-parts.asciidoc [Ingest Processor] Add ignore_missing param to the uri_parts ingest processor. (#95068) 2023-04-13 15:11:19 +02:00
url-decode.asciidoc [DOCS] Fix case of ingest processor titles (#61024) 2020-08-12 11:28:00 -04:00
user-agent.asciidoc Update JSON parser and snippets (#77983) 2021-09-20 11:08:26 +01:00