Skip to content
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.

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

lookup join docs #124531

Merged
merged 17 commits into from
Mar 13, 2025
Merged

lookup join docs #124531

merged 17 commits into from
Mar 13, 2025

Conversation

georgewallace
Copy link
Contributor

No description provided.

@georgewallace georgewallace self-assigned this Mar 11, 2025
@georgewallace georgewallace added >docs General docs changes Team:Docs Meta label for docs team labels Mar 11, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@georgewallace
Copy link
Contributor Author

@leemthompo @alex-spies somehow I accidently rebased some things and messed up my old branch. It was too much to go and determine the fix so I just moved stuff over to this new PR. Apologize for the confusion. I think I have addressed all the feedback so please take another look.

Copy link
Contributor

@alex-spies alex-spies left a comment

Choose a reason for hiding this comment

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

I think this is in a nice state now! I have mostly minor remaining comments.

As discussed, we probably want to follow this up and reference examples from .csv-spec files directly. We should probably also then add an example that shows how name conflicts between columns in the lookup index and the existing table are resolved.

Comment on lines 98 to 99
| 10094 | 4 | Quenya | null|
| 10095 | 5 | null | Atlantis|
Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for including the example from the docs. In a follow-up, maybe we want to construct a nicer example for the docs? (We used to place such examples in docs.csv-spec.) Then readers won't have to wonder why we include Atlantis or the elven language of Quenya :D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you think it would be cleaner, I just just replace those values with something more realistic @alex-spies

Copy link
Member

Choose a reason for hiding this comment

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

👍 on having better sample data that ties to the existing sample data in Kibana (which can have its own separate section).

| LOOKUP JOIN service_owners ON service_id
```

In case of name collisions, the newly created columns will override existing columns.
Copy link
Contributor

Choose a reason for hiding this comment

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

Also, we should provide an example here if possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@alex-spies I was unable to find a proper example for that. Can you point me in the right direction?

Copy link
Contributor

Choose a reason for hiding this comment

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

There are examples in the tests (we sometimes internally call the behavior "shadowing", so all tests with "shadowing" in their name deal with this behavior.)

However, these tests are super constructed to reveal the details of the behavior - I don't think they would flow very well in this document.

The same is true for the example that illustrates left-join behavior; that made sense as a test but may not be an intuitive example for esql-lookup-join.md.

I think we'd have to construct nicer examples for this, maybe in a follow up.

Copy link
Member

@costin costin left a comment

Choose a reason for hiding this comment

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

Great to see this start taking shape.

@leemthompo
Copy link
Contributor

leemthompo commented Mar 13, 2025

cc @craigtaverner's re how your auto-generation work will intersect with the syntax reference part of this

@georgewallace georgewallace merged commit 472536c into elastic:main Mar 13, 2025
6 checks passed
alex-spies added a commit to alex-spies/elasticsearch that referenced this pull request Mar 24, 2025
This was initially part of
elastic#124531 but got lost during
the manual backport.
alex-spies added a commit that referenced this pull request Mar 24, 2025
This was initially part of
#124531 but got lost during
the manual backport.
alex-spies added a commit to alex-spies/elasticsearch that referenced this pull request Mar 24, 2025
This was initially part of
elastic#124531 but got lost during
the manual backport.
elasticsearchmachine pushed a commit that referenced this pull request Mar 24, 2025
This was initially part of
#124531 but got lost during
the manual backport.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants