Skip to content

ESQL: Document LU JOIN/MV_EXPAND not respecting SORT #127718

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

Merged
merged 6 commits into from
May 7, 2025
Merged

ESQL: Document LU JOIN/MV_EXPAND not respecting SORT #127718

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1d670f4
Document LU JOIN/MV_EXPAND not respecting SORT
alex-spies May 5, 2025
c1cc777
Create implementation details section, move collision, sorting tips t…
leemthompo May 6, 2025
e5643da
fix typo
leemthompo May 6, 2025
87ef558
rename heading, tweak opening sentence, add collision info
leemthompo May 7, 2025
4a30c20
fix link, tweak wording
leemthompo May 7, 2025
cd68742
Update docs/reference/query-languages/esql/esql-lookup-join.md
leemthompo May 7, 2025
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
6 changes: 6 additions & 0 deletions docs/reference/query-languages/esql/_snippets/commands/layout/lookup-join.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ results, the output will contain one row for each matching combination.
In case of name collisions, the newly created columns will override existing columns.
::::

::::{warning}
The output rows produced by `LOOKUP JOIN` can be in any order and may not
Copy link
Contributor Author

@alex-spies alex-spies May 5, 2025

Choose a reason for hiding this comment

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

@leemthompo , should we also place this warning in the more in-depth landing page for lookup join?

Copy link
Contributor

@leemthompo leemthompo May 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I think we are running the risk of those two pages becoming undifferentiated and therefore hard to maintain, if we repeat everything in both. Also adding admonitions like this doesn't scale.

We could consider moving this warning and the tip above it into the landing page under a new heading like Usage notes. And then we can link to that new section of the landing page from here with a message like "Refer to Usage notes for important information about using the LOOKUP JOIN command"— instead of repeating admonitions on both pages. This will be cleaner, more future-proof, and easier to maintain.

WDYT?

Copy link
Contributor

@leemthompo leemthompo May 6, 2025

Choose a reason for hiding this comment

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

pushed with c1cc777

Copy link
Contributor Author

@alex-spies alex-spies May 6, 2025

Choose a reason for hiding this comment

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

I like the new structure. Thanks, Liam!

respect preceding `SORT`s. To guarantee a certain ordering, place a `SORT` after
any `LOOKUP JOIN`s.
::::

**Examples**

**IP Threat correlation**: This query would allow you to see if any source
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/query-languages/esql/_snippets/commands/layout/mv_expand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ MV_EXPAND column
`column`
: The multivalued column to expand.

::::{warning}
The output rows produced by `MV_EXPAND` can be in any order and may not respect
preceding `SORT`s. To guarantee a certain ordering, place a `SORT` after any
`MV_EXPAND`s.
::::

**Example**

:::{include} ../examples/mv_expand.csv-spec/simple.md
Expand Down
Loading