-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathfetch.rs
More file actions
1272 lines (1134 loc) · 44 KB
/
fetch.rs
File metadata and controls
1272 lines (1134 loc) · 44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use std::any::Any;
use std::fmt;
use std::sync::Arc;
use datafusion::common::Statistics;
use datafusion::error::{DataFusionError, Result};
use datafusion::execution::context::TaskContext;
use datafusion::execution::SendableRecordBatchStream;
use futures::future::BoxFuture;
use futures::FutureExt;
use std::pin::Pin;
use std::task::{Context, Poll};
use datafusion::arrow::datatypes::{Schema, SchemaRef};
use datafusion::arrow::record_batch::RecordBatch;
use datafusion::physical_expr::EquivalenceProperties;
use datafusion::physical_plan::metrics::{BaselineMetrics, ExecutionPlanMetricsSet};
use datafusion::physical_plan::{
DisplayAs, DisplayFormatType, Distribution, ExecutionPlan, Partitioning, PlanProperties,
RecordBatchStream,
};
use futures::stream::{Stream, StreamExt};
use crate::physical_plan::exec::index::IndexScanExec;
use crate::physical_plan::exec::sequential_union::SequentialUnionExec;
use crate::physical_plan::fetcher::RecordFetcher;
use crate::physical_plan::joins::try_create_index_lookup_join;
use crate::types::{IndexFilter, IndexFilters, UnionMode};
use datafusion::physical_plan::aggregates::{AggregateExec, AggregateMode, PhysicalGroupBy};
use datafusion::physical_plan::empty::EmptyExec;
use datafusion::physical_plan::expressions::Column;
use datafusion::physical_plan::projection::ProjectionExec;
use datafusion::physical_plan::union::UnionExec;
use datafusion::physical_plan::PhysicalExpr;
/// Physical plan node for fetching records from a [`RecordFetcher`] using
/// row IDs produced by one or more index scans.
///
/// This operator takes one or more [`IndexFilter`]s, builds an input plan
/// to produce row IDs (by scanning and joining index results), and then uses
/// a [`RecordFetcher`] to retrieve the actual data for those row IDs.
#[derive(Debug)]
pub struct RecordFetchExec {
indexes: Arc<IndexFilters>,
limit: Option<usize>,
plan_properties: PlanProperties,
record_fetcher: Arc<dyn RecordFetcher>,
/// The input plan that produces the row IDs.
input: Arc<dyn ExecutionPlan>,
metrics: ExecutionPlanMetricsSet,
schema: SchemaRef,
/// Controls how union operations are executed for OR conditions.
union_mode: UnionMode,
}
impl RecordFetchExec {
/// Create a new `RecordFetchExec` plan.
///
/// # Arguments
/// * `indexes` - Index filters to use for scanning
/// * `limit` - Optional limit on the number of rows
/// * `record_fetcher` - The fetcher to retrieve records by row ID
/// * `schema` - Output schema
/// * `union_mode` - Controls whether OR conditions use parallel or sequential union
pub fn try_new(
indexes: Vec<IndexFilter>,
limit: Option<usize>,
record_fetcher: Arc<dyn RecordFetcher>,
schema: SchemaRef,
union_mode: UnionMode,
) -> Result<Self> {
if indexes.is_empty() {
return Err(DataFusionError::Plan(
"RecordFetchExec requires at least one index".to_string(),
));
}
if indexes.len() > 1 {
return Err(DataFusionError::Internal(
"RecordFetchExec expects a single root IndexFilter".to_string(),
));
}
let input = match indexes.first() {
Some(index_filter) => Self::build_scan_exec(index_filter, limit, union_mode)?,
None => {
return Err(DataFusionError::Plan(
"RecordFetchExec requires at least one index".to_string(),
));
}
};
let eq_properties = EquivalenceProperties::new(schema.clone());
let plan_properties = PlanProperties::new(
eq_properties,
Partitioning::UnknownPartitioning(1),
input.properties().emission_type,
input.properties().boundedness,
);
Ok(Self {
indexes: indexes.into(),
limit,
plan_properties,
record_fetcher,
input,
metrics: ExecutionPlanMetricsSet::new(),
schema,
union_mode,
})
}
/// Builds the input execution plan that produces primary key values based on the IndexFilter structure.
///
/// This method is the core of the index-based execution plan generation. It recursively
/// processes the [`IndexFilter`] tree to create an optimized physical plan that efficiently
/// produces primary key values matching the query filters.
///
/// # Plan Generation Strategy
///
/// The method generates different execution plans based on the [`IndexFilter`] variant:
///
/// ## [`IndexFilter::Single`] - Direct Index Scan
/// Creates a single [`IndexScanExec`] that directly scans the specified index with the given filter.
/// This is the most efficient case with minimal overhead.
///
/// ```text
/// IndexScanExec(index, filter)
/// ```
///
/// ## [`IndexFilter::And`] - Index Intersection via Joins
/// Builds a left-deep tree of joins to intersect primary key values from multiple indexes.
/// The joins are performed on all primary key columns to find rows that satisfy ALL conditions.
/// Uses [`crate::physical_plan::joins::try_create_index_lookup_join`] which selects between
/// HashJoin and SortMergeJoin based on input ordering.
///
/// ```text
/// Projection(PK columns)
/// └── HashJoin/SortMergeJoin(
/// Projection(PK columns)
/// └── HashJoin/SortMergeJoin(
/// IndexScanExec(index1, filter1),
/// IndexScanExec(index2, filter2)
/// ),
/// IndexScanExec(index3, filter3)
/// )
/// ```
///
/// ## [`IndexFilter::Or`] - Union with Deduplication
/// Creates a [`UnionExec`](datafusion::physical_plan::union::UnionExec) of all index scans followed by an [`AggregateExec`] that groups by
/// all primary key columns to automatically deduplicate overlapping results.
///
/// ```text
/// AggregateExec(GROUP BY PK columns,
/// UnionExec(
/// IndexScanExec(index1, filter1),
/// IndexScanExec(index2, filter2),
/// IndexScanExec(index3, filter3)
/// )
/// )
/// ```
///
/// # Arguments
/// * `index_filter` - The [`IndexFilter`] tree specifying which indexes to scan and how to combine them
/// * `limit` - Optional limit on the number of rows to return, passed through to individual index scans
/// * `union_mode` - Controls whether OR conditions use parallel or sequential union
///
/// # Returns
/// An [`Arc<dyn ExecutionPlan>`] that produces a stream of primary key values matching the filter criteria.
/// The output schema contains all columns from the index schema (the composite primary key).
///
/// # Errors
/// Returns [`DataFusionError::Plan`] if:
/// - An [`IndexFilter::And`] contains no sub-filters
/// - Any recursive call to build sub-plans fails
/// - Index scan creation fails due to invalid filter expressions
fn build_scan_exec(
index_filter: &IndexFilter,
limit: Option<usize>,
union_mode: UnionMode,
) -> Result<Arc<dyn ExecutionPlan>> {
match index_filter {
IndexFilter::Single { index, filter } => {
let schema = index.index_schema();
let exec =
IndexScanExec::try_new(index.clone(), vec![filter.clone()], limit, schema)?;
Ok(Arc::new(exec))
}
IndexFilter::And(filters) => {
let mut plans = filters
.iter()
.map(|f| Self::build_scan_exec(f, limit, union_mode))
.collect::<Result<Vec<_>>>()?;
if plans.is_empty() {
return Err(DataFusionError::Plan(
"IndexFilter::And requires at least one sub-filter".to_string(),
));
}
let mut left = plans.remove(0);
let pk_schema = left.schema();
while !plans.is_empty() {
let right = plans.remove(0);
let joined = try_create_index_lookup_join(left, right)?;
left = Self::project_to_pk_schema(joined, &pk_schema)?;
}
Ok(left)
}
IndexFilter::Or(filters) => {
let original_plans = filters
.iter()
.map(|f| Self::build_scan_exec(f, limit, union_mode))
.collect::<Result<Vec<_>>>()?;
if original_plans.is_empty() {
return Ok(Arc::new(EmptyExec::new(Arc::new(Schema::empty()))));
}
// Derive canonical PK schema from the first plan
let canonical_schema = original_plans[0].schema();
// Normalize all plans to the canonical schema
let normalized_plans: Vec<Arc<dyn ExecutionPlan>> = original_plans
.into_iter()
.map(|plan| Self::project_to_pk_schema(plan, &canonical_schema))
.collect::<Result<Vec<_>>>()?;
// Create union based on mode
let union_input: Arc<dyn ExecutionPlan> = match union_mode {
UnionMode::Parallel => UnionExec::try_new(normalized_plans)?,
UnionMode::Sequential => {
Arc::new(SequentialUnionExec::try_new(normalized_plans)?)
}
};
// Create aggregate to deduplicate by ALL primary key columns
let group_exprs: Vec<(Arc<dyn PhysicalExpr>, String)> = canonical_schema
.fields()
.iter()
.enumerate()
.map(|(i, field)| {
(
Arc::new(Column::new(field.name(), i)) as Arc<dyn PhysicalExpr>,
field.name().to_string(),
)
})
.collect();
let group_by = PhysicalGroupBy::new_single(group_exprs);
let agg_exec = AggregateExec::try_new(
AggregateMode::Single,
group_by,
vec![],
vec![],
union_input,
canonical_schema,
)?;
Ok(Arc::new(agg_exec))
}
}
}
/// Projects a plan's output down to the primary key schema columns.
///
/// After a join, the output may contain duplicate columns from both sides
/// (e.g., `(a_left, b_left, a_right, b_right)`). This projects to just the
/// first occurrence of each PK column.
fn project_to_pk_schema(
plan: Arc<dyn ExecutionPlan>,
pk_schema: &SchemaRef,
) -> Result<Arc<dyn ExecutionPlan>> {
let plan_schema = plan.schema();
// Short-circuit if schemas already match
if plan_schema.fields().len() == pk_schema.fields().len()
&& pk_schema
.fields()
.iter()
.enumerate()
.all(|(i, f)| plan_schema.field(i) == f.as_ref())
{
return Ok(plan);
}
// Build projection selecting first occurrence of each PK column
let exprs: Vec<(Arc<dyn PhysicalExpr>, String)> = pk_schema
.fields()
.iter()
.map(|field| {
let idx = plan_schema
.fields()
.iter()
.position(|f| f.name() == field.name())
.ok_or_else(|| {
DataFusionError::Plan(format!(
"Primary key column '{}' not found in plan schema: {:?}",
field.name(),
plan_schema
))
})?;
Ok((
Arc::new(Column::new(field.name(), idx)) as Arc<dyn PhysicalExpr>,
field.name().to_string(),
))
})
.collect::<Result<Vec<_>>>()?;
Ok(Arc::new(ProjectionExec::try_new(exprs, plan)?))
}
}
impl DisplayAs for RecordFetchExec {
fn fmt_as(&self, t: DisplayFormatType, f: &mut fmt::Formatter) -> fmt::Result {
match t {
DisplayFormatType::Default
| DisplayFormatType::Verbose
| DisplayFormatType::TreeRender => {
let index_names: Vec<_> = self.indexes.iter().map(|i| i.to_string()).collect();
write!(
f,
"RecordFetchExec: indexes=[{}], limit={:?}",
index_names.join(", "),
self.limit
)
}
}
}
}
impl ExecutionPlan for RecordFetchExec {
/// Return a reference to the name of this execution plan.
fn name(&self) -> &str {
"RecordFetchExec"
}
/// Return a reference to the logical plan as [`Any`] so that it can be
/// downcast to a specific implementation.
fn as_any(&self) -> &dyn Any {
self
}
/// Get the schema of this execution plan
fn schema(&self) -> SchemaRef {
self.schema.clone()
}
/// Get the properties for this execution plan
fn properties(&self) -> &PlanProperties {
&self.plan_properties
}
/// Returns the children of this [`ExecutionPlan`].
fn children(&self) -> Vec<&Arc<dyn ExecutionPlan>> {
vec![&self.input]
}
fn required_input_distribution(&self) -> Vec<Distribution> {
// RecordFetchExec requires a single partition input because it merges
// results from multiple index scans.
vec![Distribution::SinglePartition]
}
/// Create a new [`ExecutionPlan`] with new children.
fn with_new_children(
self: Arc<Self>,
children: Vec<Arc<dyn ExecutionPlan>>,
) -> Result<Arc<dyn ExecutionPlan>> {
if children.len() != 1 {
return Err(DataFusionError::Internal(
"RecordFetchExec should have exactly one child".to_string(),
));
}
Ok(Arc::new(RecordFetchExec {
indexes: self.indexes.clone(),
limit: self.limit,
plan_properties: self.plan_properties.clone(),
record_fetcher: self.record_fetcher.clone(),
input: children[0].clone(),
metrics: self.metrics.clone(),
schema: self.schema.clone(),
union_mode: self.union_mode,
}))
}
/// Executes this plan and returns a stream of `RecordBatch`es.
fn execute(
&self,
partition: usize,
context: Arc<TaskContext>,
) -> Result<SendableRecordBatchStream> {
if partition != 0 {
return Err(DataFusionError::Internal(format!(
"RecordFetchExec executed with partition {partition} but expected 0"
)));
}
let input_stream = self.input.execute(0, context)?;
let baseline_metrics = BaselineMetrics::new(&self.metrics, partition);
Ok(Box::pin(RecordFetchStream::new(
input_stream,
self.record_fetcher.clone(),
baseline_metrics,
)))
}
/// Get the statistics for this execution plan.
fn statistics(&self) -> Result<Statistics> {
Ok(Statistics::new_unknown(&self.schema()))
}
}
/// A stream that fetches records using row IDs from an input stream.
pub struct RecordFetchStream {
/// The schema of the output data.
schema: SchemaRef,
/// Execution metrics.
baseline_metrics: BaselineMetrics,
/// The state of the stream.
state: FetchState,
}
/// A future that resolves to a fetched `RecordBatch` and the reclaimed
/// input stream and fetcher.
type FetchFuture = BoxFuture<
'static,
Result<(
SendableRecordBatchStream,
Arc<dyn RecordFetcher>,
RecordBatch,
)>,
>;
/// The state of the `RecordFetchStream`.
enum FetchState {
/// Reading from the input stream.
ReadingInput {
input: SendableRecordBatchStream,
fetcher: Arc<dyn RecordFetcher>,
},
/// Fetching a batch of records. The future returns the input stream and
/// fetcher so they can be reclaimed.
Fetching(FetchFuture),
/// An error occurred.
Error,
}
impl RecordFetchStream {
/// Create a new `RecordFetchStream`.
pub fn new(
input: SendableRecordBatchStream,
fetcher: Arc<dyn RecordFetcher>,
baseline_metrics: BaselineMetrics,
) -> Self {
let schema = fetcher.schema();
let state = FetchState::ReadingInput { input, fetcher };
Self {
schema,
baseline_metrics,
state,
}
}
}
impl Stream for RecordFetchStream {
type Item = Result<RecordBatch>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
loop {
match std::mem::replace(&mut self.state, FetchState::Error) {
FetchState::ReadingInput { mut input, fetcher } => {
match input.poll_next_unpin(cx) {
Poll::Ready(Some(Ok(batch))) if batch.num_rows() > 0 => {
// Start async fetch for non-empty batch
let fut = {
let fetcher = fetcher.clone();
async move {
fetcher
.fetch(batch)
.await
.map(|batch| (input, fetcher, batch))
}
.boxed()
};
self.state = FetchState::Fetching(fut);
}
Poll::Ready(Some(Ok(_))) => {
// Empty batch - continue reading
self.state = FetchState::ReadingInput { input, fetcher };
}
Poll::Ready(Some(Err(e))) => {
return self.baseline_metrics.record_poll(Poll::Ready(Some(Err(e))));
}
Poll::Ready(None) => {
return self.baseline_metrics.record_poll(Poll::Ready(None));
}
Poll::Pending => {
self.state = FetchState::ReadingInput { input, fetcher };
return self.baseline_metrics.record_poll(Poll::Pending);
}
}
}
FetchState::Fetching(mut fut) => {
match fut.as_mut().poll(cx) {
Poll::Ready(Ok((input, fetcher, batch))) if batch.num_rows() > 0 => {
// Yield non-empty batch and prepare for next input
self.state = FetchState::ReadingInput { input, fetcher };
return self
.baseline_metrics
.record_poll(Poll::Ready(Some(Ok(batch))));
}
Poll::Ready(Ok((input, fetcher, _))) => {
// Empty batch - continue reading
self.state = FetchState::ReadingInput { input, fetcher };
}
Poll::Ready(Err(e)) => {
return self.baseline_metrics.record_poll(Poll::Ready(Some(Err(e))));
}
Poll::Pending => {
self.state = FetchState::Fetching(fut);
return self.baseline_metrics.record_poll(Poll::Pending);
}
}
}
FetchState::Error => {
return self.baseline_metrics.record_poll(Poll::Ready(None));
}
}
}
}
}
impl fmt::Debug for RecordFetchStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("RecordFetchStream")
.field("schema", &self.schema)
.field("baseline_metrics", &self.baseline_metrics)
.finish()
}
}
impl RecordBatchStream for RecordFetchStream {
fn schema(&self) -> SchemaRef {
self.schema.clone()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::physical_plan::create_index_schema;
use crate::physical_plan::Index;
use async_trait::async_trait;
use datafusion::arrow::array::StringArray;
use datafusion::arrow::array::UInt64Array;
use datafusion::arrow::datatypes::{DataType, Field, Schema, SchemaRef};
use datafusion::arrow::record_batch::RecordBatch;
use datafusion::common::Statistics;
use datafusion::logical_expr::Expr;
use datafusion::logical_expr::{col, lit};
use datafusion::physical_plan::joins::HashJoinExec;
use datafusion::physical_plan::memory::MemoryStream;
use datafusion::prelude::SessionContext;
use std::any::Any;
use std::sync::Mutex;
use std::time::Duration;
const PK_COL: &str = "id";
// --- Mock Index ---
#[derive(Debug)]
struct MockIndex {
schema: SchemaRef,
scan_called: Mutex<bool>,
batches: Vec<RecordBatch>,
}
impl MockIndex {
fn new(batches: Vec<RecordBatch>) -> Self {
Self {
schema: create_index_schema([Field::new(PK_COL, DataType::UInt64, false)]),
scan_called: Mutex::new(false),
batches,
}
}
}
impl Index for MockIndex {
fn as_any(&self) -> &dyn Any {
self
}
fn name(&self) -> &str {
"mock_index"
}
fn index_schema(&self) -> SchemaRef {
self.schema.clone()
}
fn table_name(&self) -> &str {
"mock_table"
}
fn column_name(&self) -> &str {
"mock_column"
}
fn scan(
&self,
_filters: &[Expr],
_limit: Option<usize>,
) -> Result<SendableRecordBatchStream> {
*self.scan_called.lock().unwrap() = true;
let stream = MemoryStream::try_new(self.batches.clone(), self.schema.clone(), None)?;
Ok(Box::pin(stream))
}
fn statistics(&self) -> Statistics {
Statistics::new_unknown(&self.schema)
}
}
// --- Mock Record Fetcher ---
#[derive(Debug, Clone)]
struct MockRecordFetcher {
schema: SchemaRef,
}
impl MockRecordFetcher {
fn new() -> Self {
Self {
schema: Arc::new(Schema::new(vec![
Field::new(PK_COL, DataType::UInt64, false),
Field::new("name", DataType::Utf8, false),
])),
}
}
fn with_data(self) -> impl RecordFetcher {
#[derive(Debug)]
struct MockFetcherWithData {
schema: SchemaRef,
}
#[async_trait]
impl RecordFetcher for MockFetcherWithData {
fn schema(&self) -> SchemaRef {
self.schema.clone()
}
async fn fetch(&self, index_batch: RecordBatch) -> Result<RecordBatch> {
let row_ids = index_batch
.column_by_name(PK_COL)
.unwrap()
.as_any()
.downcast_ref::<UInt64Array>()
.unwrap();
let names: Vec<_> = row_ids
.values()
.iter()
.map(|id| format!("name_{id}"))
.collect();
Ok(RecordBatch::try_new(
self.schema.clone(),
vec![
Arc::new(row_ids.clone()),
Arc::new(StringArray::from(names)),
],
)?)
}
}
MockFetcherWithData {
schema: self.schema,
}
}
}
#[async_trait]
impl RecordFetcher for MockRecordFetcher {
fn schema(&self) -> SchemaRef {
self.schema.clone()
}
async fn fetch(&self, _index_batch: RecordBatch) -> Result<RecordBatch> {
unimplemented!("MockRecordFetcher::fetch should not be called in these tests")
}
}
// --- Slow Record Fetcher ---
#[derive(Debug)]
struct SlowRecordFetcher {
schema: SchemaRef,
names: Vec<String>,
}
impl SlowRecordFetcher {
fn new(names: Vec<String>) -> Self {
Self {
schema: Arc::new(Schema::new(vec![
Field::new(PK_COL, DataType::UInt64, false),
Field::new("name", DataType::Utf8, false),
])),
names,
}
}
}
#[async_trait]
impl RecordFetcher for SlowRecordFetcher {
fn schema(&self) -> SchemaRef {
self.schema.clone()
}
async fn fetch(&self, index_batch: RecordBatch) -> Result<RecordBatch> {
// Simulate a delay
tokio::time::sleep(Duration::from_millis(20)).await;
let row_ids = index_batch
.column_by_name(PK_COL)
.unwrap()
.as_any()
.downcast_ref::<UInt64Array>()
.unwrap();
// add a delay between each row
let mut names = Vec::with_capacity(row_ids.len());
for id in row_ids.values().iter() {
// simulate an await point
tokio::time::sleep(Duration::from_millis(20)).await;
names.push(self.names[*id as usize].clone());
}
Ok(RecordBatch::try_new(
self.schema.clone(),
vec![
Arc::new(row_ids.clone()),
Arc::new(StringArray::from(names)),
],
)?)
}
}
#[tokio::test]
async fn test_record_fetch_exec_slow_input() {
let session_ctx = SessionContext::new();
let _task_ctx = session_ctx.task_ctx();
let schema = Arc::new(Schema::new(vec![Field::new(
PK_COL,
DataType::UInt64,
false,
)]));
// create a memoryStream of 5 rows
let input_stream = MemoryStream::try_new(
vec![RecordBatch::try_new(
schema.clone(),
vec![Arc::new(UInt64Array::from(vec![0, 1, 2, 3, 4]))],
)
.expect("Failed to create RecordBatch")],
schema.clone(),
None,
)
.expect("Failed to create MemoryStream");
let fetcher = Arc::new(SlowRecordFetcher::new(vec![
"name_0".to_string(),
"name_1".to_string(),
"name_2".to_string(),
"name_3".to_string(),
"name_4".to_string(),
]));
let metrics = ExecutionPlanMetricsSet::new();
let baseline_metrics = BaselineMetrics::new(&metrics, 0);
let mut stream = RecordFetchStream::new(Box::pin(input_stream), fetcher, baseline_metrics);
let mut total_rows = 0;
while let Some(batch_result) = stream.next().await {
let batch = batch_result.unwrap();
total_rows += batch.num_rows();
}
assert_eq!(total_rows, 5, "Should have fetched all 5 rows");
}
#[tokio::test]
async fn test_record_fetch_exec_slow_and_multiple() {
let session_ctx = SessionContext::new();
let _task_ctx = session_ctx.task_ctx();
let schema = Arc::new(Schema::new(vec![Field::new(
PK_COL,
DataType::UInt64,
false,
)]));
// create a memoryStream of 5 rows
let input_stream = MemoryStream::try_new(
vec![
RecordBatch::try_new(
schema.clone(),
vec![Arc::new(UInt64Array::from(vec![0, 1, 2]))],
)
.expect("Failed to create RecordBatch"),
RecordBatch::try_new(
schema.clone(),
vec![Arc::new(UInt64Array::from(vec![3, 4]))],
)
.expect("Failed to create RecordBatch"),
],
schema.clone(),
None,
)
.expect("Failed to create MemoryStream");
let fetcher = Arc::new(SlowRecordFetcher::new(vec![
"name_0".to_string(),
"name_1".to_string(),
"name_2".to_string(),
"name_3".to_string(),
"name_4".to_string(),
]));
let metrics = ExecutionPlanMetricsSet::new();
let baseline_metrics = BaselineMetrics::new(&metrics, 0);
let mut stream = RecordFetchStream::new(Box::pin(input_stream), fetcher, baseline_metrics);
let mut total_rows = 0;
while let Some(batch_result) = stream.next().await {
let batch = batch_result.unwrap();
total_rows += batch.num_rows();
}
assert_eq!(total_rows, 5, "Should have fetched all 5 rows");
}
#[tokio::test]
async fn test_record_fetch_exec_multiple_recordbatch() {
let session_ctx = SessionContext::new();
let _task_ctx = session_ctx.task_ctx();
let schema = Arc::new(Schema::new(vec![Field::new(
PK_COL,
DataType::UInt64,
false,
)]));
// create a memoryStream of 5 recordBatch
let input_stream = MemoryStream::try_new(
vec![
RecordBatch::try_new(schema.clone(), vec![Arc::new(UInt64Array::from(vec![0]))])
.expect("Failed to create RecordBatch"),
RecordBatch::try_new(schema.clone(), vec![Arc::new(UInt64Array::from(vec![1]))])
.expect("Failed to create RecordBatch"),
RecordBatch::try_new(schema.clone(), vec![Arc::new(UInt64Array::from(vec![2]))])
.expect("Failed to create RecordBatch"),
RecordBatch::try_new(schema.clone(), vec![Arc::new(UInt64Array::from(vec![3]))])
.expect("Failed to create RecordBatch"),
RecordBatch::try_new(schema.clone(), vec![Arc::new(UInt64Array::from(vec![4]))])
.expect("Failed to create RecordBatch"),
],
schema.clone(),
None,
)
.expect("Failed to create MemoryStream");
let fetcher = Arc::new(SlowRecordFetcher::new(vec![
"name_0".to_string(),
"name_1".to_string(),
"name_2".to_string(),
"name_3".to_string(),
"name_4".to_string(),
]));
let metrics = ExecutionPlanMetricsSet::new();
let baseline_metrics = BaselineMetrics::new(&metrics, 0);
let mut stream = RecordFetchStream::new(Box::pin(input_stream), fetcher, baseline_metrics);
let mut total_rows = 0;
while let Some(batch_result) = stream.next().await {
let batch = batch_result.unwrap();
total_rows += batch.num_rows();
}
assert_eq!(total_rows, 5, "Should have fetched all 5 rows");
}
// --- Tests ---
#[tokio::test]
async fn test_record_fetch_stream_eager_with_empty_batches() -> Result<()> {
// This test ensures that the stream is "eager" and will skip over empty
// input batches to find the next valid one within a single poll cycle.
// 1. Setup input stream with an empty batch in the middle
let schema = Arc::new(Schema::new(vec![Field::new(
PK_COL,
DataType::UInt64,
false,
)]));
let batch1 = RecordBatch::try_new(
schema.clone(),
vec![Arc::new(UInt64Array::from(vec![1, 2]))],
)?;
let empty_batch = RecordBatch::new_empty(schema.clone());
let batch2 = RecordBatch::try_new(
schema.clone(),
vec![Arc::new(UInt64Array::from(vec![3, 4]))],
)?;
let input_stream = MemoryStream::try_new(vec![batch1, empty_batch, batch2], schema, None)?;
// 2. Setup fetcher and stream
let names = (0..5).map(|i| format!("name_{i}")).collect();
let fetcher = Arc::new(SlowRecordFetcher::new(names));
let metrics = ExecutionPlanMetricsSet::new();
let baseline_metrics = BaselineMetrics::new(&metrics, 0);
let stream =
RecordFetchStream::new(Box::pin(input_stream), fetcher.clone(), baseline_metrics);
// 3. Collect results
let results = datafusion::physical_plan::common::collect(Box::pin(stream)).await?;
// 4. Assert results
let expected_batch1 = RecordBatch::try_new(
fetcher.schema(),
vec![
Arc::new(UInt64Array::from(vec![1, 2])),
Arc::new(StringArray::from(vec!["name_1", "name_2"])),
],
)?;
let expected_batch2 = RecordBatch::try_new(
fetcher.schema(),
vec![
Arc::new(UInt64Array::from(vec![3, 4])),
Arc::new(StringArray::from(vec!["name_3", "name_4"])),
],
)?;
assert_eq!(
results.len(),
2,
"Should have produced two non-empty batches"
);
assert_eq!(results[0], expected_batch1);
assert_eq!(results[1], expected_batch2);
Ok(())
}
#[tokio::test]
async fn test_record_fetch_exec_no_indexes() {
let fetcher = Arc::new(MockRecordFetcher::new());
let err = RecordFetchExec::try_new(
vec![],
None,
fetcher,
Arc::new(Schema::empty()),
UnionMode::Parallel,
)
.unwrap_err();
assert!(
matches!(err, DataFusionError::Plan(ref msg) if msg == "RecordFetchExec requires at least one index"),
"Unexpected error: {err:?}"
);
}
#[tokio::test]
async fn test_record_fetch_exec_single_index() -> Result<()> {
let index_batch = RecordBatch::try_from_iter(vec![(
PK_COL,
Arc::new(UInt64Array::from(vec![1, 3])) as _,
)])?;
let index = Arc::new(MockIndex::new(vec![index_batch]));
let indexes: Vec<IndexFilter> = vec![IndexFilter::Single {
index: index.clone() as Arc<dyn Index>,
filter: col("a").eq(lit(1)),
}];