1use std::collections::{BTreeMap, HashSet};
18use std::fmt;
19use std::num::NonZeroU64;
20use std::sync::{Arc, OnceLock};
21use std::time::Instant;
22
23use api::v1::SemanticType;
24use common_error::ext::BoxedError;
25use common_recordbatch::adapter::RegionQueryStatCounters;
26use common_recordbatch::filter::SimpleFilterEvaluator;
27use common_recordbatch::{QueryMemoryTracker, SendableRecordBatchStream};
28use common_telemetry::tracing::Instrument;
29use common_telemetry::{debug, error, tracing, warn};
30use common_time::range::TimestampRange;
31use datafusion::optimizer::simplify_expressions::ExprSimplifier;
32use datafusion::physical_plan::expressions::DynamicFilterPhysicalExpr;
33use datafusion_common::pruning::PruningStatistics;
34use datafusion_common::{Column, ScalarValue, ToDFSchema};
35use datafusion_expr::Expr;
36use datafusion_expr::simplify::SimplifyContext;
37use datafusion_expr::utils::expr_to_columns;
38use datatypes::arrow::array::{ArrayRef, BooleanArray, UInt64Array};
39use datatypes::extension::json::is_json2_extension_type;
40use datatypes::prelude::ConcreteDataType;
41use datatypes::types::json_type::JsonNativeType;
42use datatypes::value::timestamp_to_scalar_value;
43use futures::StreamExt;
44use partition::expr::PartitionExpr;
45use smallvec::SmallVec;
46use snafu::{OptionExt, ResultExt, ensure};
47use store_api::metadata::{RegionMetadata, RegionMetadataRef};
48use store_api::region_engine::{PartitionRange, RegionScannerRef};
49use store_api::storage::{
50 ColumnId, RegionId, ScanRequest, SequenceNumber, SequenceRange, TimeSeriesDistribution,
51 TimeSeriesRowSelector,
52};
53use table::predicate::{Predicate, build_time_range_predicate, extract_time_range_from_expr};
54use tokio::sync::{Semaphore, mpsc};
55use tokio_stream::wrappers::ReceiverStream;
56
57use crate::access_layer::AccessLayerRef;
58use crate::cache::CacheStrategy;
59use crate::config::DEFAULT_MAX_CONCURRENT_SCAN_FILES;
60use crate::error::{
61 EvalPartitionFilterSnafu, InvalidPartitionExprSnafu, InvalidRequestSnafu,
62 RegionSequenceDomainBrokenSnafu, Result, SequenceRangeUnsupportedSnafu,
63};
64#[cfg(feature = "enterprise")]
65use crate::extension::{BoxedExtensionRange, BoxedExtensionRangeProvider};
66use crate::memtable::{MemtableRange, RangesOptions};
67use crate::metrics::READ_SST_COUNT;
68use crate::read::compat::{self, FlatCompatBatch};
69use crate::read::flat_projection::FlatProjectionMapper;
70use crate::read::range::{FileRangeBuilder, MemRangeBuilder, RangeMeta, RowGroupIndex};
71use crate::read::range_cache::{ScanRequestFingerprint, implied_time_range_from_exprs};
72use crate::read::read_columns::ReadColumns;
73use crate::read::seq_scan::SeqScan;
74use crate::read::series_scan::SeriesScan;
75use crate::read::stream::ScanBatchStream;
76use crate::read::unordered_scan::UnorderedScan;
77use crate::read::{BoxedRecordBatchStream, RecordBatch};
78use crate::region::options::MergeMode;
79use crate::region::version::VersionRef;
80use crate::series_index::SeriesIndexReadContext;
81use crate::sst::file::FileHandle;
82use crate::sst::index::bloom_filter::applier::{
83 BloomFilterIndexApplierBuilder, BloomFilterIndexApplierRef,
84};
85use crate::sst::index::fulltext_index::applier::FulltextIndexApplierRef;
86use crate::sst::index::fulltext_index::applier::builder::FulltextIndexApplierBuilder;
87use crate::sst::index::inverted_index::applier::InvertedIndexApplierRef;
88use crate::sst::index::inverted_index::applier::builder::InvertedIndexApplierBuilder;
89use crate::sst::parquet::Json2RewriteTargets;
90use crate::sst::parquet::file_range::PreFilterMode;
91use crate::sst::parquet::reader::ReaderMetrics;
92use crate::sst::primary_key::PrimaryKeyRangeMapper;
93
94pub(crate) enum Scanner {
96 Seq(SeqScan),
98 Unordered(UnorderedScan),
100 Series(SeriesScan),
102}
103
104impl Scanner {
105 #[tracing::instrument(level = tracing::Level::DEBUG, skip_all)]
107 pub(crate) async fn scan(&self) -> Result<SendableRecordBatchStream, BoxedError> {
108 match self {
109 Scanner::Seq(seq_scan) => seq_scan.build_stream(),
110 Scanner::Unordered(unordered_scan) => unordered_scan.build_stream().await,
111 Scanner::Series(series_scan) => series_scan.build_stream().await,
112 }
113 }
114
115 pub(crate) fn scan_batch(&self) -> Result<ScanBatchStream> {
117 match self {
118 Scanner::Seq(x) => x.scan_all_partitions(),
119 Scanner::Unordered(x) => x.scan_all_partitions(),
120 Scanner::Series(x) => x.scan_all_partitions(),
121 }
122 }
123}
124
125#[cfg(test)]
126impl Scanner {
127 pub(crate) fn num_files(&self) -> usize {
129 match self {
130 Scanner::Seq(seq_scan) => seq_scan.input().num_files(),
131 Scanner::Unordered(unordered_scan) => unordered_scan.input().num_files(),
132 Scanner::Series(series_scan) => series_scan.input().num_files(),
133 }
134 }
135
136 pub(crate) fn num_memtables(&self) -> usize {
138 match self {
139 Scanner::Seq(seq_scan) => seq_scan.input().num_memtables(),
140 Scanner::Unordered(unordered_scan) => unordered_scan.input().num_memtables(),
141 Scanner::Series(series_scan) => series_scan.input().num_memtables(),
142 }
143 }
144
145 pub(crate) fn file_ids(&self) -> Vec<crate::sst::file::RegionFileId> {
147 match self {
148 Scanner::Seq(seq_scan) => seq_scan.input().file_ids(),
149 Scanner::Unordered(unordered_scan) => unordered_scan.input().file_ids(),
150 Scanner::Series(series_scan) => series_scan.input().file_ids(),
151 }
152 }
153
154 pub(crate) fn index_ids(&self) -> Vec<crate::sst::file::RegionIndexId> {
155 match self {
156 Scanner::Seq(seq_scan) => seq_scan.input().index_ids(),
157 Scanner::Unordered(unordered_scan) => unordered_scan.input().index_ids(),
158 Scanner::Series(series_scan) => series_scan.input().index_ids(),
159 }
160 }
161
162 pub(crate) fn snapshot_sequence(&self) -> Option<SequenceNumber> {
163 match self {
164 Scanner::Seq(seq_scan) => seq_scan.input().snapshot_sequence,
165 Scanner::Unordered(unordered_scan) => unordered_scan.input().snapshot_sequence,
166 Scanner::Series(series_scan) => series_scan.input().snapshot_sequence,
167 }
168 }
169
170 pub(crate) fn set_target_partitions(&mut self, target_partitions: usize) {
172 use store_api::region_engine::{PrepareRequest, RegionScanner};
173
174 let request = PrepareRequest::default().with_target_partitions(target_partitions);
175 match self {
176 Scanner::Seq(seq_scan) => seq_scan.prepare(request).unwrap(),
177 Scanner::Unordered(unordered_scan) => unordered_scan.prepare(request).unwrap(),
178 Scanner::Series(series_scan) => series_scan.prepare(request).unwrap(),
179 }
180 }
181}
182
183#[cfg_attr(doc, aquamarine::aquamarine)]
184pub(crate) struct ScanRegion {
234 version: VersionRef,
236 series_index: Option<SeriesIndexReadContext>,
238 access_layer: AccessLayerRef,
240 request: ScanRequest,
242 cache_strategy: CacheStrategy,
244 max_concurrent_scan_files: usize,
246 scan_memory_tracker: Option<QueryMemoryTracker>,
247 experimental_series_scan_v2: bool,
249 ignore_range_index: bool,
251 ignore_inverted_index: bool,
253 ignore_fulltext_index: bool,
255 ignore_bloom_filter: bool,
257 start_time: Option<Instant>,
259 filter_deleted: bool,
262 exact_selection: Option<(Vec<FileHandle>, Option<SequenceRange>)>,
264 query_stat_counters: Option<RegionQueryStatCounters>,
266 #[cfg(feature = "enterprise")]
267 extension_range_provider: Option<BoxedExtensionRangeProvider>,
268}
269
270impl ScanRegion {
271 pub(crate) fn new(
273 version: VersionRef,
274 access_layer: AccessLayerRef,
275 request: ScanRequest,
276 cache_strategy: CacheStrategy,
277 ) -> ScanRegion {
278 ScanRegion {
279 version,
280 series_index: None,
281 access_layer,
282 request,
283 cache_strategy,
284 max_concurrent_scan_files: DEFAULT_MAX_CONCURRENT_SCAN_FILES,
285 scan_memory_tracker: None,
286 experimental_series_scan_v2: false,
287 ignore_range_index: false,
288 ignore_inverted_index: false,
289 ignore_fulltext_index: false,
290 ignore_bloom_filter: false,
291 start_time: None,
292 filter_deleted: true,
293 exact_selection: None,
294 query_stat_counters: None,
295 #[cfg(feature = "enterprise")]
296 extension_range_provider: None,
297 }
298 }
299
300 #[must_use]
302 pub(crate) fn with_series_index(
303 mut self,
304 series_index: Option<SeriesIndexReadContext>,
305 ) -> Self {
306 self.series_index = series_index;
307 self
308 }
309
310 #[must_use]
312 pub(crate) fn with_query_stat_counters(mut self, counters: RegionQueryStatCounters) -> Self {
313 self.query_stat_counters = Some(counters);
314 self
315 }
316
317 #[must_use]
319 pub(crate) fn with_max_concurrent_scan_files(
320 mut self,
321 max_concurrent_scan_files: usize,
322 ) -> Self {
323 self.max_concurrent_scan_files = max_concurrent_scan_files;
324 self
325 }
326
327 pub(crate) fn with_scan_memory_tracker(mut self, tracker: QueryMemoryTracker) -> Self {
328 self.scan_memory_tracker = Some(tracker);
329 self
330 }
331
332 #[must_use]
334 pub(crate) fn with_experimental_series_scan_v2(mut self, enabled: bool) -> Self {
335 self.experimental_series_scan_v2 = enabled;
336 self
337 }
338
339 #[must_use]
341 pub(crate) fn with_ignore_range_index(mut self, ignore: bool) -> Self {
342 self.ignore_range_index = ignore;
343 self
344 }
345
346 #[must_use]
348 pub(crate) fn with_ignore_inverted_index(mut self, ignore: bool) -> Self {
349 self.ignore_inverted_index = ignore;
350 self
351 }
352
353 #[must_use]
355 pub(crate) fn with_ignore_fulltext_index(mut self, ignore: bool) -> Self {
356 self.ignore_fulltext_index = ignore;
357 self
358 }
359
360 #[must_use]
362 pub(crate) fn with_ignore_bloom_filter(mut self, ignore: bool) -> Self {
363 self.ignore_bloom_filter = ignore;
364 self
365 }
366
367 #[must_use]
368 pub(crate) fn with_start_time(mut self, now: Instant) -> Self {
369 self.start_time = Some(now);
370 self
371 }
372
373 pub(crate) fn set_filter_deleted(&mut self, filter_deleted: bool) {
374 self.filter_deleted = filter_deleted;
375 }
376
377 pub(crate) fn with_exact_selection(
378 mut self,
379 exact_selection: (Vec<FileHandle>, Option<SequenceRange>),
380 ) -> Self {
381 self.exact_selection = Some(exact_selection);
382 self
383 }
384
385 #[cfg(feature = "enterprise")]
386 pub(crate) fn set_extension_range_provider(
387 &mut self,
388 extension_range_provider: BoxedExtensionRangeProvider,
389 ) {
390 self.extension_range_provider = Some(extension_range_provider);
391 }
392
393 #[tracing::instrument(skip_all, fields(region_id = %self.region_id()))]
395 pub(crate) async fn scanner(self) -> Result<Scanner> {
396 if self.use_series_scan() {
397 self.series_scan().await.map(Scanner::Series)
398 } else if self.use_unordered_scan() {
399 self.unordered_scan().await.map(Scanner::Unordered)
402 } else {
403 self.seq_scan().await.map(Scanner::Seq)
404 }
405 }
406
407 #[tracing::instrument(
409 level = tracing::Level::DEBUG,
410 skip_all,
411 fields(region_id = %self.region_id())
412 )]
413 pub(crate) async fn region_scanner(self) -> Result<RegionScannerRef> {
414 if self.use_series_scan() {
415 self.series_scan()
416 .await
417 .map(|scanner| Box::new(scanner) as _)
418 } else if self.use_unordered_scan() {
419 self.unordered_scan()
420 .await
421 .map(|scanner| Box::new(scanner) as _)
422 } else {
423 self.seq_scan().await.map(|scanner| Box::new(scanner) as _)
424 }
425 }
426
427 #[tracing::instrument(skip_all, fields(region_id = %self.region_id()))]
429 pub(crate) async fn seq_scan(self) -> Result<SeqScan> {
430 let input = self.scan_input().await?;
431 Ok(SeqScan::new(input))
432 }
433
434 #[tracing::instrument(skip_all, fields(region_id = %self.region_id()))]
436 pub(crate) async fn unordered_scan(self) -> Result<UnorderedScan> {
437 let input = self.scan_input().await?;
438 let query_start = input.query_start.unwrap_or_else(Instant::now);
439 let ranges = RangeMeta::unordered_scan_ranges(&input).await;
440 let stream_ctx = StreamContext::unordered_scan_ctx(input, ranges, query_start);
441 Ok(UnorderedScan::new(stream_ctx))
442 }
443
444 #[tracing::instrument(skip_all, fields(region_id = %self.region_id()))]
446 pub(crate) async fn series_scan(self) -> Result<SeriesScan> {
447 let experimental_series_scan_v2 = self.experimental_series_scan_v2;
448 let input = self.scan_input().await?;
449 Ok(SeriesScan::new(input, experimental_series_scan_v2))
450 }
451
452 fn use_unordered_scan(&self) -> bool {
454 self.version.options.append_mode
461 && self.request.series_row_selector.is_none()
462 && (self.request.distribution.is_none()
463 || self.request.distribution == Some(TimeSeriesDistribution::TimeWindowed))
464 }
465
466 fn use_series_scan(&self) -> bool {
468 self.request.distribution == Some(TimeSeriesDistribution::PerSeries)
469 }
470
471 #[tracing::instrument(skip_all, fields(region_id = %self.region_id()))]
473 async fn scan_input(mut self) -> Result<ScanInput> {
474 let metadata = &self.version.metadata;
475 let sst_min_sequence = self.request.sst_min_sequence.and_then(NonZeroU64::new);
476 let time_range = self.build_time_range_predicate();
477 let predicate = PredicateGroup::new(metadata, &self.request.filters)?;
478
479 let read_col_ids =
480 self.build_read_col_ids(self.request.projection.as_deref(), &predicate)?;
481 let read_cols = self.build_read_columns(&read_col_ids)?;
482
483 let projection = self
485 .request
486 .projection
487 .clone()
488 .unwrap_or_else(|| (0..metadata.column_metadatas.len()).collect());
489 let mapper = FlatProjectionMapper::new_with_read_columns(metadata, projection, read_cols)?;
490 let mapper = if self.request.preserve_pk_dictionary_encoding {
491 mapper.with_pk_dictionary_encoding()
492 } else {
493 mapper
494 };
495
496 let (files, sequence_range) =
497 if let Some((files, sequence_range)) = self.exact_selection.take() {
498 (files, sequence_range)
499 } else {
500 exact_sequence_range(&self.request, &self.version)?
501 };
502 if sst_min_sequence.is_some() && sequence_range.is_some() {
503 return SequenceRangeUnsupportedSnafu {
504 region_id: self.region_id(),
505 min_seq: self.request.memtable_min_sequence.unwrap_or_default(),
506 max_seq: self.request.memtable_max_sequence.unwrap_or_default(),
507 reason:
508 "sst_min_sequence pruning hint is incompatible with exact sequence-range reads"
509 .to_string(),
510 }
511 .fail();
512 }
513 let memtables = self.version.memtables.list_memtables();
514 let mut mem_range_builders = Vec::new();
516 let filter_mode = pre_filter_mode(
517 self.version.options.append_mode,
518 self.version.options.merge_mode(),
519 );
520
521 for m in memtables {
522 let Some((start, end)) = m.stats().time_range() else {
524 continue;
525 };
526 let memtable_range = TimestampRange::new_inclusive(Some(start), Some(end));
528 if !memtable_range.intersects(&time_range) {
529 continue;
530 }
531 let ranges_in_memtable = m.ranges(
532 Some(&read_col_ids),
533 RangesOptions::default()
534 .with_predicate(predicate.clone())
535 .with_sequence(SequenceRange::new(
536 self.request.memtable_min_sequence,
537 self.request.memtable_max_sequence,
538 ))
539 .with_pre_filter_mode(filter_mode),
540 )?;
541 mem_range_builders.extend(ranges_in_memtable.ranges.into_values().map(|v| {
542 let stats = v.stats().clone();
543 MemRangeBuilder::new(v, stats)
544 }));
545 }
546
547 let region_id = self.region_id();
548 debug!(
549 "Scan region {}, request: {:?}, time range: {:?}, memtables: {}, ssts_to_read: {}, append_mode: {}",
550 region_id,
551 self.request,
552 time_range,
553 mem_range_builders.len(),
554 files.len(),
555 self.version.options.append_mode,
556 );
557
558 let (non_field_filters, field_filters) = self.partition_by_field_filters();
559 let inverted_index_appliers = [
560 self.build_invereted_index_applier(&non_field_filters),
561 self.build_invereted_index_applier(&field_filters),
562 ];
563 let bloom_filter_appliers = [
564 self.build_bloom_filter_applier(&non_field_filters),
565 self.build_bloom_filter_applier(&field_filters),
566 ];
567 let fulltext_index_appliers = [
568 self.build_fulltext_index_applier(&non_field_filters),
569 self.build_fulltext_index_applier(&field_filters),
570 ];
571
572 let input = ScanInput::builder(self.access_layer, mapper)
573 .with_series_index(self.series_index)
574 .with_ignore_range_index(self.ignore_range_index)
575 .with_time_range(Some(time_range))
576 .with_predicate(predicate)
577 .with_memtables(mem_range_builders)
578 .with_files(files)
579 .with_primary_key_mapper(self.version.ssts.primary_key_mapper())
580 .with_cache(self.cache_strategy)
581 .with_inverted_index_appliers(inverted_index_appliers)
582 .with_bloom_filter_index_appliers(bloom_filter_appliers)
583 .with_fulltext_index_appliers(fulltext_index_appliers)
584 .with_max_concurrent_scan_files(self.max_concurrent_scan_files)
585 .with_scan_memory_tracker(self.scan_memory_tracker)
586 .with_start_time(self.start_time)
587 .with_append_mode(self.version.options.append_mode)
588 .with_filter_deleted(self.filter_deleted)
589 .with_merge_mode(self.version.options.merge_mode())
590 .with_series_row_selector(self.request.series_row_selector)
591 .with_distribution(self.request.distribution)
592 .with_explain_flat_format(
593 self.version.options.sst_format == Some(crate::sst::FormatType::Flat),
594 )
595 .with_snapshot_sequence(
596 self.request
597 .snapshot_on_scan
598 .then_some(self.request.memtable_max_sequence)
599 .flatten(),
600 )
601 .with_sequence_range(sequence_range)
602 .with_query_stat_counters(self.query_stat_counters);
603 #[cfg(feature = "enterprise")]
604 let input = if !self.request.skip_sst_files
605 && let Some(provider) = self.extension_range_provider
606 {
607 if sequence_range.is_some() {
608 return SequenceRangeUnsupportedSnafu {
614 region_id,
615 min_seq: self.request.memtable_min_sequence.unwrap_or_default(),
616 max_seq: self.request.memtable_max_sequence.unwrap_or_default(),
617 reason:
618 "exact sequence-range reads are unsupported when an extension range provider is present"
619 .to_string(),
620 }
621 .fail();
622 }
623 let ranges = provider
624 .find_extension_ranges(self.version.flushed_sequence, time_range, &self.request)
625 .await?;
626 debug!("Find extension ranges: {ranges:?}");
627 input.with_extension_ranges(ranges)
628 } else {
629 input
630 };
631 Ok(input.build())
632 }
633
634 fn build_read_col_ids(
637 &self,
638 projection: Option<&[usize]>,
639 predicate: &PredicateGroup,
640 ) -> Result<Vec<ColumnId>> {
641 let metadata = &self.version.metadata;
642 let Some(projection) = projection else {
643 return Ok(metadata
644 .column_metadatas
645 .iter()
646 .map(|col| col.column_id)
647 .collect());
648 };
649
650 let mut read_col_ids = Vec::new();
651 let mut seen = HashSet::new();
652 for idx in projection {
653 let col_id = metadata
654 .column_metadatas
655 .get(*idx)
656 .with_context(|| InvalidRequestSnafu {
657 region_id: metadata.region_id,
658 reason: format!("projection index {} is out of bounds", idx),
659 })?
660 .column_id;
661 let inserted = seen.insert(col_id);
662 debug_assert!(
665 inserted,
666 "projection contains duplicate column id: {}",
667 col_id
668 );
669 read_col_ids.push(col_id);
671 }
672
673 if projection.is_empty() {
674 let time_index = metadata.time_index_column().column_id;
675 if seen.insert(time_index) {
676 read_col_ids.push(time_index);
677 }
678 }
679
680 let mut extra_col_names = HashSet::new();
681 let mut cols = HashSet::new();
682
683 if let Some(p) = predicate.predicate_without_region() {
684 for expr in p.exprs() {
685 cols.clear();
686 if expr_to_columns(expr, &mut cols).is_err() {
687 continue;
688 }
689 extra_col_names.extend(cols.iter().map(|col| col.name.clone()));
690 }
691 }
692
693 if let Some(expr) = predicate.region_partition_expr() {
694 expr.collect_column_names(&mut extra_col_names);
695 }
696
697 if !extra_col_names.is_empty() {
698 for col in &metadata.column_metadatas {
699 if extra_col_names.remove(&col.column_schema.name) && !seen.contains(&col.column_id)
700 {
701 read_col_ids.push(col.column_id);
702 }
703 }
704 if !extra_col_names.is_empty() {
705 warn!(
706 "Some columns in filters are not found in region {}: {:?}",
707 metadata.region_id, extra_col_names
708 );
709 }
710 }
711 Ok(read_col_ids)
712 }
713
714 fn build_read_columns(&self, col_ids: &[ColumnId]) -> Result<ReadColumns> {
720 let metadata = &self.version.metadata;
721 let json_type_hint = &self.request.json_type_hint;
722
723 let has_json2 = metadata
724 .schema
725 .arrow_schema()
726 .fields()
727 .iter()
728 .any(is_json2_extension_type);
729
730 if !has_json2 && json_type_hint.is_empty() {
731 return Ok(ReadColumns::new(col_ids.iter().copied()));
732 }
733
734 let mut json_target_types = BTreeMap::new();
735 for &col_id in col_ids {
736 let Some(col) = metadata.column_by_id(col_id) else {
737 continue;
738 };
739 let col_name = &col.column_schema.name;
740 let hint = json_type_hint.get(col_name);
741 if !col.column_schema.data_type.is_json2() {
742 ensure!(
743 hint.is_none(),
744 InvalidRequestSnafu {
745 region_id: metadata.region_id,
746 reason: format!(
747 "JSON type hint targets non-JSON2 column {} (id: {}, type: {})",
748 col_name, col_id, col.column_schema.data_type
749 ),
750 }
751 );
752 continue;
753 }
754 let target_type = hint.cloned().unwrap_or(JsonNativeType::Variant);
755 json_target_types.insert(col_id, target_type);
756 }
757 Ok(ReadColumns::new(col_ids.iter().copied()).with_json_target_types(json_target_types))
758 }
759
760 fn region_id(&self) -> RegionId {
761 self.version.metadata.region_id
762 }
763
764 fn build_time_range_predicate(&self) -> TimestampRange {
766 let time_index = self.version.metadata.time_index_column();
767 let unit = time_index
768 .column_schema
769 .data_type
770 .as_timestamp()
771 .expect("Time index must have timestamp-compatible type")
772 .unit();
773 build_time_range_predicate(&time_index.column_schema.name, unit, &self.request.filters)
774 }
775
776 fn partition_by_field_filters(&self) -> (Vec<Expr>, Vec<Expr>) {
779 let field_columns = self
780 .version
781 .metadata
782 .field_columns()
783 .map(|col| &col.column_schema.name)
784 .collect::<HashSet<_>>();
785
786 let mut columns = HashSet::new();
787
788 self.request.filters.iter().cloned().partition(|expr| {
789 columns.clear();
790 if expr_to_columns(expr, &mut columns).is_err() {
792 return true;
794 }
795 !columns
797 .iter()
798 .any(|column| field_columns.contains(&column.name))
799 })
800 }
801
802 fn build_invereted_index_applier(&self, filters: &[Expr]) -> Option<InvertedIndexApplierRef> {
804 if self.ignore_inverted_index {
805 return None;
806 }
807
808 let file_cache = self.cache_strategy.write_cache().map(|w| w.file_cache());
809 let inverted_index_cache = self.cache_strategy.inverted_index_cache().cloned();
810
811 let puffin_metadata_cache = self.cache_strategy.puffin_metadata_cache().cloned();
812
813 InvertedIndexApplierBuilder::new(
814 self.access_layer.table_dir().to_string(),
815 self.access_layer.path_type(),
816 self.access_layer.object_store().clone(),
817 self.version.metadata.as_ref(),
818 self.version.metadata.inverted_indexed_column_ids(
819 self.version
820 .options
821 .index_options
822 .inverted_index
823 .ignore_column_ids
824 .iter(),
825 ),
826 self.access_layer.puffin_manager_factory().clone(),
827 )
828 .with_file_cache(file_cache)
829 .with_inverted_index_cache(inverted_index_cache)
830 .with_puffin_metadata_cache(puffin_metadata_cache)
831 .build(filters)
832 .inspect_err(|err| warn!(err; "Failed to build invereted index applier"))
833 .ok()
834 .flatten()
835 .map(Arc::new)
836 }
837
838 fn build_bloom_filter_applier(&self, filters: &[Expr]) -> Option<BloomFilterIndexApplierRef> {
840 if self.ignore_bloom_filter {
841 return None;
842 }
843
844 let file_cache = self.cache_strategy.write_cache().map(|w| w.file_cache());
845 let bloom_filter_index_cache = self.cache_strategy.bloom_filter_index_cache().cloned();
846 let puffin_metadata_cache = self.cache_strategy.puffin_metadata_cache().cloned();
847
848 BloomFilterIndexApplierBuilder::new(
849 self.access_layer.table_dir().to_string(),
850 self.access_layer.path_type(),
851 self.access_layer.object_store().clone(),
852 self.version.metadata.as_ref(),
853 self.access_layer.puffin_manager_factory().clone(),
854 )
855 .with_file_cache(file_cache)
856 .with_bloom_filter_index_cache(bloom_filter_index_cache)
857 .with_puffin_metadata_cache(puffin_metadata_cache)
858 .build(filters)
859 .inspect_err(|err| warn!(err; "Failed to build bloom filter index applier"))
860 .ok()
861 .flatten()
862 .map(Arc::new)
863 }
864
865 fn build_fulltext_index_applier(&self, filters: &[Expr]) -> Option<FulltextIndexApplierRef> {
867 if self.ignore_fulltext_index {
868 return None;
869 }
870
871 let file_cache = self.cache_strategy.write_cache().map(|w| w.file_cache());
872 let puffin_metadata_cache = self.cache_strategy.puffin_metadata_cache().cloned();
873 let bloom_filter_index_cache = self.cache_strategy.bloom_filter_index_cache().cloned();
874 FulltextIndexApplierBuilder::new(
875 self.access_layer.table_dir().to_string(),
876 self.access_layer.path_type(),
877 self.access_layer.object_store().clone(),
878 self.access_layer.puffin_manager_factory().clone(),
879 self.version.metadata.as_ref(),
880 )
881 .with_file_cache(file_cache)
882 .with_puffin_metadata_cache(puffin_metadata_cache)
883 .with_bloom_filter_cache(bloom_filter_index_cache)
884 .build(filters)
885 .inspect_err(|err| warn!(err; "Failed to build fulltext index applier"))
886 .ok()
887 .flatten()
888 .map(Arc::new)
889 }
890}
891
892fn file_in_range(file: &FileHandle, predicate: &TimestampRange) -> bool {
894 if predicate == &TimestampRange::min_to_max() {
895 return true;
896 }
897 let (start, end) = file.time_range();
899 let file_ts_range = TimestampRange::new_inclusive(Some(start), Some(end));
900 file_ts_range.intersects(predicate)
901}
902
903fn time_range_covers_file(time_range: Option<&TimestampRange>, file: &FileHandle) -> bool {
905 let Some(time_range) = time_range else {
906 return false;
907 };
908 let (start, end) = file.time_range();
909 time_range.contains(&start) && time_range.contains(&end)
910}
911
912pub struct ScanInput {
914 pub(crate) series_index: Option<SeriesIndexReadContext>,
916 ignore_range_index: bool,
918 access_layer: AccessLayerRef,
920 pub(crate) mapper: Arc<FlatProjectionMapper>,
922 pub(crate) read_cols: ReadColumns,
926 pub(crate) time_range: Option<TimestampRange>,
928 scan_analysis: Option<ScanAnalysis>,
930 pub(crate) predicate: PredicateGroup,
932 region_partition_expr: Option<PartitionExpr>,
934 pub(crate) memtables: Vec<MemRangeBuilder>,
936 pub(crate) files: Vec<FileHandle>,
938 primary_key_mapper: OnceLock<Arc<PrimaryKeyRangeMapper>>,
940 batch_size: usize,
942 pub(crate) cache_strategy: CacheStrategy,
944 ignore_file_not_found: bool,
946 pub(crate) max_concurrent_scan_files: usize,
948 scan_memory_tracker: Option<QueryMemoryTracker>,
950 inverted_index_appliers: [Option<InvertedIndexApplierRef>; 2],
952 bloom_filter_index_appliers: [Option<BloomFilterIndexApplierRef>; 2],
953 fulltext_index_appliers: [Option<FulltextIndexApplierRef>; 2],
954 pub(crate) query_start: Option<Instant>,
956 pub(crate) append_mode: bool,
958 pub(crate) filter_deleted: bool,
960 pub(crate) merge_mode: MergeMode,
962 pub(crate) series_row_selector: Option<TimeSeriesRowSelector>,
964 pub(crate) distribution: Option<TimeSeriesDistribution>,
966 explain_flat_format: bool,
968 pub(crate) snapshot_sequence: Option<SequenceNumber>,
970 pub(crate) sequence_range: Option<SequenceRange>,
975 pub(crate) compaction: bool,
977 pub(crate) compaction_read_parallelism: usize,
980 json2_rewrite_targets: Json2RewriteTargets,
982 pub(crate) query_stat_counters: Option<RegionQueryStatCounters>,
984 #[cfg(feature = "enterprise")]
985 extension_ranges: Vec<BoxedExtensionRange>,
986}
987
988struct ScanAnalysis {
991 fingerprint: Option<ScanRequestFingerprint>,
993 implied_time_range: Option<TimestampRange>,
999}
1000
1001pub(crate) struct ScanInputBuilder {
1003 input: ScanInput,
1004}
1005
1006impl ScanInput {
1007 #[must_use]
1009 pub(crate) fn builder(
1010 access_layer: AccessLayerRef,
1011 mapper: FlatProjectionMapper,
1012 ) -> ScanInputBuilder {
1013 ScanInputBuilder {
1014 input: ScanInput {
1015 series_index: None,
1016 ignore_range_index: false,
1017 access_layer,
1018 read_cols: mapper.read_columns().clone(),
1019 mapper: Arc::new(mapper),
1020 time_range: None,
1021 scan_analysis: None,
1022 predicate: PredicateGroup::default(),
1023 region_partition_expr: None,
1024 memtables: Vec::new(),
1025 files: Vec::new(),
1026 primary_key_mapper: OnceLock::new(),
1027 batch_size: crate::sst::parquet::DEFAULT_READ_BATCH_SIZE,
1028 cache_strategy: CacheStrategy::Disabled,
1029 ignore_file_not_found: false,
1030 max_concurrent_scan_files: DEFAULT_MAX_CONCURRENT_SCAN_FILES,
1031 scan_memory_tracker: None,
1032 inverted_index_appliers: [None, None],
1033 bloom_filter_index_appliers: [None, None],
1034 fulltext_index_appliers: [None, None],
1035 query_start: None,
1036 append_mode: false,
1037 filter_deleted: true,
1038 merge_mode: MergeMode::default(),
1039 series_row_selector: None,
1040 distribution: None,
1041 explain_flat_format: false,
1042 snapshot_sequence: None,
1043 sequence_range: None,
1044 compaction: false,
1045 compaction_read_parallelism: 1,
1046 json2_rewrite_targets: Arc::default(),
1047 query_stat_counters: None,
1048 #[cfg(feature = "enterprise")]
1049 extension_ranges: Vec::new(),
1050 },
1051 }
1052 }
1053
1054 pub(crate) fn batch_size(&self) -> usize {
1056 self.batch_size
1057 }
1058
1059 pub(crate) fn primary_key_mapper(&self) -> &PrimaryKeyRangeMapper {
1061 self.primary_key_mapper
1062 .get_or_init(|| Arc::new(PrimaryKeyRangeMapper::new(self.region_metadata().clone())))
1063 }
1064
1065 pub(crate) fn implied_time_range(&self) -> Option<&TimestampRange> {
1067 self.scan_analysis
1068 .as_ref()
1069 .expect("ScanInput must be built")
1070 .implied_time_range
1071 .as_ref()
1072 }
1073
1074 pub(crate) fn scan_fingerprint(&self) -> Option<&ScanRequestFingerprint> {
1076 self.scan_analysis
1077 .as_ref()
1078 .expect("ScanInput must be built")
1079 .fingerprint
1080 .as_ref()
1081 }
1082}
1083
1084impl ScanInputBuilder {
1085 fn with_primary_key_mapper(mut self, mapper: Arc<PrimaryKeyRangeMapper>) -> Self {
1086 self.input.primary_key_mapper = OnceLock::from(mapper);
1087 self
1088 }
1089
1090 #[must_use]
1092 pub(crate) fn with_ignore_range_index(mut self, ignore: bool) -> Self {
1093 self.input.ignore_range_index = ignore;
1094 self
1095 }
1096
1097 #[must_use]
1099 pub(crate) fn with_series_index(
1100 mut self,
1101 series_index: Option<SeriesIndexReadContext>,
1102 ) -> Self {
1103 self.input.series_index = series_index;
1104 self
1105 }
1106
1107 #[must_use]
1109 pub(crate) fn with_time_range(mut self, time_range: Option<TimestampRange>) -> Self {
1110 self.input.time_range = time_range;
1111 self
1112 }
1113
1114 #[must_use]
1116 pub(crate) fn with_predicate(mut self, predicate: PredicateGroup) -> Self {
1117 self.input.region_partition_expr = predicate.region_partition_expr().cloned();
1118 self.input.predicate = predicate;
1119 self
1120 }
1121
1122 #[must_use]
1124 pub(crate) fn build(mut self) -> ScanInput {
1125 if self.input.compaction {
1126 self.input.scan_memory_tracker = None;
1127 }
1128 let input = &self.input;
1129 let eligible = !input.compaction
1130 && !input.files.is_empty()
1131 && matches!(input.cache_strategy, CacheStrategy::EnableAll(_));
1132
1133 let metadata = input.region_metadata();
1134 let tag_names: HashSet<&str> = metadata
1135 .column_metadatas
1136 .iter()
1137 .filter(|col| col.semantic_type == SemanticType::Tag)
1138 .map(|col| col.column_schema.name.as_str())
1139 .collect();
1140
1141 let time_index = metadata.time_index_column();
1142 let time_index_name = time_index.column_schema.name.clone();
1143 let ts_col_unit = time_index
1144 .column_schema
1145 .data_type
1146 .as_timestamp()
1147 .expect("Time index must have timestamp-compatible type")
1148 .unit();
1149
1150 let exprs = input
1151 .predicate_group()
1152 .predicate_without_region()
1153 .map(|predicate| predicate.exprs())
1154 .unwrap_or_default();
1155
1156 let mut filters = Vec::new();
1157 let mut time_only_exprs: Vec<&Expr> = Vec::new();
1158 let mut has_tag_filter = false;
1159 let mut columns = HashSet::new();
1160
1161 for expr in exprs {
1162 columns.clear();
1163 let is_time_only = match expr_to_columns(expr, &mut columns) {
1164 Ok(()) if !columns.is_empty() => {
1165 has_tag_filter |= columns
1166 .iter()
1167 .any(|col| tag_names.contains(col.name.as_str()));
1168 columns.iter().all(|col| col.name == time_index_name)
1169 }
1170 _ => false,
1171 };
1172
1173 if is_time_only
1181 && extract_time_range_from_expr(&time_index_name, ts_col_unit, expr).is_some()
1182 {
1183 time_only_exprs.push(expr);
1184 } else {
1185 filters.push(expr.to_string());
1186 }
1187 }
1188
1189 let implied_time_range =
1190 implied_time_range_from_exprs(&time_index_name, ts_col_unit, &time_only_exprs);
1191
1192 let fingerprint = if eligible && has_tag_filter {
1194 let mut time_filters: Vec<String> =
1195 time_only_exprs.iter().map(|e| e.to_string()).collect();
1196
1197 filters.sort_unstable();
1199 time_filters.sort_unstable();
1200 let read_columns = input.read_cols.clone();
1201 let fingerprint = crate::read::range_cache::ScanRequestFingerprintBuilder {
1202 read_column_types: read_columns
1203 .column_ids_iter()
1204 .map(|id| {
1205 read_columns
1206 .json_target_type(id)
1207 .cloned()
1208 .map(ConcreteDataType::json2)
1209 .or_else(|| {
1210 metadata
1211 .column_by_id(id)
1212 .map(|col| col.column_schema.data_type.clone())
1213 })
1214 })
1215 .collect(),
1216 read_columns,
1217 filters,
1218 time_filters,
1219 series_row_selector: input.series_row_selector,
1220 append_mode: input.append_mode,
1221 filter_deleted: input.filter_deleted,
1222 merge_mode: input.merge_mode,
1223 sequence_range: input.sequence_range,
1224 partition_expr_version: metadata.partition_expr_version,
1225 }
1226 .build();
1227 Some(fingerprint)
1228 } else {
1229 None
1230 };
1231
1232 self.input.scan_analysis = Some(ScanAnalysis {
1233 fingerprint,
1234 implied_time_range,
1235 });
1236 self.input
1237 }
1238
1239 #[must_use]
1241 pub(crate) fn with_memtables(mut self, memtables: Vec<MemRangeBuilder>) -> Self {
1242 self.input.memtables = memtables;
1243 self
1244 }
1245
1246 #[must_use]
1248 pub(crate) fn with_files(mut self, files: Vec<FileHandle>) -> Self {
1249 self.input.files = files;
1250 self
1251 }
1252
1253 #[must_use]
1255 pub(crate) fn with_batch_size(mut self, batch_size: usize) -> Self {
1256 self.input.batch_size = batch_size;
1257 self
1258 }
1259
1260 #[must_use]
1262 pub(crate) fn with_cache(mut self, cache: CacheStrategy) -> Self {
1263 self.input.cache_strategy = cache;
1264 self
1265 }
1266
1267 #[must_use]
1269 pub(crate) fn with_ignore_file_not_found(mut self, ignore: bool) -> Self {
1270 self.input.ignore_file_not_found = ignore;
1271 self
1272 }
1273
1274 #[must_use]
1276 pub(crate) fn with_max_concurrent_scan_files(
1277 mut self,
1278 max_concurrent_scan_files: usize,
1279 ) -> Self {
1280 self.input.max_concurrent_scan_files = max_concurrent_scan_files;
1281 self
1282 }
1283
1284 pub(crate) fn with_scan_memory_tracker(mut self, tracker: Option<QueryMemoryTracker>) -> Self {
1285 self.input.scan_memory_tracker = tracker;
1286 self
1287 }
1288
1289 #[must_use]
1291 pub(crate) fn with_inverted_index_appliers(
1292 mut self,
1293 appliers: [Option<InvertedIndexApplierRef>; 2],
1294 ) -> Self {
1295 self.input.inverted_index_appliers = appliers;
1296 self
1297 }
1298
1299 #[must_use]
1301 pub(crate) fn with_bloom_filter_index_appliers(
1302 mut self,
1303 appliers: [Option<BloomFilterIndexApplierRef>; 2],
1304 ) -> Self {
1305 self.input.bloom_filter_index_appliers = appliers;
1306 self
1307 }
1308
1309 #[must_use]
1311 pub(crate) fn with_fulltext_index_appliers(
1312 mut self,
1313 appliers: [Option<FulltextIndexApplierRef>; 2],
1314 ) -> Self {
1315 self.input.fulltext_index_appliers = appliers;
1316 self
1317 }
1318
1319 #[must_use]
1321 pub(crate) fn with_start_time(mut self, now: Option<Instant>) -> Self {
1322 self.input.query_start = now;
1323 self
1324 }
1325
1326 #[must_use]
1327 pub(crate) fn with_append_mode(mut self, is_append_mode: bool) -> Self {
1328 self.input.append_mode = is_append_mode;
1329 self
1330 }
1331
1332 pub(crate) fn with_query_stat_counters(
1333 mut self,
1334 counters: Option<RegionQueryStatCounters>,
1335 ) -> Self {
1336 self.input.query_stat_counters = counters;
1337 self
1338 }
1339
1340 #[must_use]
1342 pub(crate) fn with_filter_deleted(mut self, filter_deleted: bool) -> Self {
1343 self.input.filter_deleted = filter_deleted;
1344 self
1345 }
1346
1347 #[must_use]
1349 pub(crate) fn with_merge_mode(mut self, merge_mode: MergeMode) -> Self {
1350 self.input.merge_mode = merge_mode;
1351 self
1352 }
1353
1354 #[must_use]
1356 pub(crate) fn with_distribution(
1357 mut self,
1358 distribution: Option<TimeSeriesDistribution>,
1359 ) -> Self {
1360 self.input.distribution = distribution;
1361 self
1362 }
1363
1364 #[must_use]
1366 pub(crate) fn with_explain_flat_format(mut self, explain_flat_format: bool) -> Self {
1367 self.input.explain_flat_format = explain_flat_format;
1368 self
1369 }
1370
1371 #[must_use]
1373 pub(crate) fn with_series_row_selector(
1374 mut self,
1375 series_row_selector: Option<TimeSeriesRowSelector>,
1376 ) -> Self {
1377 self.input.series_row_selector = series_row_selector;
1378 self
1379 }
1380
1381 #[must_use]
1382 pub(crate) fn with_snapshot_sequence(
1383 mut self,
1384 snapshot_sequence: Option<SequenceNumber>,
1385 ) -> Self {
1386 self.input.snapshot_sequence = snapshot_sequence;
1387 self
1388 }
1389
1390 #[must_use]
1391 pub(crate) fn with_sequence_range(mut self, sequence_range: Option<SequenceRange>) -> Self {
1392 self.input.sequence_range = sequence_range;
1393 self
1394 }
1395
1396 #[must_use]
1398 pub(crate) fn with_compaction(mut self, compaction: bool) -> Self {
1399 self.input.compaction = compaction;
1400 self
1401 }
1402
1403 #[must_use]
1405 pub(crate) fn with_compaction_read_parallelism(mut self, parallelism: usize) -> Self {
1406 self.input.compaction_read_parallelism = parallelism;
1407 self
1408 }
1409
1410 #[must_use]
1412 pub(crate) fn with_json2_rewrite_targets(mut self, targets: Json2RewriteTargets) -> Self {
1413 self.input.json2_rewrite_targets = targets;
1414 self
1415 }
1416
1417 #[cfg(feature = "enterprise")]
1418 #[must_use]
1419 pub(crate) fn with_extension_ranges(
1420 mut self,
1421 extension_ranges: Vec<BoxedExtensionRange>,
1422 ) -> Self {
1423 self.input.extension_ranges = extension_ranges;
1424 self
1425 }
1426}
1427
1428impl ScanInput {
1429 pub(crate) fn uses_scan_memory_limit(&self) -> bool {
1430 let covered = self
1431 .scan_memory_tracker
1432 .as_ref()
1433 .is_some_and(|tracker| tracker.limit() > 0);
1434 #[cfg(feature = "enterprise")]
1435 let covered = covered && self.extension_ranges.is_empty();
1436 covered
1437 }
1438
1439 pub(crate) fn build_mem_ranges(&self, index: RowGroupIndex) -> SmallVec<[MemtableRange; 2]> {
1441 let memtable = &self.memtables[index.index];
1442 let mut ranges = SmallVec::new();
1443 memtable.build_ranges(index.row_group_index, &mut ranges);
1444 ranges
1445 }
1446
1447 pub(crate) fn predicate_for_file(&self, file: &FileHandle) -> Option<Predicate> {
1448 if self.should_skip_region_partition(file) {
1449 self.predicate.predicate_without_region().cloned()
1450 } else {
1451 self.predicate.predicate().cloned()
1452 }
1453 }
1454
1455 fn should_skip_region_partition(&self, file: &FileHandle) -> bool {
1456 match (
1457 self.region_partition_expr.as_ref(),
1458 file.meta_ref().partition_expr.as_ref(),
1459 ) {
1460 (Some(region_expr), Some(file_expr)) => region_expr == file_expr,
1461 _ => false,
1462 }
1463 }
1464
1465 fn try_file_level_pruning_stats(&self, file: &FileHandle) -> Option<FileLevelPruningStats> {
1470 let (ts_min, ts_max) = file.time_range();
1471 let time_index = self.mapper.metadata().time_index_column();
1472 let time_index_unit = time_index.column_schema.data_type.as_timestamp()?.unit();
1473
1474 let min_ts = ts_min.convert_to(time_index_unit)?;
1477 let max_ts = ts_max.convert_to_ceil(time_index_unit)?;
1478
1479 Some(FileLevelPruningStats {
1480 min_scalar: timestamp_to_scalar_value(time_index_unit, Some(min_ts.value())),
1481 max_scalar: timestamp_to_scalar_value(time_index_unit, Some(max_ts.value())),
1482 time_index_col_name: time_index.column_schema.name.clone(),
1483 })
1484 }
1485
1486 #[inline]
1491 pub(crate) fn can_manifest_prune_file(&self, file: &FileHandle) -> bool {
1492 let predicate = self.predicate_for_file(file);
1493 self.manifest_prunes_file(file, predicate.as_ref())
1494 }
1495
1496 fn manifest_prunes_file(&self, file: &FileHandle, predicate: Option<&Predicate>) -> bool {
1497 if let Some(pred) = predicate
1498 && !pred.is_empty()
1499 && let Some(file_level_stats) = self.try_file_level_pruning_stats(file)
1500 {
1501 let pruning_results = pred.prune_with_stats(
1502 &file_level_stats,
1503 self.mapper.metadata().schema.arrow_schema(),
1504 );
1505 pruning_results.first() == Some(&false)
1506 } else {
1507 false
1508 }
1509 }
1510
1511 #[tracing::instrument(
1516 skip_all,
1517 fields(
1518 region_id = %self.region_metadata().region_id,
1519 file_id = %file.file_id()
1520 )
1521 )]
1522 pub async fn prune_file(
1523 &self,
1524 file: &FileHandle,
1525 pre_filter_mode: PreFilterMode,
1526 reader_metrics: &mut ReaderMetrics,
1527 ) -> Result<FileRangeBuilder> {
1528 let predicate = self.predicate_for_file(file);
1529
1530 if self.manifest_prunes_file(file, predicate.as_ref()) {
1532 reader_metrics.filter_metrics.files_time_range_pruned += 1;
1533 return Ok(FileRangeBuilder::default());
1534 }
1535
1536 self.prune_file_after_manifest_check(file, pre_filter_mode, true, predicate, reader_metrics)
1537 .await
1538 }
1539
1540 pub(crate) async fn prune_file_after_manifest_check(
1548 &self,
1549 file: &FileHandle,
1550 pre_filter_mode: PreFilterMode,
1551 enable_predicate_prefilter: bool,
1552 predicate: Option<Predicate>,
1553 reader_metrics: &mut ReaderMetrics,
1554 ) -> Result<FileRangeBuilder> {
1555 let may_build_selective_row_selection = predicate.is_some();
1556 let postpone_time_index_filter = time_range_covers_file(self.implied_time_range(), file);
1557 let decode_pk_values = !self.compaction
1558 && self
1559 .mapper
1560 .read_columns()
1561 .column_ids_iter()
1562 .any(|column_id| self.mapper.metadata().primary_key.contains(&column_id));
1563 let reader = self
1564 .access_layer
1565 .read_sst(file.clone())
1566 .series_index(
1567 self.series_index
1568 .clone()
1569 .filter(|_| !self.ignore_range_index),
1570 )
1571 .memory_tracker(self.scan_memory_tracker.clone())
1572 .predicate(predicate)
1573 .projection(Some(self.read_cols.clone()))
1574 .json2_rewrite_targets(self.json2_rewrite_targets.clone())
1575 .cache(self.cache_strategy.clone())
1576 .inverted_index_appliers(self.inverted_index_appliers.clone())
1577 .bloom_filter_index_appliers(self.bloom_filter_index_appliers.clone())
1578 .fulltext_index_appliers(self.fulltext_index_appliers.clone());
1579 let reader = reader.batch_size(self.batch_size);
1580 let reader = if !self.compaction && may_build_selective_row_selection {
1581 reader.deferred_optional_page_index()
1582 } else {
1583 reader
1584 };
1585 let res = reader
1586 .expected_metadata(Some(self.mapper.metadata().clone()))
1587 .compaction(self.compaction)
1588 .pre_filter_mode(pre_filter_mode)
1589 .enable_predicate_prefilter(enable_predicate_prefilter)
1590 .postpone_time_index_filter(postpone_time_index_filter)
1591 .decode_primary_key_values(decode_pk_values)
1592 .build_reader_input(reader_metrics)
1593 .await;
1594 let read_input = match res {
1595 Ok(x) => x,
1596 Err(e) => {
1597 if e.is_object_not_found() && self.ignore_file_not_found {
1598 error!(e; "File to scan does not exist, region_id: {}, file: {}", file.region_id(), file.file_id());
1599 return Ok(FileRangeBuilder::default());
1600 } else {
1601 return Err(e);
1602 }
1603 }
1604 };
1605
1606 let Some((mut file_range_ctx, selection)) = read_input else {
1607 return Ok(FileRangeBuilder::default());
1608 };
1609
1610 let need_compat = !compat::has_same_columns_and_pk_encoding(
1611 &self.mapper,
1612 file_range_ctx.read_format(),
1613 self.compaction,
1614 );
1615 if need_compat {
1616 let compat = FlatCompatBatch::try_new(
1619 &self.mapper,
1620 file_range_ctx.read_format(),
1621 self.compaction,
1622 )?;
1623 file_range_ctx.set_compat_batch(compat);
1624 }
1625 Ok(FileRangeBuilder::new(Arc::new(file_range_ctx), selection))
1626 }
1627
1628 #[tracing::instrument(
1632 skip(self, sources, semaphore),
1633 fields(
1634 region_id = %self.region_metadata().region_id,
1635 source_count = sources.len()
1636 )
1637 )]
1638 pub(crate) fn create_parallel_flat_sources(
1639 &self,
1640 sources: Vec<BoxedRecordBatchStream>,
1641 semaphore: Arc<Semaphore>,
1642 channel_size: usize,
1643 ) -> Result<Vec<BoxedRecordBatchStream>> {
1644 if sources.len() <= 1 {
1645 return Ok(sources);
1646 }
1647
1648 let sources = sources
1650 .into_iter()
1651 .map(|source| {
1652 let (sender, receiver) = mpsc::channel(channel_size);
1653 self.spawn_flat_scan_task(source, semaphore.clone(), sender);
1654 let stream = Box::pin(ReceiverStream::new(receiver));
1655 Box::pin(stream) as _
1656 })
1657 .collect();
1658 Ok(sources)
1659 }
1660
1661 #[tracing::instrument(
1663 skip(self, input, semaphore, sender),
1664 fields(region_id = %self.region_metadata().region_id)
1665 )]
1666 pub(crate) fn spawn_flat_scan_task(
1667 &self,
1668 mut input: BoxedRecordBatchStream,
1669 semaphore: Arc<Semaphore>,
1670 sender: mpsc::Sender<Result<RecordBatch>>,
1671 ) {
1672 let region_id = self.region_metadata().region_id;
1673 let span = tracing::info_span!(
1674 "ScanInput::parallel_scan_task",
1675 region_id = %region_id,
1676 stream_kind = "flat"
1677 );
1678 common_runtime::spawn_query(
1679 async move {
1680 loop {
1681 let maybe_batch = {
1684 tokio::select! {
1685 _ = sender.closed() => break,
1689 batch = async {
1690 let _permit = semaphore.acquire().await.unwrap();
1692 input.next().await
1693 } => batch,
1694 }
1695 };
1696 match maybe_batch {
1697 Some(Ok(batch)) => {
1698 if let Err(e) = sender.send(Ok(batch)).await {
1701 debug!(
1702 "Stop parallel scan task, receiver dropped, region_id: {}, error: {}",
1703 region_id, e
1704 );
1705 break;
1706 }
1707 }
1708 Some(Err(e)) => {
1709 let _ = sender.send(Err(e)).await;
1710 break;
1711 }
1712 None => break,
1713 }
1714 }
1715 }
1716 .instrument(span),
1717 );
1718 }
1719
1720 pub(crate) fn total_rows_is_exact(&self) -> bool {
1723 if self.files.iter().any(|file| file.num_rows() == 0) {
1725 return false;
1726 }
1727
1728 if self.region_partition_expr.is_none() {
1729 return true;
1730 }
1731
1732 #[cfg(feature = "enterprise")]
1734 if !self.extension_ranges.is_empty() {
1735 return false;
1736 }
1737
1738 self.files
1742 .iter()
1743 .all(|file| self.should_skip_region_partition(file))
1744 }
1745
1746 pub(crate) fn total_rows(&self) -> usize {
1747 let rows_in_files: usize = self.files.iter().map(|f| f.num_rows()).sum();
1748 let rows_in_memtables: usize = self.memtables.iter().map(|m| m.stats().num_rows()).sum();
1749
1750 let rows = rows_in_files + rows_in_memtables;
1751 #[cfg(feature = "enterprise")]
1752 let rows = rows
1753 + self
1754 .extension_ranges
1755 .iter()
1756 .map(|x| x.num_rows())
1757 .sum::<u64>() as usize;
1758 rows
1759 }
1760
1761 pub(crate) fn predicate_group(&self) -> &PredicateGroup {
1762 &self.predicate
1763 }
1764
1765 pub(crate) fn num_memtables(&self) -> usize {
1767 self.memtables.len()
1768 }
1769
1770 pub(crate) fn num_files(&self) -> usize {
1772 self.files.len()
1773 }
1774
1775 pub(crate) fn file_from_index(&self, index: RowGroupIndex) -> &FileHandle {
1777 let file_index = index.index - self.num_memtables();
1778 &self.files[file_index]
1779 }
1780
1781 pub fn region_metadata(&self) -> &RegionMetadataRef {
1782 self.mapper.metadata()
1783 }
1784
1785 fn range_pre_filter_mode(&self, source_count: usize) -> PreFilterMode {
1786 if source_count <= 1 {
1787 return PreFilterMode::All;
1792 }
1793
1794 pre_filter_mode(self.append_mode, self.merge_mode)
1795 }
1796}
1797
1798#[cfg(feature = "enterprise")]
1799impl ScanInput {
1800 #[cfg(feature = "enterprise")]
1801 pub(crate) fn extension_ranges(&self) -> &[BoxedExtensionRange] {
1802 &self.extension_ranges
1803 }
1804
1805 #[cfg(feature = "enterprise")]
1807 pub(crate) fn extension_range(&self, i: usize) -> &BoxedExtensionRange {
1808 &self.extension_ranges[i - self.num_memtables() - self.num_files()]
1809 }
1810}
1811
1812pub(crate) struct FileLevelPruningStats {
1816 pub(crate) min_scalar: ScalarValue,
1818 pub(crate) max_scalar: ScalarValue,
1820 pub(crate) time_index_col_name: String,
1822}
1823
1824impl PruningStatistics for FileLevelPruningStats {
1825 fn min_values(&self, column: &Column) -> Option<ArrayRef> {
1826 if column.name == self.time_index_col_name {
1827 ScalarValue::iter_to_array(std::iter::once(self.min_scalar.clone())).ok()
1828 } else {
1829 None
1830 }
1831 }
1832
1833 fn max_values(&self, column: &Column) -> Option<ArrayRef> {
1834 if column.name == self.time_index_col_name {
1835 ScalarValue::iter_to_array(std::iter::once(self.max_scalar.clone())).ok()
1836 } else {
1837 None
1838 }
1839 }
1840
1841 fn num_containers(&self) -> usize {
1842 1
1843 }
1844
1845 fn null_counts(&self, column: &Column) -> Option<ArrayRef> {
1846 if column.name == self.time_index_col_name {
1847 Some(Arc::new(UInt64Array::from(vec![0u64])))
1849 } else {
1850 None
1851 }
1852 }
1853
1854 fn row_counts(&self) -> Option<ArrayRef> {
1855 None
1856 }
1857
1858 fn contained(&self, _column: &Column, _values: &HashSet<ScalarValue>) -> Option<BooleanArray> {
1859 None
1860 }
1861}
1862
1863#[cfg(test)]
1864impl ScanInput {
1865 pub(crate) fn file_ids(&self) -> Vec<crate::sst::file::RegionFileId> {
1867 self.files.iter().map(|file| file.file_id()).collect()
1868 }
1869
1870 pub(crate) fn index_ids(&self) -> Vec<crate::sst::file::RegionIndexId> {
1871 self.files.iter().map(|file| file.index_id()).collect()
1872 }
1873}
1874
1875fn pre_filter_mode(append_mode: bool, merge_mode: MergeMode) -> PreFilterMode {
1876 if append_mode {
1877 return PreFilterMode::All;
1878 }
1879
1880 match merge_mode {
1881 MergeMode::LastRow => PreFilterMode::SkipFields,
1882 MergeMode::LastNonNull => PreFilterMode::SkipFields,
1883 }
1884}
1885
1886pub(crate) fn exact_sequence_range(
1906 request: &ScanRequest,
1907 version: &crate::region::version::Version,
1908) -> Result<(Vec<FileHandle>, Option<SequenceRange>)> {
1909 if request.skip_sst_files {
1910 return Ok((Vec::new(), None));
1911 }
1912
1913 let time_index = version.metadata.time_index_column();
1914 let unit = time_index
1915 .column_schema
1916 .data_type
1917 .as_timestamp()
1918 .expect("Time index must have timestamp-compatible type")
1919 .unit();
1920 let time_range =
1921 build_time_range_predicate(&time_index.column_schema.name, unit, &request.filters);
1922 let min = request.memtable_min_sequence;
1923 let mut check_capability = request.exact_sequence_range && min.is_some();
1924 let sst_min_sequence = request.sst_min_sequence.and_then(NonZeroU64::new);
1925 let mut files = Vec::new();
1926 let mut files_allow_exact_range = true;
1927
1928 for file in version
1929 .ssts
1930 .levels()
1931 .iter()
1932 .flat_map(|level| level.files.values())
1933 .filter(|file| file_in_range(file, &time_range))
1934 {
1935 let meta = file.meta_ref();
1936 let selected = (!request.exact_sequence_range
1937 || min.is_none_or(|min| meta.sequence.is_none_or(|sequence| sequence.get() > min)))
1938 && match (sst_min_sequence, meta.sequence) {
1939 (Some(min_sequence), Some(file_sequence)) => file_sequence > min_sequence,
1940 (Some(_), None) | (None, _) => true,
1943 };
1944 if !selected {
1945 continue;
1946 }
1947
1948 if let Some(min) = min
1949 && check_capability
1950 {
1951 if meta.region_id != version.metadata.region_id && meta.sequence.is_none() {
1952 return RegionSequenceDomainBrokenSnafu {
1953 region_id: version.metadata.region_id,
1954 file_region_id: meta.region_id,
1955 file_id: meta.file_id,
1956 }
1957 .fail();
1958 }
1959 if meta.region_id == version.metadata.region_id
1960 && !file.is_effective_target_sequence_trusted(version.metadata.region_id)
1961 && meta.sequence.is_none_or(|barrier| barrier.get() > min)
1962 {
1963 files_allow_exact_range = false;
1967 check_capability = false;
1968 }
1969 }
1970 files.push(file.clone());
1971 }
1972
1973 let sequence_range = match (
1974 request.exact_sequence_range,
1975 min,
1976 version.options.preserve_row_sequence,
1977 request.memtable_max_sequence,
1978 files_allow_exact_range,
1979 ) {
1980 (true, Some(min), true, Some(max), true) => Some(SequenceRange::GtLtEq { min, max }),
1981 _ => None,
1982 };
1983 Ok((files, sequence_range))
1984}
1985
1986#[derive(Default, serde::Serialize)]
1989struct FileSummary {
1990 files: usize,
1991 rows: u64,
1992 row_groups: u64,
1993 size: u64,
1994 index_size: u64,
1995}
1996
1997impl FileSummary {
1998 fn new<'a>(files: impl IntoIterator<Item = &'a FileHandle>) -> Self {
1999 let mut summary = Self::default();
2000 for file in files {
2001 summary.files += 1;
2002 summary.rows += file.meta_ref().num_rows;
2003 summary.row_groups += file.meta_ref().num_row_groups;
2004 summary.size += file.size();
2005 summary.index_size += file.index_size();
2006 }
2007 summary
2008 }
2009}
2010
2011struct ExplainString<'a>(&'a str);
2014
2015impl fmt::Debug for ExplainString<'_> {
2016 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2017 f.write_str(&serde_json::to_string(self.0).map_err(|_| fmt::Error)?)
2018 }
2019}
2020
2021pub struct StreamContext {
2024 pub input: ScanInput,
2026 pub(crate) ranges: Vec<RangeMeta>,
2028 pub(crate) query_start: Instant,
2031}
2032
2033impl StreamContext {
2034 pub(crate) fn seq_scan_ctx(input: ScanInput) -> Self {
2036 let query_start = input.query_start.unwrap_or_else(Instant::now);
2037 let ranges = RangeMeta::seq_scan_ranges(&input);
2038 READ_SST_COUNT.observe(input.num_files() as f64);
2039 Self {
2040 input,
2041 ranges,
2042 query_start,
2043 }
2044 }
2045
2046 pub(crate) fn unordered_scan_ctx(
2048 input: ScanInput,
2049 ranges: Vec<RangeMeta>,
2050 query_start: Instant,
2051 ) -> Self {
2052 READ_SST_COUNT.observe(input.num_files() as f64);
2053 Self {
2054 input,
2055 ranges,
2056 query_start,
2057 }
2058 }
2059
2060 pub(crate) fn is_mem_range_index(&self, index: RowGroupIndex) -> bool {
2062 self.input.num_memtables() > index.index
2063 }
2064
2065 pub(crate) fn is_file_range_index(&self, index: RowGroupIndex) -> bool {
2066 !self.is_mem_range_index(index)
2067 && index.index < self.input.num_files() + self.input.num_memtables()
2068 }
2069
2070 pub(crate) fn range_pre_filter_mode(&self, part_range: &PartitionRange) -> PreFilterMode {
2071 let range_meta = &self.ranges[part_range.identifier];
2072 let source_count = range_meta.indices.len();
2073
2074 self.input.range_pre_filter_mode(source_count)
2075 }
2076
2077 pub(crate) fn partition_ranges(&self) -> Vec<PartitionRange> {
2079 self.ranges
2080 .iter()
2081 .enumerate()
2082 .map(|(idx, range_meta)| range_meta.new_partition_range(idx))
2083 .collect()
2084 }
2085
2086 pub(crate) fn format_for_explain(&self, verbose: bool, f: &mut fmt::Formatter) -> fmt::Result {
2088 let (mut num_mem_ranges, mut num_file_ranges, mut num_other_ranges) = (0, 0, 0);
2089 for range_meta in &self.ranges {
2090 for idx in &range_meta.row_group_indices {
2091 if self.is_mem_range_index(*idx) {
2092 num_mem_ranges += 1;
2093 } else if self.is_file_range_index(*idx) {
2094 num_file_ranges += 1;
2095 } else {
2096 num_other_ranges += 1;
2097 }
2098 }
2099 }
2100 if verbose {
2101 write!(f, "{{")?;
2102 }
2103 write!(
2104 f,
2105 r#""partition_count":{{"count":{}, "mem_ranges":{}, "files":{}, "file_ranges":{}"#,
2106 self.ranges.len(),
2107 num_mem_ranges,
2108 self.input.num_files(),
2109 num_file_ranges,
2110 )?;
2111 if num_other_ranges > 0 {
2112 write!(f, r#", "other_ranges":{}"#, num_other_ranges)?;
2113 }
2114 write!(f, "}}")?;
2115
2116 if let Some(selector) = &self.input.series_row_selector {
2117 write!(f, ", \"selector\":\"{}\"", selector)?;
2118 }
2119 if let Some(distribution) = &self.input.distribution {
2120 write!(f, ", \"distribution\":\"{}\"", distribution)?;
2121 }
2122
2123 self.format_scan_details(f)?;
2124 if verbose {
2125 self.format_verbose_content(f)?;
2126 }
2127
2128 Ok(())
2129 }
2130
2131 fn format_scan_details(&self, f: &mut fmt::Formatter) -> fmt::Result {
2132 let output_schema = self.input.mapper.output_schema();
2133 if !output_schema.is_empty() {
2134 write!(f, ", \"projection\": ")?;
2135 f.debug_list()
2136 .entries(
2137 output_schema
2138 .column_schemas()
2139 .iter()
2140 .map(|col| ExplainString(&col.name)),
2141 )
2142 .finish()?;
2143 }
2144 if let Some(predicate) = self.input.predicate.predicate() {
2145 if !predicate.exprs().is_empty() {
2146 let exprs: Vec<_> = predicate.exprs().iter().map(|e| e.to_string()).collect();
2147 write!(f, ", \"filters\": ")?;
2148 f.debug_list()
2149 .entries(exprs.iter().map(|e| ExplainString(e)))
2150 .finish()?;
2151 }
2152 if !predicate.dyn_filters().is_empty() {
2153 let filters: Vec<_> = predicate
2154 .dyn_filters()
2155 .iter()
2156 .map(|filter| filter.to_string())
2157 .collect();
2158 write!(f, ", \"dyn_filters\": ")?;
2159 f.debug_list()
2160 .entries(filters.iter().map(|filter| ExplainString(filter)))
2161 .finish()?;
2162 }
2163 }
2164 if let Some(time_range) = &self.input.time_range {
2165 write!(
2166 f,
2167 ", \"time_range\": {:?}",
2168 ExplainString(&time_range.to_string())
2169 )?;
2170 }
2171 let summary = FileSummary::new(&self.input.files);
2172 write!(
2173 f,
2174 ", \"file_summary\": {}",
2175 serde_json::to_string(&summary).map_err(|_| fmt::Error)?
2176 )?;
2177
2178 let file_offset = self.input.num_memtables();
2181 let file_end = file_offset + self.input.num_files();
2182 let mut max_range = None;
2183 let mut max_files = 0;
2184 for range in &self.ranges {
2185 let files = range
2186 .indices
2187 .iter()
2188 .filter(|source| (file_offset..file_end).contains(&source.index))
2189 .count();
2190 if files > max_files {
2191 max_files = files;
2192 max_range = Some(range);
2193 }
2194 }
2195 if let Some(range) = max_range {
2196 let summary = FileSummary::new(range.indices.iter().filter_map(|source| {
2197 source
2198 .index
2199 .checked_sub(file_offset)
2200 .and_then(|index| self.input.files.get(index))
2201 }));
2202 let (start, end) = range.time_range;
2203 let summary = serde_json::json!({
2205 "time_range_start": format!("{}::{}", start.value(), start.unit()),
2206 "time_range_end": format!("{}::{}", end.value(), end.unit()),
2207 "files": summary.files,
2208 "rows": summary.rows,
2209 "row_groups": summary.row_groups,
2210 "size": summary.size,
2211 "index_size": summary.index_size,
2212 "estimated_rows": range.num_rows,
2213 });
2214 write!(f, ", \"max_part_range\": {summary}")?;
2215 }
2216 Ok(())
2217 }
2218
2219 fn format_verbose_content(&self, f: &mut fmt::Formatter) -> fmt::Result {
2220 struct FileWrapper<'a> {
2221 file: &'a FileHandle,
2222 }
2223
2224 impl fmt::Debug for FileWrapper<'_> {
2225 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2226 let (start, end) = self.file.time_range();
2227 write!(
2228 f,
2229 r#"{{"file_id":"{}","time_range_start":"{}::{}","time_range_end":"{}::{}","rows":{},"size":{},"index_size":{}}}"#,
2230 self.file.file_id(),
2231 start.value(),
2232 start.unit(),
2233 end.value(),
2234 end.unit(),
2235 self.file.num_rows(),
2236 self.file.size(),
2237 self.file.index_size()
2238 )
2239 }
2240 }
2241
2242 struct InputWrapper<'a> {
2243 input: &'a ScanInput,
2244 }
2245
2246 #[cfg(feature = "enterprise")]
2247 impl InputWrapper<'_> {
2248 fn format_extension_ranges(&self, f: &mut fmt::Formatter) -> fmt::Result {
2249 if self.input.extension_ranges.is_empty() {
2250 return Ok(());
2251 }
2252
2253 let mut delimiter = "";
2254 write!(f, ", extension_ranges: [")?;
2255 for range in self.input.extension_ranges() {
2256 write!(f, "{}{:?}", delimiter, range)?;
2257 delimiter = ", ";
2258 }
2259 write!(f, "]")?;
2260 Ok(())
2261 }
2262 }
2263
2264 impl fmt::Debug for InputWrapper<'_> {
2265 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2266 if !self.input.files.is_empty() {
2267 write!(f, ", \"files\": ")?;
2268 f.debug_list()
2269 .entries(self.input.files.iter().map(|file| FileWrapper { file }))
2270 .finish()?;
2271 }
2272 write!(f, ", \"flat_format\": {}", self.input.explain_flat_format)?;
2273 #[cfg(feature = "enterprise")]
2274 self.format_extension_ranges(f)?;
2275
2276 Ok(())
2277 }
2278 }
2279
2280 write!(f, "{:?}", InputWrapper { input: &self.input })
2281 }
2282
2283 pub(crate) fn add_dyn_filter_to_predicate(
2286 self: &Arc<Self>,
2287 filter_exprs: Vec<Arc<dyn datafusion::physical_plan::PhysicalExpr>>,
2288 ) -> Vec<bool> {
2289 let mut supported = Vec::with_capacity(filter_exprs.len());
2290 let filter_expr = filter_exprs
2291 .into_iter()
2292 .filter_map(|expr| {
2293 if let Ok(dyn_filter) = (expr as Arc<dyn std::any::Any + Send + Sync + 'static>)
2294 .downcast::<datafusion::physical_plan::expressions::DynamicFilterPhysicalExpr>()
2295 {
2296 supported.push(true);
2297 Some(dyn_filter)
2298 } else {
2299 supported.push(false);
2300 None
2301 }
2302 })
2303 .collect();
2304 self.input.predicate.add_dyn_filters(filter_expr);
2305 supported
2306 }
2307}
2308
2309#[derive(Clone, Default)]
2312pub struct PredicateGroup {
2313 time_filters: Option<Arc<Vec<SimpleFilterEvaluator>>>,
2314 predicate_all: Predicate,
2316 predicate_without_region: Predicate,
2318 region_partition_expr: Option<PartitionExpr>,
2320}
2321
2322impl PredicateGroup {
2323 pub fn new(metadata: &RegionMetadata, exprs: &[Expr]) -> Result<Self> {
2325 let mut combined_exprs = exprs.to_vec();
2326 let mut region_partition_expr = None;
2327
2328 if let Some(expr_json) = metadata.partition_expr.as_ref()
2329 && !expr_json.is_empty()
2330 && let Some(expr) = PartitionExpr::from_json_str(expr_json)
2331 .context(InvalidPartitionExprSnafu { expr: expr_json })?
2332 {
2333 let logical_expr = expr
2334 .try_as_logical_expr()
2335 .context(InvalidPartitionExprSnafu {
2336 expr: expr_json.clone(),
2337 })?;
2338
2339 let schema = metadata
2341 .schema
2342 .arrow_schema()
2343 .clone()
2344 .to_dfschema_ref()
2345 .context(EvalPartitionFilterSnafu)?;
2346 let simplifier = ExprSimplifier::new(
2347 SimplifyContext::builder()
2348 .with_schema(schema.clone())
2349 .build(),
2350 );
2351 let logical_expr = simplifier
2352 .coerce(logical_expr, &schema)
2353 .and_then(|expr| simplifier.simplify(expr))
2354 .context(EvalPartitionFilterSnafu)?;
2355 combined_exprs.push(logical_expr);
2356 region_partition_expr = Some(expr);
2357 }
2358
2359 let mut time_filters = Vec::with_capacity(combined_exprs.len());
2360 let mut columns = HashSet::new();
2362 for expr in &combined_exprs {
2363 columns.clear();
2364 let Some(filter) = Self::expr_to_filter(expr, metadata, &mut columns) else {
2365 continue;
2366 };
2367 time_filters.push(filter);
2368 }
2369 let time_filters = if time_filters.is_empty() {
2370 None
2371 } else {
2372 Some(Arc::new(time_filters))
2373 };
2374
2375 let predicate_all = Predicate::new(combined_exprs);
2376 let predicate_without_region = Predicate::new(exprs.to_vec());
2377
2378 Ok(Self {
2379 time_filters,
2380 predicate_all,
2381 predicate_without_region,
2382 region_partition_expr,
2383 })
2384 }
2385
2386 pub(crate) fn time_filters(&self) -> Option<Arc<Vec<SimpleFilterEvaluator>>> {
2388 self.time_filters.clone()
2389 }
2390
2391 pub(crate) fn predicate(&self) -> Option<&Predicate> {
2393 if self.predicate_all.is_empty() {
2394 None
2395 } else {
2396 Some(&self.predicate_all)
2397 }
2398 }
2399
2400 pub(crate) fn predicate_without_region(&self) -> Option<&Predicate> {
2402 if self.predicate_without_region.is_empty() {
2403 None
2404 } else {
2405 Some(&self.predicate_without_region)
2406 }
2407 }
2408
2409 pub(crate) fn add_dyn_filters(&self, dyn_filters: Vec<Arc<DynamicFilterPhysicalExpr>>) {
2411 self.predicate_all.add_dyn_filters(dyn_filters.clone());
2412 self.predicate_without_region.add_dyn_filters(dyn_filters);
2413 }
2414
2415 pub(crate) fn clear_dyn_filters(&self) {
2417 self.predicate_all.clear_dyn_filters();
2418 self.predicate_without_region.clear_dyn_filters();
2419 }
2420
2421 pub(crate) fn region_partition_expr(&self) -> Option<&PartitionExpr> {
2423 self.region_partition_expr.as_ref()
2424 }
2425
2426 fn expr_to_filter(
2427 expr: &Expr,
2428 metadata: &RegionMetadata,
2429 columns: &mut HashSet<Column>,
2430 ) -> Option<SimpleFilterEvaluator> {
2431 columns.clear();
2432 expr_to_columns(expr, columns).ok()?;
2435 if columns.len() > 1 {
2436 return None;
2438 }
2439 let column = columns.iter().next()?;
2440 let column_meta = metadata.column_by_name(&column.name)?;
2441 if column_meta.semantic_type == SemanticType::Timestamp {
2442 SimpleFilterEvaluator::try_new(expr)
2443 } else {
2444 None
2445 }
2446 }
2447}
2448
2449#[cfg(test)]
2450mod tests {
2451 use std::collections::BTreeMap;
2452 use std::sync::Arc;
2453
2454 use common_time::timestamp::{TimeUnit, Timestamp};
2455 use datafusion::physical_plan::expressions::{
2456 binary as physical_binary, col as physical_col, lit as physical_lit,
2457 };
2458 use datafusion_common::ScalarValue;
2459 use datafusion_expr::{Operator, col, lit};
2460 use datatypes::arrow::datatypes::{
2461 DataType as ArrowDataType, Field, Schema as ArrowSchema, TimeUnit as ArrowTimeUnit,
2462 };
2463 use datatypes::prelude::ConcreteDataType;
2464 use datatypes::schema::ColumnSchema;
2465 use datatypes::types::json_type::JsonObjectType;
2466 use datatypes::value::Value;
2467 use partition::expr::col as partition_col;
2468 use store_api::metadata::{ColumnMetadata, RegionMetadataBuilder};
2469 use store_api::storage::{RegionId, TimeSeriesDistribution, TimeSeriesRowSelector};
2470
2471 use super::*;
2472 use crate::cache::CacheManager;
2473 use crate::read::range_cache::ScanRequestFingerprintBuilder;
2474 use crate::sst::file::FileMeta;
2475 use crate::test_util::memtable_util::metadata_with_primary_key;
2476 use crate::test_util::scheduler_util::SchedulerEnv;
2477
2478 async fn new_scan_input(metadata: RegionMetadataRef, filters: Vec<Expr>) -> ScanInputBuilder {
2479 let env = SchedulerEnv::new().await;
2480 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2481 let predicate = PredicateGroup::new(metadata.as_ref(), &filters).unwrap();
2482 let file = FileHandle::new(
2483 crate::sst::file::FileMeta::default(),
2484 Arc::new(crate::sst::file_purger::NoopFilePurger),
2485 );
2486
2487 ScanInput::builder(env.access_layer.clone(), mapper)
2488 .with_predicate(predicate)
2489 .with_cache(CacheStrategy::EnableAll(Arc::new(
2490 CacheManager::builder()
2491 .range_result_cache_size(1024)
2492 .build(),
2493 )))
2494 .with_files(vec![file])
2495 }
2496
2497 #[test]
2498 fn test_partition_time_filter_after_unit_widening() {
2499 use datatypes::arrow::array::TimestampMicrosecondArray;
2500
2501 let bound = Value::Timestamp(Timestamp::new_millisecond(1));
2502 for (expr, expected) in [
2503 (
2504 partition_col("ts").lt(bound.clone()),
2505 vec![true, false, false],
2506 ),
2507 (partition_col("ts").gt_eq(bound), vec![false, true, true]),
2508 ] {
2509 let mut builder = RegionMetadataBuilder::new(RegionId::new(1, 1));
2510 builder.push_column_metadata(ColumnMetadata {
2511 column_schema: ColumnSchema::new(
2512 "ts",
2513 ConcreteDataType::timestamp_microsecond_datatype(),
2514 false,
2515 ),
2516 semantic_type: SemanticType::Timestamp,
2517 column_id: 0,
2518 });
2519 builder.primary_key(vec![]);
2520 builder.partition_expr_json(Some(expr.as_json_str().unwrap()));
2521 let metadata = builder.build().unwrap();
2522 let group = PredicateGroup::new(&metadata, &[]).unwrap();
2523 let filters = group.time_filters().unwrap();
2524 let input: ArrayRef = Arc::new(TimestampMicrosecondArray::from(vec![999, 1000, 1001]));
2525 assert_eq!(filters.len(), 1);
2526 assert_eq!(
2527 filters[0].evaluate_array(&input).unwrap(),
2528 datafusion_common::arrow::buffer::BooleanBuffer::from(expected),
2529 );
2530 }
2531 }
2532
2533 #[test]
2534 fn test_partition_time_filter_overflow_after_unit_widening() {
2535 let bound = Value::Timestamp(Timestamp::new_millisecond(32_503_680_000_000));
2537 let expr = partition_col("ts").lt(bound);
2538 let mut builder = RegionMetadataBuilder::new(RegionId::new(1, 1));
2539 builder.push_column_metadata(ColumnMetadata {
2540 column_schema: ColumnSchema::new(
2541 "ts",
2542 ConcreteDataType::timestamp_nanosecond_datatype(),
2543 false,
2544 ),
2545 semantic_type: SemanticType::Timestamp,
2546 column_id: 0,
2547 });
2548 builder.primary_key(vec![]);
2549 builder.partition_expr_json(Some(expr.as_json_str().unwrap()));
2550 let metadata = builder.build().unwrap();
2551
2552 let error = PredicateGroup::new(&metadata, &[])
2553 .err()
2554 .expect("an overflowing partition bound must fail scan construction");
2555 let crate::error::Error::EvalPartitionFilter { error, .. } = error else {
2556 panic!("unexpected error: {error:?}");
2557 };
2558 assert!(
2559 error
2560 .to_string()
2561 .contains("converted value exceeds the representable i64 range"),
2562 "{error}"
2563 );
2564 }
2565
2566 #[tokio::test]
2567 async fn test_total_rows_is_exact_with_legacy_file() {
2568 let file_meta = FileMeta {
2569 num_rows: 10,
2570 ..Default::default()
2571 };
2572 let mut json = serde_json::to_value(&file_meta).unwrap();
2573 json.as_object_mut().unwrap().remove("num_rows");
2574 let legacy_meta = serde_json::from_value::<FileMeta>(json).unwrap();
2575 assert_eq!(legacy_meta.num_rows, 0);
2576
2577 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2578 for (file_metas, expected_rows, exact) in [
2579 (vec![file_meta.clone()], 10, true),
2580 (vec![legacy_meta.clone()], 0, false),
2581 (vec![file_meta, legacy_meta], 10, false),
2582 ] {
2583 let files = file_metas
2584 .into_iter()
2585 .map(|meta| {
2586 FileHandle::new(meta, Arc::new(crate::sst::file_purger::NoopFilePurger))
2587 })
2588 .collect();
2589 let input = new_scan_input(metadata.clone(), vec![])
2590 .await
2591 .with_append_mode(true)
2592 .with_files(files)
2593 .build();
2594 assert_eq!(input.total_rows(), expected_rows);
2595 assert_eq!(input.total_rows_is_exact(), exact);
2596 }
2597 }
2598
2599 #[tokio::test]
2600 async fn test_total_rows_is_exact_after_partition_filter() {
2601 let expr = partition_col("k0").gt_eq(Value::String("foo".into()));
2602 let other = partition_col("k0").gt_eq(Value::String("bar".into()));
2603 for (region_expr, file_exprs, exact) in [
2604 (None, vec![None], true),
2605 (None, vec![Some(expr.clone())], true),
2606 (Some(expr.clone()), vec![], true),
2607 (Some(expr.clone()), vec![Some(expr.clone())], true),
2608 (Some(expr.clone()), vec![None], false),
2609 (Some(expr.clone()), vec![Some(other)], false),
2610 (Some(expr.clone()), vec![Some(expr), None], false),
2611 ] {
2612 let mut builder =
2613 RegionMetadataBuilder::from_existing(metadata_with_primary_key(vec![0, 1], false));
2614 builder.partition_expr_json(region_expr.map(|expr| expr.as_json_str().unwrap()));
2615 let metadata = Arc::new(builder.build_without_validation().unwrap());
2616 let files = file_exprs
2617 .into_iter()
2618 .map(|partition_expr| {
2619 FileHandle::new(
2620 FileMeta {
2621 num_rows: 1,
2622 partition_expr,
2623 ..Default::default()
2624 },
2625 Arc::new(crate::sst::file_purger::NoopFilePurger),
2626 )
2627 })
2628 .collect();
2629 let input = new_scan_input(metadata, vec![])
2630 .await
2631 .with_files(files)
2632 .build();
2633 assert_eq!(input.total_rows_is_exact(), exact);
2634 }
2635 }
2636
2637 fn ts_lit(val: i64) -> datafusion_expr::Expr {
2639 lit(ScalarValue::TimestampMillisecond(Some(val), None))
2640 }
2641
2642 fn metadata_with_time_index_unit(unit: TimeUnit) -> RegionMetadataRef {
2643 let mut builder = RegionMetadataBuilder::new(RegionId::new(123, 456));
2644 builder
2645 .push_column_metadata(ColumnMetadata {
2646 column_schema: ColumnSchema::new(
2647 "k0".to_string(),
2648 ConcreteDataType::string_datatype(),
2649 false,
2650 ),
2651 semantic_type: SemanticType::Tag,
2652 column_id: 0,
2653 })
2654 .push_column_metadata(ColumnMetadata {
2655 column_schema: ColumnSchema::new(
2656 "k1".to_string(),
2657 ConcreteDataType::uint32_datatype(),
2658 false,
2659 ),
2660 semantic_type: SemanticType::Tag,
2661 column_id: 1,
2662 })
2663 .push_column_metadata(ColumnMetadata {
2664 column_schema: ColumnSchema::new(
2665 "ts".to_string(),
2666 ConcreteDataType::timestamp_datatype(unit),
2667 false,
2668 ),
2669 semantic_type: SemanticType::Timestamp,
2670 column_id: 2,
2671 })
2672 .push_column_metadata(ColumnMetadata {
2673 column_schema: ColumnSchema::new(
2674 "v0".to_string(),
2675 ConcreteDataType::int64_datatype(),
2676 true,
2677 ),
2678 semantic_type: SemanticType::Field,
2679 column_id: 3,
2680 })
2681 .primary_key(vec![0, 1]);
2682
2683 Arc::new(builder.build().unwrap())
2684 }
2685
2686 fn file_handle_with_time_range(start: Timestamp, end: Timestamp) -> FileHandle {
2687 FileHandle::new(
2688 FileMeta {
2689 time_range: (start, end),
2690 ..Default::default()
2691 },
2692 Arc::new(crate::sst::file_purger::NoopFilePurger),
2693 )
2694 }
2695
2696 #[test]
2697 fn test_time_range_covers_file() {
2698 let file = file_handle_with_time_range(
2699 Timestamp::new_millisecond(1000),
2700 Timestamp::new_millisecond(2000),
2701 );
2702
2703 assert!(!time_range_covers_file(None, &file));
2704 assert!(time_range_covers_file(
2705 Some(&TimestampRange::min_to_max()),
2706 &file
2707 ));
2708 assert!(time_range_covers_file(
2709 Some(&TimestampRange::new_inclusive(
2710 Some(Timestamp::new_millisecond(1000)),
2711 Some(Timestamp::new_millisecond(2000)),
2712 )),
2713 &file
2714 ));
2715 assert!(time_range_covers_file(
2716 TimestampRange::with_unit(500, 3000, TimeUnit::Millisecond).as_ref(),
2717 &file
2718 ));
2719 assert!(!time_range_covers_file(
2720 TimestampRange::with_unit(1000, 2000, TimeUnit::Millisecond).as_ref(),
2721 &file
2722 ));
2723 assert!(!time_range_covers_file(
2724 TimestampRange::with_unit(1001, 3000, TimeUnit::Millisecond).as_ref(),
2725 &file
2726 ));
2727 assert!(!time_range_covers_file(
2728 Some(&TimestampRange::empty()),
2729 &file
2730 ));
2731
2732 let seconds_file = file_handle_with_time_range(
2733 Timestamp::new(1, TimeUnit::Second),
2734 Timestamp::new(2, TimeUnit::Second),
2735 );
2736 assert!(time_range_covers_file(
2737 TimestampRange::with_unit(1000, 2001, TimeUnit::Millisecond).as_ref(),
2738 &seconds_file
2739 ));
2740 }
2741
2742 #[tokio::test]
2743 async fn test_scan_input_builder_computes_scan_analysis() {
2744 let metadata = metadata_with_time_index_unit(TimeUnit::Millisecond);
2745 let env = SchedulerEnv::new().await;
2746 let file = file_handle_with_time_range(
2747 Timestamp::new_millisecond(1000),
2748 Timestamp::new_millisecond(2000),
2749 );
2750
2751 let make_input = |filters: &[Expr]| {
2752 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2753 ScanInput::builder(env.access_layer.clone(), mapper)
2754 .with_predicate(PredicateGroup::new(&metadata, filters).unwrap())
2755 .build()
2756 };
2757
2758 let covered = make_input(&[col("ts").gt_eq(ts_lit(500)), col("ts").lt(ts_lit(3000))]);
2759 assert!(time_range_covers_file(covered.implied_time_range(), &file));
2760
2761 let disjoint = make_input(&[col("ts").eq(ts_lit(1000)).or(col("ts").eq(ts_lit(2000)))]);
2764 assert!(disjoint.implied_time_range().is_none());
2765 assert!(!time_range_covers_file(
2766 disjoint.implied_time_range(),
2767 &file
2768 ));
2769
2770 let replaced = ScanInput::builder(
2771 env.access_layer.clone(),
2772 FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap(),
2773 )
2774 .with_predicate(PredicateGroup::new(&metadata, &[col("ts").gt(ts_lit(3000))]).unwrap())
2775 .build();
2776 assert!(!time_range_covers_file(
2777 replaced.implied_time_range(),
2778 &file
2779 ));
2780 }
2781
2782 #[tokio::test]
2783 async fn test_scan_input_uses_explicit_batch_size() {
2784 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2785 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2786 let env = SchedulerEnv::new().await;
2787 let input = ScanInput::builder(env.access_layer.clone(), mapper).build();
2788 assert_eq!(
2789 crate::sst::parquet::DEFAULT_READ_BATCH_SIZE,
2790 input.batch_size()
2791 );
2792
2793 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2794 let input = ScanInput::builder(env.access_layer.clone(), mapper)
2795 .with_compaction(true)
2796 .with_batch_size(256)
2797 .build();
2798 assert_eq!(256, input.batch_size());
2799
2800 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2801 let input = ScanInput::builder(env.access_layer.clone(), mapper)
2802 .with_batch_size(256)
2803 .with_compaction(true)
2804 .with_compaction(false)
2805 .build();
2806 assert_eq!(256, input.batch_size());
2807 }
2808
2809 #[tokio::test]
2810 async fn test_build_scan_fingerprint_for_eligible_scan() {
2811 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2812 let input = new_scan_input(
2813 metadata.clone(),
2814 vec![
2815 col("ts").gt_eq(ts_lit(1000)),
2816 col("k0").eq(lit("foo")),
2817 col("v0").gt(lit(1)),
2818 ],
2819 )
2820 .await
2821 .with_distribution(Some(TimeSeriesDistribution::PerSeries))
2822 .with_series_row_selector(Some(TimeSeriesRowSelector::LastRow { after_merge: true }))
2823 .with_merge_mode(MergeMode::LastNonNull)
2824 .with_filter_deleted(false)
2825 .build();
2826
2827 let fingerprint = input.scan_fingerprint().unwrap();
2828
2829 let expected = ScanRequestFingerprintBuilder {
2830 read_columns: input.read_cols.clone(),
2831 read_column_types: vec![
2832 metadata
2833 .column_by_id(0)
2834 .map(|col| col.column_schema.data_type.clone()),
2835 metadata
2836 .column_by_id(2)
2837 .map(|col| col.column_schema.data_type.clone()),
2838 metadata
2839 .column_by_id(3)
2840 .map(|col| col.column_schema.data_type.clone()),
2841 ],
2842 filters: vec![
2843 col("k0").eq(lit("foo")).to_string(),
2844 col("v0").gt(lit(1)).to_string(),
2845 ],
2846 time_filters: vec![col("ts").gt_eq(ts_lit(1000)).to_string()],
2847 series_row_selector: Some(TimeSeriesRowSelector::LastRow { after_merge: true }),
2848 append_mode: false,
2849 filter_deleted: false,
2850 merge_mode: MergeMode::LastNonNull,
2851 sequence_range: None,
2852 partition_expr_version: 0,
2853 }
2854 .build();
2855 assert_eq!(&expected, fingerprint);
2856 assert_eq!(
2857 input.series_row_selector,
2858 Some(TimeSeriesRowSelector::LastRow { after_merge: true })
2859 );
2860 }
2861
2862 #[tokio::test]
2863 async fn test_build_scan_fingerprint_requires_tag_filter() {
2864 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2865 let input = new_scan_input(
2866 metadata,
2867 vec![col("ts").gt_eq(lit(1000)), col("v0").gt(lit(1))],
2868 )
2869 .await
2870 .build();
2871
2872 assert!(input.scan_fingerprint().is_none());
2873 }
2874
2875 #[tokio::test]
2876 async fn test_build_scan_fingerprint_respects_scan_eligibility() {
2877 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2878 let filters = vec![col("k0").eq(lit("foo"))];
2879
2880 let disabled = ScanInput::builder(
2881 SchedulerEnv::new().await.access_layer.clone(),
2882 FlatProjectionMapper::new(&metadata, [0, 2, 3].into_iter()).unwrap(),
2883 )
2884 .with_predicate(PredicateGroup::new(metadata.as_ref(), &filters).unwrap())
2885 .build();
2886 assert!(disabled.scan_fingerprint().is_none());
2887
2888 let compaction = new_scan_input(metadata.clone(), filters.clone())
2889 .await
2890 .with_compaction(true)
2891 .build();
2892 assert!(compaction.scan_fingerprint().is_none());
2893
2894 let no_files = new_scan_input(metadata, filters)
2896 .await
2897 .with_files(vec![])
2898 .build();
2899 assert!(no_files.scan_fingerprint().is_none());
2900 }
2901
2902 #[tokio::test]
2903 async fn test_build_scan_fingerprint_tracks_schema_and_partition_expr_changes() {
2904 let base = metadata_with_primary_key(vec![0, 1], false);
2905 let mut builder = RegionMetadataBuilder::from_existing(base);
2906 let partition_expr = partition_col("k0")
2907 .gt_eq(Value::String("foo".into()))
2908 .as_json_str()
2909 .unwrap();
2910 builder.partition_expr_json(Some(partition_expr));
2911 let metadata = Arc::new(builder.build_without_validation().unwrap());
2912
2913 let input = new_scan_input(metadata.clone(), vec![col("k0").eq(lit("foo"))])
2914 .await
2915 .build();
2916 let fingerprint = input.scan_fingerprint().unwrap();
2917
2918 let expected = ScanRequestFingerprintBuilder {
2919 read_columns: input.read_cols.clone(),
2920 read_column_types: vec![
2921 metadata
2922 .column_by_id(0)
2923 .map(|col| col.column_schema.data_type.clone()),
2924 metadata
2925 .column_by_id(2)
2926 .map(|col| col.column_schema.data_type.clone()),
2927 metadata
2928 .column_by_id(3)
2929 .map(|col| col.column_schema.data_type.clone()),
2930 ],
2931 filters: vec![col("k0").eq(lit("foo")).to_string()],
2932 time_filters: vec![],
2933 series_row_selector: None,
2934 append_mode: false,
2935 filter_deleted: true,
2936 merge_mode: MergeMode::LastRow,
2937 sequence_range: None,
2938 partition_expr_version: metadata.partition_expr_version,
2939 }
2940 .build();
2941 assert_eq!(&expected, fingerprint);
2942 assert_ne!(0, metadata.partition_expr_version);
2943 }
2944
2945 #[tokio::test]
2946 async fn test_build_scan_fingerprint_uses_json_target_types() {
2947 let mut builder = RegionMetadataBuilder::new(RegionId::new(123, 456));
2948 builder
2949 .push_column_metadata(ColumnMetadata {
2950 column_schema: ColumnSchema::new(
2951 "k0".to_string(),
2952 ConcreteDataType::string_datatype(),
2953 false,
2954 ),
2955 semantic_type: SemanticType::Tag,
2956 column_id: 0,
2957 })
2958 .push_column_metadata(ColumnMetadata {
2959 column_schema: ColumnSchema::new(
2960 "ts".to_string(),
2961 ConcreteDataType::timestamp_millisecond_datatype(),
2962 false,
2963 ),
2964 semantic_type: SemanticType::Timestamp,
2965 column_id: 1,
2966 })
2967 .push_column_metadata(ColumnMetadata {
2968 column_schema: ColumnSchema::new(
2969 "j".to_string(),
2970 ConcreteDataType::json2(JsonNativeType::Variant),
2971 true,
2972 ),
2973 semantic_type: SemanticType::Field,
2974 column_id: 2,
2975 })
2976 .primary_key(vec![0]);
2977 let metadata = Arc::new(builder.build().unwrap());
2978
2979 let make_input = |target_type| async {
2980 let env = SchedulerEnv::new().await;
2981 let read_cols = ReadColumns::new([0, 1, 2])
2982 .with_json_target_types(BTreeMap::from([(2, target_type)]));
2983 let mapper =
2984 FlatProjectionMapper::new_with_read_columns(&metadata, vec![0, 1, 2], read_cols)
2985 .unwrap();
2986 let predicate =
2987 PredicateGroup::new(metadata.as_ref(), &[col("k0").eq(lit("foo"))]).unwrap();
2988 let file = FileHandle::new(
2989 FileMeta::default(),
2990 Arc::new(crate::sst::file_purger::NoopFilePurger),
2991 );
2992 ScanInput::builder(env.access_layer.clone(), mapper)
2993 .with_predicate(predicate)
2994 .with_cache(CacheStrategy::EnableAll(Arc::new(
2995 CacheManager::builder()
2996 .range_result_cache_size(1024)
2997 .build(),
2998 )))
2999 .with_files(vec![file])
3000 .build()
3001 };
3002
3003 let int_target = JsonNativeType::i64();
3004 let string_target = JsonNativeType::String;
3005 let int_input = make_input(int_target.clone()).await;
3006 let string_input = make_input(string_target).await;
3007 let int_fingerprint = int_input.scan_fingerprint().unwrap();
3008 let string_fingerprint = string_input.scan_fingerprint().unwrap();
3009
3010 assert_ne!(int_fingerprint, string_fingerprint);
3011 assert_eq!(
3012 Some(&Some(ConcreteDataType::json2(int_target))),
3013 int_fingerprint.read_column_types().get(2)
3014 );
3015 }
3016
3017 #[tokio::test]
3018 async fn test_scan_input_rejects_json_type_hint_for_non_json2_column() {
3019 let mut builder = RegionMetadataBuilder::new(RegionId::new(123, 456));
3020 builder
3021 .push_column_metadata(ColumnMetadata {
3022 column_schema: ColumnSchema::new(
3023 "k0".to_string(),
3024 ConcreteDataType::string_datatype(),
3025 false,
3026 ),
3027 semantic_type: SemanticType::Tag,
3028 column_id: 0,
3029 })
3030 .push_column_metadata(ColumnMetadata {
3031 column_schema: ColumnSchema::new(
3032 "ts".to_string(),
3033 ConcreteDataType::timestamp_millisecond_datatype(),
3034 false,
3035 ),
3036 semantic_type: SemanticType::Timestamp,
3037 column_id: 1,
3038 })
3039 .push_column_metadata(ColumnMetadata {
3040 column_schema: ColumnSchema::new(
3041 "j".to_string(),
3042 ConcreteDataType::json2(JsonNativeType::Object(JsonObjectType::from([(
3043 "a".to_string(),
3044 JsonNativeType::i64(),
3045 )]))),
3046 true,
3047 ),
3048 semantic_type: SemanticType::Field,
3049 column_id: 2,
3050 })
3051 .push_column_metadata(ColumnMetadata {
3052 column_schema: ColumnSchema::new(
3053 "v0".to_string(),
3054 ConcreteDataType::int64_datatype(),
3055 true,
3056 ),
3057 semantic_type: SemanticType::Field,
3058 column_id: 3,
3059 })
3060 .primary_key(vec![0]);
3061 let metadata = Arc::new(builder.build().unwrap());
3062 let mutable = crate::memtable::time_partition::TimePartitions::new(
3063 metadata.clone(),
3064 Arc::new(crate::test_util::memtable_util::EmptyMemtableBuilder::default()),
3065 0,
3066 None,
3067 );
3068 let version = Arc::new(
3069 crate::region::version::VersionBuilder::new(metadata.clone(), mutable).build(),
3070 );
3071 let env = SchedulerEnv::new().await;
3072 let request = ScanRequest {
3073 projection: Some(vec![0, 1, 2, 3]),
3074 json_type_hint: std::collections::HashMap::from([(
3075 "v0".to_string(),
3076 JsonNativeType::i64(),
3077 )]),
3078 ..Default::default()
3079 };
3080
3081 let err = ScanRegion::new(
3082 version,
3083 env.access_layer.clone(),
3084 request,
3085 CacheStrategy::Disabled,
3086 )
3087 .scan_input()
3088 .await;
3089 let Err(err) = err else {
3090 panic!("scan input should reject JSON type hint for non-JSON2 column");
3091 };
3092
3093 assert!(err.to_string().contains("non-JSON2 column v0"));
3094 }
3095
3096 #[test]
3097 fn test_update_dyn_filters_with_empty_base_predicates() {
3098 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3099 let predicate_group = PredicateGroup::new(metadata.as_ref(), &[]).unwrap();
3100 assert!(predicate_group.predicate().is_none());
3101 assert!(predicate_group.predicate_without_region().is_none());
3102
3103 let dyn_filter = Arc::new(DynamicFilterPhysicalExpr::new(vec![], physical_lit(false)));
3104 predicate_group.add_dyn_filters(vec![dyn_filter]);
3105
3106 let predicate_all = predicate_group.predicate().unwrap();
3107 assert!(predicate_all.exprs().is_empty());
3108 assert_eq!(1, predicate_all.dyn_filters().len());
3109
3110 let predicate_without_region = predicate_group.predicate_without_region().unwrap();
3111 assert!(predicate_without_region.exprs().is_empty());
3112 assert_eq!(1, predicate_without_region.dyn_filters().len());
3113 }
3114
3115 #[test]
3116 fn test_clear_dyn_filters_preserves_predicate_group_static_filters() {
3117 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3118 let static_filters = vec![col("k0").eq(lit("foo"))];
3119 let predicate_group = PredicateGroup::new(metadata.as_ref(), &static_filters).unwrap();
3120 let dynamic_filter = Arc::new(DynamicFilterPhysicalExpr::new(vec![], physical_lit(true)));
3121 predicate_group.add_dyn_filters(vec![dynamic_filter.clone()]);
3122
3123 predicate_group.clear_dyn_filters();
3124 dynamic_filter.update(physical_lit(false)).unwrap();
3126
3127 for predicate in [
3128 predicate_group.predicate().unwrap(),
3129 predicate_group.predicate_without_region().unwrap(),
3130 ] {
3131 assert_eq!(predicate.exprs(), static_filters);
3132 assert!(predicate.dyn_filters().is_empty());
3133 }
3134 }
3135
3136 #[test]
3137 fn test_file_level_pruning_stats_prunes_old_file() {
3138 let ts_col_name = "ts";
3139 let predicate = Predicate::new(vec![col(ts_col_name).gt(ts_lit(1000))]);
3140 let arrow_schema = Arc::new(ArrowSchema::new(vec![Field::new(
3141 ts_col_name,
3142 ArrowDataType::Timestamp(ArrowTimeUnit::Millisecond, None),
3143 false,
3144 )]));
3145
3146 let stats = FileLevelPruningStats {
3148 min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3149 max_scalar: ScalarValue::TimestampMillisecond(Some(500), None),
3150 time_index_col_name: ts_col_name.to_string(),
3151 };
3152 assert_eq!(
3153 vec![false],
3154 predicate.prune_with_stats(&stats, &arrow_schema)
3155 );
3156
3157 let stats = FileLevelPruningStats {
3159 min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3160 max_scalar: ScalarValue::TimestampMillisecond(Some(2000), None),
3161 time_index_col_name: ts_col_name.to_string(),
3162 };
3163 assert_eq!(
3164 vec![true],
3165 predicate.prune_with_stats(&stats, &arrow_schema)
3166 );
3167 }
3168
3169 #[test]
3170 fn test_file_level_pruning_stats_no_predicate_keeps_all() {
3171 let predicate = Predicate::new(vec![]);
3172 assert!(predicate.is_empty());
3173
3174 let stats = FileLevelPruningStats {
3175 min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3176 max_scalar: ScalarValue::TimestampMillisecond(Some(500), None),
3177 time_index_col_name: "ts".to_string(),
3178 };
3179 let arrow_schema = Arc::new(ArrowSchema::new(Vec::<Field>::new()));
3180 assert_eq!(
3181 vec![true],
3182 predicate.prune_with_stats(&stats, &arrow_schema)
3183 );
3184 }
3185
3186 #[tokio::test]
3187 async fn test_file_level_pruning_stats_ceil_max_unit_conversion() {
3188 let metadata = metadata_with_time_index_unit(TimeUnit::Millisecond);
3189 let input = new_scan_input(metadata, vec![]).await.build();
3190 let file = file_handle_with_time_range(
3191 Timestamp::new(1_000_001, TimeUnit::Nanosecond),
3192 Timestamp::new(1_000_001, TimeUnit::Nanosecond),
3193 );
3194
3195 let stats = input.try_file_level_pruning_stats(&file).unwrap();
3196 assert_eq!(
3197 ScalarValue::TimestampMillisecond(Some(1), None),
3198 stats.min_scalar
3199 );
3200 assert_eq!(
3201 ScalarValue::TimestampMillisecond(Some(2), None),
3202 stats.max_scalar
3203 );
3204
3205 let predicate = Predicate::new(vec![col("ts").gt(ts_lit(1))]);
3207 assert_eq!(
3208 vec![true],
3209 predicate.prune_with_stats(&stats, input.mapper.metadata().schema.arrow_schema())
3210 );
3211 }
3212
3213 #[tokio::test]
3214 async fn test_file_level_pruning_stats_overflow_keeps_file() {
3215 let metadata = metadata_with_time_index_unit(TimeUnit::Nanosecond);
3216 let input = new_scan_input(metadata, vec![]).await.build();
3217 let file = file_handle_with_time_range(
3218 Timestamp::new(0, TimeUnit::Second),
3219 Timestamp::new(i64::MAX, TimeUnit::Second),
3220 );
3221
3222 assert!(input.try_file_level_pruning_stats(&file).is_none());
3223 }
3224
3225 #[test]
3226 fn test_file_level_pruning_stats_keeps_inclusive_boundary() {
3227 let ts_col_name = "ts";
3228 let predicate = Predicate::new(vec![col(ts_col_name).gt_eq(ts_lit(1000))]);
3229 let arrow_schema = Arc::new(ArrowSchema::new(vec![Field::new(
3230 ts_col_name,
3231 ArrowDataType::Timestamp(ArrowTimeUnit::Millisecond, None),
3232 false,
3233 )]));
3234 let stats = FileLevelPruningStats {
3235 min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3236 max_scalar: ScalarValue::TimestampMillisecond(Some(1000), None),
3237 time_index_col_name: ts_col_name.to_string(),
3238 };
3239
3240 assert_eq!(
3241 vec![true],
3242 predicate.prune_with_stats(&stats, &arrow_schema)
3243 );
3244 }
3245
3246 #[tokio::test]
3247 async fn test_file_level_pruning_with_dyn_filter_only_predicate() {
3248 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3249 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
3250 let predicate_group = PredicateGroup::new(metadata.as_ref(), &[]).unwrap();
3251 predicate_group.add_dyn_filters(vec![Arc::new(DynamicFilterPhysicalExpr::new(
3252 vec![],
3253 physical_lit(false),
3254 ))]);
3255 let input = ScanInput::builder(SchedulerEnv::new().await.access_layer.clone(), mapper)
3256 .with_predicate(predicate_group)
3257 .build();
3258 let file = file_handle_with_time_range(
3259 Timestamp::new_millisecond(0),
3260 Timestamp::new_millisecond(1000),
3261 );
3262 let mut reader_metrics = ReaderMetrics::default();
3263
3264 let builder = input
3265 .prune_file(&file, PreFilterMode::SkipFields, &mut reader_metrics)
3266 .await
3267 .unwrap();
3268
3269 assert_eq!(1, reader_metrics.filter_metrics.files_time_range_pruned);
3270 let mut ranges = SmallVec::new();
3271 builder.build_ranges(-1, &mut ranges);
3272 assert!(ranges.is_empty());
3273 }
3274
3275 #[tokio::test]
3276 async fn test_manifest_pruning_observes_dynamic_filter_update() {
3277 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3278 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
3279 let predicate_group = PredicateGroup::new(metadata.as_ref(), &[]).unwrap();
3280 let arrow_schema = metadata.schema.arrow_schema();
3281 let ts_expr = physical_col("ts", arrow_schema.as_ref()).unwrap();
3282 let dyn_filter = Arc::new(DynamicFilterPhysicalExpr::new(
3283 vec![ts_expr.clone()],
3284 physical_lit(true),
3285 ));
3286 predicate_group.add_dyn_filters(vec![dyn_filter.clone()]);
3287 let input = ScanInput::builder(SchedulerEnv::new().await.access_layer.clone(), mapper)
3288 .with_predicate(predicate_group)
3289 .build();
3290 let file = file_handle_with_time_range(
3291 Timestamp::new_millisecond(0),
3292 Timestamp::new_millisecond(1000),
3293 );
3294
3295 assert!(!input.can_manifest_prune_file(&file));
3296
3297 let updated = physical_binary(
3298 ts_expr,
3299 Operator::Gt,
3300 physical_lit(ScalarValue::TimestampMillisecond(Some(1000), None)),
3301 arrow_schema.as_ref(),
3302 )
3303 .unwrap();
3304 dyn_filter.update(updated).unwrap();
3305
3306 assert!(input.can_manifest_prune_file(&file));
3307 input.predicate.clear_dyn_filters();
3308 assert!(!input.can_manifest_prune_file(&file));
3309 }
3310
3311 #[tokio::test]
3312 async fn test_range_pre_filter_mode() {
3313 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3314 let cases = [
3315 (true, MergeMode::LastRow, 1, PreFilterMode::All),
3316 (false, MergeMode::LastNonNull, 1, PreFilterMode::All),
3317 (false, MergeMode::LastRow, 2, PreFilterMode::SkipFields),
3318 (true, MergeMode::LastRow, 2, PreFilterMode::All),
3319 ];
3320
3321 for (append_mode, merge_mode, source_count, expected_mode) in cases {
3322 let input = new_scan_input(metadata.clone(), vec![])
3323 .await
3324 .with_append_mode(append_mode)
3325 .with_merge_mode(merge_mode)
3326 .build();
3327
3328 assert_eq!(expected_mode, input.range_pre_filter_mode(source_count));
3329 }
3330 }
3331
3332 #[test]
3333 fn test_exact_sequence_selection_preserves_range_and_fallback() {
3334 let request = ScanRequest {
3335 exact_sequence_range: true,
3336 memtable_min_sequence: Some(1),
3337 memtable_max_sequence: Some(2),
3338 ..Default::default()
3339 };
3340 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3341 let mutable = crate::memtable::time_partition::TimePartitions::new(
3342 metadata.clone(),
3343 Arc::new(crate::test_util::memtable_util::EmptyMemtableBuilder::default()),
3344 0,
3345 None,
3346 );
3347 let version = Arc::new(
3348 crate::region::version::VersionBuilder::new(metadata, mutable)
3349 .options(crate::region::options::RegionOptions {
3350 preserve_row_sequence: true,
3351 ..Default::default()
3352 })
3353 .build(),
3354 );
3355 let (files, range) = exact_sequence_range(&request, &version).unwrap();
3356 assert!(files.is_empty());
3357 assert_eq!(Some(SequenceRange::GtLtEq { min: 1, max: 2 }), range);
3358
3359 let skip_sst_request = ScanRequest {
3360 skip_sst_files: true,
3361 ..request
3362 };
3363 let (files, range) = exact_sequence_range(&skip_sst_request, &version).unwrap();
3364 assert!(files.is_empty());
3365 assert_eq!(None, range);
3366 }
3367
3368 #[test]
3369 fn test_exact_sequence_selection_checks_selected_files() {
3370 use std::num::NonZeroU64;
3371
3372 use crate::test_util::new_noop_file_purger;
3373
3374 let request = ScanRequest {
3375 exact_sequence_range: true,
3376 memtable_min_sequence: Some(5),
3377 memtable_max_sequence: Some(10),
3378 ..Default::default()
3379 };
3380 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3381 let mutable = crate::memtable::time_partition::TimePartitions::new(
3382 metadata.clone(),
3383 Arc::new(crate::test_util::memtable_util::EmptyMemtableBuilder::default()),
3384 0,
3385 None,
3386 );
3387 let target_region_id = metadata.region_id;
3388
3389 for (sequence, marked, expected_files, expected_range) in [
3392 (NonZeroU64::new(5), false, false, true),
3393 (NonZeroU64::new(5), true, false, true),
3394 (NonZeroU64::new(100), false, true, false),
3395 (None, false, true, false),
3396 (None, true, true, true),
3397 ] {
3398 let version = crate::region::version::VersionBuilder::new(
3399 metadata.clone(),
3400 mutable.new_with_part_duration(None, None),
3401 )
3402 .options(crate::region::options::RegionOptions {
3403 preserve_row_sequence: true,
3404 ..Default::default()
3405 })
3406 .add_files(
3407 new_noop_file_purger(),
3408 [FileMeta {
3409 region_id: target_region_id,
3410 sequence,
3411 preserve_row_sequence: marked,
3412 ..Default::default()
3413 }]
3414 .into_iter(),
3415 )
3416 .build();
3417 let (files, range) = exact_sequence_range(&request, &version).unwrap();
3418 assert_eq!(expected_files, !files.is_empty());
3419 assert_eq!(expected_range, range.is_some());
3420 }
3421
3422 for (sequence, marked, expected_count, expected_error) in [
3425 (NonZeroU64::new(5), false, 0, false),
3426 (NonZeroU64::new(6), false, 1, false),
3427 (NonZeroU64::new(11), true, 1, false),
3428 (None, true, 1, true),
3429 ] {
3430 let file_id = store_api::storage::FileId::random();
3431 let version = crate::region::version::VersionBuilder::new(
3432 metadata.clone(),
3433 mutable.new_with_part_duration(None, None),
3434 )
3435 .options(crate::region::options::RegionOptions {
3436 preserve_row_sequence: true,
3437 ..Default::default()
3438 })
3439 .add_files(
3440 new_noop_file_purger(),
3441 [FileMeta {
3442 region_id: RegionId::new(1, 2),
3443 file_id,
3444 sequence,
3445 preserve_row_sequence: marked,
3446 ..Default::default()
3447 }]
3448 .into_iter(),
3449 )
3450 .build();
3451 let result = exact_sequence_range(&request, &version);
3452 if expected_error {
3453 assert!(result.is_err());
3454 } else {
3455 let (files, range) = result.unwrap();
3456 assert_eq!(expected_count, files.len());
3457 assert!(range.is_some());
3458 }
3459 }
3460
3461 let request = ScanRequest {
3464 memtable_max_sequence: None,
3465 ..request
3466 };
3467 let version = crate::region::version::VersionBuilder::new(metadata, mutable)
3468 .options(crate::region::options::RegionOptions {
3469 preserve_row_sequence: false,
3470 ..Default::default()
3471 })
3472 .add_files(
3473 new_noop_file_purger(),
3474 [FileMeta {
3475 region_id: RegionId::new(1, 2),
3476 ..Default::default()
3477 }]
3478 .into_iter(),
3479 )
3480 .build();
3481 assert!(exact_sequence_range(&request, &version).is_err());
3482 }
3483
3484 #[tokio::test]
3485 async fn test_parallel_flat_source_stops_after_receiver_dropped() {
3486 use std::sync::atomic::{AtomicUsize, Ordering};
3487
3488 use datatypes::arrow::array::Int64Array;
3489
3490 const SOURCE_BATCHES: usize = 10_000;
3491
3492 let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3493 let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
3494 let env = SchedulerEnv::new().await;
3495 let input = ScanInput::builder(env.access_layer.clone(), mapper).build();
3496
3497 let schema = Arc::new(ArrowSchema::new(vec![Field::new(
3498 "v",
3499 ArrowDataType::Int64,
3500 false,
3501 )]));
3502 let batch =
3503 RecordBatch::try_new(schema, vec![Arc::new(Int64Array::from(vec![1]))]).unwrap();
3504 let pulled = Arc::new(AtomicUsize::new(0));
3505 let mut released = Vec::new();
3506 let sources = (0..2)
3507 .map(|_| {
3508 let (release_tx, release_rx) = tokio::sync::oneshot::channel::<()>();
3509 released.push(release_rx);
3510 let batch = batch.clone();
3511 let pulled = pulled.clone();
3512 futures::stream::iter(0..SOURCE_BATCHES)
3513 .map(move |_| {
3514 let _ = &release_tx;
3516 pulled.fetch_add(1, Ordering::Relaxed);
3517 Ok(batch.clone())
3518 })
3519 .boxed()
3520 })
3521 .collect();
3522
3523 let streams = input
3524 .create_parallel_flat_sources(sources, Arc::new(Semaphore::new(2)), 1)
3525 .unwrap();
3526 drop(streams);
3527
3528 for release_rx in released {
3529 tokio::time::timeout(std::time::Duration::from_secs(10), release_rx)
3530 .await
3531 .unwrap()
3532 .unwrap_err();
3533 }
3534 assert!(pulled.load(Ordering::Relaxed) < 100);
3537 }
3538}