Trait StreamProvider

Source

pub trait StreamProvider:
    Debug
    + Send
    + Sync {
    // Required methods
    fn schema(&self) -> &Arc<Schema>;
    fn reader(
        &self,
    ) -> Result<Box<dyn RecordBatchReader<Item = Result<RecordBatch, ArrowError>>>, DataFusionError>;
    fn stream_write_display(
        &self,
        t: DisplayFormatType,
        f: &mut Formatter<'_>,
    ) -> Result<(), Error>;

    // Provided method
    fn writer(&self) -> Result<Box<dyn RecordBatchWriter>, DataFusionError> { ... }
}

Expand description

The StreamProvider trait is used as a generic interface for reading and writing from streaming data sources (such as FIFO, Websocket, Kafka, etc.). Implementations of the provider are responsible for providing a RecordBatchReader and optionally a RecordBatchWriter.