Skip to main content

mito2/read/
scan_region.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Scans a region according to the scan request.
16
17use 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
94/// A scanner scans a region and returns a [SendableRecordBatchStream].
95pub(crate) enum Scanner {
96    /// Sequential scan.
97    Seq(SeqScan),
98    /// Unordered scan.
99    Unordered(UnorderedScan),
100    /// Per-series scan.
101    Series(SeriesScan),
102}
103
104impl Scanner {
105    /// Returns a [SendableRecordBatchStream] to retrieve scan results from all partitions.
106    #[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    /// Create a stream of [`Batch`] by this scanner.
116    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    /// Returns number of files to scan.
128    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    /// Returns number of memtables to scan.
137    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    /// Returns SST file ids to scan.
146    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    /// Sets the target partitions for the scanner. It can controls the parallelism of the scanner.
171    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)]
184/// Helper to scans a region by [ScanRequest].
185///
186/// [ScanRegion] collects SSTs and memtables to scan without actually reading them. It
187/// creates a [Scanner] to actually scan these targets in [Scanner::scan()].
188///
189/// ```mermaid
190/// classDiagram
191/// class ScanRegion {
192///     -VersionRef version
193///     -ScanRequest request
194///     ~scanner() Scanner
195///     ~seq_scan() SeqScan
196/// }
197/// class Scanner {
198///     <<enumeration>>
199///     SeqScan
200///     UnorderedScan
201///     +scan() SendableRecordBatchStream
202/// }
203/// class SeqScan {
204///     -ScanInput input
205///     +build() SendableRecordBatchStream
206/// }
207/// class UnorderedScan {
208///     -ScanInput input
209///     +build() SendableRecordBatchStream
210/// }
211/// class ScanInput {
212///     -ProjectionMapper mapper
213///     -Option~TimeRange~ time_range
214///     -Option~Predicate~ predicate
215///     -Vec~MemtableRef~ memtables
216///     -Vec~FileHandle~ files
217/// }
218/// class ProjectionMapper {
219///     ~output_schema() SchemaRef
220///     ~convert(Batch) RecordBatch
221/// }
222/// ScanRegion -- Scanner
223/// ScanRegion o-- ScanRequest
224/// Scanner o-- SeqScan
225/// Scanner o-- UnorderedScan
226/// SeqScan o-- ScanInput
227/// UnorderedScan o-- ScanInput
228/// Scanner -- SendableRecordBatchStream
229/// ScanInput o-- ProjectionMapper
230/// SeqScan -- SendableRecordBatchStream
231/// UnorderedScan -- SendableRecordBatchStream
232/// ```
233pub(crate) struct ScanRegion {
234    /// Version of the region at scan.
235    version: VersionRef,
236    /// Pinned index snapshot and its storage for candidate discovery.
237    series_index: Option<SeriesIndexReadContext>,
238    /// Access layer of the region.
239    access_layer: AccessLayerRef,
240    /// Scan request.
241    request: ScanRequest,
242    /// Cache.
243    cache_strategy: CacheStrategy,
244    /// Maximum number of SST files to scan concurrently.
245    max_concurrent_scan_files: usize,
246    scan_memory_tracker: Option<QueryMemoryTracker>,
247    /// Whether to enable the experimental two-phase metric series scan.
248    experimental_series_scan_v2: bool,
249    /// Whether to ignore range indexes during scans.
250    ignore_range_index: bool,
251    /// Whether to ignore inverted index.
252    ignore_inverted_index: bool,
253    /// Whether to ignore fulltext index.
254    ignore_fulltext_index: bool,
255    /// Whether to ignore bloom filter.
256    ignore_bloom_filter: bool,
257    /// Start time of the scan task.
258    start_time: Option<Instant>,
259    /// Whether to filter out the deleted rows.
260    /// Usually true for normal read, and false for scan for compaction.
261    filter_deleted: bool,
262    /// Files and exact sequence capability selected together by the engine.
263    exact_selection: Option<(Vec<FileHandle>, Option<SequenceRange>)>,
264    /// Counters that should receive query-load metrics.
265    query_stat_counters: Option<RegionQueryStatCounters>,
266    #[cfg(feature = "enterprise")]
267    extension_range_provider: Option<BoxedExtensionRangeProvider>,
268}
269
270impl ScanRegion {
271    /// Creates a [ScanRegion].
272    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    /// Pins the series-index snapshot used by candidate discovery.
301    #[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    /// Sets counters that should receive query-load metrics.
311    #[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    /// Sets maximum number of SST files to scan concurrently.
318    #[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    /// Sets whether eligible metric series scans use the two-phase implementation.
333    #[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    /// Sets whether to ignore range indexes during scans.
340    #[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    /// Sets whether to ignore inverted index.
347    #[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    /// Sets whether to ignore fulltext index.
354    #[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    /// Sets whether to ignore bloom filter.
361    #[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    /// Returns a [Scanner] to scan the region.
394    #[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            // If table is append only and there is no series row selector, we use unordered scan in query.
400            // We still use seq scan in compaction.
401            self.unordered_scan().await.map(Scanner::Unordered)
402        } else {
403            self.seq_scan().await.map(Scanner::Seq)
404        }
405    }
406
407    /// Returns a [RegionScanner] to scan the region.
408    #[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    /// Scan sequentially.
428    #[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    /// Unordered scan.
435    #[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        Ok(UnorderedScan::new(input))
439    }
440
441    /// Scans by series.
442    #[tracing::instrument(skip_all, fields(region_id = %self.region_id()))]
443    pub(crate) async fn series_scan(self) -> Result<SeriesScan> {
444        let experimental_series_scan_v2 = self.experimental_series_scan_v2;
445        let input = self.scan_input().await?;
446        Ok(SeriesScan::new(input, experimental_series_scan_v2))
447    }
448
449    /// Returns true if the region can use unordered scan for current request.
450    fn use_unordered_scan(&self) -> bool {
451        // We use unordered scan when:
452        // 1. The region is in append mode.
453        // 2. There is no series row selector.
454        // 3. The required distribution is None or TimeSeriesDistribution::TimeWindowed.
455        //
456        // We still use seq scan in compaction.
457        self.version.options.append_mode
458            && self.request.series_row_selector.is_none()
459            && (self.request.distribution.is_none()
460                || self.request.distribution == Some(TimeSeriesDistribution::TimeWindowed))
461    }
462
463    /// Returns true if the region can use series scan for current request.
464    fn use_series_scan(&self) -> bool {
465        self.request.distribution == Some(TimeSeriesDistribution::PerSeries)
466    }
467
468    /// Creates a scan input.
469    #[tracing::instrument(skip_all, fields(region_id = %self.region_id()))]
470    async fn scan_input(mut self) -> Result<ScanInput> {
471        let metadata = &self.version.metadata;
472        let sst_min_sequence = self.request.sst_min_sequence.and_then(NonZeroU64::new);
473        let time_range = self.build_time_range_predicate();
474        let predicate = PredicateGroup::new(metadata, &self.request.filters)?;
475
476        let read_col_ids =
477            self.build_read_col_ids(self.request.projection.as_deref(), &predicate)?;
478        let read_cols = self.build_read_columns(&read_col_ids)?;
479
480        // The mapper always computes projected column ids as the schema of SSTs may change.
481        let projection = self
482            .request
483            .projection
484            .clone()
485            .unwrap_or_else(|| (0..metadata.column_metadatas.len()).collect());
486        let mapper = FlatProjectionMapper::new_with_read_columns(metadata, projection, read_cols)?;
487        let mapper = if self.request.preserve_pk_dictionary_encoding {
488            mapper.with_pk_dictionary_encoding()
489        } else {
490            mapper
491        };
492
493        let (files, sequence_range) =
494            if let Some((files, sequence_range)) = self.exact_selection.take() {
495                (files, sequence_range)
496            } else {
497                exact_sequence_range(&self.request, &self.version)?
498            };
499        if sst_min_sequence.is_some() && sequence_range.is_some() {
500            return SequenceRangeUnsupportedSnafu {
501                region_id: self.region_id(),
502                min_seq: self.request.memtable_min_sequence.unwrap_or_default(),
503                max_seq: self.request.memtable_max_sequence.unwrap_or_default(),
504                reason:
505                    "sst_min_sequence pruning hint is incompatible with exact sequence-range reads"
506                        .to_string(),
507            }
508            .fail();
509        }
510        let memtables = self.version.memtables.list_memtables();
511        // Skip empty memtables and memtables out of time range.
512        let mut mem_range_builders = Vec::new();
513        let filter_mode = pre_filter_mode(
514            self.version.options.append_mode,
515            self.version.options.merge_mode(),
516        );
517
518        for m in memtables {
519            // check if memtable is empty by reading stats.
520            let Some((start, end)) = m.stats().time_range() else {
521                continue;
522            };
523            // The time range of the memtable is inclusive.
524            let memtable_range = TimestampRange::new_inclusive(Some(start), Some(end));
525            if !memtable_range.intersects(&time_range) {
526                continue;
527            }
528            let ranges_in_memtable = m.ranges(
529                Some(&read_col_ids),
530                RangesOptions::default()
531                    .with_predicate(predicate.clone())
532                    .with_sequence(SequenceRange::new(
533                        self.request.memtable_min_sequence,
534                        self.request.memtable_max_sequence,
535                    ))
536                    .with_pre_filter_mode(filter_mode),
537            )?;
538            mem_range_builders.extend(ranges_in_memtable.ranges.into_values().map(|v| {
539                let stats = v.stats().clone();
540                MemRangeBuilder::new(v, stats)
541            }));
542        }
543
544        let region_id = self.region_id();
545        debug!(
546            "Scan region {}, request: {:?}, time range: {:?}, memtables: {}, ssts_to_read: {}, append_mode: {}",
547            region_id,
548            self.request,
549            time_range,
550            mem_range_builders.len(),
551            files.len(),
552            self.version.options.append_mode,
553        );
554
555        let (non_field_filters, field_filters) = self.partition_by_field_filters();
556        let inverted_index_appliers = [
557            self.build_invereted_index_applier(&non_field_filters),
558            self.build_invereted_index_applier(&field_filters),
559        ];
560        let bloom_filter_appliers = [
561            self.build_bloom_filter_applier(&non_field_filters),
562            self.build_bloom_filter_applier(&field_filters),
563        ];
564        let fulltext_index_appliers = [
565            self.build_fulltext_index_applier(&non_field_filters),
566            self.build_fulltext_index_applier(&field_filters),
567        ];
568
569        let input = ScanInput::builder(self.access_layer, mapper)
570            .with_series_index(self.series_index)
571            .with_ignore_range_index(self.ignore_range_index)
572            .with_time_range(Some(time_range))
573            .with_predicate(predicate)
574            .with_memtables(mem_range_builders)
575            .with_files(files)
576            .with_primary_key_mapper(self.version.ssts.primary_key_mapper())
577            .with_cache(self.cache_strategy)
578            .with_inverted_index_appliers(inverted_index_appliers)
579            .with_bloom_filter_index_appliers(bloom_filter_appliers)
580            .with_fulltext_index_appliers(fulltext_index_appliers)
581            .with_max_concurrent_scan_files(self.max_concurrent_scan_files)
582            .with_scan_memory_tracker(self.scan_memory_tracker)
583            .with_start_time(self.start_time)
584            .with_append_mode(self.version.options.append_mode)
585            .with_filter_deleted(self.filter_deleted)
586            .with_merge_mode(self.version.options.merge_mode())
587            .with_series_row_selector(self.request.series_row_selector)
588            .with_distribution(self.request.distribution)
589            .with_explain_flat_format(
590                self.version.options.sst_format == Some(crate::sst::FormatType::Flat),
591            )
592            .with_snapshot_sequence(
593                self.request
594                    .snapshot_on_scan
595                    .then_some(self.request.memtable_max_sequence)
596                    .flatten(),
597            )
598            .with_sequence_range(sequence_range)
599            .with_query_stat_counters(self.query_stat_counters);
600        #[cfg(feature = "enterprise")]
601        let input = if !self.request.skip_sst_files
602            && let Some(provider) = self.extension_range_provider
603        {
604            if sequence_range.is_some() {
605                // Defense in depth: the engine already rejects exact
606                // sequence-range reads on follower regions with an extension
607                // provider, but if one ever reaches the reader, fail closed
608                // here rather than letting unfiltered extension streams bypass
609                // the row-level sequence filter and emit out-of-range rows.
610                return SequenceRangeUnsupportedSnafu {
611                    region_id,
612                    min_seq: self.request.memtable_min_sequence.unwrap_or_default(),
613                    max_seq: self.request.memtable_max_sequence.unwrap_or_default(),
614                    reason:
615                        "exact sequence-range reads are unsupported when an extension range provider is present"
616                            .to_string(),
617                }
618                .fail();
619            }
620            let ranges = provider
621                .find_extension_ranges(self.version.flushed_sequence, time_range, &self.request)
622                .await?;
623            debug!("Find extension ranges: {ranges:?}");
624            input.with_extension_ranges(ranges)
625        } else {
626            input
627        };
628        Ok(input.build())
629    }
630
631    /// Builds the deduplicated root column ids required by the projection and
632    /// predicate.
633    fn build_read_col_ids(
634        &self,
635        projection: Option<&[usize]>,
636        predicate: &PredicateGroup,
637    ) -> Result<Vec<ColumnId>> {
638        let metadata = &self.version.metadata;
639        let Some(projection) = projection else {
640            return Ok(metadata
641                .column_metadatas
642                .iter()
643                .map(|col| col.column_id)
644                .collect());
645        };
646
647        let mut read_col_ids = Vec::new();
648        let mut seen = HashSet::new();
649        for idx in projection {
650            let col_id = metadata
651                .column_metadatas
652                .get(*idx)
653                .with_context(|| InvalidRequestSnafu {
654                    region_id: metadata.region_id,
655                    reason: format!("projection index {} is out of bounds", idx),
656                })?
657                .column_id;
658            let inserted = seen.insert(col_id);
659            // DataFusion's logical `OptimizeProjections` rule deduplicates pushed-down
660            // projection indices via `RequiredIndices::compact()`.
661            debug_assert!(
662                inserted,
663                "projection contains duplicate column id: {}",
664                col_id
665            );
666            // Keep the projection order.
667            read_col_ids.push(col_id);
668        }
669
670        if projection.is_empty() {
671            let time_index = metadata.time_index_column().column_id;
672            if seen.insert(time_index) {
673                read_col_ids.push(time_index);
674            }
675        }
676
677        let mut extra_col_names = HashSet::new();
678        let mut cols = HashSet::new();
679
680        if let Some(p) = predicate.predicate_without_region() {
681            for expr in p.exprs() {
682                cols.clear();
683                if expr_to_columns(expr, &mut cols).is_err() {
684                    continue;
685                }
686                extra_col_names.extend(cols.iter().map(|col| col.name.clone()));
687            }
688        }
689
690        if let Some(expr) = predicate.region_partition_expr() {
691            expr.collect_column_names(&mut extra_col_names);
692        }
693
694        if !extra_col_names.is_empty() {
695            for col in &metadata.column_metadatas {
696                if extra_col_names.remove(&col.column_schema.name) && !seen.contains(&col.column_id)
697                {
698                    read_col_ids.push(col.column_id);
699                }
700            }
701            if !extra_col_names.is_empty() {
702                warn!(
703                    "Some columns in filters are not found in region {}: {:?}",
704                    metadata.region_id, extra_col_names
705                );
706            }
707        }
708        Ok(read_col_ids)
709    }
710
711    /// Builds logical read columns and attaches JSON2 target types when needed.
712    ///
713    /// The behavior about JSON2 is as follows:
714    /// - JSON2 columns without hints use Variant to read the whole column.
715    /// - Hints targeting non-JSON2 read columns are rejected.
716    fn build_read_columns(&self, col_ids: &[ColumnId]) -> Result<ReadColumns> {
717        let metadata = &self.version.metadata;
718        let json_type_hint = &self.request.json_type_hint;
719
720        let has_json2 = metadata
721            .schema
722            .arrow_schema()
723            .fields()
724            .iter()
725            .any(is_json2_extension_type);
726
727        if !has_json2 && json_type_hint.is_empty() {
728            return Ok(ReadColumns::new(col_ids.iter().copied()));
729        }
730
731        let mut json_target_types = BTreeMap::new();
732        for &col_id in col_ids {
733            let Some(col) = metadata.column_by_id(col_id) else {
734                continue;
735            };
736            let col_name = &col.column_schema.name;
737            let hint = json_type_hint.get(col_name);
738            if !col.column_schema.data_type.is_json2() {
739                ensure!(
740                    hint.is_none(),
741                    InvalidRequestSnafu {
742                        region_id: metadata.region_id,
743                        reason: format!(
744                            "JSON type hint targets non-JSON2 column {} (id: {}, type: {})",
745                            col_name, col_id, col.column_schema.data_type
746                        ),
747                    }
748                );
749                continue;
750            }
751            let target_type = hint.cloned().unwrap_or(JsonNativeType::Variant);
752            json_target_types.insert(col_id, target_type);
753        }
754        Ok(ReadColumns::new(col_ids.iter().copied()).with_json_target_types(json_target_types))
755    }
756
757    fn region_id(&self) -> RegionId {
758        self.version.metadata.region_id
759    }
760
761    /// Build time range predicate from filters.
762    fn build_time_range_predicate(&self) -> TimestampRange {
763        let time_index = self.version.metadata.time_index_column();
764        let unit = time_index
765            .column_schema
766            .data_type
767            .as_timestamp()
768            .expect("Time index must have timestamp-compatible type")
769            .unit();
770        build_time_range_predicate(&time_index.column_schema.name, unit, &self.request.filters)
771    }
772
773    /// Partitions filters into two groups: non-field filters and field filters.
774    /// Returns `(non_field_filters, field_filters)`.
775    fn partition_by_field_filters(&self) -> (Vec<Expr>, Vec<Expr>) {
776        let field_columns = self
777            .version
778            .metadata
779            .field_columns()
780            .map(|col| &col.column_schema.name)
781            .collect::<HashSet<_>>();
782
783        let mut columns = HashSet::new();
784
785        self.request.filters.iter().cloned().partition(|expr| {
786            columns.clear();
787            // `expr_to_columns` won't return error.
788            if expr_to_columns(expr, &mut columns).is_err() {
789                // If we can't extract columns, treat it as non-field filter
790                return true;
791            }
792            // Return true for non-field filters (partition puts true cases in first vec)
793            !columns
794                .iter()
795                .any(|column| field_columns.contains(&column.name))
796        })
797    }
798
799    /// Use the latest schema to build the inverted index applier.
800    fn build_invereted_index_applier(&self, filters: &[Expr]) -> Option<InvertedIndexApplierRef> {
801        if self.ignore_inverted_index {
802            return None;
803        }
804
805        let file_cache = self.cache_strategy.write_cache().map(|w| w.file_cache());
806        let inverted_index_cache = self.cache_strategy.inverted_index_cache().cloned();
807
808        let puffin_metadata_cache = self.cache_strategy.puffin_metadata_cache().cloned();
809
810        InvertedIndexApplierBuilder::new(
811            self.access_layer.table_dir().to_string(),
812            self.access_layer.path_type(),
813            self.access_layer.object_store().clone(),
814            self.version.metadata.as_ref(),
815            self.version.metadata.inverted_indexed_column_ids(
816                self.version
817                    .options
818                    .index_options
819                    .inverted_index
820                    .ignore_column_ids
821                    .iter(),
822            ),
823            self.access_layer.puffin_manager_factory().clone(),
824        )
825        .with_file_cache(file_cache)
826        .with_inverted_index_cache(inverted_index_cache)
827        .with_puffin_metadata_cache(puffin_metadata_cache)
828        .build(filters)
829        .inspect_err(|err| warn!(err; "Failed to build invereted index applier"))
830        .ok()
831        .flatten()
832        .map(Arc::new)
833    }
834
835    /// Use the latest schema to build the bloom filter index applier.
836    fn build_bloom_filter_applier(&self, filters: &[Expr]) -> Option<BloomFilterIndexApplierRef> {
837        if self.ignore_bloom_filter {
838            return None;
839        }
840
841        let file_cache = self.cache_strategy.write_cache().map(|w| w.file_cache());
842        let bloom_filter_index_cache = self.cache_strategy.bloom_filter_index_cache().cloned();
843        let puffin_metadata_cache = self.cache_strategy.puffin_metadata_cache().cloned();
844
845        BloomFilterIndexApplierBuilder::new(
846            self.access_layer.table_dir().to_string(),
847            self.access_layer.path_type(),
848            self.access_layer.object_store().clone(),
849            self.version.metadata.as_ref(),
850            self.access_layer.puffin_manager_factory().clone(),
851        )
852        .with_file_cache(file_cache)
853        .with_bloom_filter_index_cache(bloom_filter_index_cache)
854        .with_puffin_metadata_cache(puffin_metadata_cache)
855        .build(filters)
856        .inspect_err(|err| warn!(err; "Failed to build bloom filter index applier"))
857        .ok()
858        .flatten()
859        .map(Arc::new)
860    }
861
862    /// Use the latest schema to build the fulltext index applier.
863    fn build_fulltext_index_applier(&self, filters: &[Expr]) -> Option<FulltextIndexApplierRef> {
864        if self.ignore_fulltext_index {
865            return None;
866        }
867
868        let file_cache = self.cache_strategy.write_cache().map(|w| w.file_cache());
869        let puffin_metadata_cache = self.cache_strategy.puffin_metadata_cache().cloned();
870        let bloom_filter_index_cache = self.cache_strategy.bloom_filter_index_cache().cloned();
871        FulltextIndexApplierBuilder::new(
872            self.access_layer.table_dir().to_string(),
873            self.access_layer.path_type(),
874            self.access_layer.object_store().clone(),
875            self.access_layer.puffin_manager_factory().clone(),
876            self.version.metadata.as_ref(),
877        )
878        .with_file_cache(file_cache)
879        .with_puffin_metadata_cache(puffin_metadata_cache)
880        .with_bloom_filter_cache(bloom_filter_index_cache)
881        .build(filters)
882        .inspect_err(|err| warn!(err; "Failed to build fulltext index applier"))
883        .ok()
884        .flatten()
885        .map(Arc::new)
886    }
887}
888
889/// Returns true if the time range of a SST `file` matches the `predicate`.
890fn file_in_range(file: &FileHandle, predicate: &TimestampRange) -> bool {
891    if predicate == &TimestampRange::min_to_max() {
892        return true;
893    }
894    // end timestamp of a SST is inclusive.
895    let (start, end) = file.time_range();
896    let file_ts_range = TimestampRange::new_inclusive(Some(start), Some(end));
897    file_ts_range.intersects(predicate)
898}
899
900/// Returns true if `time_range` contains the inclusive time range of `file`.
901fn time_range_covers_file(time_range: Option<&TimestampRange>, file: &FileHandle) -> bool {
902    let Some(time_range) = time_range else {
903        return false;
904    };
905    let (start, end) = file.time_range();
906    time_range.contains(&start) && time_range.contains(&end)
907}
908
909/// Common input for different scanners.
910pub struct ScanInput {
911    /// Pinned series-index snapshot and its storage, when configured.
912    pub(crate) series_index: Option<SeriesIndexReadContext>,
913    /// Whether to ignore range indexes while retaining series-index candidate discovery.
914    ignore_range_index: bool,
915    /// Region SST access layer.
916    access_layer: AccessLayerRef,
917    /// Maps projected Batches to RecordBatches.
918    pub(crate) mapper: Arc<FlatProjectionMapper>,
919    /// The columns to read from memtables and SSTs.
920    /// Notice this is different from the columns in `mapper` which are projected columns.
921    /// But this read columns might also include non-projected columns needed for filtering.
922    pub(crate) read_cols: ReadColumns,
923    /// Time range filter for time index.
924    pub(crate) time_range: Option<TimestampRange>,
925    /// Cached analysis of the finalized scan request.
926    scan_analysis: Option<ScanAnalysis>,
927    /// Predicate to push down.
928    pub(crate) predicate: PredicateGroup,
929    /// Region partition expr applied at read time.
930    region_partition_expr: Option<PartitionExpr>,
931    /// Memtable range builders for memtables in the time range..
932    pub(crate) memtables: Vec<MemRangeBuilder>,
933    /// Handles to SST files to scan.
934    pub(crate) files: Vec<FileHandle>,
935    /// Shares the pinned schema's encoded defaults across parallel range readers.
936    primary_key_mapper: OnceLock<Arc<PrimaryKeyRangeMapper>>,
937    /// Scan-wide hint for rows in an execution batch.
938    batch_size: usize,
939    /// Cache.
940    pub(crate) cache_strategy: CacheStrategy,
941    /// Ignores file not found error.
942    ignore_file_not_found: bool,
943    /// Maximum number of SST files to scan concurrently.
944    pub(crate) max_concurrent_scan_files: usize,
945    /// Shared scan quota for projected SST row groups; absent during compaction.
946    scan_memory_tracker: Option<QueryMemoryTracker>,
947    /// Index appliers.
948    inverted_index_appliers: [Option<InvertedIndexApplierRef>; 2],
949    bloom_filter_index_appliers: [Option<BloomFilterIndexApplierRef>; 2],
950    fulltext_index_appliers: [Option<FulltextIndexApplierRef>; 2],
951    /// Start time of the query.
952    pub(crate) query_start: Option<Instant>,
953    /// The region is using append mode.
954    pub(crate) append_mode: bool,
955    /// Whether to remove deletion markers.
956    pub(crate) filter_deleted: bool,
957    /// Mode to merge duplicate rows.
958    pub(crate) merge_mode: MergeMode,
959    /// Hint to select rows from time series.
960    pub(crate) series_row_selector: Option<TimeSeriesRowSelector>,
961    /// Hint for the required distribution of the scanner.
962    pub(crate) distribution: Option<TimeSeriesDistribution>,
963    /// Whether the region's configured SST format is flat.
964    explain_flat_format: bool,
965    /// Snapshot upper bound bound at scan open and propagated back to the caller.
966    pub(crate) snapshot_sequence: Option<SequenceNumber>,
967    /// Set only when the region preserves per-row sequences
968    /// (`preserve_row_sequence` on an append-only table) and the scan
969    /// carries an explicit exact range. When set, SST readers apply the same
970    /// `(checkpoint, upper_bound]` row-level filter as memtables.
971    pub(crate) sequence_range: Option<SequenceRange>,
972    /// Whether this scan is for compaction.
973    pub(crate) compaction: bool,
974    /// Compaction-only JSON2 physical rewrite targets.
975    json2_rewrite_targets: Json2RewriteTargets,
976    /// Counters that should receive query-load metrics.
977    pub(crate) query_stat_counters: Option<RegionQueryStatCounters>,
978    #[cfg(feature = "enterprise")]
979    extension_ranges: Vec<BoxedExtensionRange>,
980}
981
982/// Cached output of scan request analysis: the optional range-cache fingerprint
983/// plus the derived implied time range used by range cache and prefilter.
984struct ScanAnalysis {
985    /// `None` when the scan is not eligible for range caching.
986    fingerprint: Option<ScanRequestFingerprint>,
987    /// `Some(r)` = all time-only predicates are guaranteed true on `r` (in the
988    /// column's `TimeUnit`).
989    /// `None`    = there is no analyzable time-only predicate or at least one
990    /// predicate could not be proven (e.g. `OR`), so the time-filter
991    /// optimization is disabled for this scan.
992    implied_time_range: Option<TimestampRange>,
993}
994
995/// Builder for a finalized [ScanInput].
996pub(crate) struct ScanInputBuilder {
997    input: ScanInput,
998}
999
1000impl ScanInput {
1001    /// Creates a new [ScanInputBuilder].
1002    #[must_use]
1003    pub(crate) fn builder(
1004        access_layer: AccessLayerRef,
1005        mapper: FlatProjectionMapper,
1006    ) -> ScanInputBuilder {
1007        ScanInputBuilder {
1008            input: ScanInput {
1009                series_index: None,
1010                ignore_range_index: false,
1011                access_layer,
1012                read_cols: mapper.read_columns().clone(),
1013                mapper: Arc::new(mapper),
1014                time_range: None,
1015                scan_analysis: None,
1016                predicate: PredicateGroup::default(),
1017                region_partition_expr: None,
1018                memtables: Vec::new(),
1019                files: Vec::new(),
1020                primary_key_mapper: OnceLock::new(),
1021                batch_size: crate::sst::parquet::DEFAULT_READ_BATCH_SIZE,
1022                cache_strategy: CacheStrategy::Disabled,
1023                ignore_file_not_found: false,
1024                max_concurrent_scan_files: DEFAULT_MAX_CONCURRENT_SCAN_FILES,
1025                scan_memory_tracker: None,
1026                inverted_index_appliers: [None, None],
1027                bloom_filter_index_appliers: [None, None],
1028                fulltext_index_appliers: [None, None],
1029                query_start: None,
1030                append_mode: false,
1031                filter_deleted: true,
1032                merge_mode: MergeMode::default(),
1033                series_row_selector: None,
1034                distribution: None,
1035                explain_flat_format: false,
1036                snapshot_sequence: None,
1037                sequence_range: None,
1038                compaction: false,
1039                json2_rewrite_targets: Arc::default(),
1040                query_stat_counters: None,
1041                #[cfg(feature = "enterprise")]
1042                extension_ranges: Vec::new(),
1043            },
1044        }
1045    }
1046
1047    /// Returns the scan-wide hint for rows in an execution batch.
1048    pub(crate) fn batch_size(&self) -> usize {
1049        self.batch_size
1050    }
1051
1052    /// Interprets file statistics using this scan's pinned schema.
1053    pub(crate) fn primary_key_mapper(&self) -> &PrimaryKeyRangeMapper {
1054        self.primary_key_mapper
1055            .get_or_init(|| Arc::new(PrimaryKeyRangeMapper::new(self.region_metadata().clone())))
1056    }
1057
1058    /// Returns the range implied by the range-cache time filters.
1059    pub(crate) fn implied_time_range(&self) -> Option<&TimestampRange> {
1060        self.scan_analysis
1061            .as_ref()
1062            .expect("ScanInput must be built")
1063            .implied_time_range
1064            .as_ref()
1065    }
1066
1067    /// Returns the fingerprint for partition range caching.
1068    pub(crate) fn scan_fingerprint(&self) -> Option<&ScanRequestFingerprint> {
1069        self.scan_analysis
1070            .as_ref()
1071            .expect("ScanInput must be built")
1072            .fingerprint
1073            .as_ref()
1074    }
1075}
1076
1077impl ScanInputBuilder {
1078    fn with_primary_key_mapper(mut self, mapper: Arc<PrimaryKeyRangeMapper>) -> Self {
1079        self.input.primary_key_mapper = OnceLock::from(mapper);
1080        self
1081    }
1082
1083    /// Sets whether to ignore range indexes during scans.
1084    #[must_use]
1085    pub(crate) fn with_ignore_range_index(mut self, ignore: bool) -> Self {
1086        self.input.ignore_range_index = ignore;
1087        self
1088    }
1089
1090    /// Sets the pinned series-index context for candidate discovery.
1091    #[must_use]
1092    pub(crate) fn with_series_index(
1093        mut self,
1094        series_index: Option<SeriesIndexReadContext>,
1095    ) -> Self {
1096        self.input.series_index = series_index;
1097        self
1098    }
1099
1100    /// Sets time range filter for time index.
1101    #[must_use]
1102    pub(crate) fn with_time_range(mut self, time_range: Option<TimestampRange>) -> Self {
1103        self.input.time_range = time_range;
1104        self
1105    }
1106
1107    /// Sets predicate to push down.
1108    #[must_use]
1109    pub(crate) fn with_predicate(mut self, predicate: PredicateGroup) -> Self {
1110        self.input.region_partition_expr = predicate.region_partition_expr().cloned();
1111        self.input.predicate = predicate;
1112        self
1113    }
1114
1115    /// Builds a finalized [ScanInput] and computes its scan analysis.
1116    #[must_use]
1117    pub(crate) fn build(mut self) -> ScanInput {
1118        if self.input.compaction {
1119            self.input.scan_memory_tracker = None;
1120        }
1121        let input = &self.input;
1122        let eligible = !input.compaction
1123            && !input.files.is_empty()
1124            && matches!(input.cache_strategy, CacheStrategy::EnableAll(_));
1125
1126        let metadata = input.region_metadata();
1127        let tag_names: HashSet<&str> = metadata
1128            .column_metadatas
1129            .iter()
1130            .filter(|col| col.semantic_type == SemanticType::Tag)
1131            .map(|col| col.column_schema.name.as_str())
1132            .collect();
1133
1134        let time_index = metadata.time_index_column();
1135        let time_index_name = time_index.column_schema.name.clone();
1136        let ts_col_unit = time_index
1137            .column_schema
1138            .data_type
1139            .as_timestamp()
1140            .expect("Time index must have timestamp-compatible type")
1141            .unit();
1142
1143        let exprs = input
1144            .predicate_group()
1145            .predicate_without_region()
1146            .map(|predicate| predicate.exprs())
1147            .unwrap_or_default();
1148
1149        let mut filters = Vec::new();
1150        let mut time_only_exprs: Vec<&Expr> = Vec::new();
1151        let mut has_tag_filter = false;
1152        let mut columns = HashSet::new();
1153
1154        for expr in exprs {
1155            columns.clear();
1156            let is_time_only = match expr_to_columns(expr, &mut columns) {
1157                Ok(()) if !columns.is_empty() => {
1158                    has_tag_filter |= columns
1159                        .iter()
1160                        .any(|col| tag_names.contains(col.name.as_str()));
1161                    columns.iter().all(|col| col.name == time_index_name)
1162                }
1163                _ => false,
1164            };
1165
1166            // Route time-only exprs that the legacy extractor recognizes into
1167            // `time_only_exprs` so the implication walker
1168            // (`implied_time_range_from_exprs`, called below) can attempt to drop
1169            // them from the cache key when the partition's `FileTimeRange` is fully
1170            // covered, then stringify them into the fingerprint's `time_filters`
1171            // bucket. Time-only exprs that the extractor doesn't recognize stay in
1172            // `filters` and never get stripped — conservatively correct.
1173            if is_time_only
1174                && extract_time_range_from_expr(&time_index_name, ts_col_unit, expr).is_some()
1175            {
1176                time_only_exprs.push(expr);
1177            } else {
1178                filters.push(expr.to_string());
1179            }
1180        }
1181
1182        let implied_time_range =
1183            implied_time_range_from_exprs(&time_index_name, ts_col_unit, &time_only_exprs);
1184
1185        // We only cache requests that have tag filters to avoid caching all series.
1186        let fingerprint = if eligible && has_tag_filter {
1187            let mut time_filters: Vec<String> =
1188                time_only_exprs.iter().map(|e| e.to_string()).collect();
1189
1190            // Ensure the filters are sorted for consistent fingerprinting.
1191            filters.sort_unstable();
1192            time_filters.sort_unstable();
1193            let read_columns = input.read_cols.clone();
1194            let fingerprint = crate::read::range_cache::ScanRequestFingerprintBuilder {
1195                read_column_types: read_columns
1196                    .column_ids_iter()
1197                    .map(|id| {
1198                        read_columns
1199                            .json_target_type(id)
1200                            .cloned()
1201                            .map(ConcreteDataType::json2)
1202                            .or_else(|| {
1203                                metadata
1204                                    .column_by_id(id)
1205                                    .map(|col| col.column_schema.data_type.clone())
1206                            })
1207                    })
1208                    .collect(),
1209                read_columns,
1210                filters,
1211                time_filters,
1212                series_row_selector: input.series_row_selector,
1213                append_mode: input.append_mode,
1214                filter_deleted: input.filter_deleted,
1215                merge_mode: input.merge_mode,
1216                sequence_range: input.sequence_range,
1217                partition_expr_version: metadata.partition_expr_version,
1218            }
1219            .build();
1220            Some(fingerprint)
1221        } else {
1222            None
1223        };
1224
1225        self.input.scan_analysis = Some(ScanAnalysis {
1226            fingerprint,
1227            implied_time_range,
1228        });
1229        self.input
1230    }
1231
1232    /// Sets memtable range builders.
1233    #[must_use]
1234    pub(crate) fn with_memtables(mut self, memtables: Vec<MemRangeBuilder>) -> Self {
1235        self.input.memtables = memtables;
1236        self
1237    }
1238
1239    /// Sets files to read.
1240    #[must_use]
1241    pub(crate) fn with_files(mut self, files: Vec<FileHandle>) -> Self {
1242        self.input.files = files;
1243        self
1244    }
1245
1246    /// Sets the scan-wide hint for rows in an execution batch.
1247    #[must_use]
1248    pub(crate) fn with_batch_size(mut self, batch_size: usize) -> Self {
1249        self.input.batch_size = batch_size;
1250        self
1251    }
1252
1253    /// Sets cache for this query.
1254    #[must_use]
1255    pub(crate) fn with_cache(mut self, cache: CacheStrategy) -> Self {
1256        self.input.cache_strategy = cache;
1257        self
1258    }
1259
1260    /// Ignores file not found error.
1261    #[must_use]
1262    pub(crate) fn with_ignore_file_not_found(mut self, ignore: bool) -> Self {
1263        self.input.ignore_file_not_found = ignore;
1264        self
1265    }
1266
1267    /// Sets maximum number of SST files to scan concurrently.
1268    #[must_use]
1269    pub(crate) fn with_max_concurrent_scan_files(
1270        mut self,
1271        max_concurrent_scan_files: usize,
1272    ) -> Self {
1273        self.input.max_concurrent_scan_files = max_concurrent_scan_files;
1274        self
1275    }
1276
1277    pub(crate) fn with_scan_memory_tracker(mut self, tracker: Option<QueryMemoryTracker>) -> Self {
1278        self.input.scan_memory_tracker = tracker;
1279        self
1280    }
1281
1282    /// Sets inverted index appliers.
1283    #[must_use]
1284    pub(crate) fn with_inverted_index_appliers(
1285        mut self,
1286        appliers: [Option<InvertedIndexApplierRef>; 2],
1287    ) -> Self {
1288        self.input.inverted_index_appliers = appliers;
1289        self
1290    }
1291
1292    /// Sets bloom filter appliers.
1293    #[must_use]
1294    pub(crate) fn with_bloom_filter_index_appliers(
1295        mut self,
1296        appliers: [Option<BloomFilterIndexApplierRef>; 2],
1297    ) -> Self {
1298        self.input.bloom_filter_index_appliers = appliers;
1299        self
1300    }
1301
1302    /// Sets fulltext index appliers.
1303    #[must_use]
1304    pub(crate) fn with_fulltext_index_appliers(
1305        mut self,
1306        appliers: [Option<FulltextIndexApplierRef>; 2],
1307    ) -> Self {
1308        self.input.fulltext_index_appliers = appliers;
1309        self
1310    }
1311
1312    /// Sets start time of the query.
1313    #[must_use]
1314    pub(crate) fn with_start_time(mut self, now: Option<Instant>) -> Self {
1315        self.input.query_start = now;
1316        self
1317    }
1318
1319    #[must_use]
1320    pub(crate) fn with_append_mode(mut self, is_append_mode: bool) -> Self {
1321        self.input.append_mode = is_append_mode;
1322        self
1323    }
1324
1325    pub(crate) fn with_query_stat_counters(
1326        mut self,
1327        counters: Option<RegionQueryStatCounters>,
1328    ) -> Self {
1329        self.input.query_stat_counters = counters;
1330        self
1331    }
1332
1333    /// Sets whether to remove deletion markers during scan.
1334    #[must_use]
1335    pub(crate) fn with_filter_deleted(mut self, filter_deleted: bool) -> Self {
1336        self.input.filter_deleted = filter_deleted;
1337        self
1338    }
1339
1340    /// Sets the merge mode.
1341    #[must_use]
1342    pub(crate) fn with_merge_mode(mut self, merge_mode: MergeMode) -> Self {
1343        self.input.merge_mode = merge_mode;
1344        self
1345    }
1346
1347    /// Sets the distribution hint.
1348    #[must_use]
1349    pub(crate) fn with_distribution(
1350        mut self,
1351        distribution: Option<TimeSeriesDistribution>,
1352    ) -> Self {
1353        self.input.distribution = distribution;
1354        self
1355    }
1356
1357    /// Sets whether the region's configured SST format is flat for explain output.
1358    #[must_use]
1359    pub(crate) fn with_explain_flat_format(mut self, explain_flat_format: bool) -> Self {
1360        self.input.explain_flat_format = explain_flat_format;
1361        self
1362    }
1363
1364    /// Sets the time series row selector.
1365    #[must_use]
1366    pub(crate) fn with_series_row_selector(
1367        mut self,
1368        series_row_selector: Option<TimeSeriesRowSelector>,
1369    ) -> Self {
1370        self.input.series_row_selector = series_row_selector;
1371        self
1372    }
1373
1374    #[must_use]
1375    pub(crate) fn with_snapshot_sequence(
1376        mut self,
1377        snapshot_sequence: Option<SequenceNumber>,
1378    ) -> Self {
1379        self.input.snapshot_sequence = snapshot_sequence;
1380        self
1381    }
1382
1383    #[must_use]
1384    pub(crate) fn with_sequence_range(mut self, sequence_range: Option<SequenceRange>) -> Self {
1385        self.input.sequence_range = sequence_range;
1386        self
1387    }
1388
1389    /// Sets whether this scan is for compaction.
1390    #[must_use]
1391    pub(crate) fn with_compaction(mut self, compaction: bool) -> Self {
1392        self.input.compaction = compaction;
1393        self
1394    }
1395
1396    /// Sets compaction-only JSON2 physical rewrite targets.
1397    #[must_use]
1398    pub(crate) fn with_json2_rewrite_targets(mut self, targets: Json2RewriteTargets) -> Self {
1399        self.input.json2_rewrite_targets = targets;
1400        self
1401    }
1402
1403    #[cfg(feature = "enterprise")]
1404    #[must_use]
1405    pub(crate) fn with_extension_ranges(
1406        mut self,
1407        extension_ranges: Vec<BoxedExtensionRange>,
1408    ) -> Self {
1409        self.input.extension_ranges = extension_ranges;
1410        self
1411    }
1412}
1413
1414impl ScanInput {
1415    pub(crate) fn uses_scan_memory_limit(&self) -> bool {
1416        let covered = self
1417            .scan_memory_tracker
1418            .as_ref()
1419            .is_some_and(|tracker| tracker.limit() > 0);
1420        #[cfg(feature = "enterprise")]
1421        let covered = covered && self.extension_ranges.is_empty();
1422        covered
1423    }
1424
1425    /// Builds memtable ranges to scan by `index`.
1426    pub(crate) fn build_mem_ranges(&self, index: RowGroupIndex) -> SmallVec<[MemtableRange; 2]> {
1427        let memtable = &self.memtables[index.index];
1428        let mut ranges = SmallVec::new();
1429        memtable.build_ranges(index.row_group_index, &mut ranges);
1430        ranges
1431    }
1432
1433    pub(crate) fn predicate_for_file(&self, file: &FileHandle) -> Option<Predicate> {
1434        if self.should_skip_region_partition(file) {
1435            self.predicate.predicate_without_region().cloned()
1436        } else {
1437            self.predicate.predicate().cloned()
1438        }
1439    }
1440
1441    fn should_skip_region_partition(&self, file: &FileHandle) -> bool {
1442        match (
1443            self.region_partition_expr.as_ref(),
1444            file.meta_ref().partition_expr.as_ref(),
1445        ) {
1446            (Some(region_expr), Some(file_expr)) => region_expr == file_expr,
1447            _ => false,
1448        }
1449    }
1450
1451    /// Tries to build file-level pruning statistics using only the [FileHandle]'s manifest-level
1452    /// time range, without reading any parquet metadata.
1453    ///
1454    /// Returns `None` if timestamp unit conversion overflows (conservative: keep the file).
1455    fn try_file_level_pruning_stats(&self, file: &FileHandle) -> Option<FileLevelPruningStats> {
1456        let (ts_min, ts_max) = file.time_range();
1457        let time_index = self.mapper.metadata().time_index_column();
1458        let time_index_unit = time_index.column_schema.data_type.as_timestamp()?.unit();
1459
1460        // Convert file timestamps to the time index column's unit. Use `convert_to_ceil` for
1461        // the upper bound to avoid accidentally shrinking the manifest range.
1462        let min_ts = ts_min.convert_to(time_index_unit)?;
1463        let max_ts = ts_max.convert_to_ceil(time_index_unit)?;
1464
1465        Some(FileLevelPruningStats {
1466            min_scalar: timestamp_to_scalar_value(time_index_unit, Some(min_ts.value())),
1467            max_scalar: timestamp_to_scalar_value(time_index_unit, Some(max_ts.value())),
1468            time_index_col_name: time_index.column_schema.name.clone(),
1469        })
1470    }
1471
1472    /// Checks whether a file can be definitively pruned using only its manifest-level
1473    /// time range and the current predicate, without reading any parquet metadata.
1474    ///
1475    /// Returns `true` if [PruningStatistics] proves the file cannot contain matching rows.
1476    #[inline]
1477    pub(crate) fn can_manifest_prune_file(&self, file: &FileHandle) -> bool {
1478        let predicate = self.predicate_for_file(file);
1479        self.manifest_prunes_file(file, predicate.as_ref())
1480    }
1481
1482    fn manifest_prunes_file(&self, file: &FileHandle, predicate: Option<&Predicate>) -> bool {
1483        if let Some(pred) = predicate
1484            && !pred.is_empty()
1485            && let Some(file_level_stats) = self.try_file_level_pruning_stats(file)
1486        {
1487            let pruning_results = pred.prune_with_stats(
1488                &file_level_stats,
1489                self.mapper.metadata().schema.arrow_schema(),
1490            );
1491            pruning_results.first() == Some(&false)
1492        } else {
1493            false
1494        }
1495    }
1496
1497    /// Prunes a file to scan and returns the builder to build readers.
1498    ///
1499    /// This is the public entry point used by direct tests and non-pruner callers.
1500    /// It performs its own manifest-level pruning check internally.
1501    #[tracing::instrument(
1502        skip_all,
1503        fields(
1504            region_id = %self.region_metadata().region_id,
1505            file_id = %file.file_id()
1506        )
1507    )]
1508    pub async fn prune_file(
1509        &self,
1510        file: &FileHandle,
1511        pre_filter_mode: PreFilterMode,
1512        reader_metrics: &mut ReaderMetrics,
1513    ) -> Result<FileRangeBuilder> {
1514        let predicate = self.predicate_for_file(file);
1515
1516        // Early file-level pruning using manifest time range before any parquet metadata access.
1517        if self.manifest_prunes_file(file, predicate.as_ref()) {
1518            reader_metrics.filter_metrics.files_time_range_pruned += 1;
1519            return Ok(FileRangeBuilder::default());
1520        }
1521
1522        self.prune_file_after_manifest_check(file, pre_filter_mode, true, predicate, reader_metrics)
1523            .await
1524    }
1525
1526    /// Second half of `prune_file` — performs the actual parquet metadata /
1527    /// reader setup. Callers that already performed manifest-level pruning
1528    /// (e.g. the `Pruner` via its shared `manifest_pruned_files` cache) should
1529    /// call this directly to avoid a redundant manifest check.
1530    ///
1531    /// `predicate` is the result of `self.predicate_for_file(file)` computed
1532    /// externally so the caller can reuse it if needed.
1533    pub(crate) async fn prune_file_after_manifest_check(
1534        &self,
1535        file: &FileHandle,
1536        pre_filter_mode: PreFilterMode,
1537        enable_predicate_prefilter: bool,
1538        predicate: Option<Predicate>,
1539        reader_metrics: &mut ReaderMetrics,
1540    ) -> Result<FileRangeBuilder> {
1541        let may_build_selective_row_selection = predicate.is_some();
1542        let postpone_time_index_filter = time_range_covers_file(self.implied_time_range(), file);
1543        let decode_pk_values = !self.compaction
1544            && self
1545                .mapper
1546                .read_columns()
1547                .column_ids_iter()
1548                .any(|column_id| self.mapper.metadata().primary_key.contains(&column_id));
1549        let reader = self
1550            .access_layer
1551            .read_sst(file.clone())
1552            .series_index(
1553                self.series_index
1554                    .clone()
1555                    .filter(|_| !self.ignore_range_index),
1556            )
1557            .memory_tracker(self.scan_memory_tracker.clone())
1558            .predicate(predicate)
1559            .projection(Some(self.read_cols.clone()))
1560            .json2_rewrite_targets(self.json2_rewrite_targets.clone())
1561            .cache(self.cache_strategy.clone())
1562            .inverted_index_appliers(self.inverted_index_appliers.clone())
1563            .bloom_filter_index_appliers(self.bloom_filter_index_appliers.clone())
1564            .fulltext_index_appliers(self.fulltext_index_appliers.clone());
1565        let reader = reader.batch_size(self.batch_size);
1566        let reader = if !self.compaction && may_build_selective_row_selection {
1567            reader.deferred_optional_page_index()
1568        } else {
1569            reader
1570        };
1571        let res = reader
1572            .expected_metadata(Some(self.mapper.metadata().clone()))
1573            .compaction(self.compaction)
1574            .pre_filter_mode(pre_filter_mode)
1575            .enable_predicate_prefilter(enable_predicate_prefilter)
1576            .postpone_time_index_filter(postpone_time_index_filter)
1577            .decode_primary_key_values(decode_pk_values)
1578            .build_reader_input(reader_metrics)
1579            .await;
1580        let read_input = match res {
1581            Ok(x) => x,
1582            Err(e) => {
1583                if e.is_object_not_found() && self.ignore_file_not_found {
1584                    error!(e; "File to scan does not exist, region_id: {}, file: {}", file.region_id(), file.file_id());
1585                    return Ok(FileRangeBuilder::default());
1586                } else {
1587                    return Err(e);
1588                }
1589            }
1590        };
1591
1592        let Some((mut file_range_ctx, selection)) = read_input else {
1593            return Ok(FileRangeBuilder::default());
1594        };
1595
1596        let need_compat = !compat::has_same_columns_and_pk_encoding(
1597            &self.mapper,
1598            file_range_ctx.read_format(),
1599            self.compaction,
1600        );
1601        if need_compat {
1602            // They have different schema. We need to adapt the batch first so the
1603            // mapper can convert it.
1604            let compat = FlatCompatBatch::try_new(
1605                &self.mapper,
1606                file_range_ctx.read_format(),
1607                self.compaction,
1608            )?;
1609            file_range_ctx.set_compat_batch(compat);
1610        }
1611        Ok(FileRangeBuilder::new(Arc::new(file_range_ctx), selection))
1612    }
1613
1614    /// Scans flat sources (RecordBatch streams) in parallel.
1615    ///
1616    /// # Panics if the input doesn't allow parallel scan.
1617    #[tracing::instrument(
1618        skip(self, sources, semaphore),
1619        fields(
1620            region_id = %self.region_metadata().region_id,
1621            source_count = sources.len()
1622        )
1623    )]
1624    pub(crate) fn create_parallel_flat_sources(
1625        &self,
1626        sources: Vec<BoxedRecordBatchStream>,
1627        semaphore: Arc<Semaphore>,
1628        channel_size: usize,
1629    ) -> Result<Vec<BoxedRecordBatchStream>> {
1630        if sources.len() <= 1 {
1631            return Ok(sources);
1632        }
1633
1634        // Spawn a task for each source.
1635        let sources = sources
1636            .into_iter()
1637            .map(|source| {
1638                let (sender, receiver) = mpsc::channel(channel_size);
1639                self.spawn_flat_scan_task(source, semaphore.clone(), sender);
1640                let stream = Box::pin(ReceiverStream::new(receiver));
1641                Box::pin(stream) as _
1642            })
1643            .collect();
1644        Ok(sources)
1645    }
1646
1647    /// Spawns a task to scan a flat source (RecordBatch stream) asynchronously.
1648    #[tracing::instrument(
1649        skip(self, input, semaphore, sender),
1650        fields(region_id = %self.region_metadata().region_id)
1651    )]
1652    pub(crate) fn spawn_flat_scan_task(
1653        &self,
1654        mut input: BoxedRecordBatchStream,
1655        semaphore: Arc<Semaphore>,
1656        sender: mpsc::Sender<Result<RecordBatch>>,
1657    ) {
1658        let region_id = self.region_metadata().region_id;
1659        let span = tracing::info_span!(
1660            "ScanInput::parallel_scan_task",
1661            region_id = %region_id,
1662            stream_kind = "flat"
1663        );
1664        common_runtime::spawn_query(
1665            async move {
1666                loop {
1667                    // We release the permit before sending result to avoid the task waiting on
1668                    // the channel with the permit held.
1669                    let maybe_batch = {
1670                        tokio::select! {
1671                            // Cancellation or early completion can drop the receiver while
1672                            // we wait for a permit or I/O. Exit and drop the
1673                            // input to release its reservations without waiting for a batch.
1674                            _ = sender.closed() => break,
1675                            batch = async {
1676                                // Safety: We never close the semaphore.
1677                                let _permit = semaphore.acquire().await.unwrap();
1678                                input.next().await
1679                            } => batch,
1680                        }
1681                    };
1682                    match maybe_batch {
1683                        Some(Ok(batch)) => {
1684                            // The receiver is gone when the query is cancelled or finishes early,
1685                            // so stop reading the source.
1686                            if let Err(e) = sender.send(Ok(batch)).await {
1687                                debug!(
1688                                    "Stop parallel scan task, receiver dropped, region_id: {}, error: {}",
1689                                    region_id, e
1690                                );
1691                                break;
1692                            }
1693                        }
1694                        Some(Err(e)) => {
1695                            let _ = sender.send(Err(e)).await;
1696                            break;
1697                        }
1698                        None => break,
1699                    }
1700                }
1701            }
1702            .instrument(span),
1703        );
1704    }
1705
1706    /// Whether physical source row counts are known and equal the rows visible
1707    /// to this region, before applying query predicates.
1708    pub(crate) fn total_rows_is_exact(&self) -> bool {
1709        // Legacy SST metadata uses zero for unknown row counts.
1710        if self.files.iter().any(|file| file.num_rows() == 0) {
1711            return false;
1712        }
1713
1714        if self.region_partition_expr.is_none() {
1715            return true;
1716        }
1717
1718        // Extension ranges do not expose their partition expressions.
1719        #[cfg(feature = "enterprise")]
1720        if !self.extension_ranges.is_empty() {
1721            return false;
1722        }
1723
1724        // Repartition flushes existing memtables before entering staging. New
1725        // writes are routed under the target partition rules, whereas historical
1726        // SSTs can be shared by regions and still need partition filtering.
1727        self.files
1728            .iter()
1729            .all(|file| self.should_skip_region_partition(file))
1730    }
1731
1732    pub(crate) fn total_rows(&self) -> usize {
1733        let rows_in_files: usize = self.files.iter().map(|f| f.num_rows()).sum();
1734        let rows_in_memtables: usize = self.memtables.iter().map(|m| m.stats().num_rows()).sum();
1735
1736        let rows = rows_in_files + rows_in_memtables;
1737        #[cfg(feature = "enterprise")]
1738        let rows = rows
1739            + self
1740                .extension_ranges
1741                .iter()
1742                .map(|x| x.num_rows())
1743                .sum::<u64>() as usize;
1744        rows
1745    }
1746
1747    pub(crate) fn predicate_group(&self) -> &PredicateGroup {
1748        &self.predicate
1749    }
1750
1751    /// Returns number of memtables to scan.
1752    pub(crate) fn num_memtables(&self) -> usize {
1753        self.memtables.len()
1754    }
1755
1756    /// Returns number of SST files to scan.
1757    pub(crate) fn num_files(&self) -> usize {
1758        self.files.len()
1759    }
1760
1761    /// Gets the file handle from a row group index.
1762    pub(crate) fn file_from_index(&self, index: RowGroupIndex) -> &FileHandle {
1763        let file_index = index.index - self.num_memtables();
1764        &self.files[file_index]
1765    }
1766
1767    pub fn region_metadata(&self) -> &RegionMetadataRef {
1768        self.mapper.metadata()
1769    }
1770
1771    fn range_pre_filter_mode(&self, source_count: usize) -> PreFilterMode {
1772        if source_count <= 1 {
1773            // Duplicated rows in the same source is not a normal case and we don't provide
1774            // strict dedup semantic (last_row/last_non_null) for it. We expect the duplicated rows
1775            // are exactly identical in the same source so we use PreFilterMode::All for
1776            // performance reason.
1777            return PreFilterMode::All;
1778        }
1779
1780        pre_filter_mode(self.append_mode, self.merge_mode)
1781    }
1782}
1783
1784#[cfg(feature = "enterprise")]
1785impl ScanInput {
1786    #[cfg(feature = "enterprise")]
1787    pub(crate) fn extension_ranges(&self) -> &[BoxedExtensionRange] {
1788        &self.extension_ranges
1789    }
1790
1791    /// Get a boxed [ExtensionRange] by the index in all ranges.
1792    #[cfg(feature = "enterprise")]
1793    pub(crate) fn extension_range(&self, i: usize) -> &BoxedExtensionRange {
1794        &self.extension_ranges[i - self.num_memtables() - self.num_files()]
1795    }
1796}
1797
1798/// Lightweight [PruningStatistics] that only uses the file-level time range from manifest
1799/// metadata, avoiding any parquet metadata reads. Used for early file-level pruning before
1800/// accessing row-group-level statistics.
1801pub(crate) struct FileLevelPruningStats {
1802    /// Scalar value for the file's minimum timestamp in the time index column's unit.
1803    pub(crate) min_scalar: ScalarValue,
1804    /// Scalar value for the file's maximum timestamp in the time index column's unit.
1805    pub(crate) max_scalar: ScalarValue,
1806    /// Name of the time index column.
1807    pub(crate) time_index_col_name: String,
1808}
1809
1810impl PruningStatistics for FileLevelPruningStats {
1811    fn min_values(&self, column: &Column) -> Option<ArrayRef> {
1812        if column.name == self.time_index_col_name {
1813            ScalarValue::iter_to_array(std::iter::once(self.min_scalar.clone())).ok()
1814        } else {
1815            None
1816        }
1817    }
1818
1819    fn max_values(&self, column: &Column) -> Option<ArrayRef> {
1820        if column.name == self.time_index_col_name {
1821            ScalarValue::iter_to_array(std::iter::once(self.max_scalar.clone())).ok()
1822        } else {
1823            None
1824        }
1825    }
1826
1827    fn num_containers(&self) -> usize {
1828        1
1829    }
1830
1831    fn null_counts(&self, column: &Column) -> Option<ArrayRef> {
1832        if column.name == self.time_index_col_name {
1833            // The time index column is NOT NULL.
1834            Some(Arc::new(UInt64Array::from(vec![0u64])))
1835        } else {
1836            None
1837        }
1838    }
1839
1840    fn row_counts(&self) -> Option<ArrayRef> {
1841        None
1842    }
1843
1844    fn contained(&self, _column: &Column, _values: &HashSet<ScalarValue>) -> Option<BooleanArray> {
1845        None
1846    }
1847}
1848
1849#[cfg(test)]
1850impl ScanInput {
1851    /// Returns SST file ids to scan.
1852    pub(crate) fn file_ids(&self) -> Vec<crate::sst::file::RegionFileId> {
1853        self.files.iter().map(|file| file.file_id()).collect()
1854    }
1855
1856    pub(crate) fn index_ids(&self) -> Vec<crate::sst::file::RegionIndexId> {
1857        self.files.iter().map(|file| file.index_id()).collect()
1858    }
1859}
1860
1861fn pre_filter_mode(append_mode: bool, merge_mode: MergeMode) -> PreFilterMode {
1862    if append_mode {
1863        return PreFilterMode::All;
1864    }
1865
1866    match merge_mode {
1867        MergeMode::LastRow => PreFilterMode::SkipFields,
1868        MergeMode::LastNonNull => PreFilterMode::SkipFields,
1869    }
1870}
1871
1872/// Selects the SST files for a scan and, when requested, determines whether
1873/// the selected files support an exact sequence-range scan.
1874///
1875/// Files excluded by the request time range are not selected: `(C, H]` rows are
1876/// a subset of the query's time-range rows, so a time-pruned file cannot
1877/// contribute a row to `(C, H]`.
1878///
1879/// Unmarked local files use `FileMeta.sequence` as an admission barrier rather
1880/// than a row maximum. Region edits allocate this barrier; compaction inherits
1881/// the maximum input bound without assigning a new barrier. `C >= barrier`
1882/// proves Flow has already consumed the entire file, so such a file is excluded
1883/// before the capability check. An unknown bound cannot prove this exclusion.
1884///
1885/// A foreign file is different: the parquet reader virtualizes every row to its
1886/// target-local `FileMeta.sequence`. Consequently, a present sequence is the
1887/// only trust requirement for a foreign file; its source marker is irrelevant.
1888/// A foreign file without that barrier is retained as a failed-closed error so
1889/// it cannot be mistaken for a local sequence domain. This check is performed
1890/// even when another exact-range capability condition would return `None`.
1891pub(crate) fn exact_sequence_range(
1892    request: &ScanRequest,
1893    version: &crate::region::version::Version,
1894) -> Result<(Vec<FileHandle>, Option<SequenceRange>)> {
1895    if request.skip_sst_files {
1896        return Ok((Vec::new(), None));
1897    }
1898
1899    let time_index = version.metadata.time_index_column();
1900    let unit = time_index
1901        .column_schema
1902        .data_type
1903        .as_timestamp()
1904        .expect("Time index must have timestamp-compatible type")
1905        .unit();
1906    let time_range =
1907        build_time_range_predicate(&time_index.column_schema.name, unit, &request.filters);
1908    let min = request.memtable_min_sequence;
1909    let mut check_capability = request.exact_sequence_range && min.is_some();
1910    let sst_min_sequence = request.sst_min_sequence.and_then(NonZeroU64::new);
1911    let mut files = Vec::new();
1912    let mut files_allow_exact_range = true;
1913
1914    for file in version
1915        .ssts
1916        .levels()
1917        .iter()
1918        .flat_map(|level| level.files.values())
1919        .filter(|file| file_in_range(file, &time_range))
1920    {
1921        let meta = file.meta_ref();
1922        let selected = (!request.exact_sequence_range
1923            || min.is_none_or(|min| meta.sequence.is_none_or(|sequence| sequence.get() > min)))
1924            && match (sst_min_sequence, meta.sequence) {
1925                (Some(min_sequence), Some(file_sequence)) => file_sequence > min_sequence,
1926                // A missing file sequence is treated as newer than the SST
1927                // pruning hint, matching scan input construction.
1928                (Some(_), None) | (None, _) => true,
1929            };
1930        if !selected {
1931            continue;
1932        }
1933
1934        if let Some(min) = min
1935            && check_capability
1936        {
1937            if meta.region_id != version.metadata.region_id && meta.sequence.is_none() {
1938                return RegionSequenceDomainBrokenSnafu {
1939                    region_id: version.metadata.region_id,
1940                    file_region_id: meta.region_id,
1941                    file_id: meta.file_id,
1942                }
1943                .fail();
1944            }
1945            if meta.region_id == version.metadata.region_id
1946                && !file.is_effective_target_sequence_trusted(version.metadata.region_id)
1947                && meta.sequence.is_none_or(|barrier| barrier.get() > min)
1948            {
1949                // Match the capability helper's short-circuit behavior: once
1950                // an unadmitted local file is found, later files cannot change
1951                // the result or expose a foreign-domain error.
1952                files_allow_exact_range = false;
1953                check_capability = false;
1954            }
1955        }
1956        files.push(file.clone());
1957    }
1958
1959    let sequence_range = match (
1960        request.exact_sequence_range,
1961        min,
1962        version.options.preserve_row_sequence,
1963        request.memtable_max_sequence,
1964        files_allow_exact_range,
1965    ) {
1966        (true, Some(min), true, Some(max), true) => Some(SequenceRange::GtLtEq { min, max }),
1967        _ => None,
1968    };
1969    Ok((files, sequence_range))
1970}
1971
1972/// Metadata totals for distinct SST files, not post-filter rows or actual read bytes.
1973/// Older files may have unknown row and row-group counts represented by zero.
1974#[derive(Default, serde::Serialize)]
1975struct FileSummary {
1976    files: usize,
1977    rows: u64,
1978    row_groups: u64,
1979    size: u64,
1980    index_size: u64,
1981}
1982
1983impl FileSummary {
1984    fn new<'a>(files: impl IntoIterator<Item = &'a FileHandle>) -> Self {
1985        let mut summary = Self::default();
1986        for file in files {
1987            summary.files += 1;
1988            summary.rows += file.meta_ref().num_rows;
1989            summary.row_groups += file.meta_ref().num_row_groups;
1990            summary.size += file.size();
1991            summary.index_size += file.index_size();
1992        }
1993        summary
1994    }
1995}
1996
1997/// Keeps the existing debug-list spacing while escaping strings as JSON, including
1998/// control characters for which Rust's Debug escaping is not valid JSON.
1999struct ExplainString<'a>(&'a str);
2000
2001impl fmt::Debug for ExplainString<'_> {
2002    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2003        f.write_str(&serde_json::to_string(self.0).map_err(|_| fmt::Error)?)
2004    }
2005}
2006
2007/// Context shared by different streams from a scanner.
2008/// It contains the input and ranges to scan.
2009pub struct StreamContext {
2010    /// Input memtables and files.
2011    pub input: ScanInput,
2012    /// Metadata for partition ranges.
2013    pub(crate) ranges: Vec<RangeMeta>,
2014    // Metrics:
2015    /// The start time of the query.
2016    pub(crate) query_start: Instant,
2017}
2018
2019impl StreamContext {
2020    /// Creates a new [StreamContext] for [SeqScan].
2021    pub(crate) fn seq_scan_ctx(input: ScanInput) -> Self {
2022        let query_start = input.query_start.unwrap_or_else(Instant::now);
2023        let ranges = RangeMeta::seq_scan_ranges(&input);
2024        READ_SST_COUNT.observe(input.num_files() as f64);
2025        Self {
2026            input,
2027            ranges,
2028            query_start,
2029        }
2030    }
2031
2032    /// Creates a new [StreamContext] for [UnorderedScan].
2033    pub(crate) fn unordered_scan_ctx(input: ScanInput) -> Self {
2034        let query_start = input.query_start.unwrap_or_else(Instant::now);
2035        let ranges = RangeMeta::unordered_scan_ranges(&input);
2036        READ_SST_COUNT.observe(input.num_files() as f64);
2037        Self {
2038            input,
2039            ranges,
2040            query_start,
2041        }
2042    }
2043
2044    /// Returns true if the index refers to a memtable.
2045    pub(crate) fn is_mem_range_index(&self, index: RowGroupIndex) -> bool {
2046        self.input.num_memtables() > index.index
2047    }
2048
2049    pub(crate) fn is_file_range_index(&self, index: RowGroupIndex) -> bool {
2050        !self.is_mem_range_index(index)
2051            && index.index < self.input.num_files() + self.input.num_memtables()
2052    }
2053
2054    pub(crate) fn range_pre_filter_mode(&self, part_range: &PartitionRange) -> PreFilterMode {
2055        let range_meta = &self.ranges[part_range.identifier];
2056        let source_count = range_meta.indices.len();
2057
2058        self.input.range_pre_filter_mode(source_count)
2059    }
2060
2061    /// Retrieves the partition ranges.
2062    pub(crate) fn partition_ranges(&self) -> Vec<PartitionRange> {
2063        self.ranges
2064            .iter()
2065            .enumerate()
2066            .map(|(idx, range_meta)| range_meta.new_partition_range(idx))
2067            .collect()
2068    }
2069
2070    /// Format the context for explain.
2071    pub(crate) fn format_for_explain(&self, verbose: bool, f: &mut fmt::Formatter) -> fmt::Result {
2072        let (mut num_mem_ranges, mut num_file_ranges, mut num_other_ranges) = (0, 0, 0);
2073        for range_meta in &self.ranges {
2074            for idx in &range_meta.row_group_indices {
2075                if self.is_mem_range_index(*idx) {
2076                    num_mem_ranges += 1;
2077                } else if self.is_file_range_index(*idx) {
2078                    num_file_ranges += 1;
2079                } else {
2080                    num_other_ranges += 1;
2081                }
2082            }
2083        }
2084        if verbose {
2085            write!(f, "{{")?;
2086        }
2087        write!(
2088            f,
2089            r#""partition_count":{{"count":{}, "mem_ranges":{}, "files":{}, "file_ranges":{}"#,
2090            self.ranges.len(),
2091            num_mem_ranges,
2092            self.input.num_files(),
2093            num_file_ranges,
2094        )?;
2095        if num_other_ranges > 0 {
2096            write!(f, r#", "other_ranges":{}"#, num_other_ranges)?;
2097        }
2098        write!(f, "}}")?;
2099
2100        if let Some(selector) = &self.input.series_row_selector {
2101            write!(f, ", \"selector\":\"{}\"", selector)?;
2102        }
2103        if let Some(distribution) = &self.input.distribution {
2104            write!(f, ", \"distribution\":\"{}\"", distribution)?;
2105        }
2106
2107        self.format_scan_details(f)?;
2108        if verbose {
2109            self.format_verbose_content(f)?;
2110        }
2111
2112        Ok(())
2113    }
2114
2115    fn format_scan_details(&self, f: &mut fmt::Formatter) -> fmt::Result {
2116        let output_schema = self.input.mapper.output_schema();
2117        if !output_schema.is_empty() {
2118            write!(f, ", \"projection\": ")?;
2119            f.debug_list()
2120                .entries(
2121                    output_schema
2122                        .column_schemas()
2123                        .iter()
2124                        .map(|col| ExplainString(&col.name)),
2125                )
2126                .finish()?;
2127        }
2128        if let Some(predicate) = self.input.predicate.predicate() {
2129            if !predicate.exprs().is_empty() {
2130                let exprs: Vec<_> = predicate.exprs().iter().map(|e| e.to_string()).collect();
2131                write!(f, ", \"filters\": ")?;
2132                f.debug_list()
2133                    .entries(exprs.iter().map(|e| ExplainString(e)))
2134                    .finish()?;
2135            }
2136            if !predicate.dyn_filters().is_empty() {
2137                let filters: Vec<_> = predicate
2138                    .dyn_filters()
2139                    .iter()
2140                    .map(|filter| filter.to_string())
2141                    .collect();
2142                write!(f, ", \"dyn_filters\": ")?;
2143                f.debug_list()
2144                    .entries(filters.iter().map(|filter| ExplainString(filter)))
2145                    .finish()?;
2146            }
2147        }
2148        if let Some(time_range) = &self.input.time_range {
2149            write!(
2150                f,
2151                ", \"time_range\": {:?}",
2152                ExplainString(&time_range.to_string())
2153            )?;
2154        }
2155        let summary = FileSummary::new(&self.input.files);
2156        write!(
2157            f,
2158            ", \"file_summary\": {}",
2159            serde_json::to_string(&summary).map_err(|_| fmt::Error)?
2160        )?;
2161
2162        // Source indices are unique within a range even when a file is split into
2163        // row groups. Memtables and extension sources must not count as files.
2164        let file_offset = self.input.num_memtables();
2165        let file_end = file_offset + self.input.num_files();
2166        let mut max_range = None;
2167        let mut max_files = 0;
2168        for range in &self.ranges {
2169            let files = range
2170                .indices
2171                .iter()
2172                .filter(|source| (file_offset..file_end).contains(&source.index))
2173                .count();
2174            if files > max_files {
2175                max_files = files;
2176                max_range = Some(range);
2177            }
2178        }
2179        if let Some(range) = max_range {
2180            let summary = FileSummary::new(range.indices.iter().filter_map(|source| {
2181                source
2182                    .index
2183                    .checked_sub(file_offset)
2184                    .and_then(|index| self.input.files.get(index))
2185            }));
2186            let (start, end) = range.time_range;
2187            // RangeMeta bounds are inclusive, just like the verbose file list.
2188            let summary = serde_json::json!({
2189                "time_range_start": format!("{}::{}", start.value(), start.unit()),
2190                "time_range_end": format!("{}::{}", end.value(), end.unit()),
2191                "files": summary.files,
2192                "rows": summary.rows,
2193                "row_groups": summary.row_groups,
2194                "size": summary.size,
2195                "index_size": summary.index_size,
2196                "estimated_rows": range.num_rows,
2197            });
2198            write!(f, ", \"max_part_range\": {summary}")?;
2199        }
2200        Ok(())
2201    }
2202
2203    fn format_verbose_content(&self, f: &mut fmt::Formatter) -> fmt::Result {
2204        struct FileWrapper<'a> {
2205            file: &'a FileHandle,
2206        }
2207
2208        impl fmt::Debug for FileWrapper<'_> {
2209            fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2210                let (start, end) = self.file.time_range();
2211                write!(
2212                    f,
2213                    r#"{{"file_id":"{}","time_range_start":"{}::{}","time_range_end":"{}::{}","rows":{},"size":{},"index_size":{}}}"#,
2214                    self.file.file_id(),
2215                    start.value(),
2216                    start.unit(),
2217                    end.value(),
2218                    end.unit(),
2219                    self.file.num_rows(),
2220                    self.file.size(),
2221                    self.file.index_size()
2222                )
2223            }
2224        }
2225
2226        struct InputWrapper<'a> {
2227            input: &'a ScanInput,
2228        }
2229
2230        #[cfg(feature = "enterprise")]
2231        impl InputWrapper<'_> {
2232            fn format_extension_ranges(&self, f: &mut fmt::Formatter) -> fmt::Result {
2233                if self.input.extension_ranges.is_empty() {
2234                    return Ok(());
2235                }
2236
2237                let mut delimiter = "";
2238                write!(f, ", extension_ranges: [")?;
2239                for range in self.input.extension_ranges() {
2240                    write!(f, "{}{:?}", delimiter, range)?;
2241                    delimiter = ", ";
2242                }
2243                write!(f, "]")?;
2244                Ok(())
2245            }
2246        }
2247
2248        impl fmt::Debug for InputWrapper<'_> {
2249            fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2250                if !self.input.files.is_empty() {
2251                    write!(f, ", \"files\": ")?;
2252                    f.debug_list()
2253                        .entries(self.input.files.iter().map(|file| FileWrapper { file }))
2254                        .finish()?;
2255                }
2256                write!(f, ", \"flat_format\": {}", self.input.explain_flat_format)?;
2257                #[cfg(feature = "enterprise")]
2258                self.format_extension_ranges(f)?;
2259
2260                Ok(())
2261            }
2262        }
2263
2264        write!(f, "{:?}", InputWrapper { input: &self.input })
2265    }
2266
2267    /// Add new dynamic filters to the predicates.
2268    /// Safe after stream creation; in-flight reads may still observe an older snapshot.
2269    pub(crate) fn add_dyn_filter_to_predicate(
2270        self: &Arc<Self>,
2271        filter_exprs: Vec<Arc<dyn datafusion::physical_plan::PhysicalExpr>>,
2272    ) -> Vec<bool> {
2273        let mut supported = Vec::with_capacity(filter_exprs.len());
2274        let filter_expr = filter_exprs
2275            .into_iter()
2276            .filter_map(|expr| {
2277                if let Ok(dyn_filter) = (expr as Arc<dyn std::any::Any + Send + Sync + 'static>)
2278                .downcast::<datafusion::physical_plan::expressions::DynamicFilterPhysicalExpr>()
2279            {
2280                supported.push(true);
2281                Some(dyn_filter)
2282            } else {
2283                supported.push(false);
2284                None
2285            }
2286            })
2287            .collect();
2288        self.input.predicate.add_dyn_filters(filter_expr);
2289        supported
2290    }
2291}
2292
2293/// Predicates to evaluate.
2294/// It only keeps filters that [SimpleFilterEvaluator] supports.
2295#[derive(Clone, Default)]
2296pub struct PredicateGroup {
2297    time_filters: Option<Arc<Vec<SimpleFilterEvaluator>>>,
2298    /// Predicate that includes request filters and region partition expr (if any).
2299    predicate_all: Predicate,
2300    /// Predicate that only includes request filters.
2301    predicate_without_region: Predicate,
2302    /// Region partition expression restored from metadata.
2303    region_partition_expr: Option<PartitionExpr>,
2304}
2305
2306impl PredicateGroup {
2307    /// Creates a new `PredicateGroup` from exprs according to the metadata.
2308    pub fn new(metadata: &RegionMetadata, exprs: &[Expr]) -> Result<Self> {
2309        let mut combined_exprs = exprs.to_vec();
2310        let mut region_partition_expr = None;
2311
2312        if let Some(expr_json) = metadata.partition_expr.as_ref()
2313            && !expr_json.is_empty()
2314            && let Some(expr) = PartitionExpr::from_json_str(expr_json)
2315                .context(InvalidPartitionExprSnafu { expr: expr_json })?
2316        {
2317            let logical_expr = expr
2318                .try_as_logical_expr()
2319                .context(InvalidPartitionExprSnafu {
2320                    expr: expr_json.clone(),
2321                })?;
2322
2323            // Persisted partition bounds retain their original types after schema changes.
2324            let schema = metadata
2325                .schema
2326                .arrow_schema()
2327                .clone()
2328                .to_dfschema_ref()
2329                .context(EvalPartitionFilterSnafu)?;
2330            let simplifier = ExprSimplifier::new(
2331                SimplifyContext::builder()
2332                    .with_schema(schema.clone())
2333                    .build(),
2334            );
2335            let logical_expr = simplifier
2336                .coerce(logical_expr, &schema)
2337                .and_then(|expr| simplifier.simplify(expr))
2338                .context(EvalPartitionFilterSnafu)?;
2339            combined_exprs.push(logical_expr);
2340            region_partition_expr = Some(expr);
2341        }
2342
2343        let mut time_filters = Vec::with_capacity(combined_exprs.len());
2344        // Columns in the expr.
2345        let mut columns = HashSet::new();
2346        for expr in &combined_exprs {
2347            columns.clear();
2348            let Some(filter) = Self::expr_to_filter(expr, metadata, &mut columns) else {
2349                continue;
2350            };
2351            time_filters.push(filter);
2352        }
2353        let time_filters = if time_filters.is_empty() {
2354            None
2355        } else {
2356            Some(Arc::new(time_filters))
2357        };
2358
2359        let predicate_all = Predicate::new(combined_exprs);
2360        let predicate_without_region = Predicate::new(exprs.to_vec());
2361
2362        Ok(Self {
2363            time_filters,
2364            predicate_all,
2365            predicate_without_region,
2366            region_partition_expr,
2367        })
2368    }
2369
2370    /// Returns time filters.
2371    pub(crate) fn time_filters(&self) -> Option<Arc<Vec<SimpleFilterEvaluator>>> {
2372        self.time_filters.clone()
2373    }
2374
2375    /// Returns predicate of all exprs (including region partition expr if present).
2376    pub(crate) fn predicate(&self) -> Option<&Predicate> {
2377        if self.predicate_all.is_empty() {
2378            None
2379        } else {
2380            Some(&self.predicate_all)
2381        }
2382    }
2383
2384    /// Returns predicate that excludes region partition expr.
2385    pub(crate) fn predicate_without_region(&self) -> Option<&Predicate> {
2386        if self.predicate_without_region.is_empty() {
2387            None
2388        } else {
2389            Some(&self.predicate_without_region)
2390        }
2391    }
2392
2393    /// Add dynamic filters in the predicates.
2394    pub(crate) fn add_dyn_filters(&self, dyn_filters: Vec<Arc<DynamicFilterPhysicalExpr>>) {
2395        self.predicate_all.add_dyn_filters(dyn_filters.clone());
2396        self.predicate_without_region.add_dyn_filters(dyn_filters);
2397    }
2398
2399    /// Removes dynamic filters while preserving the static and region predicates.
2400    pub(crate) fn clear_dyn_filters(&self) {
2401        self.predicate_all.clear_dyn_filters();
2402        self.predicate_without_region.clear_dyn_filters();
2403    }
2404
2405    /// Returns the region partition expr from metadata, if any.
2406    pub(crate) fn region_partition_expr(&self) -> Option<&PartitionExpr> {
2407        self.region_partition_expr.as_ref()
2408    }
2409
2410    fn expr_to_filter(
2411        expr: &Expr,
2412        metadata: &RegionMetadata,
2413        columns: &mut HashSet<Column>,
2414    ) -> Option<SimpleFilterEvaluator> {
2415        columns.clear();
2416        // `expr_to_columns` won't return error.
2417        // We still ignore these expressions for safety.
2418        expr_to_columns(expr, columns).ok()?;
2419        if columns.len() > 1 {
2420            // Simple filter doesn't support multiple columns.
2421            return None;
2422        }
2423        let column = columns.iter().next()?;
2424        let column_meta = metadata.column_by_name(&column.name)?;
2425        if column_meta.semantic_type == SemanticType::Timestamp {
2426            SimpleFilterEvaluator::try_new(expr)
2427        } else {
2428            None
2429        }
2430    }
2431}
2432
2433#[cfg(test)]
2434mod tests {
2435    use std::collections::BTreeMap;
2436    use std::sync::Arc;
2437
2438    use common_time::timestamp::{TimeUnit, Timestamp};
2439    use datafusion::physical_plan::expressions::{
2440        binary as physical_binary, col as physical_col, lit as physical_lit,
2441    };
2442    use datafusion_common::ScalarValue;
2443    use datafusion_expr::{Operator, col, lit};
2444    use datatypes::arrow::datatypes::{
2445        DataType as ArrowDataType, Field, Schema as ArrowSchema, TimeUnit as ArrowTimeUnit,
2446    };
2447    use datatypes::prelude::ConcreteDataType;
2448    use datatypes::schema::ColumnSchema;
2449    use datatypes::types::json_type::JsonObjectType;
2450    use datatypes::value::Value;
2451    use partition::expr::col as partition_col;
2452    use store_api::metadata::{ColumnMetadata, RegionMetadataBuilder};
2453    use store_api::storage::{RegionId, TimeSeriesDistribution, TimeSeriesRowSelector};
2454
2455    use super::*;
2456    use crate::cache::CacheManager;
2457    use crate::read::range_cache::ScanRequestFingerprintBuilder;
2458    use crate::sst::file::FileMeta;
2459    use crate::test_util::memtable_util::metadata_with_primary_key;
2460    use crate::test_util::scheduler_util::SchedulerEnv;
2461
2462    async fn new_scan_input(metadata: RegionMetadataRef, filters: Vec<Expr>) -> ScanInputBuilder {
2463        let env = SchedulerEnv::new().await;
2464        let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2465        let predicate = PredicateGroup::new(metadata.as_ref(), &filters).unwrap();
2466        let file = FileHandle::new(
2467            crate::sst::file::FileMeta::default(),
2468            Arc::new(crate::sst::file_purger::NoopFilePurger),
2469        );
2470
2471        ScanInput::builder(env.access_layer.clone(), mapper)
2472            .with_predicate(predicate)
2473            .with_cache(CacheStrategy::EnableAll(Arc::new(
2474                CacheManager::builder()
2475                    .range_result_cache_size(1024)
2476                    .build(),
2477            )))
2478            .with_files(vec![file])
2479    }
2480
2481    #[test]
2482    fn test_partition_time_filter_after_unit_widening() {
2483        use datatypes::arrow::array::TimestampMicrosecondArray;
2484
2485        let bound = Value::Timestamp(Timestamp::new_millisecond(1));
2486        for (expr, expected) in [
2487            (
2488                partition_col("ts").lt(bound.clone()),
2489                vec![true, false, false],
2490            ),
2491            (partition_col("ts").gt_eq(bound), vec![false, true, true]),
2492        ] {
2493            let mut builder = RegionMetadataBuilder::new(RegionId::new(1, 1));
2494            builder.push_column_metadata(ColumnMetadata {
2495                column_schema: ColumnSchema::new(
2496                    "ts",
2497                    ConcreteDataType::timestamp_microsecond_datatype(),
2498                    false,
2499                ),
2500                semantic_type: SemanticType::Timestamp,
2501                column_id: 0,
2502            });
2503            builder.primary_key(vec![]);
2504            builder.partition_expr_json(Some(expr.as_json_str().unwrap()));
2505            let metadata = builder.build().unwrap();
2506            let group = PredicateGroup::new(&metadata, &[]).unwrap();
2507            let filters = group.time_filters().unwrap();
2508            let input: ArrayRef = Arc::new(TimestampMicrosecondArray::from(vec![999, 1000, 1001]));
2509            assert_eq!(filters.len(), 1);
2510            assert_eq!(
2511                filters[0].evaluate_array(&input).unwrap(),
2512                datafusion_common::arrow::buffer::BooleanBuffer::from(expected),
2513            );
2514        }
2515    }
2516
2517    #[test]
2518    fn test_partition_time_filter_overflow_after_unit_widening() {
2519        // Year 3000 fits milliseconds but overflows nanoseconds.
2520        let bound = Value::Timestamp(Timestamp::new_millisecond(32_503_680_000_000));
2521        let expr = partition_col("ts").lt(bound);
2522        let mut builder = RegionMetadataBuilder::new(RegionId::new(1, 1));
2523        builder.push_column_metadata(ColumnMetadata {
2524            column_schema: ColumnSchema::new(
2525                "ts",
2526                ConcreteDataType::timestamp_nanosecond_datatype(),
2527                false,
2528            ),
2529            semantic_type: SemanticType::Timestamp,
2530            column_id: 0,
2531        });
2532        builder.primary_key(vec![]);
2533        builder.partition_expr_json(Some(expr.as_json_str().unwrap()));
2534        let metadata = builder.build().unwrap();
2535
2536        let error = PredicateGroup::new(&metadata, &[])
2537            .err()
2538            .expect("an overflowing partition bound must fail scan construction");
2539        let crate::error::Error::EvalPartitionFilter { error, .. } = error else {
2540            panic!("unexpected error: {error:?}");
2541        };
2542        assert!(
2543            error
2544                .to_string()
2545                .contains("converted value exceeds the representable i64 range"),
2546            "{error}"
2547        );
2548    }
2549
2550    #[tokio::test]
2551    async fn test_total_rows_is_exact_with_legacy_file() {
2552        let file_meta = FileMeta {
2553            num_rows: 10,
2554            ..Default::default()
2555        };
2556        let mut json = serde_json::to_value(&file_meta).unwrap();
2557        json.as_object_mut().unwrap().remove("num_rows");
2558        let legacy_meta = serde_json::from_value::<FileMeta>(json).unwrap();
2559        assert_eq!(legacy_meta.num_rows, 0);
2560
2561        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2562        for (file_metas, expected_rows, exact) in [
2563            (vec![file_meta.clone()], 10, true),
2564            (vec![legacy_meta.clone()], 0, false),
2565            (vec![file_meta, legacy_meta], 10, false),
2566        ] {
2567            let files = file_metas
2568                .into_iter()
2569                .map(|meta| {
2570                    FileHandle::new(meta, Arc::new(crate::sst::file_purger::NoopFilePurger))
2571                })
2572                .collect();
2573            let input = new_scan_input(metadata.clone(), vec![])
2574                .await
2575                .with_append_mode(true)
2576                .with_files(files)
2577                .build();
2578            assert_eq!(input.total_rows(), expected_rows);
2579            assert_eq!(input.total_rows_is_exact(), exact);
2580        }
2581    }
2582
2583    #[tokio::test]
2584    async fn test_total_rows_is_exact_after_partition_filter() {
2585        let expr = partition_col("k0").gt_eq(Value::String("foo".into()));
2586        let other = partition_col("k0").gt_eq(Value::String("bar".into()));
2587        for (region_expr, file_exprs, exact) in [
2588            (None, vec![None], true),
2589            (None, vec![Some(expr.clone())], true),
2590            (Some(expr.clone()), vec![], true),
2591            (Some(expr.clone()), vec![Some(expr.clone())], true),
2592            (Some(expr.clone()), vec![None], false),
2593            (Some(expr.clone()), vec![Some(other)], false),
2594            (Some(expr.clone()), vec![Some(expr), None], false),
2595        ] {
2596            let mut builder =
2597                RegionMetadataBuilder::from_existing(metadata_with_primary_key(vec![0, 1], false));
2598            builder.partition_expr_json(region_expr.map(|expr| expr.as_json_str().unwrap()));
2599            let metadata = Arc::new(builder.build_without_validation().unwrap());
2600            let files = file_exprs
2601                .into_iter()
2602                .map(|partition_expr| {
2603                    FileHandle::new(
2604                        FileMeta {
2605                            num_rows: 1,
2606                            partition_expr,
2607                            ..Default::default()
2608                        },
2609                        Arc::new(crate::sst::file_purger::NoopFilePurger),
2610                    )
2611                })
2612                .collect();
2613            let input = new_scan_input(metadata, vec![])
2614                .await
2615                .with_files(files)
2616                .build();
2617            assert_eq!(input.total_rows_is_exact(), exact);
2618        }
2619    }
2620
2621    /// Helper to create a timestamp millisecond literal.
2622    fn ts_lit(val: i64) -> datafusion_expr::Expr {
2623        lit(ScalarValue::TimestampMillisecond(Some(val), None))
2624    }
2625
2626    fn metadata_with_time_index_unit(unit: TimeUnit) -> RegionMetadataRef {
2627        let mut builder = RegionMetadataBuilder::new(RegionId::new(123, 456));
2628        builder
2629            .push_column_metadata(ColumnMetadata {
2630                column_schema: ColumnSchema::new(
2631                    "k0".to_string(),
2632                    ConcreteDataType::string_datatype(),
2633                    false,
2634                ),
2635                semantic_type: SemanticType::Tag,
2636                column_id: 0,
2637            })
2638            .push_column_metadata(ColumnMetadata {
2639                column_schema: ColumnSchema::new(
2640                    "k1".to_string(),
2641                    ConcreteDataType::uint32_datatype(),
2642                    false,
2643                ),
2644                semantic_type: SemanticType::Tag,
2645                column_id: 1,
2646            })
2647            .push_column_metadata(ColumnMetadata {
2648                column_schema: ColumnSchema::new(
2649                    "ts".to_string(),
2650                    ConcreteDataType::timestamp_datatype(unit),
2651                    false,
2652                ),
2653                semantic_type: SemanticType::Timestamp,
2654                column_id: 2,
2655            })
2656            .push_column_metadata(ColumnMetadata {
2657                column_schema: ColumnSchema::new(
2658                    "v0".to_string(),
2659                    ConcreteDataType::int64_datatype(),
2660                    true,
2661                ),
2662                semantic_type: SemanticType::Field,
2663                column_id: 3,
2664            })
2665            .primary_key(vec![0, 1]);
2666
2667        Arc::new(builder.build().unwrap())
2668    }
2669
2670    fn file_handle_with_time_range(start: Timestamp, end: Timestamp) -> FileHandle {
2671        FileHandle::new(
2672            FileMeta {
2673                time_range: (start, end),
2674                ..Default::default()
2675            },
2676            Arc::new(crate::sst::file_purger::NoopFilePurger),
2677        )
2678    }
2679
2680    #[test]
2681    fn test_time_range_covers_file() {
2682        let file = file_handle_with_time_range(
2683            Timestamp::new_millisecond(1000),
2684            Timestamp::new_millisecond(2000),
2685        );
2686
2687        assert!(!time_range_covers_file(None, &file));
2688        assert!(time_range_covers_file(
2689            Some(&TimestampRange::min_to_max()),
2690            &file
2691        ));
2692        assert!(time_range_covers_file(
2693            Some(&TimestampRange::new_inclusive(
2694                Some(Timestamp::new_millisecond(1000)),
2695                Some(Timestamp::new_millisecond(2000)),
2696            )),
2697            &file
2698        ));
2699        assert!(time_range_covers_file(
2700            TimestampRange::with_unit(500, 3000, TimeUnit::Millisecond).as_ref(),
2701            &file
2702        ));
2703        assert!(!time_range_covers_file(
2704            TimestampRange::with_unit(1000, 2000, TimeUnit::Millisecond).as_ref(),
2705            &file
2706        ));
2707        assert!(!time_range_covers_file(
2708            TimestampRange::with_unit(1001, 3000, TimeUnit::Millisecond).as_ref(),
2709            &file
2710        ));
2711        assert!(!time_range_covers_file(
2712            Some(&TimestampRange::empty()),
2713            &file
2714        ));
2715
2716        let seconds_file = file_handle_with_time_range(
2717            Timestamp::new(1, TimeUnit::Second),
2718            Timestamp::new(2, TimeUnit::Second),
2719        );
2720        assert!(time_range_covers_file(
2721            TimestampRange::with_unit(1000, 2001, TimeUnit::Millisecond).as_ref(),
2722            &seconds_file
2723        ));
2724    }
2725
2726    #[tokio::test]
2727    async fn test_scan_input_builder_computes_scan_analysis() {
2728        let metadata = metadata_with_time_index_unit(TimeUnit::Millisecond);
2729        let env = SchedulerEnv::new().await;
2730        let file = file_handle_with_time_range(
2731            Timestamp::new_millisecond(1000),
2732            Timestamp::new_millisecond(2000),
2733        );
2734
2735        let make_input = |filters: &[Expr]| {
2736            let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2737            ScanInput::builder(env.access_layer.clone(), mapper)
2738                .with_predicate(PredicateGroup::new(&metadata, filters).unwrap())
2739                .build()
2740        };
2741
2742        let covered = make_input(&[col("ts").gt_eq(ts_lit(500)), col("ts").lt(ts_lit(3000))]);
2743        assert!(time_range_covers_file(covered.implied_time_range(), &file));
2744
2745        // The convex hull of this disjunction covers the file, but most rows do
2746        // not satisfy it. The strict implied-range analysis must reject it.
2747        let disjoint = make_input(&[col("ts").eq(ts_lit(1000)).or(col("ts").eq(ts_lit(2000)))]);
2748        assert!(disjoint.implied_time_range().is_none());
2749        assert!(!time_range_covers_file(
2750            disjoint.implied_time_range(),
2751            &file
2752        ));
2753
2754        let replaced = ScanInput::builder(
2755            env.access_layer.clone(),
2756            FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap(),
2757        )
2758        .with_predicate(PredicateGroup::new(&metadata, &[col("ts").gt(ts_lit(3000))]).unwrap())
2759        .build();
2760        assert!(!time_range_covers_file(
2761            replaced.implied_time_range(),
2762            &file
2763        ));
2764    }
2765
2766    #[tokio::test]
2767    async fn test_scan_input_uses_explicit_batch_size() {
2768        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2769        let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2770        let env = SchedulerEnv::new().await;
2771        let input = ScanInput::builder(env.access_layer.clone(), mapper).build();
2772        assert_eq!(
2773            crate::sst::parquet::DEFAULT_READ_BATCH_SIZE,
2774            input.batch_size()
2775        );
2776
2777        let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2778        let input = ScanInput::builder(env.access_layer.clone(), mapper)
2779            .with_compaction(true)
2780            .with_batch_size(256)
2781            .build();
2782        assert_eq!(256, input.batch_size());
2783
2784        let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
2785        let input = ScanInput::builder(env.access_layer.clone(), mapper)
2786            .with_batch_size(256)
2787            .with_compaction(true)
2788            .with_compaction(false)
2789            .build();
2790        assert_eq!(256, input.batch_size());
2791    }
2792
2793    #[tokio::test]
2794    async fn test_build_scan_fingerprint_for_eligible_scan() {
2795        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2796        let input = new_scan_input(
2797            metadata.clone(),
2798            vec![
2799                col("ts").gt_eq(ts_lit(1000)),
2800                col("k0").eq(lit("foo")),
2801                col("v0").gt(lit(1)),
2802            ],
2803        )
2804        .await
2805        .with_distribution(Some(TimeSeriesDistribution::PerSeries))
2806        .with_series_row_selector(Some(TimeSeriesRowSelector::LastRow { after_merge: true }))
2807        .with_merge_mode(MergeMode::LastNonNull)
2808        .with_filter_deleted(false)
2809        .build();
2810
2811        let fingerprint = input.scan_fingerprint().unwrap();
2812
2813        let expected = ScanRequestFingerprintBuilder {
2814            read_columns: input.read_cols.clone(),
2815            read_column_types: vec![
2816                metadata
2817                    .column_by_id(0)
2818                    .map(|col| col.column_schema.data_type.clone()),
2819                metadata
2820                    .column_by_id(2)
2821                    .map(|col| col.column_schema.data_type.clone()),
2822                metadata
2823                    .column_by_id(3)
2824                    .map(|col| col.column_schema.data_type.clone()),
2825            ],
2826            filters: vec![
2827                col("k0").eq(lit("foo")).to_string(),
2828                col("v0").gt(lit(1)).to_string(),
2829            ],
2830            time_filters: vec![col("ts").gt_eq(ts_lit(1000)).to_string()],
2831            series_row_selector: Some(TimeSeriesRowSelector::LastRow { after_merge: true }),
2832            append_mode: false,
2833            filter_deleted: false,
2834            merge_mode: MergeMode::LastNonNull,
2835            sequence_range: None,
2836            partition_expr_version: 0,
2837        }
2838        .build();
2839        assert_eq!(&expected, fingerprint);
2840        assert_eq!(
2841            input.series_row_selector,
2842            Some(TimeSeriesRowSelector::LastRow { after_merge: true })
2843        );
2844    }
2845
2846    #[tokio::test]
2847    async fn test_build_scan_fingerprint_requires_tag_filter() {
2848        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2849        let input = new_scan_input(
2850            metadata,
2851            vec![col("ts").gt_eq(lit(1000)), col("v0").gt(lit(1))],
2852        )
2853        .await
2854        .build();
2855
2856        assert!(input.scan_fingerprint().is_none());
2857    }
2858
2859    #[tokio::test]
2860    async fn test_build_scan_fingerprint_respects_scan_eligibility() {
2861        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
2862        let filters = vec![col("k0").eq(lit("foo"))];
2863
2864        let disabled = ScanInput::builder(
2865            SchedulerEnv::new().await.access_layer.clone(),
2866            FlatProjectionMapper::new(&metadata, [0, 2, 3].into_iter()).unwrap(),
2867        )
2868        .with_predicate(PredicateGroup::new(metadata.as_ref(), &filters).unwrap())
2869        .build();
2870        assert!(disabled.scan_fingerprint().is_none());
2871
2872        let compaction = new_scan_input(metadata.clone(), filters.clone())
2873            .await
2874            .with_compaction(true)
2875            .build();
2876        assert!(compaction.scan_fingerprint().is_none());
2877
2878        // No files to read.
2879        let no_files = new_scan_input(metadata, filters)
2880            .await
2881            .with_files(vec![])
2882            .build();
2883        assert!(no_files.scan_fingerprint().is_none());
2884    }
2885
2886    #[tokio::test]
2887    async fn test_build_scan_fingerprint_tracks_schema_and_partition_expr_changes() {
2888        let base = metadata_with_primary_key(vec![0, 1], false);
2889        let mut builder = RegionMetadataBuilder::from_existing(base);
2890        let partition_expr = partition_col("k0")
2891            .gt_eq(Value::String("foo".into()))
2892            .as_json_str()
2893            .unwrap();
2894        builder.partition_expr_json(Some(partition_expr));
2895        let metadata = Arc::new(builder.build_without_validation().unwrap());
2896
2897        let input = new_scan_input(metadata.clone(), vec![col("k0").eq(lit("foo"))])
2898            .await
2899            .build();
2900        let fingerprint = input.scan_fingerprint().unwrap();
2901
2902        let expected = ScanRequestFingerprintBuilder {
2903            read_columns: input.read_cols.clone(),
2904            read_column_types: vec![
2905                metadata
2906                    .column_by_id(0)
2907                    .map(|col| col.column_schema.data_type.clone()),
2908                metadata
2909                    .column_by_id(2)
2910                    .map(|col| col.column_schema.data_type.clone()),
2911                metadata
2912                    .column_by_id(3)
2913                    .map(|col| col.column_schema.data_type.clone()),
2914            ],
2915            filters: vec![col("k0").eq(lit("foo")).to_string()],
2916            time_filters: vec![],
2917            series_row_selector: None,
2918            append_mode: false,
2919            filter_deleted: true,
2920            merge_mode: MergeMode::LastRow,
2921            sequence_range: None,
2922            partition_expr_version: metadata.partition_expr_version,
2923        }
2924        .build();
2925        assert_eq!(&expected, fingerprint);
2926        assert_ne!(0, metadata.partition_expr_version);
2927    }
2928
2929    #[tokio::test]
2930    async fn test_build_scan_fingerprint_uses_json_target_types() {
2931        let mut builder = RegionMetadataBuilder::new(RegionId::new(123, 456));
2932        builder
2933            .push_column_metadata(ColumnMetadata {
2934                column_schema: ColumnSchema::new(
2935                    "k0".to_string(),
2936                    ConcreteDataType::string_datatype(),
2937                    false,
2938                ),
2939                semantic_type: SemanticType::Tag,
2940                column_id: 0,
2941            })
2942            .push_column_metadata(ColumnMetadata {
2943                column_schema: ColumnSchema::new(
2944                    "ts".to_string(),
2945                    ConcreteDataType::timestamp_millisecond_datatype(),
2946                    false,
2947                ),
2948                semantic_type: SemanticType::Timestamp,
2949                column_id: 1,
2950            })
2951            .push_column_metadata(ColumnMetadata {
2952                column_schema: ColumnSchema::new(
2953                    "j".to_string(),
2954                    ConcreteDataType::json2(JsonNativeType::Variant),
2955                    true,
2956                ),
2957                semantic_type: SemanticType::Field,
2958                column_id: 2,
2959            })
2960            .primary_key(vec![0]);
2961        let metadata = Arc::new(builder.build().unwrap());
2962
2963        let make_input = |target_type| async {
2964            let env = SchedulerEnv::new().await;
2965            let read_cols = ReadColumns::new([0, 1, 2])
2966                .with_json_target_types(BTreeMap::from([(2, target_type)]));
2967            let mapper =
2968                FlatProjectionMapper::new_with_read_columns(&metadata, vec![0, 1, 2], read_cols)
2969                    .unwrap();
2970            let predicate =
2971                PredicateGroup::new(metadata.as_ref(), &[col("k0").eq(lit("foo"))]).unwrap();
2972            let file = FileHandle::new(
2973                FileMeta::default(),
2974                Arc::new(crate::sst::file_purger::NoopFilePurger),
2975            );
2976            ScanInput::builder(env.access_layer.clone(), mapper)
2977                .with_predicate(predicate)
2978                .with_cache(CacheStrategy::EnableAll(Arc::new(
2979                    CacheManager::builder()
2980                        .range_result_cache_size(1024)
2981                        .build(),
2982                )))
2983                .with_files(vec![file])
2984                .build()
2985        };
2986
2987        let int_target = JsonNativeType::i64();
2988        let string_target = JsonNativeType::String;
2989        let int_input = make_input(int_target.clone()).await;
2990        let string_input = make_input(string_target).await;
2991        let int_fingerprint = int_input.scan_fingerprint().unwrap();
2992        let string_fingerprint = string_input.scan_fingerprint().unwrap();
2993
2994        assert_ne!(int_fingerprint, string_fingerprint);
2995        assert_eq!(
2996            Some(&Some(ConcreteDataType::json2(int_target))),
2997            int_fingerprint.read_column_types().get(2)
2998        );
2999    }
3000
3001    #[tokio::test]
3002    async fn test_scan_input_rejects_json_type_hint_for_non_json2_column() {
3003        let mut builder = RegionMetadataBuilder::new(RegionId::new(123, 456));
3004        builder
3005            .push_column_metadata(ColumnMetadata {
3006                column_schema: ColumnSchema::new(
3007                    "k0".to_string(),
3008                    ConcreteDataType::string_datatype(),
3009                    false,
3010                ),
3011                semantic_type: SemanticType::Tag,
3012                column_id: 0,
3013            })
3014            .push_column_metadata(ColumnMetadata {
3015                column_schema: ColumnSchema::new(
3016                    "ts".to_string(),
3017                    ConcreteDataType::timestamp_millisecond_datatype(),
3018                    false,
3019                ),
3020                semantic_type: SemanticType::Timestamp,
3021                column_id: 1,
3022            })
3023            .push_column_metadata(ColumnMetadata {
3024                column_schema: ColumnSchema::new(
3025                    "j".to_string(),
3026                    ConcreteDataType::json2(JsonNativeType::Object(JsonObjectType::from([(
3027                        "a".to_string(),
3028                        JsonNativeType::i64(),
3029                    )]))),
3030                    true,
3031                ),
3032                semantic_type: SemanticType::Field,
3033                column_id: 2,
3034            })
3035            .push_column_metadata(ColumnMetadata {
3036                column_schema: ColumnSchema::new(
3037                    "v0".to_string(),
3038                    ConcreteDataType::int64_datatype(),
3039                    true,
3040                ),
3041                semantic_type: SemanticType::Field,
3042                column_id: 3,
3043            })
3044            .primary_key(vec![0]);
3045        let metadata = Arc::new(builder.build().unwrap());
3046        let mutable = crate::memtable::time_partition::TimePartitions::new(
3047            metadata.clone(),
3048            Arc::new(crate::test_util::memtable_util::EmptyMemtableBuilder::default()),
3049            0,
3050            None,
3051        );
3052        let version = Arc::new(
3053            crate::region::version::VersionBuilder::new(metadata.clone(), mutable).build(),
3054        );
3055        let env = SchedulerEnv::new().await;
3056        let request = ScanRequest {
3057            projection: Some(vec![0, 1, 2, 3]),
3058            json_type_hint: std::collections::HashMap::from([(
3059                "v0".to_string(),
3060                JsonNativeType::i64(),
3061            )]),
3062            ..Default::default()
3063        };
3064
3065        let err = ScanRegion::new(
3066            version,
3067            env.access_layer.clone(),
3068            request,
3069            CacheStrategy::Disabled,
3070        )
3071        .scan_input()
3072        .await;
3073        let Err(err) = err else {
3074            panic!("scan input should reject JSON type hint for non-JSON2 column");
3075        };
3076
3077        assert!(err.to_string().contains("non-JSON2 column v0"));
3078    }
3079
3080    #[test]
3081    fn test_update_dyn_filters_with_empty_base_predicates() {
3082        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3083        let predicate_group = PredicateGroup::new(metadata.as_ref(), &[]).unwrap();
3084        assert!(predicate_group.predicate().is_none());
3085        assert!(predicate_group.predicate_without_region().is_none());
3086
3087        let dyn_filter = Arc::new(DynamicFilterPhysicalExpr::new(vec![], physical_lit(false)));
3088        predicate_group.add_dyn_filters(vec![dyn_filter]);
3089
3090        let predicate_all = predicate_group.predicate().unwrap();
3091        assert!(predicate_all.exprs().is_empty());
3092        assert_eq!(1, predicate_all.dyn_filters().len());
3093
3094        let predicate_without_region = predicate_group.predicate_without_region().unwrap();
3095        assert!(predicate_without_region.exprs().is_empty());
3096        assert_eq!(1, predicate_without_region.dyn_filters().len());
3097    }
3098
3099    #[test]
3100    fn test_clear_dyn_filters_preserves_predicate_group_static_filters() {
3101        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3102        let static_filters = vec![col("k0").eq(lit("foo"))];
3103        let predicate_group = PredicateGroup::new(metadata.as_ref(), &static_filters).unwrap();
3104        let dynamic_filter = Arc::new(DynamicFilterPhysicalExpr::new(vec![], physical_lit(true)));
3105        predicate_group.add_dyn_filters(vec![dynamic_filter.clone()]);
3106
3107        predicate_group.clear_dyn_filters();
3108        // Updating the old producer cannot add its wrapper to a new execution.
3109        dynamic_filter.update(physical_lit(false)).unwrap();
3110
3111        for predicate in [
3112            predicate_group.predicate().unwrap(),
3113            predicate_group.predicate_without_region().unwrap(),
3114        ] {
3115            assert_eq!(predicate.exprs(), static_filters);
3116            assert!(predicate.dyn_filters().is_empty());
3117        }
3118    }
3119
3120    #[test]
3121    fn test_file_level_pruning_stats_prunes_old_file() {
3122        let ts_col_name = "ts";
3123        let predicate = Predicate::new(vec![col(ts_col_name).gt(ts_lit(1000))]);
3124        let arrow_schema = Arc::new(ArrowSchema::new(vec![Field::new(
3125            ts_col_name,
3126            ArrowDataType::Timestamp(ArrowTimeUnit::Millisecond, None),
3127            false,
3128        )]));
3129
3130        // File with time range [0ms, 500ms] is completely before `ts > 1000ms`.
3131        let stats = FileLevelPruningStats {
3132            min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3133            max_scalar: ScalarValue::TimestampMillisecond(Some(500), None),
3134            time_index_col_name: ts_col_name.to_string(),
3135        };
3136        assert_eq!(
3137            vec![false],
3138            predicate.prune_with_stats(&stats, &arrow_schema)
3139        );
3140
3141        // File with time range [0ms, 2000ms] overlaps `ts > 1000ms`, so keep it.
3142        let stats = FileLevelPruningStats {
3143            min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3144            max_scalar: ScalarValue::TimestampMillisecond(Some(2000), None),
3145            time_index_col_name: ts_col_name.to_string(),
3146        };
3147        assert_eq!(
3148            vec![true],
3149            predicate.prune_with_stats(&stats, &arrow_schema)
3150        );
3151    }
3152
3153    #[test]
3154    fn test_file_level_pruning_stats_no_predicate_keeps_all() {
3155        let predicate = Predicate::new(vec![]);
3156        assert!(predicate.is_empty());
3157
3158        let stats = FileLevelPruningStats {
3159            min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3160            max_scalar: ScalarValue::TimestampMillisecond(Some(500), None),
3161            time_index_col_name: "ts".to_string(),
3162        };
3163        let arrow_schema = Arc::new(ArrowSchema::new(Vec::<Field>::new()));
3164        assert_eq!(
3165            vec![true],
3166            predicate.prune_with_stats(&stats, &arrow_schema)
3167        );
3168    }
3169
3170    #[tokio::test]
3171    async fn test_file_level_pruning_stats_ceil_max_unit_conversion() {
3172        let metadata = metadata_with_time_index_unit(TimeUnit::Millisecond);
3173        let input = new_scan_input(metadata, vec![]).await.build();
3174        let file = file_handle_with_time_range(
3175            Timestamp::new(1_000_001, TimeUnit::Nanosecond),
3176            Timestamp::new(1_000_001, TimeUnit::Nanosecond),
3177        );
3178
3179        let stats = input.try_file_level_pruning_stats(&file).unwrap();
3180        assert_eq!(
3181            ScalarValue::TimestampMillisecond(Some(1), None),
3182            stats.min_scalar
3183        );
3184        assert_eq!(
3185            ScalarValue::TimestampMillisecond(Some(2), None),
3186            stats.max_scalar
3187        );
3188
3189        // The actual max timestamp is slightly greater than 1ms. It must be kept for `ts > 1ms`.
3190        let predicate = Predicate::new(vec![col("ts").gt(ts_lit(1))]);
3191        assert_eq!(
3192            vec![true],
3193            predicate.prune_with_stats(&stats, input.mapper.metadata().schema.arrow_schema())
3194        );
3195    }
3196
3197    #[tokio::test]
3198    async fn test_file_level_pruning_stats_overflow_keeps_file() {
3199        let metadata = metadata_with_time_index_unit(TimeUnit::Nanosecond);
3200        let input = new_scan_input(metadata, vec![]).await.build();
3201        let file = file_handle_with_time_range(
3202            Timestamp::new(0, TimeUnit::Second),
3203            Timestamp::new(i64::MAX, TimeUnit::Second),
3204        );
3205
3206        assert!(input.try_file_level_pruning_stats(&file).is_none());
3207    }
3208
3209    #[test]
3210    fn test_file_level_pruning_stats_keeps_inclusive_boundary() {
3211        let ts_col_name = "ts";
3212        let predicate = Predicate::new(vec![col(ts_col_name).gt_eq(ts_lit(1000))]);
3213        let arrow_schema = Arc::new(ArrowSchema::new(vec![Field::new(
3214            ts_col_name,
3215            ArrowDataType::Timestamp(ArrowTimeUnit::Millisecond, None),
3216            false,
3217        )]));
3218        let stats = FileLevelPruningStats {
3219            min_scalar: ScalarValue::TimestampMillisecond(Some(0), None),
3220            max_scalar: ScalarValue::TimestampMillisecond(Some(1000), None),
3221            time_index_col_name: ts_col_name.to_string(),
3222        };
3223
3224        assert_eq!(
3225            vec![true],
3226            predicate.prune_with_stats(&stats, &arrow_schema)
3227        );
3228    }
3229
3230    #[tokio::test]
3231    async fn test_file_level_pruning_with_dyn_filter_only_predicate() {
3232        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3233        let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
3234        let predicate_group = PredicateGroup::new(metadata.as_ref(), &[]).unwrap();
3235        predicate_group.add_dyn_filters(vec![Arc::new(DynamicFilterPhysicalExpr::new(
3236            vec![],
3237            physical_lit(false),
3238        ))]);
3239        let input = ScanInput::builder(SchedulerEnv::new().await.access_layer.clone(), mapper)
3240            .with_predicate(predicate_group)
3241            .build();
3242        let file = file_handle_with_time_range(
3243            Timestamp::new_millisecond(0),
3244            Timestamp::new_millisecond(1000),
3245        );
3246        let mut reader_metrics = ReaderMetrics::default();
3247
3248        let builder = input
3249            .prune_file(&file, PreFilterMode::SkipFields, &mut reader_metrics)
3250            .await
3251            .unwrap();
3252
3253        assert_eq!(1, reader_metrics.filter_metrics.files_time_range_pruned);
3254        let mut ranges = SmallVec::new();
3255        builder.build_ranges(-1, &mut ranges);
3256        assert!(ranges.is_empty());
3257    }
3258
3259    #[tokio::test]
3260    async fn test_manifest_pruning_observes_dynamic_filter_update() {
3261        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3262        let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
3263        let predicate_group = PredicateGroup::new(metadata.as_ref(), &[]).unwrap();
3264        let arrow_schema = metadata.schema.arrow_schema();
3265        let ts_expr = physical_col("ts", arrow_schema.as_ref()).unwrap();
3266        let dyn_filter = Arc::new(DynamicFilterPhysicalExpr::new(
3267            vec![ts_expr.clone()],
3268            physical_lit(true),
3269        ));
3270        predicate_group.add_dyn_filters(vec![dyn_filter.clone()]);
3271        let input = ScanInput::builder(SchedulerEnv::new().await.access_layer.clone(), mapper)
3272            .with_predicate(predicate_group)
3273            .build();
3274        let file = file_handle_with_time_range(
3275            Timestamp::new_millisecond(0),
3276            Timestamp::new_millisecond(1000),
3277        );
3278
3279        assert!(!input.can_manifest_prune_file(&file));
3280
3281        let updated = physical_binary(
3282            ts_expr,
3283            Operator::Gt,
3284            physical_lit(ScalarValue::TimestampMillisecond(Some(1000), None)),
3285            arrow_schema.as_ref(),
3286        )
3287        .unwrap();
3288        dyn_filter.update(updated).unwrap();
3289
3290        assert!(input.can_manifest_prune_file(&file));
3291        input.predicate.clear_dyn_filters();
3292        assert!(!input.can_manifest_prune_file(&file));
3293    }
3294
3295    #[tokio::test]
3296    async fn test_range_pre_filter_mode() {
3297        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3298        let cases = [
3299            (true, MergeMode::LastRow, 1, PreFilterMode::All),
3300            (false, MergeMode::LastNonNull, 1, PreFilterMode::All),
3301            (false, MergeMode::LastRow, 2, PreFilterMode::SkipFields),
3302            (true, MergeMode::LastRow, 2, PreFilterMode::All),
3303        ];
3304
3305        for (append_mode, merge_mode, source_count, expected_mode) in cases {
3306            let input = new_scan_input(metadata.clone(), vec![])
3307                .await
3308                .with_append_mode(append_mode)
3309                .with_merge_mode(merge_mode)
3310                .build();
3311
3312            assert_eq!(expected_mode, input.range_pre_filter_mode(source_count));
3313        }
3314    }
3315
3316    #[test]
3317    fn test_exact_sequence_selection_preserves_range_and_fallback() {
3318        let request = ScanRequest {
3319            exact_sequence_range: true,
3320            memtable_min_sequence: Some(1),
3321            memtable_max_sequence: Some(2),
3322            ..Default::default()
3323        };
3324        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3325        let mutable = crate::memtable::time_partition::TimePartitions::new(
3326            metadata.clone(),
3327            Arc::new(crate::test_util::memtable_util::EmptyMemtableBuilder::default()),
3328            0,
3329            None,
3330        );
3331        let version = Arc::new(
3332            crate::region::version::VersionBuilder::new(metadata, mutable)
3333                .options(crate::region::options::RegionOptions {
3334                    preserve_row_sequence: true,
3335                    ..Default::default()
3336                })
3337                .build(),
3338        );
3339        let (files, range) = exact_sequence_range(&request, &version).unwrap();
3340        assert!(files.is_empty());
3341        assert_eq!(Some(SequenceRange::GtLtEq { min: 1, max: 2 }), range);
3342
3343        let skip_sst_request = ScanRequest {
3344            skip_sst_files: true,
3345            ..request
3346        };
3347        let (files, range) = exact_sequence_range(&skip_sst_request, &version).unwrap();
3348        assert!(files.is_empty());
3349        assert_eq!(None, range);
3350    }
3351
3352    #[test]
3353    fn test_exact_sequence_selection_checks_selected_files() {
3354        use std::num::NonZeroU64;
3355
3356        use crate::test_util::new_noop_file_purger;
3357
3358        let request = ScanRequest {
3359            exact_sequence_range: true,
3360            memtable_min_sequence: Some(5),
3361            memtable_max_sequence: Some(10),
3362            ..Default::default()
3363        };
3364        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3365        let mutable = crate::memtable::time_partition::TimePartitions::new(
3366            metadata.clone(),
3367            Arc::new(crate::test_util::memtable_util::EmptyMemtableBuilder::default()),
3368            0,
3369            None,
3370        );
3371        let target_region_id = metadata.region_id;
3372
3373        // Files at or below the cursor are excluded. Among the remaining files,
3374        // marked locals are exact-capable while unmarked locals deny exactness.
3375        for (sequence, marked, expected_files, expected_range) in [
3376            (NonZeroU64::new(5), false, false, true),
3377            (NonZeroU64::new(5), true, false, true),
3378            (NonZeroU64::new(100), false, true, false),
3379            (None, false, true, false),
3380            (None, true, true, true),
3381        ] {
3382            let version = crate::region::version::VersionBuilder::new(
3383                metadata.clone(),
3384                mutable.new_with_part_duration(None, None),
3385            )
3386            .options(crate::region::options::RegionOptions {
3387                preserve_row_sequence: true,
3388                ..Default::default()
3389            })
3390            .add_files(
3391                new_noop_file_purger(),
3392                [FileMeta {
3393                    region_id: target_region_id,
3394                    sequence,
3395                    preserve_row_sequence: marked,
3396                    ..Default::default()
3397                }]
3398                .into_iter(),
3399            )
3400            .build();
3401            let (files, range) = exact_sequence_range(&request, &version).unwrap();
3402            assert_eq!(expected_files, !files.is_empty());
3403            assert_eq!(expected_range, range.is_some());
3404        }
3405
3406        // Foreign files use the target-local barrier, regardless of their
3407        // source marker. A missing barrier fails closed.
3408        for (sequence, marked, expected_count, expected_error) in [
3409            (NonZeroU64::new(5), false, 0, false),
3410            (NonZeroU64::new(6), false, 1, false),
3411            (NonZeroU64::new(11), true, 1, false),
3412            (None, true, 1, true),
3413        ] {
3414            let file_id = store_api::storage::FileId::random();
3415            let version = crate::region::version::VersionBuilder::new(
3416                metadata.clone(),
3417                mutable.new_with_part_duration(None, None),
3418            )
3419            .options(crate::region::options::RegionOptions {
3420                preserve_row_sequence: true,
3421                ..Default::default()
3422            })
3423            .add_files(
3424                new_noop_file_purger(),
3425                [FileMeta {
3426                    region_id: RegionId::new(1, 2),
3427                    file_id,
3428                    sequence,
3429                    preserve_row_sequence: marked,
3430                    ..Default::default()
3431                }]
3432                .into_iter(),
3433            )
3434            .build();
3435            let result = exact_sequence_range(&request, &version);
3436            if expected_error {
3437                assert!(result.is_err());
3438            } else {
3439                let (files, range) = result.unwrap();
3440                assert_eq!(expected_count, files.len());
3441                assert!(range.is_some());
3442            }
3443        }
3444
3445        // Foreign-domain validation still takes precedence over preserve mode
3446        // and a missing upper bound once the file is selected.
3447        let request = ScanRequest {
3448            memtable_max_sequence: None,
3449            ..request
3450        };
3451        let version = crate::region::version::VersionBuilder::new(metadata, mutable)
3452            .options(crate::region::options::RegionOptions {
3453                preserve_row_sequence: false,
3454                ..Default::default()
3455            })
3456            .add_files(
3457                new_noop_file_purger(),
3458                [FileMeta {
3459                    region_id: RegionId::new(1, 2),
3460                    ..Default::default()
3461                }]
3462                .into_iter(),
3463            )
3464            .build();
3465        assert!(exact_sequence_range(&request, &version).is_err());
3466    }
3467
3468    #[tokio::test]
3469    async fn test_parallel_flat_source_stops_after_receiver_dropped() {
3470        use std::sync::atomic::{AtomicUsize, Ordering};
3471
3472        use datatypes::arrow::array::Int64Array;
3473
3474        const SOURCE_BATCHES: usize = 10_000;
3475
3476        let metadata = Arc::new(metadata_with_primary_key(vec![0, 1], false));
3477        let mapper = FlatProjectionMapper::new(&metadata, [0, 2, 3]).unwrap();
3478        let env = SchedulerEnv::new().await;
3479        let input = ScanInput::builder(env.access_layer.clone(), mapper).build();
3480
3481        let schema = Arc::new(ArrowSchema::new(vec![Field::new(
3482            "v",
3483            ArrowDataType::Int64,
3484            false,
3485        )]));
3486        let batch =
3487            RecordBatch::try_new(schema, vec![Arc::new(Int64Array::from(vec![1]))]).unwrap();
3488        let pulled = Arc::new(AtomicUsize::new(0));
3489        let mut released = Vec::new();
3490        let sources = (0..2)
3491            .map(|_| {
3492                let (release_tx, release_rx) = tokio::sync::oneshot::channel::<()>();
3493                released.push(release_rx);
3494                let batch = batch.clone();
3495                let pulled = pulled.clone();
3496                futures::stream::iter(0..SOURCE_BATCHES)
3497                    .map(move |_| {
3498                        // Dropped together with the source stream.
3499                        let _ = &release_tx;
3500                        pulled.fetch_add(1, Ordering::Relaxed);
3501                        Ok(batch.clone())
3502                    })
3503                    .boxed()
3504            })
3505            .collect();
3506
3507        let streams = input
3508            .create_parallel_flat_sources(sources, Arc::new(Semaphore::new(2)), 1)
3509            .unwrap();
3510        drop(streams);
3511
3512        for release_rx in released {
3513            tokio::time::timeout(std::time::Duration::from_secs(10), release_rx)
3514                .await
3515                .unwrap()
3516                .unwrap_err();
3517        }
3518        // Each task may have read a few batches ahead into its channel before the
3519        // receiver went away, but must not drain the rest of its source.
3520        assert!(pulled.load(Ordering::Relaxed) < 100);
3521    }
3522}