alamb commented on code in PR #8021:
URL: https://github.com/apache/arrow-datafusion/pull/8021#discussion_r1394148556
##########
datafusion/sqllogictest/test_files/ddl.slt:
##########
@@ -750,7 +750,7 @@ query TT
explain select c1 from t;
----
logical_plan TableScan: t projection=[c1]
-physical_plan CsvExec: file_groups={1 group:
[[WORKSPACE_ROOT/datafusion/core/tests/data/empty.csv]]}, projection=[c1],
infinite_source=true, has_header=true
+physical_plan StreamingTableExec: partition_sizes=1, projection=[c1],
infinite_source=true
Review Comment:
👍
##########
datafusion/core/src/datasource/stream.rs:
##########
@@ -0,0 +1,326 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! TableProvider for stream sources, such as FIFO files
+
+use std::any::Any;
+use std::fmt::Formatter;
+use std::fs::{File, OpenOptions};
+use std::io::BufReader;
+use std::path::PathBuf;
+use std::str::FromStr;
+use std::sync::Arc;
+
+use arrow_array::{RecordBatch, RecordBatchReader, RecordBatchWriter};
+use arrow_schema::SchemaRef;
+use async_trait::async_trait;
+use futures::StreamExt;
+use tokio::task::spawn_blocking;
+
+use datafusion_common::{plan_err, DataFusionError, Result};
+use datafusion_execution::{SendableRecordBatchStream, TaskContext};
+use datafusion_expr::{CreateExternalTable, Expr, TableType};
+use datafusion_physical_plan::common::AbortOnDropSingle;
+use datafusion_physical_plan::insert::{DataSink, FileSinkExec};
+use datafusion_physical_plan::metrics::MetricsSet;
+use datafusion_physical_plan::stream::RecordBatchReceiverStreamBuilder;
+use datafusion_physical_plan::streaming::{PartitionStream, StreamingTableExec};
+use datafusion_physical_plan::{DisplayAs, DisplayFormatType, ExecutionPlan};
+
+use crate::datasource::provider::TableProviderFactory;
+use crate::datasource::{create_ordering, TableProvider};
+use crate::execution::context::SessionState;
+
+/// A [`TableProviderFactory`] for [`StreamTable`]
+#[derive(Debug, Default)]
+pub struct StreamTableFactory {}
+
+#[async_trait]
+impl TableProviderFactory for StreamTableFactory {
+ async fn create(
+ &self,
+ state: &SessionState,
+ cmd: &CreateExternalTable,
+ ) -> Result<Arc<dyn TableProvider>> {
+ let schema: SchemaRef = Arc::new(cmd.schema.as_ref().into());
+ let location = cmd.location.clone();
+ let encoding = cmd.file_type.parse()?;
+
+ let config = StreamConfig::new_file(schema, location.into())
+ .with_encoding(encoding)
+ .with_order(cmd.order_exprs.clone())
+ .with_header(cmd.has_header)
+ .with_batch_size(state.config().batch_size());
+
+ Ok(Arc::new(StreamTable(Arc::new(config))))
+ }
+}
+
+/// The data encoding for [`StreamTable`]
+#[derive(Debug, Clone)]
+pub enum StreamEncoding {
+ /// CSV records
+ Csv,
+ /// Newline-delimited JSON records
+ Json,
+}
+
+impl FromStr for StreamEncoding {
+ type Err = DataFusionError;
+
+ fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
+ match s.to_ascii_lowercase().as_str() {
+ "csv" => Ok(Self::Csv),
+ "json" => Ok(Self::Json),
+ _ => plan_err!("Unrecognised StreamEncoding {}", s),
+ }
+ }
+}
+
+/// The configuration for a [`StreamTable`]
+#[derive(Debug)]
+pub struct StreamConfig {
Review Comment:
Should we note here that this is likely to undergo API changes to support
additional usecases (like streaming to/from Kafka)?
##########
datafusion/core/src/datasource/stream.rs:
##########
@@ -0,0 +1,326 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! TableProvider for stream sources, such as FIFO files
+
+use std::any::Any;
+use std::fmt::Formatter;
+use std::fs::{File, OpenOptions};
+use std::io::BufReader;
+use std::path::PathBuf;
+use std::str::FromStr;
+use std::sync::Arc;
+
+use arrow_array::{RecordBatch, RecordBatchReader, RecordBatchWriter};
+use arrow_schema::SchemaRef;
+use async_trait::async_trait;
+use futures::StreamExt;
+use tokio::task::spawn_blocking;
+
+use datafusion_common::{plan_err, DataFusionError, Result};
+use datafusion_execution::{SendableRecordBatchStream, TaskContext};
+use datafusion_expr::{CreateExternalTable, Expr, TableType};
+use datafusion_physical_plan::common::AbortOnDropSingle;
+use datafusion_physical_plan::insert::{DataSink, FileSinkExec};
+use datafusion_physical_plan::metrics::MetricsSet;
+use datafusion_physical_plan::stream::RecordBatchReceiverStreamBuilder;
+use datafusion_physical_plan::streaming::{PartitionStream, StreamingTableExec};
+use datafusion_physical_plan::{DisplayAs, DisplayFormatType, ExecutionPlan};
+
+use crate::datasource::provider::TableProviderFactory;
+use crate::datasource::{create_ordering, TableProvider};
+use crate::execution::context::SessionState;
+
+/// A [`TableProviderFactory`] for [`StreamTable`]
+#[derive(Debug, Default)]
+pub struct StreamTableFactory {}
+
+#[async_trait]
+impl TableProviderFactory for StreamTableFactory {
+ async fn create(
+ &self,
+ state: &SessionState,
+ cmd: &CreateExternalTable,
+ ) -> Result<Arc<dyn TableProvider>> {
+ let schema: SchemaRef = Arc::new(cmd.schema.as_ref().into());
+ let location = cmd.location.clone();
+ let encoding = cmd.file_type.parse()?;
+
+ let config = StreamConfig::new_file(schema, location.into())
+ .with_encoding(encoding)
+ .with_order(cmd.order_exprs.clone())
+ .with_header(cmd.has_header)
+ .with_batch_size(state.config().batch_size());
+
+ Ok(Arc::new(StreamTable(Arc::new(config))))
+ }
+}
+
+/// The data encoding for [`StreamTable`]
+#[derive(Debug, Clone)]
+pub enum StreamEncoding {
Review Comment:
👍
##########
datafusion/sqllogictest/test_files/ddl.slt:
##########
@@ -750,7 +750,7 @@ query TT
explain select c1 from t;
----
logical_plan TableScan: t projection=[c1]
-physical_plan CsvExec: file_groups={1 group:
[[WORKSPACE_ROOT/datafusion/core/tests/data/empty.csv]]}, projection=[c1],
infinite_source=true, has_header=true
+physical_plan StreamingTableExec: partition_sizes=1, projection=[c1],
infinite_source=true
Review Comment:
👍
##########
datafusion/core/src/datasource/stream.rs:
##########
@@ -0,0 +1,326 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! TableProvider for stream sources, such as FIFO files
+
+use std::any::Any;
+use std::fmt::Formatter;
+use std::fs::{File, OpenOptions};
+use std::io::BufReader;
+use std::path::PathBuf;
+use std::str::FromStr;
+use std::sync::Arc;
+
+use arrow_array::{RecordBatch, RecordBatchReader, RecordBatchWriter};
+use arrow_schema::SchemaRef;
+use async_trait::async_trait;
+use futures::StreamExt;
+use tokio::task::spawn_blocking;
+
+use datafusion_common::{plan_err, DataFusionError, Result};
+use datafusion_execution::{SendableRecordBatchStream, TaskContext};
+use datafusion_expr::{CreateExternalTable, Expr, TableType};
+use datafusion_physical_plan::common::AbortOnDropSingle;
+use datafusion_physical_plan::insert::{DataSink, FileSinkExec};
+use datafusion_physical_plan::metrics::MetricsSet;
+use datafusion_physical_plan::stream::RecordBatchReceiverStreamBuilder;
+use datafusion_physical_plan::streaming::{PartitionStream, StreamingTableExec};
+use datafusion_physical_plan::{DisplayAs, DisplayFormatType, ExecutionPlan};
+
+use crate::datasource::provider::TableProviderFactory;
+use crate::datasource::{create_ordering, TableProvider};
+use crate::execution::context::SessionState;
+
+/// A [`TableProviderFactory`] for [`StreamTable`]
+#[derive(Debug, Default)]
+pub struct StreamTableFactory {}
+
+#[async_trait]
+impl TableProviderFactory for StreamTableFactory {
+ async fn create(
+ &self,
+ state: &SessionState,
+ cmd: &CreateExternalTable,
+ ) -> Result<Arc<dyn TableProvider>> {
+ let schema: SchemaRef = Arc::new(cmd.schema.as_ref().into());
+ let location = cmd.location.clone();
+ let encoding = cmd.file_type.parse()?;
+
+ let config = StreamConfig::new_file(schema, location.into())
+ .with_encoding(encoding)
+ .with_order(cmd.order_exprs.clone())
+ .with_header(cmd.has_header)
+ .with_batch_size(state.config().batch_size());
+
+ Ok(Arc::new(StreamTable(Arc::new(config))))
+ }
+}
+
+/// The data encoding for [`StreamTable`]
+#[derive(Debug, Clone)]
+pub enum StreamEncoding {
Review Comment:
👍
##########
datafusion/core/src/datasource/stream.rs:
##########
@@ -0,0 +1,326 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+//! TableProvider for stream sources, such as FIFO files
+
+use std::any::Any;
+use std::fmt::Formatter;
+use std::fs::{File, OpenOptions};
+use std::io::BufReader;
+use std::path::PathBuf;
+use std::str::FromStr;
+use std::sync::Arc;
+
+use arrow_array::{RecordBatch, RecordBatchReader, RecordBatchWriter};
+use arrow_schema::SchemaRef;
+use async_trait::async_trait;
+use futures::StreamExt;
+use tokio::task::spawn_blocking;
+
+use datafusion_common::{plan_err, DataFusionError, Result};
+use datafusion_execution::{SendableRecordBatchStream, TaskContext};
+use datafusion_expr::{CreateExternalTable, Expr, TableType};
+use datafusion_physical_plan::common::AbortOnDropSingle;
+use datafusion_physical_plan::insert::{DataSink, FileSinkExec};
+use datafusion_physical_plan::metrics::MetricsSet;
+use datafusion_physical_plan::stream::RecordBatchReceiverStreamBuilder;
+use datafusion_physical_plan::streaming::{PartitionStream, StreamingTableExec};
+use datafusion_physical_plan::{DisplayAs, DisplayFormatType, ExecutionPlan};
+
+use crate::datasource::provider::TableProviderFactory;
+use crate::datasource::{create_ordering, TableProvider};
+use crate::execution::context::SessionState;
+
+/// A [`TableProviderFactory`] for [`StreamTable`]
+#[derive(Debug, Default)]
+pub struct StreamTableFactory {}
+
+#[async_trait]
+impl TableProviderFactory for StreamTableFactory {
+ async fn create(
+ &self,
+ state: &SessionState,
+ cmd: &CreateExternalTable,
+ ) -> Result<Arc<dyn TableProvider>> {
+ let schema: SchemaRef = Arc::new(cmd.schema.as_ref().into());
+ let location = cmd.location.clone();
+ let encoding = cmd.file_type.parse()?;
+
+ let config = StreamConfig::new_file(schema, location.into())
+ .with_encoding(encoding)
+ .with_order(cmd.order_exprs.clone())
+ .with_header(cmd.has_header)
+ .with_batch_size(state.config().batch_size());
+
+ Ok(Arc::new(StreamTable(Arc::new(config))))
+ }
+}
+
+/// The data encoding for [`StreamTable`]
+#[derive(Debug, Clone)]
+pub enum StreamEncoding {
+ /// CSV records
+ Csv,
+ /// Newline-delimited JSON records
+ Json,
+}
+
+impl FromStr for StreamEncoding {
+ type Err = DataFusionError;
+
+ fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
+ match s.to_ascii_lowercase().as_str() {
+ "csv" => Ok(Self::Csv),
+ "json" => Ok(Self::Json),
+ _ => plan_err!("Unrecognised StreamEncoding {}", s),
+ }
+ }
+}
+
+/// The configuration for a [`StreamTable`]
+#[derive(Debug)]
+pub struct StreamConfig {
+ schema: SchemaRef,
+ location: PathBuf,
+ batch_size: usize,
+ encoding: StreamEncoding,
+ header: bool,
+ order: Vec<Vec<Expr>>,
+}
+
+impl StreamConfig {
+ /// Stream data from the file at `location`
+ pub fn new_file(schema: SchemaRef, location: PathBuf) -> Self {
+ Self {
+ schema,
+ location,
+ batch_size: 1024,
+ encoding: StreamEncoding::Csv,
+ order: vec![],
+ header: false,
+ }
+ }
+
+ /// Specify a sort order for the stream
+ pub fn with_order(mut self, order: Vec<Vec<Expr>>) -> Self {
+ self.order = order;
+ self
+ }
+
+ /// Specify the batch size
+ pub fn with_batch_size(mut self, batch_size: usize) -> Self {
+ self.batch_size = batch_size;
+ self
+ }
+
+ /// Specify whether the file has a header (only applicable for
[`StreamEncoding::Csv`])
+ pub fn with_header(mut self, header: bool) -> Self {
+ self.header = header;
+ self
+ }
+
+ /// Specify an encoding for the stream
+ pub fn with_encoding(mut self, encoding: StreamEncoding) -> Self {
+ self.encoding = encoding;
+ self
+ }
+
+ fn reader(&self) -> Result<Box<dyn RecordBatchReader>> {
+ let file = File::open(&self.location)?;
+ let schema = self.schema.clone();
+ match &self.encoding {
+ StreamEncoding::Csv => {
+ let reader = arrow::csv::ReaderBuilder::new(schema)
+ .with_header(self.header)
+ .with_batch_size(self.batch_size)
+ .build(file)?;
+
+ Ok(Box::new(reader))
+ }
+ StreamEncoding::Json => {
+ let reader = arrow::json::ReaderBuilder::new(schema)
+ .with_batch_size(self.batch_size)
+ .build(BufReader::new(file))?;
+
+ Ok(Box::new(reader))
+ }
+ }
+ }
+
+ fn writer(&self) -> Result<Box<dyn RecordBatchWriter>> {
+ match &self.encoding {
+ StreamEncoding::Csv => {
+ let header = self.header && !self.location.exists();
+ let file =
OpenOptions::new().write(true).open(&self.location)?;
+ let writer = arrow::csv::WriterBuilder::new()
+ .with_header(header)
+ .build(file);
+
+ Ok(Box::new(writer))
+ }
+ StreamEncoding::Json => {
+ let file =
OpenOptions::new().write(true).open(&self.location)?;
+ Ok(Box::new(arrow::json::LineDelimitedWriter::new(file)))
+ }
+ }
+ }
+}
+
+/// A [`TableProvider`] for a stream source, such as a FIFO file
Review Comment:
Can we maybe also add some comments here about how this is similar /
different than `ListingTable` to help new people navigate the code and
understand when to use one vs the other?
We could totally do this as a follow on PR as well
--
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: github-unsubscr...@arrow.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
