Skip to content

Commit

Permalink
docs: Add instructions for using clp-s' array structurization feature. (
Browse files Browse the repository at this point in the history
y-scope#429)

Co-authored-by: kirkrodrigues <[email protected]>
  • Loading branch information
gibber9809 and kirkrodrigues authored Jun 7, 2024
1 parent 2725b9a commit ee5d0ba
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/src/user-guide/core-clp-s.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <field-path>`).
timestamp (`--timestamp-key <field-path>`), 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
Expand Down
4 changes: 3 additions & 1 deletion docs/src/user-guide/reference-json-search-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ee5d0ba

Please sign in to comment.