-
Notifications
You must be signed in to change notification settings - Fork 149
Expand file tree
/
Copy pathformat.rs
More file actions
732 lines (660 loc) · 27.7 KB
/
format.rs
File metadata and controls
732 lines (660 loc) · 27.7 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
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors
use std::any::Any;
use std::fmt::Debug;
use std::fmt::Formatter;
use std::sync::Arc;
use arrow_schema::DataType;
use arrow_schema::Schema;
use arrow_schema::SchemaRef;
use async_trait::async_trait;
use datafusion_catalog::Session;
use datafusion_common::ColumnStatistics;
use datafusion_common::DataFusionError;
use datafusion_common::GetExt;
use datafusion_common::Result as DFResult;
use datafusion_common::Statistics;
use datafusion_common::config::ConfigField;
use datafusion_common::config_namespace;
use datafusion_common::internal_datafusion_err;
use datafusion_common::not_impl_err;
use datafusion_common::parsers::CompressionTypeVariant;
use datafusion_common::stats::Precision;
use datafusion_common_runtime::SpawnedTask;
use datafusion_datasource::TableSchema;
use datafusion_datasource::file::FileSource;
use datafusion_datasource::file_compression_type::FileCompressionType;
use datafusion_datasource::file_format::FileFormat;
use datafusion_datasource::file_format::FileFormatFactory;
use datafusion_datasource::file_scan_config::FileScanConfig;
use datafusion_datasource::file_scan_config::FileScanConfigBuilder;
use datafusion_datasource::file_sink_config::FileSinkConfig;
use datafusion_datasource::sink::DataSinkExec;
use datafusion_datasource::source::DataSourceExec;
use datafusion_execution::cache::cache_manager::CachedFileMetadataEntry;
use datafusion_expr::dml::InsertOp;
use datafusion_physical_expr::LexRequirement;
use datafusion_physical_plan::ExecutionPlan;
use futures::FutureExt;
use futures::StreamExt as _;
use futures::TryStreamExt as _;
use futures::stream;
use object_store::ObjectMeta;
use object_store::ObjectStore;
use vortex::VortexSessionDefault;
use vortex::array::memory::MemorySessionExt;
use vortex::dtype::DType;
use vortex::dtype::Nullability;
use vortex::dtype::PType;
use vortex::dtype::arrow::FromArrowType;
use vortex::error::VortexExpect;
use vortex::error::VortexResult;
use vortex::error::vortex_err;
use vortex::expr::stats;
use vortex::expr::stats::Stat;
use vortex::file::EOF_SIZE;
use vortex::file::MAX_POSTSCRIPT_SIZE;
use vortex::file::OpenOptionsSessionExt;
use vortex::file::VORTEX_FILE_EXTENSION;
use vortex::io::object_store::ObjectStoreReadAt;
use vortex::io::session::RuntimeSessionExt;
use vortex::scalar::Scalar;
use vortex::session::VortexSession;
use super::cache::CachedVortexMetadata;
use super::sink::VortexSink;
use super::source::VortexSource;
use crate::PrecisionExt as _;
use crate::convert::TryToDataFusion;
const DEFAULT_FOOTER_INITIAL_READ_SIZE_BYTES: usize = MAX_POSTSCRIPT_SIZE as usize + EOF_SIZE;
/// DataFusion [`FileFormat`] implementation for `.vortex` files.
///
/// Most applications do not construct `VortexFormat` directly. Instead, they
/// register [`VortexFormatFactory`] with a [`SessionContext`] and let
/// DataFusion instantiate `VortexFormat` as tables are planned.
///
/// Construct `VortexFormat` directly when you are wiring a [`ListingTable`] by
/// hand and need to pass a file format into [`ListingOptions`].
///
/// # Example
///
/// ```no_run
/// use std::sync::Arc;
///
/// use datafusion::datasource::listing::ListingOptions;
/// use datafusion::datasource::listing::ListingTable;
/// use datafusion::datasource::listing::ListingTableConfig;
/// use datafusion::datasource::listing::ListingTableUrl;
/// use datafusion::prelude::SessionContext;
/// use tempfile::tempdir;
/// use vortex::VortexSessionDefault;
/// use vortex::session::VortexSession;
/// use vortex_datafusion::VortexFormat;
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let ctx = SessionContext::new();
/// let dir = tempdir()?;
///
/// let format = Arc::new(VortexFormat::new(VortexSession::default()));
/// let table_url = ListingTableUrl::parse(dir.path().to_str().unwrap())?;
/// let config = ListingTableConfig::new(table_url)
/// .with_listing_options(
/// ListingOptions::new(format).with_session_config_options(ctx.state().config()),
/// )
/// .infer_schema(&ctx.state())
/// .await?;
///
/// let table = ListingTable::try_new(config)?;
/// # let _ = table;
/// # Ok(())
/// # }
/// ```
///
/// [`SessionContext`]: https://docs.rs/datafusion/latest/datafusion/prelude/struct.SessionContext.html
/// [`ListingTable`]: https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingTable.html
/// [`ListingOptions`]: https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingOptions.html
pub struct VortexFormat {
session: VortexSession,
opts: VortexTableOptions,
}
impl Debug for VortexFormat {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("VortexFormat")
.field("opts", &self.opts)
.finish()
}
}
config_namespace! {
/// Options to configure [`VortexFormat`] and [`VortexSource`].
///
/// These options are usually set on a [`VortexFormatFactory`] and inherited
/// by the `VortexFormat` / `VortexSource` instances created for individual
/// tables.
///
/// # Example
///
/// ```rust
/// use vortex_datafusion::{VortexFormatFactory, VortexTableOptions};
///
/// let factory = VortexFormatFactory::new().with_options(VortexTableOptions {
/// projection_pushdown: true,
/// scan_concurrency: Some(8),
/// ..Default::default()
/// });
/// # let _ = factory;
/// ```
///
/// [`SessionConfig`]: https://docs.rs/datafusion/latest/datafusion/prelude/struct.SessionConfig.html
pub struct VortexTableOptions {
/// The number of bytes to read when parsing a file footer.
///
/// Values smaller than `MAX_POSTSCRIPT_SIZE + EOF_SIZE` will be clamped to that minimum
/// during footer parsing.
pub footer_initial_read_size_bytes: usize, default = DEFAULT_FOOTER_INITIAL_READ_SIZE_BYTES
/// Whether to enable projection pushdown into the underlying Vortex scan.
///
/// When enabled, projection expressions may be partially evaluated during
/// the scan. When disabled, Vortex reads only the referenced columns and
/// all expressions are evaluated after the scan.
pub projection_pushdown: bool, default = false
/// The intra-partition scan concurrency, controlling the number of row splits to process
/// concurrently per-thread within each file.
///
/// This does not affect the overall parallelism
/// across partitions, which is controlled by DataFusion's execution configuration.
pub scan_concurrency: Option<usize>, default = None
}
}
impl Eq for VortexTableOptions {}
/// Registration entry point for the file-backed Vortex integration.
///
/// `VortexFormatFactory` is the type most applications use. Register it with a
/// DataFusion session, and DataFusion will create [`VortexFormat`] values for
/// `CREATE EXTERNAL TABLE`, [`ListingTable`], and URL-table scans.
///
/// The factory stores a [`VortexSession`] and default [`VortexTableOptions`].
/// Those defaults are copied into the formats and sources created for each
/// table.
///
/// # Example
///
/// ```no_run
/// use std::sync::Arc;
///
/// use datafusion::datasource::provider::DefaultTableFactory;
/// use datafusion::execution::SessionStateBuilder;
/// use datafusion_common::GetExt;
/// use vortex_datafusion::{VortexFormatFactory, VortexTableOptions};
///
/// let factory = Arc::new(VortexFormatFactory::new().with_options(VortexTableOptions {
/// projection_pushdown: true,
/// ..Default::default()
/// }));
///
/// let mut state_builder = SessionStateBuilder::new()
/// .with_default_features()
/// .with_table_factory(
/// factory.get_ext().to_uppercase(),
/// Arc::new(DefaultTableFactory::new()),
/// );
///
/// if let Some(file_formats) = state_builder.file_formats() {
/// file_formats.push(factory.clone() as _);
/// }
/// ```
///
/// [`ListingTable`]: https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingTable.html
#[derive(Debug)]
pub struct VortexFormatFactory {
session: VortexSession,
options: Option<VortexTableOptions>,
}
impl GetExt for VortexFormatFactory {
fn get_ext(&self) -> String {
VORTEX_FILE_EXTENSION.to_string()
}
}
impl VortexFormatFactory {
/// Creates a factory with a default [`VortexSession`] and default options.
#[expect(
clippy::new_without_default,
reason = "FormatFactory defines `default` method, so having `Default` implementation is confusing"
)]
pub fn new() -> Self {
Self {
session: VortexSession::default(),
options: None,
}
}
/// Creates a factory with an explicit session and default options.
///
/// The supplied options become the baseline for every [`VortexFormat`]
/// created by this factory. DataFusion may still override them with
/// table-level options passed into [`FileFormatFactory::create`].
pub fn new_with_options(session: VortexSession, options: VortexTableOptions) -> Self {
Self {
session,
options: Some(options),
}
}
/// Overrides the default options for this factory.
///
/// This is the usual way to turn on features such as projection pushdown for
/// every table created through the factory.
///
/// # Example
///
/// ```rust
/// use vortex_datafusion::{VortexFormatFactory, VortexTableOptions};
///
/// let factory = VortexFormatFactory::new().with_options(VortexTableOptions {
/// projection_pushdown: true,
/// ..Default::default()
/// });
/// # let _ = factory;
/// ```
pub fn with_options(mut self, options: VortexTableOptions) -> Self {
self.options = Some(options);
self
}
}
impl FileFormatFactory for VortexFormatFactory {
#[expect(clippy::disallowed_types, reason = "required by trait signature")]
fn create(
&self,
_state: &dyn Session,
format_options: &std::collections::HashMap<String, String>,
) -> DFResult<Arc<dyn FileFormat>> {
let mut opts = self.options.clone().unwrap_or_default();
for (key, value) in format_options {
if let Some(key) = key.strip_prefix("format.") {
opts.set(key, value)?;
} else {
tracing::trace!("Ignoring options '{key}'");
}
}
Ok(Arc::new(VortexFormat::new_with_options(
self.session.clone(),
opts,
)))
}
fn default(&self) -> Arc<dyn FileFormat> {
Arc::new(VortexFormat::new(self.session.clone()))
}
fn as_any(&self) -> &dyn Any {
self
}
}
impl VortexFormat {
/// Creates a format with default [`VortexTableOptions`].
///
/// Prefer [`VortexFormatFactory`] when registering with a session. Construct
/// `VortexFormat` directly when building [`ListingOptions`] manually.
///
/// [`ListingOptions`]: https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingOptions.html
pub fn new(session: VortexSession) -> Self {
Self::new_with_options(session, VortexTableOptions::default())
}
/// Creates a format with explicit [`VortexTableOptions`].
pub fn new_with_options(session: VortexSession, opts: VortexTableOptions) -> Self {
Self { session, opts }
}
/// Returns the format-specific configuration that will be copied into the
/// [`VortexSource`] created for a scan.
pub fn options(&self) -> &VortexTableOptions {
&self.opts
}
}
#[async_trait]
impl FileFormat for VortexFormat {
fn as_any(&self) -> &dyn Any {
self
}
fn compression_type(&self) -> Option<FileCompressionType> {
None
}
fn get_ext(&self) -> String {
VORTEX_FILE_EXTENSION.to_string()
}
fn get_ext_with_compression(
&self,
file_compression_type: &FileCompressionType,
) -> DFResult<String> {
match file_compression_type.get_variant() {
CompressionTypeVariant::UNCOMPRESSED => Ok(self.get_ext()),
_ => Err(DataFusionError::Internal(
"Vortex does not support file level compression.".into(),
)),
}
}
async fn infer_schema(
&self,
state: &dyn Session,
store: &Arc<dyn ObjectStore>,
objects: &[ObjectMeta],
) -> DFResult<SchemaRef> {
let file_metadata_cache = state.runtime_env().cache_manager.get_file_metadata_cache();
let mut file_schemas = stream::iter(objects.iter().cloned())
.map(|object| {
let store = Arc::clone(store);
let session = self.session.clone();
let opts = self.opts.clone();
let cache = Arc::clone(&file_metadata_cache);
SpawnedTask::spawn(async move {
// Check if we have entry metadata for this file
if let Some(entry) = cache.get(&object.location)
&& entry.is_valid_for(&object)
&& let Some(cached_vortex) = entry
.file_metadata
.as_any()
.downcast_ref::<CachedVortexMetadata>()
{
let inferred_schema = cached_vortex.footer().dtype().to_arrow_schema()?;
return VortexResult::Ok((object.location, inferred_schema));
}
// Not entry or invalid - open the file
let reader = Arc::new(ObjectStoreReadAt::new_with_allocator(
store,
object.location.clone(),
session.handle(),
session.allocator(),
));
let vxf = session
.open_options()
.with_initial_read_size(opts.footer_initial_read_size_bytes)
.with_file_size(object.size)
.open_read(reader)
.await?;
// Cache the metadata
let cached_metadata = Arc::new(CachedVortexMetadata::new(&vxf));
let entry = CachedFileMetadataEntry::new(object.clone(), cached_metadata);
cache.put(&object.location, entry);
let inferred_schema = vxf.dtype().to_arrow_schema()?;
VortexResult::Ok((object.location, inferred_schema))
})
.map(|f| f.vortex_expect("Failed to spawn infer_schema"))
})
.buffer_unordered(state.config_options().execution.meta_fetch_concurrency)
.try_collect::<Vec<_>>()
.await
.map_err(|e| DataFusionError::Execution(format!("Failed to infer schema: {e}")))?;
// Get consistent order of schemas for `Schema::try_merge`, as some filesystems don't have deterministic listing orders
file_schemas.sort_by(|(l1, _), (l2, _)| l1.cmp(l2));
let file_schemas = file_schemas.into_iter().map(|(_, schema)| schema);
Ok(Arc::new(Schema::try_merge(file_schemas)?))
}
#[tracing::instrument(skip_all, fields(location = object.location.as_ref()))]
async fn infer_stats(
&self,
state: &dyn Session,
store: &Arc<dyn ObjectStore>,
table_schema: SchemaRef,
object: &ObjectMeta,
) -> DFResult<Statistics> {
let object = object.clone();
let store = Arc::clone(store);
let session = self.session.clone();
let opts = self.opts.clone();
let file_metadata_cache = state.runtime_env().cache_manager.get_file_metadata_cache();
SpawnedTask::spawn(async move {
// Try to get entry metadata first
let cached_metadata = file_metadata_cache
.get(&object.location)
.filter(|entry| entry.is_valid_for(&object))
.and_then(|entry| {
entry
.file_metadata
.as_any()
.downcast_ref::<CachedVortexMetadata>()
.map(|m| {
(
m.footer().dtype().clone(),
m.footer().statistics().cloned(),
m.footer().row_count(),
)
})
});
let (dtype, file_stats, row_count) = match cached_metadata {
Some(metadata) => metadata,
None => {
// Not entry - open the file
let reader = Arc::new(ObjectStoreReadAt::new_with_allocator(
store,
object.location.clone(),
session.handle(),
session.allocator(),
));
let vxf = session
.open_options()
.with_initial_read_size(opts.footer_initial_read_size_bytes)
.with_file_size(object.size)
.open_read(reader)
.await
.map_err(|e| {
DataFusionError::Execution(format!(
"Failed to open Vortex file {}: {e}",
object.location
))
})?;
// Cache the metadata
let file_metadata = Arc::new(CachedVortexMetadata::new(&vxf));
let entry = CachedFileMetadataEntry::new(object.clone(), file_metadata);
file_metadata_cache.put(&object.location, entry);
(
vxf.dtype().clone(),
vxf.file_stats().cloned(),
vxf.row_count(),
)
}
};
let struct_dtype = dtype
.as_struct_fields_opt()
.vortex_expect("dtype is not a struct");
// Evaluate the statistics for each column that we are able to return to DataFusion.
let Some(file_stats) = file_stats else {
// If the file has no column stats, the best we can do is return a row count.
return Ok(Statistics {
num_rows: Precision::Exact(
usize::try_from(row_count)
.map_err(|_| vortex_err!("Row count overflow"))
.vortex_expect("Row count overflow"),
),
total_byte_size: Precision::Absent,
column_statistics: vec![ColumnStatistics::default(); struct_dtype.nfields()],
});
};
let mut sum_of_column_byte_sizes = stats::Precision::exact(0_usize);
let mut column_statistics = Vec::with_capacity(table_schema.fields().len());
for field in table_schema.fields().iter() {
// If the column does not exist, continue. This can happen if the schema has evolved
// but we have not yet updated the Vortex file.
let Some(col_idx) = struct_dtype.find(field.name()) else {
// The default sets all statistics to `Precision<Absent>`.
column_statistics.push(ColumnStatistics::default());
continue;
};
let (stats_set, stats_dtype) = file_stats.get(col_idx);
// Update the total size in bytes.
let column_size = stats_set
.get_as::<usize>(Stat::UncompressedSizeInBytes, &PType::U64.into())
.unwrap_or_else(|| stats::Precision::inexact(0_usize));
sum_of_column_byte_sizes = sum_of_column_byte_sizes
.zip(column_size)
.map(|(acc, size)| acc + size);
// TODO(connor): There's a lot that can go wrong here, should probably handle this
// more gracefully...
// Find the min statistic.
let min = stats_set.get(Stat::Min).and_then(|pstat_val| {
pstat_val
.map(|stat_val| {
// Because of DataFusion's Schema evolution, it is possible that the
// type of the min/max stat has changed. Thus we construct the stat as
// the file datatype first and only then do we cast accordingly.
Scalar::try_new(
Stat::Min
.dtype(stats_dtype)
.vortex_expect("must have a valid dtype"),
Some(stat_val),
)
.vortex_expect("`Stat::Min` somehow had an incompatible `DType`")
.cast(&DType::from_arrow(field.as_ref()))
.vortex_expect("Unable to cast to target type that DataFusion wants")
.try_to_df()
.ok()
})
.transpose()
});
// Find the max statistic.
let max = stats_set.get(Stat::Max).and_then(|pstat_val| {
pstat_val
.map(|stat_val| {
Scalar::try_new(
Stat::Max
.dtype(stats_dtype)
.vortex_expect("must have a valid dtype"),
Some(stat_val),
)
.vortex_expect("`Stat::Max` somehow had an incompatible `DType`")
.cast(&DType::from_arrow(field.as_ref()))
.vortex_expect("Unable to cast to target type that DataFusion wants")
.try_to_df()
.ok()
})
.transpose()
});
let sum = (!matches!(field.data_type(), DataType::Boolean))
.then(|| {
stats_set.get(Stat::Sum).and_then(|pstat_val| {
{
Stat::Sum.dtype(stats_dtype).map(|stat_dtype| {
pstat_val
.map(|stat_val| {
Scalar::try_new(stat_dtype, Some(stat_val))
.vortex_expect(
"`Stat::Sum` somehow had an incompatible `DType`",
)
.cast(&DType::from_arrow(field.as_ref()))
.vortex_expect(
"Unable to cast to target type that DataFusion wants",
)
.try_to_df()
.ok()
})
.transpose()
})
}
.flatten()
})
})
.flatten();
let null_count = stats_set.get_as::<usize>(Stat::NullCount, &PType::U64.into());
column_statistics.push(ColumnStatistics {
null_count: null_count.to_df(),
min_value: min.to_df(),
max_value: max.to_df(),
sum_value: sum.to_df(),
distinct_count: stats_set
.get_as::<bool>(Stat::IsConstant, &DType::Bool(Nullability::NonNullable))
.and_then(|is_constant| is_constant.as_exact().map(|_| Precision::Exact(1)))
.unwrap_or(Precision::Absent),
// TODO(connor): Is this correct?
byte_size: column_size.to_df(),
})
}
let total_byte_size = sum_of_column_byte_sizes.to_df();
Ok(Statistics {
num_rows: Precision::Exact(
usize::try_from(row_count)
.map_err(|_| vortex_err!("Row count overflow"))
.vortex_expect("Row count overflow"),
),
total_byte_size,
column_statistics,
})
})
.await
.vortex_expect("Failed to spawn infer_stats")
}
async fn create_physical_plan(
&self,
state: &dyn Session,
file_scan_config: FileScanConfig,
) -> DFResult<Arc<dyn ExecutionPlan>> {
let mut source = file_scan_config
.file_source()
.as_any()
.downcast_ref::<VortexSource>()
.cloned()
.ok_or_else(|| internal_datafusion_err!("Expected VortexSource"))?;
source = source
.with_file_metadata_cache(state.runtime_env().cache_manager.get_file_metadata_cache());
let conf = FileScanConfigBuilder::from(file_scan_config)
.with_source(Arc::new(source))
.build();
Ok(DataSourceExec::from_data_source(conf))
}
async fn create_writer_physical_plan(
&self,
input: Arc<dyn ExecutionPlan>,
_state: &dyn Session,
conf: FileSinkConfig,
order_requirements: Option<LexRequirement>,
) -> DFResult<Arc<dyn ExecutionPlan>> {
if conf.insert_op != InsertOp::Append {
return not_impl_err!("Overwrites are not implemented yet for Vortex");
}
let schema = Arc::clone(conf.output_schema());
let sink = Arc::new(VortexSink::new(conf, schema, self.session.clone()));
Ok(Arc::new(DataSinkExec::new(input, sink, order_requirements)) as _)
}
fn file_source(&self, table_schema: TableSchema) -> Arc<dyn FileSource> {
let mut source = VortexSource::new(table_schema, self.session.clone())
.with_projection_pushdown(self.opts.projection_pushdown);
if let Some(scan_concurrency) = self.opts.scan_concurrency {
source = source.with_scan_concurrency(scan_concurrency);
}
Arc::new(source) as _
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::common_tests::TestSessionContext;
#[tokio::test]
async fn create_table() -> anyhow::Result<()> {
let ctx = TestSessionContext::default();
ctx.session
.sql(
"CREATE EXTERNAL TABLE my_tbl \
(c1 VARCHAR NOT NULL, c2 INT NOT NULL) \
STORED AS vortex \
LOCATION 'table/'",
)
.await?;
assert!(ctx.session.table_exist("my_tbl")?);
Ok(())
}
#[tokio::test]
async fn configure_format_source() -> anyhow::Result<()> {
let ctx = TestSessionContext::default();
ctx.session
.sql(
"CREATE EXTERNAL TABLE my_tbl \
(c1 VARCHAR NOT NULL, c2 INT NOT NULL) \
STORED AS vortex \
LOCATION 'table/' \
OPTIONS( footer_initial_read_size_bytes '12345', scan_concurrency '3' );",
)
.await?
.collect()
.await?;
Ok(())
}
#[test]
fn format_plumbs_footer_initial_read_size() {
let mut opts = VortexTableOptions::default();
opts.set("footer_initial_read_size_bytes", "12345").unwrap();
let format = VortexFormat::new_with_options(VortexSession::default(), opts);
assert_eq!(format.options().footer_initial_read_size_bytes, 12345);
}
}