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