Merge pull request #15092 from jan--f/clarify-storage-contract

storage: require selectors to always return matching results
This commit is contained in:
Björn Rabenstein 2024-10-09 13:07:59 +02:00 committed by GitHub
commit 5e987e7c7d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 1 deletions

View file

@ -17,7 +17,8 @@ Request are made to the following endpoint.
### Samples
This returns a message that includes a list of raw samples.
This returns a message that includes a list of raw samples matching the
requested query.
### Streamed Chunks

View file

@ -114,6 +114,8 @@ type Querier interface {
LabelQuerier
// Select returns a set of series that matches the given label matchers.
// Results are not checked whether they match. Results that do not match
// may cause undefined behavior.
// Caller can specify if it requires returned series to be sorted. Prefer not requiring sorting for better performance.
// It allows passing hints that can help in optimising select, but it's up to implementation how this is used if used at all.
Select(ctx context.Context, sortSeries bool, hints *SelectHints, matchers ...*labels.Matcher) SeriesSet
@ -152,6 +154,8 @@ type ChunkQuerier interface {
LabelQuerier
// Select returns a set of series that matches the given label matchers.
// Results are not checked whether they match. Results that do not match
// may cause undefined behavior.
// Caller can specify if it requires returned series to be sorted. Prefer not requiring sorting for better performance.
// It allows passing hints that can help in optimising select, but it's up to implementation how this is used if used at all.
Select(ctx context.Context, sortSeries bool, hints *SelectHints, matchers ...*labels.Matcher) ChunkSeriesSet