From ee5d0ba64ccf49526204eeb5e7d0f060a80d76e7 Mon Sep 17 00:00:00 2001 From: Devin Gibson Date: Fri, 7 Jun 2024 15:01:26 -0400 Subject: [PATCH] docs: Add instructions for using clp-s' array structurization feature. (#429) Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> --- docs/src/user-guide/core-clp-s.md | 3 ++- docs/src/user-guide/reference-json-search-syntax.md | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/src/user-guide/core-clp-s.md b/docs/src/user-guide/core-clp-s.md index b48983f0c..8528f98d2 100644 --- a/docs/src/user-guide/core-clp-s.md +++ b/docs/src/user-guide/core-clp-s.md @@ -14,7 +14,8 @@ Usage: * `archives-dir` is the directory that archives should be written to. * `input-path` is any new-line-delimited JSON (ndjson) log file or directory containing such files. * `options` allow you to specify things like which field should be considered as the log event's - timestamp (`--timestamp-key `). + timestamp (`--timestamp-key `), or whether to fully parse array entries and encode + them into dedicated columns (`--structurize-arrays`). * For a complete list, run `./clp-s c --help` ### Examples diff --git a/docs/src/user-guide/reference-json-search-syntax.md b/docs/src/user-guide/reference-json-search-syntax.md index 416bbd264..ca6898984 100644 --- a/docs/src/user-guide/reference-json-search-syntax.md +++ b/docs/src/user-guide/reference-json-search-syntax.md @@ -139,8 +139,10 @@ parent1: {parent2: {child: value}} ``` :::{caution} -CLP does not currently support queries for array kv-pairs where only part of the key is known. In +By default, CLP does not support queries for array kv-pairs where only part of the key is known. In other words, the key must either be a wildcard (`*`) or it must contain no wildcards. + +Archives compressed using the `--structurize-arrays` flag *do not* have this limitation. ::: ### Complex queries