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

docs: describe ordering in http query results #6024

Merged
merged 4 commits into from
May 20, 2022
Merged

Conversation

gabor
Copy link
Contributor

@gabor gabor commented Apr 26, 2022

this pull-request describes the ordering of results when using /query and /query_range HTTP endpoints.
it is important to know whether one can rely on the results being ordered or not (for example, in the grafana loki datasource, if we cannot rely on the ordering of results, we have to sort the data)

NOTE: i do not know if what i described here is guaranteed or not. i made some tests, and it seems to work this way. it would be great if a Loki developer could also verify this info. (if it is not guaranteed, i can update the pull-request so that the docs will mention that the ordering is not guaranteed)

also, there was an error in the query-range-matrix-results format description, i fixed that.

Copy link
Contributor

@kavirajk kavirajk left a comment

Choose a reason for hiding this comment

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

LGTM 👍 thanks @gabor.

@KMiller-Grafana leave it to you for final approval

Copy link
Member

@owen-d owen-d left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

docs/sources/api/_index.md Outdated Show resolved Hide resolved
docs/sources/api/_index.md Outdated Show resolved Hide resolved
docs/sources/api/_index.md Outdated Show resolved Hide resolved
Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com>
gabor and others added 2 commits May 9, 2022 09:13
Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com>
Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com>
@gabor gabor requested a review from KMiller-Grafana May 9, 2022 07:15
Copy link
Contributor

@KMiller-Grafana KMiller-Grafana 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 changes.

@owen-d owen-d merged commit 0075085 into main May 20, 2022
@owen-d owen-d deleted the gabor/docs-describe-order branch May 20, 2022 20:10
@osg-grafana osg-grafana added type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories and removed area/docs labels Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/S type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants