Skip to content

Commit 5e6c19a

Browse files
alambetseidl
andauthored
Improve documentation for AsyncFileReader::get_metadata (#7380)
* Improve documentation for AsyncFileReader::get_metadata * Update parquet/src/arrow/async_reader/mod.rs Co-authored-by: Ed Seidl <etseidl@users.noreply.github.com> * Update parquet/src/arrow/async_reader/mod.rs Co-authored-by: Ed Seidl <etseidl@users.noreply.github.com> * Update parquet/src/arrow/async_reader/mod.rs Co-authored-by: Ed Seidl <etseidl@users.noreply.github.com> --------- Co-authored-by: Ed Seidl <etseidl@users.noreply.github.com>
1 parent d1d2c95 commit 5e6c19a

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

  • parquet/src/arrow/async_reader

parquet/src/arrow/async_reader/mod.rs

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,22 @@ pub trait AsyncFileReader: Send {
9797
.boxed()
9898
}
9999

100-
/// Provides asynchronous access to the [`ParquetMetaData`] of a parquet file,
101-
/// allowing fine-grained control over how metadata is sourced, in particular allowing
102-
/// for caching, pre-fetching, catalog metadata, etc...
103-
/// ArrowReaderOptions may be provided to supply decryption parameters
100+
/// Return a future which results in the [`ParquetMetaData`] for this Parquet file.
101+
///
102+
/// This is an asynchronous operation as it may involve reading the file
103+
/// footer and potentially other metadata from disk or a remote source.
104+
///
105+
/// Reading data from Parquet requires the metadata to understand the
106+
/// schema, row groups, and location of pages within the file. This metadata
107+
/// is stored primarily in the footer of the Parquet file, and can be read using
108+
/// [`ParquetMetaDataReader`].
109+
///
110+
/// However, implementations can significantly speed up reading Parquet by
111+
/// supplying cached metadata or pre-fetched metadata via this API.
112+
///
113+
/// # Parameters
114+
/// * `options`: Optional [`ArrowReaderOptions`] that may contain decryption
115+
/// and other options that affect how the metadata is read.
104116
fn get_metadata<'a>(
105117
&'a mut self,
106118
options: Option<&'a ArrowReaderOptions>,

0 commit comments

Comments
 (0)