Struct DatumSqlContext 

pub struct DatumSqlContext { /* private fields */ }

SQL planning context that registers Datum sources and executes supported DataFusion physical plans on Datum.

Implementations

impl DatumSqlContext

pub fn new() -> Self

Creates a SQL context with one DataFusion target partition and Datum’s planner placeholder functions registered.

pub fn with_streaming_join_config(self, config: StreamingJoinConfig) -> Self

Returns this context with a different streaming join policy.

pub fn set_streaming_join_config(&mut self, config: StreamingJoinConfig)

Replaces the streaming join policy used by future query lowering.

pub const fn streaming_join_config(&self) -> &StreamingJoinConfig

Returns the configured streaming join policy.

pub fn register_source( &self, name: &str, schema: SchemaRef, source: Source<RecordBatch>, ) -> Result<()>

Registers an append-only Datum source as a SQL table.

pub fn register_source_with_event_time( &self, name: &str, schema: SchemaRef, source: Source<RecordBatch>, event_time: EventTimeConfig, ) -> Result<()>

Registers an append-only Datum source and event-time declaration as a SQL table.

pub fn register_source_factory<F>( &self, name: &str, schema: SchemaRef, source_factory: F, ) -> Result<()>

where F: Fn() -> Source<RecordBatch> + Send + Sync + 'static,

Registers a factory for append-only Datum sources as a SQL table.

pub fn register_source_factory_with_event_time<F>( &self, name: &str, schema: SchemaRef, source_factory: F, event_time: EventTimeConfig, ) -> Result<()>

where F: Fn() -> Source<RecordBatch> + Send + Sync + 'static,

Registers a factory for append-only Datum sources with event time.

pub fn register_committable_source( &self, name: &str, schema: SchemaRef, source: Source<CommittableRecordBatch>, ) -> Result<()>

Registers a committable append-only source as a SQL table.

pub fn register_committable_source_factory<F>( &self, name: &str, schema: SchemaRef, source_factory: F, ) -> Result<()>

where F: Fn() -> Source<CommittableRecordBatch> + Send + Sync + 'static,

Registers a factory for committable append-only sources as a SQL table.

pub fn register_committable_source_with_event_time( &self, name: &str, schema: SchemaRef, source: Source<CommittableRecordBatch>, event_time: EventTimeConfig, ) -> Result<()>

Registers a committable append-only source and event-time declaration as a SQL table.

pub fn register_committable_source_factory_with_event_time<F>( &self, name: &str, schema: SchemaRef, source_factory: F, event_time: EventTimeConfig, ) -> Result<()>

where F: Fn() -> Source<CommittableRecordBatch> + Send + Sync + 'static,

Registers a factory for committable append-only sources with event time.

pub fn register_changelog_source( &self, name: &str, schema: SchemaRef, source: Source<ChangelogBatch>, ) -> Result<()>

Registers an updating source as a SQL table.

pub fn register_changelog_source_with_event_time( &self, name: &str, schema: SchemaRef, source: Source<ChangelogBatch>, event_time: EventTimeConfig, ) -> Result<()>

Registers an updating source and event-time declaration as a SQL table.

pub fn register_changelog_source_factory<F>( &self, name: &str, schema: SchemaRef, source_factory: F, ) -> Result<()>

where F: Fn() -> Source<ChangelogBatch> + Send + Sync + 'static,

Registers a factory for updating sources as a SQL table.

pub fn register_changelog_source_factory_with_event_time<F>( &self, name: &str, schema: SchemaRef, source_factory: F, event_time: EventTimeConfig, ) -> Result<()>

where F: Fn() -> Source<ChangelogBatch> + Send + Sync + 'static,

Registers a factory for updating sources with event time.

pub async fn physical_plan(&self, sql: &str) -> Result<Arc<dyn ExecutionPlan>>

Returns DataFusion’s physical plan for SQL text without lowering it.

pub async fn execute(&self, sql: &str) -> Result<Vec<RecordBatch>>

Executes a bounded append-only query and collects the output batches.

pub async fn streaming_source( &self, sql: &str, ) -> Result<Source<SqlEvent<RecordBatch>>>

Lowers a continuous SQL query into a Datum source of data/control events.

pub async fn streaming_source_with_metrics( &self, sql: &str, ) -> Result<(Source<SqlEvent<RecordBatch>>, SqlExecutionMetrics)>

Lowers a continuous SQL query and returns shared execution metrics.

pub async fn execute_streaming( &self, sql: &str, ) -> Result<ContinuousQueryHandle>

Materializes a continuous SQL query, or an INSERT INTO sink query.

pub async fn execute_insert_into( &self, sql: &str, ) -> Result<ContinuousQueryHandle>

Parses and materializes INSERT INTO <sink> SELECT ....

pub async fn select_into( &self, select_sql: &str, sink_name: &str, ) -> Result<ContinuousQueryHandle>

Materializes a SELECT body into a registered sink.

pub fn register_append_sink<F>(&self, name: &str, writer: F) -> Result<()>

where F: Fn(RecordBatch) -> StreamResult<()> + Send + Sync + 'static,

Registers an append-only sink callback.

pub fn register_changelog_sink<F, G>( &self, name: &str, append_writer: F, changelog_writer: G, ) -> Result<()>

where F: Fn(RecordBatch) -> StreamResult<()> + Send + Sync + 'static, G: Fn(ChangelogBatch) -> StreamResult<()> + Send + Sync + 'static,

Registers a sink callback that can consume both append-only and updating streams.

Trait Implementations

impl Debug for DatumSqlContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DatumSqlContext

fn default() -> Self

Returns the “default value” for a type.