Make FileStream and FileOpener public (apache#3514)

coralogix · Sep 20, 2022 · f3cdf6b · f3cdf6b
1 parent 9d981da
commit f3cdf6b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/datafusion/core/src/physical_plan/file_format/file_stream.rs b/datafusion/core/src/physical_plan/file_format/file_stream.rs
@@ -51,7 +51,11 @@ use crate::physical_plan::RecordBatchStream;
 pub type FileOpenFuture =
     BoxFuture<'static, Result<BoxStream<'static, ArrowResult<RecordBatch>>>>;
 
+/// Generic API for opening a file using an [`ObjectStore`] and resolving to a
+/// stream of [`RecordBatch`]
 pub trait FileOpener: Unpin {
+    /// Asynchronously open the specified file and return a stream
+    /// of [`RecordBatch`]
     fn open(
         &self,
         store: Arc<dyn ObjectStore>,
@@ -167,6 +171,7 @@ impl FileStreamMetrics {
 }
 
 impl<F: FileOpener> FileStream<F> {
+    /// Create a new `FileStream` using the give `FileOpener` to scan underlying files
     pub fn new(
         config: &FileScanConfig,
         partition: usize,

diff --git a/datafusion/core/src/physical_plan/file_format/mod.rs b/datafusion/core/src/physical_plan/file_format/mod.rs
@@ -41,6 +41,7 @@ use arrow::{
     record_batch::RecordBatch,
 };
 pub use avro::AvroExec;
+pub use file_stream::{FileOpenFuture, FileOpener, FileStream};
 pub(crate) use json::plan_to_json;
 pub use json::NdJsonExec;