Skip to content

Document new duplicate key behavior #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document new duplicate key behavior #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/partials/operators/ParsingOptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
import Base from "../ParsingOptionsBase.mdx";

### Duplicate Keys

If the parser encounters a duplicate key in an event, it will transparently
upgrade the field to be a list of values instead. If the values are of different
type, conversions to a common type will be attempted, such as to a common number
type. Ultimately values will be stringified if they do not share a common type.

For a simple example, consider this JSON file:
```json title="Example JSON with duplicate key" {2}
Comment on lines +10 to +11
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For a simple example, consider this JSON file:
```json title="Example JSON with duplicate key" {2}
For a simple example, consider this JSON file:
```json title="Example JSON with duplicate key" {2}

Probably needed to satisfy the linter.

{ "key": 7 }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{ "key": 7 }
{"key": 7}

This is how we render records typically.

{ "key": 0.0, "key": 1 }
{ "key": 42 }
```
The event with a duplicate key has the respective value upgraded to a list:
```tql {2}
{ key: 7 }
{ key: [0.0, 1.0] }
{ key: 42 }
```

### `merge = bool (optional)`

Merges all incoming events into a single schema\* that converges over time. This
Expand All @@ -8,4 +28,6 @@ to huge schemas filled with nulls and imprecise results. Use with caution.

\*: In selector mode, only events with the same selector are merged.

In merging mode, a repeated key will always overwrite the previous value.

<Base />
Loading