tustvold commented on code in PR #5774:
URL: https://github.com/apache/arrow-rs/pull/5774#discussion_r1606672376
##########
parquet/src/arrow/arrow_reader/mod.rs:
##########
@@ -44,14 +44,14 @@ use crate::file::page_index::index_reader;
pub use filter::{ArrowPredicate, ArrowPredicateFn, RowFilter};
pub use selection::{RowSelection, RowSelector};
-/// A generic builder for constructing sync or async arrow parquet readers.
This is not intended
-/// to be used directly, instead you should use the specialization for the
type of reader
-/// you wish to use
+/// Builder for constructing parquet readers into arrow.
///
-/// * For a synchronous API - [`ParquetRecordBatchReaderBuilder`]
-/// * For an asynchronous API - [`ParquetRecordBatchStreamBuilder`]
+/// Most users should use one of the following specializations:
///
-/// [`ParquetRecordBatchStreamBuilder`]:
crate::arrow::async_reader::ParquetRecordBatchStreamBuilder
+/// * synchronous API: [`ParquetRecordBatchReaderBuilder::try_new`]
+/// * `async` API: [`ParquetRecordBatchStreamBuilder::new_with_metadata`]
Review Comment:
New is what most people should use, new_with_metadata is for a very specific
use case of wanting to load the metadata once for many readers
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
