File tree 1 file changed +9
-2
lines changed
datafusion/core/src/datasource/physical_plan/parquet
1 file changed +9
-2
lines changed Original file line number Diff line number Diff line change 16
16
// under the License.
17
17
18
18
//! [`ParquetFileReaderFactory`] and [`DefaultParquetFileReaderFactory`] for
19
- //! creating parquet file readers
19
+ //! low level control of parquet file readers
20
20
21
21
use crate :: datasource:: physical_plan:: { FileMeta , ParquetFileMetrics } ;
22
22
use bytes:: Bytes ;
@@ -33,12 +33,19 @@ use std::sync::Arc;
33
33
///
34
34
/// The combined implementations of [`ParquetFileReaderFactory`] and
35
35
/// [`AsyncFileReader`] can be used to provide custom data access operations
36
- /// such as pre-cached data , I/O coalescing, etc.
36
+ /// such as pre-cached metadata , I/O coalescing, etc.
37
37
///
38
38
/// See [`DefaultParquetFileReaderFactory`] for a simple implementation.
39
39
pub trait ParquetFileReaderFactory : Debug + Send + Sync + ' static {
40
40
/// Provides an `AsyncFileReader` for reading data from a parquet file specified
41
41
///
42
+ /// # Notes
43
+ ///
44
+ /// If the resulting [`AsyncFileReader`] returns `ParquetMetaData` without
45
+ /// page index information, the reader will load it on demand. Thus it is important
46
+ /// to ensure that the returned `ParquetMetaData` has the necessary information
47
+ /// if you wish to avoid a subsequent I/O
48
+ ///
42
49
/// # Arguments
43
50
/// * partition_index - Index of the partition (for reporting metrics)
44
51
/// * file_meta - The file to be read
You can’t perform that action at this time.
0 commit comments