Skip to content

[DOCS][ESQL] Include bucket in STATS...BY supported functions #112513

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

Jump to bottom
Merged
merged 2 commits into from
Sep 5, 2024
Merged

[DOCS][ESQL] Include bucket in STATS...BY supported functions #112513

merged 2 commits into from
Sep 5, 2024

Conversation

leemthompo
Copy link
Contributor

This omission was flagged by @stratoula 🙏

@leemthompo leemthompo self-assigned this Sep 4, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 4, 2024

Documentation preview:

@elasticsearchmachine elasticsearchmachine added the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Sep 4, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

alex-spies
alex-spies requested changes Sep 4, 2024
View reviewed changes
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.

Heya, sorry for the blocking review but bucket is included in the grouping functions, displayed right below the agg functions.

Bucket is not an agg function and cannot be used in places where an agg function can be used. Are we sure we want to mention it in the docs next to the other agg functions?

@alex-spies
Copy link
Contributor

With this PR, this is how the functions reference looks like, and BUCKET shows up twice:
image

@stratoula
Copy link

stratoula commented Sep 4, 2024 •
edited
Loading

This feedback was given to me by people who were looking the stats by command and could not locate the date histogram. As it is used for grouping (and I am expecting to be a popular operation) I think it should be mentioned there. Or a reference to it. Because bucket in the agg functions doesnt help the users to understand that this can be used in the by operator

@leemthompo
Copy link
Contributor Author

@alex-spies you're totally right in that case. It's because I'm including the same list of functions here, but what I can do is just add bucket to the STATS....BY list manually so it doesn't show up in both the agg and group functions.

@alex-spies
Copy link
Contributor

Ah, I see the problem! Agree, as a user I'd expect to find this here
image

@leemthompo adding this manually under the STATS ... BY ... list sounds good to me!

@leemthompo
Copy link
Contributor Author

@alex-spies thanks for the eagle eye. Should be good now!

alex-spies
alex-spies approved these changes Sep 5, 2024
View reviewed changes
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.

Thanks for the iteration @leemthompo , looks great!

@leemthompo leemthompo merged commit 04678e9 into elastic:main Sep 5, 2024
5 checks passed
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
❌ 8.14 Commit could not be cherrypicked due to conflicts
❌ 8.15 Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 112513

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Sep 5, 2024
@leemthompo
[DOCS][ESQL] Include bucket in agg functions list (elastic#112513)
093c8c6 
(cherry picked from commit 04678e9)

# Conflicts:
#	docs/reference/esql/processing-commands/stats.asciidoc
@leemthompo leemthompo mentioned this pull request Sep 5, 2024
Merged
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Sep 5, 2024
@leemthompo
[DOCS][ESQL] Include bucket in agg functions list (elastic#112513)
75a3583 
(cherry picked from commit 04678e9)

# Conflicts:
#	docs/reference/esql/processing-commands/stats.asciidoc
@leemthompo leemthompo mentioned this pull request Sep 5, 2024
Merged
@leemthompo
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
✅ 8.15
✅ 8.14

Questions ?

Please refer to the Backport tool documentation

elasticsearchmachine pushed a commit that referenced this pull request Sep 5, 2024
@leemthompo
[DOCS][ESQL] Include bucket in agg functions list (#112513) (#112550)
2fce307 
(cherry picked from commit 04678e9)

# Conflicts:
#	docs/reference/esql/processing-commands/stats.asciidoc
elasticsearchmachine pushed a commit that referenced this pull request Sep 5, 2024
@leemthompo
[DOCS][ESQL] Include bucket in agg functions list (#112513) (#112551)
72a1a39 
(cherry picked from commit 04678e9)

# Conflicts:
#	docs/reference/esql/processing-commands/stats.asciidoc
@leemthompo leemthompo changed the title [DOCS][ESQL] Include bucket in agg functions list [DOCS][ESQL] Include bucket in STATS...BY supported functions Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nik9000 nik9000 nik9000 approved these changes

@alex-spies alex-spies alex-spies approved these changes

Assignees

@leemthompo leemthompo

Labels
:Analytics/ES|QL AKA ESQL backport pending >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v8.14.0 v8.15.0 v8.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@leemthompo @elasticsearchmachine @alex-spies @stratoula @nik9000