-
Notifications
You must be signed in to change notification settings - Fork 541
feat(_mapping): timestamp pushdown + column-hints fast path (on top of #6439) #6443
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
Open
congx4
wants to merge
7
commits into
main
Choose a base branch
from
cong/mapping-fast-path-on-list-fields
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
2aebb39
feat(_mapping): timestamp pushdown + column-hints fast path
congx4 2f719f6
address review feedback on _mapping fast path
congx4 2c2568e
address review followups: drop fast-path filter, remove unused dep
congx4 7aaa932
remove fast path from _mapping handler
congx4 b208d21
update comments to remove stale fast-path references
congx4 010d7f2
address remaining review nits
congx4 4d9a120
accept ES-compatible `fields` alias for field_patterns query param
congx4 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
145 changes: 145 additions & 0 deletions
145
quickwit/quickwit-serve/src/elasticsearch_api/model/index_mapping_query_params.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| // Copyright 2021-Present Datadog, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| /// Query parameters for `_mapping(s)`. Unknown params are silently ignored. | ||
| /// | ||
| /// Timestamps (`start_timestamp`, `end_timestamp`) are epoch seconds, | ||
| /// half-open `[start, end)`, forwarded to `ListFieldsRequest` to prune splits. | ||
| /// `field_patterns` is a comma-separated list mirroring | ||
| /// `ListFieldsRequest.field_patterns`, pushed down to the leaves for | ||
| /// dynamic-field filtering. | ||
| #[serde_with::skip_serializing_none] | ||
| #[derive(Default, Debug, Clone, Serialize, Deserialize)] | ||
| pub struct IndexMappingQueryParams { | ||
| #[serde(default)] | ||
| pub start_timestamp: Option<i64>, | ||
| #[serde(default)] | ||
| pub end_timestamp: Option<i64>, | ||
| /// Accepts both `field_patterns` (Quickwit) and `fields` (ES-compatible). | ||
| #[serde(default, alias = "fields")] | ||
| pub field_patterns: Option<String>, | ||
| } | ||
|
|
||
| impl IndexMappingQueryParams { | ||
| /// Splits `field_patterns` on commas, trims, and drops empties. | ||
| /// Returns an empty `Vec` when the parameter is absent or blank. | ||
| pub fn field_patterns(&self) -> Vec<String> { | ||
| self.field_patterns | ||
| .as_deref() | ||
| .unwrap_or_default() | ||
| .split(',') | ||
| .filter_map(|pattern| { | ||
| let trimmed = pattern.trim(); | ||
| if trimmed.is_empty() { | ||
| None | ||
| } else { | ||
| Some(trimmed.to_string()) | ||
| } | ||
| }) | ||
| .collect() | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::IndexMappingQueryParams; | ||
|
|
||
| #[test] | ||
| fn empty_query_string_yields_none() { | ||
| let params: IndexMappingQueryParams = serde_qs::from_str("").unwrap(); | ||
| assert!(params.start_timestamp.is_none()); | ||
| assert!(params.end_timestamp.is_none()); | ||
| assert!(params.field_patterns.is_none()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn both_params_present_yield_some() { | ||
| let qs = "start_timestamp=1712160204&end_timestamp=1712764984"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert_eq!(params.start_timestamp, Some(1712160204)); | ||
| assert_eq!(params.end_timestamp, Some(1712764984)); | ||
| assert!(params.field_patterns.is_none()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn only_start_timestamp_present() { | ||
| let qs = "start_timestamp=1712160204"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert_eq!(params.start_timestamp, Some(1712160204)); | ||
| assert!(params.end_timestamp.is_none()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn only_end_timestamp_present() { | ||
| let qs = "end_timestamp=1712764984"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert!(params.start_timestamp.is_none()); | ||
| assert_eq!(params.end_timestamp, Some(1712764984)); | ||
| } | ||
|
|
||
| #[test] | ||
| fn unknown_field_is_ignored() { | ||
| let qs = "start_timestamp=1&pretty=true&ignore_unavailable=true"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert_eq!(params.start_timestamp, Some(1)); | ||
| assert!(params.end_timestamp.is_none()); | ||
| assert!(params.field_patterns.is_none()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn field_patterns_param_present() { | ||
| let qs = "field_patterns=host,message,status"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert_eq!( | ||
| params.field_patterns.as_deref(), | ||
| Some("host,message,status") | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn field_patterns_combined_with_timestamps() { | ||
| let qs = "start_timestamp=1&end_timestamp=2&field_patterns=host"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert_eq!(params.start_timestamp, Some(1)); | ||
| assert_eq!(params.end_timestamp, Some(2)); | ||
| assert_eq!(params.field_patterns.as_deref(), Some("host")); | ||
| } | ||
|
|
||
| #[test] | ||
| fn empty_field_patterns_value() { | ||
| // `serde_qs` collapses an empty value to `None`. | ||
| let qs = "field_patterns="; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert!(params.field_patterns.is_none()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn es_compatible_fields_alias_accepted() { | ||
| // ES clients send `?fields=` — must map to the same field as `field_patterns`. | ||
| let qs = "fields=host,message"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert_eq!(params.field_patterns.as_deref(), Some("host,message")); | ||
| } | ||
|
|
||
| #[test] | ||
| fn fields_alias_combined_with_timestamps() { | ||
| let qs = "start_timestamp=1&end_timestamp=2&fields=host"; | ||
| let params: IndexMappingQueryParams = serde_qs::from_str(qs).unwrap(); | ||
| assert_eq!(params.start_timestamp, Some(1)); | ||
| assert_eq!(params.end_timestamp, Some(2)); | ||
| assert_eq!(params.field_patterns.as_deref(), Some("host")); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When
fields/field_patternscontains a pattern that the list-fields layer rejects (for example an ES-style pattern with more than one*, whichFieldPattern::from_strreturns asInvalidArgument), this forwards the user input intoroot_list_fieldsbut the handler still converts any error toNonewith.ok()below. In that scenario the request succeeds with only declared mappings and silently drops all matching dynamic fields, making the new filtered mapping endpoint return incomplete results instead of reporting the bad filter.Useful? React with 👍 / 👎.