Skip to content

Commit

Permalink
[DOCS] Empty keys for ES|QL DISSECT
Browse files Browse the repository at this point in the history
  • Loading branch information
abdonpijpelink committed Nov 27, 2023
1 parent 7a54118 commit 8085fc2
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions docs/reference/esql/esql-process-data-with-dissect-grok.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,8 @@ clientip:keyword | @timestamp:keyword | status:keyword

include::../ingest/processors/dissect.asciidoc[tag=intro-example-explanation]

A <<esql-named-skip-key,named skip key>> can be used to match values, but
exclude the value from the output.
// TODO: Change back to original text when https://github.com/elastic/elasticsearch/pull/102580 is merged
An empty key (`%{}`) or <<esql-named-skip-key,named skip key>> can be used to
match values, but exclude the value from the output.

All matched values are output as keyword string data types. Use the
<<esql-type-conversion-functions>> to convert to another data type.
Expand Down Expand Up @@ -137,8 +136,6 @@ include::{esql-specs}/docs.csv-spec[tag=dissectRightPaddingModifier]
include::{esql-specs}/docs.csv-spec[tag=dissectRightPaddingModifier-result]
|===

////
// TODO: Re-enable when https://github.com/elastic/elasticsearch/pull/102580 is merged
include::../ingest/processors/dissect.asciidoc[tag=dissect-modifier-empty-right-padding]

For example:
Expand All @@ -150,7 +147,6 @@ include::{esql-specs}/docs.csv-spec[tag=dissectEmptyRightPaddingModifier]
|===
include::{esql-specs}/docs.csv-spec[tag=dissectEmptyRightPaddingModifier-result]
|===
////

[[esql-append-modifier]]
====== Append modifier (`+`)
Expand Down Expand Up @@ -180,11 +176,9 @@ include::{esql-specs}/docs.csv-spec[tag=dissectAppendWithOrderModifier-result]

[[esql-named-skip-key]]
====== Named skip key (`?`)
// include::../ingest/processors/dissect.asciidoc[tag=named-skip-key]
// TODO: Re-enable when https://github.com/elastic/elasticsearch/pull/102580 is merged

Dissect supports ignoring matches in the final result. This can be done with a
named skip key using the `{?name}` syntax:
include::../ingest/processors/dissect.asciidoc[tag=named-skip-key]
This can be done with a named skip key using the `{?name}` syntax. In the
following query, `ident` and `auth` are not added to the output table:

[source.merge.styled,esql]
----
Expand All @@ -199,7 +193,7 @@ include::{esql-specs}/docs.csv-spec[tag=dissectNamedSkipKey-result]
===== Limitations

// tag::dissect-limitations[]
The `DISSECT` command does not support reference keys and empty keys.
The `DISSECT` command does not support reference keys.
// end::dissect-limitations[]

[[esql-process-data-with-grok]]
Expand Down

0 comments on commit 8085fc2

Please sign in to comment.