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