Skip to content

Commit 35e6ab7

Browse files
committed
Restore doc test with mock parquet source
1 parent 22416e6 commit 35e6ab7

1 file changed

Lines changed: 26 additions & 5 deletions

File tree

‎datafusion/datasource/src/file_scan_config.rs‎

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,44 @@ use crate::{
6666
/// Use [`Self::build`] to create a [`DataSourceExec`] from a ``FileScanConfig`.
6767
///
6868
/// # Example
69-
/// ```ignore
69+
/// ```
70+
/// # use std::any::Any;
7071
/// # use std::sync::Arc;
71-
/// # use arrow::datatypes::{Field, Fields, DataType, Schema};
72+
/// # use arrow::datatypes::{Field, Fields, DataType, Schema, SchemaRef};
73+
/// # use object_store::ObjectStore;
74+
/// # use datafusion_common::Statistics;
75+
/// # use datafusion_datasource::file::FileSource;
7276
/// # use datafusion_datasource::PartitionedFile;
7377
/// # use datafusion_datasource::file_scan_config::FileScanConfig;
78+
/// # use datafusion_datasource::file_stream::FileOpener;
7479
/// # use datafusion_execution::object_store::ObjectStoreUrl;
75-
/// # use datafusion::datasource::physical_plan::ArrowSource;
7680
/// # use datafusion_physical_plan::ExecutionPlan;
81+
/// # use datafusion_physical_plan::metrics::ExecutionPlanMetricsSet;
7782
/// # let file_schema = Arc::new(Schema::new(vec![
7883
/// # Field::new("c1", DataType::Int32, false),
7984
/// # Field::new("c2", DataType::Int32, false),
8085
/// # Field::new("c3", DataType::Int32, false),
8186
/// # Field::new("c4", DataType::Int32, false),
8287
/// # ]));
83-
/// // create FileScan config for reading arrow files from file://
88+
/// # // Note: crate mock ParquetSource, as ParquetSource is not in the datasource crate
89+
/// # struct ParquetSource {};
90+
/// # impl FileSource for ParquetSource {
91+
/// # fn create_file_opener(&self, _: Arc<dyn ObjectStore>, _: &FileScanConfig, _: usize) -> Arc<dyn FileOpener> { unimplemented!() }
92+
/// # fn as_any(&self) -> &dyn Any { self }
93+
/// # fn with_batch_size(&self, _: usize) -> Arc<dyn FileSource> { unimplemented!() }
94+
/// # fn with_schema(&self, _: SchemaRef) -> Arc<dyn FileSource> { unimplemented!() }
95+
/// # fn with_projection(&self, _: &FileScanConfig) -> Arc<dyn FileSource> { unimplemented!() }
96+
/// # fn with_statistics(&self, _: Statistics) -> Arc<dyn FileSource> { Arc::new(Self::new()) }
97+
/// # fn metrics(&self) -> &ExecutionPlanMetricsSet { unimplemented!() }
98+
/// # fn statistics(&self) -> datafusion_common::Result<Statistics> { unimplemented!() }
99+
/// # fn file_type(&self) -> &str { "parquet" }
100+
/// # }
101+
/// # impl ParquetSource {
102+
/// # fn new() -> Self { Self{} }
103+
/// # }
104+
/// // create FileScan config for reading parquet files from file://
84105
/// let object_store_url = ObjectStoreUrl::local_filesystem();
85-
/// let file_source = Arc::new(ArrowSource::default());
106+
/// let file_source = Arc::new(ParquetSource::new());
86107
/// let config = FileScanConfig::new(object_store_url, file_schema, file_source)
87108
/// .with_limit(Some(1000)) // read only the first 1000 records
88109
/// .with_projection(Some(vec![2, 3])) // project columns 2 and 3

0 commit comments

Comments
 (0)