|
| 1 | +// Licensed to the Apache Software Foundation (ASF) under one |
| 2 | +// or more contributor license agreements. See the NOTICE file |
| 3 | +// distributed with this work for additional information |
| 4 | +// regarding copyright ownership. The ASF licenses this file |
| 5 | +// to you under the Apache License, Version 2.0 (the |
| 6 | +// "License"); you may not use this file except in compliance |
| 7 | +// with the License. You may obtain a copy of the License at |
| 8 | +// |
| 9 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +// |
| 11 | +// Unless required by applicable law or agreed to in writing, |
| 12 | +// software distributed under the License is distributed on an |
| 13 | +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 | +// KIND, either express or implied. See the License for the |
| 15 | +// specific language governing permissions and limitations |
| 16 | +// under the License. |
| 17 | + |
| 18 | +//! End-to-end test that the optimizer-derived `StatisticsRequest`s |
| 19 | +//! reach a custom `TableProvider`'s `scan_with_args`. |
| 20 | +
|
| 21 | +use std::sync::{Arc, Mutex}; |
| 22 | + |
| 23 | +use arrow::array::{Int64Array, RecordBatch}; |
| 24 | +use arrow::datatypes::{DataType, Field, Schema, SchemaRef}; |
| 25 | +use async_trait::async_trait; |
| 26 | +use datafusion::catalog::{ScanArgs, ScanResult, Session, TableProvider}; |
| 27 | +use datafusion::datasource::TableType; |
| 28 | +use datafusion::datasource::memory::MemorySourceConfig; |
| 29 | +use datafusion::execution::context::SessionContext; |
| 30 | +use datafusion::logical_expr::Expr; |
| 31 | +use datafusion::physical_plan::ExecutionPlan; |
| 32 | +use datafusion_common::Result; |
| 33 | +use datafusion_expr_common::statistics::StatisticsRequest; |
| 34 | + |
| 35 | +/// A `TableProvider` that records the last `statistics_requests` it was |
| 36 | +/// asked for, so the test can assert what reached it. |
| 37 | +#[derive(Debug)] |
| 38 | +struct RecordingTable { |
| 39 | + schema: SchemaRef, |
| 40 | + batch: RecordBatch, |
| 41 | + last_requests: Arc<Mutex<Vec<StatisticsRequest>>>, |
| 42 | +} |
| 43 | + |
| 44 | +#[async_trait] |
| 45 | +impl TableProvider for RecordingTable { |
| 46 | + fn schema(&self) -> SchemaRef { |
| 47 | + self.schema.clone() |
| 48 | + } |
| 49 | + |
| 50 | + fn table_type(&self) -> TableType { |
| 51 | + TableType::Base |
| 52 | + } |
| 53 | + |
| 54 | + async fn scan( |
| 55 | + &self, |
| 56 | + _state: &dyn Session, |
| 57 | + projection: Option<&Vec<usize>>, |
| 58 | + _filters: &[Expr], |
| 59 | + _limit: Option<usize>, |
| 60 | + ) -> Result<Arc<dyn ExecutionPlan>> { |
| 61 | + Ok(MemorySourceConfig::try_new_exec( |
| 62 | + &[vec![self.batch.clone()]], |
| 63 | + self.schema.clone(), |
| 64 | + projection.cloned(), |
| 65 | + )?) |
| 66 | + } |
| 67 | + |
| 68 | + async fn scan_with_args<'a>( |
| 69 | + &self, |
| 70 | + state: &dyn Session, |
| 71 | + args: ScanArgs<'a>, |
| 72 | + ) -> Result<ScanResult> { |
| 73 | + // Record what reached us, then delegate to scan(). |
| 74 | + *self.last_requests.lock().unwrap() = args.statistics_requests().to_vec(); |
| 75 | + let plan = self |
| 76 | + .scan( |
| 77 | + state, |
| 78 | + args.projection().map(|p| p.to_vec()).as_ref(), |
| 79 | + args.filters().unwrap_or(&[]), |
| 80 | + args.limit(), |
| 81 | + ) |
| 82 | + .await?; |
| 83 | + Ok(ScanResult::new(plan)) |
| 84 | + } |
| 85 | +} |
| 86 | + |
| 87 | +fn make_table() -> (Arc<RecordingTable>, Arc<Mutex<Vec<StatisticsRequest>>>) { |
| 88 | + let schema = Arc::new(Schema::new(vec![ |
| 89 | + Field::new("a", DataType::Int64, false), |
| 90 | + Field::new("b", DataType::Int64, false), |
| 91 | + ])); |
| 92 | + let batch = RecordBatch::try_new( |
| 93 | + schema.clone(), |
| 94 | + vec![ |
| 95 | + Arc::new(Int64Array::from(vec![1, 2, 3])), |
| 96 | + Arc::new(Int64Array::from(vec![10, 20, 30])), |
| 97 | + ], |
| 98 | + ) |
| 99 | + .unwrap(); |
| 100 | + let last_requests = Arc::new(Mutex::new(Vec::new())); |
| 101 | + let provider = Arc::new(RecordingTable { |
| 102 | + schema, |
| 103 | + batch, |
| 104 | + last_requests: last_requests.clone(), |
| 105 | + }); |
| 106 | + (provider, last_requests) |
| 107 | +} |
| 108 | + |
| 109 | +#[tokio::test] |
| 110 | +async fn requests_reach_provider_scan_with_args() -> Result<()> { |
| 111 | + let (provider, last_requests) = make_table(); |
| 112 | + let ctx = SessionContext::new(); |
| 113 | + ctx.register_table("t", provider)?; |
| 114 | + |
| 115 | + // Filter on `a` + sort on `b` should request Min/Max/NullCount on |
| 116 | + // both, plus DistinctCount on `a` (filter), plus a RowCount. |
| 117 | + let _ = ctx |
| 118 | + .sql("SELECT a, b FROM t WHERE a > 0 ORDER BY b LIMIT 10") |
| 119 | + .await? |
| 120 | + .collect() |
| 121 | + .await?; |
| 122 | + |
| 123 | + let got = last_requests.lock().unwrap().clone(); |
| 124 | + assert!(!got.is_empty(), "expected non-empty requests, got {got:?}"); |
| 125 | + |
| 126 | + let has = |needle: &StatisticsRequest| got.iter().any(|r| r == needle); |
| 127 | + use datafusion_common::Column; |
| 128 | + use datafusion_expr_common::statistics::StatisticsRequest::*; |
| 129 | + assert!(has(&RowCount), "expected RowCount, got {got:?}"); |
| 130 | + assert!( |
| 131 | + has(&Min(Column::new_unqualified("a"))), |
| 132 | + "expected Min(a), got {got:?}" |
| 133 | + ); |
| 134 | + assert!( |
| 135 | + has(&DistinctCount(Column::new_unqualified("a"))), |
| 136 | + "expected DistinctCount(a), got {got:?}" |
| 137 | + ); |
| 138 | + assert!( |
| 139 | + has(&Min(Column::new_unqualified("b"))), |
| 140 | + "expected Min(b) from ORDER BY, got {got:?}" |
| 141 | + ); |
| 142 | + |
| 143 | + Ok(()) |
| 144 | +} |
| 145 | + |
| 146 | +#[tokio::test] |
| 147 | +async fn no_requests_when_plan_has_no_filter_sort_or_join() -> Result<()> { |
| 148 | + let (provider, last_requests) = make_table(); |
| 149 | + let ctx = SessionContext::new(); |
| 150 | + ctx.register_table("t", provider)?; |
| 151 | + |
| 152 | + // Plain `SELECT *` — only `RowCount` should be requested. |
| 153 | + let _ = ctx.sql("SELECT a, b FROM t").await?.collect().await?; |
| 154 | + |
| 155 | + let got = last_requests.lock().unwrap().clone(); |
| 156 | + use datafusion_expr_common::statistics::StatisticsRequest::*; |
| 157 | + assert_eq!(got.len(), 1, "expected only RowCount, got {got:?}"); |
| 158 | + assert!(matches!(got[0], RowCount)); |
| 159 | + |
| 160 | + Ok(()) |
| 161 | +} |
0 commit comments