Struct springql_core::api::SpringPipeline

pub struct SpringPipeline(_);

Pipeline.

Implementations

impl SpringPipeline

pub fn new(config: &SpringConfig) -> Result<Self>

Creates and open an in-process stream pipeline.

pub fn command<S: AsRef<str>>(&self, sql: S) -> Result<()>

Execute commands (DDL).

Failure

• SpringError::Sql when:
  • Invalid SQL syntax.
  • Refers to undefined objects (streams, pumps, etc)
  • Other semantic errors.
• SpringError::InvalidOption when:
  • OPTIONS in CREATE statement includes invalid key or value.

pub fn pop(&self, queue: &str) -> Result<SpringSinkRow>

Pop a row from an in memory queue. This is a blocking function.

Do not call this function from threads. If you need to pop from multiple in-memory queues using threads, use pop_non_blocking(). See: https://github.com/SpringQL/SpringQL/issues/125

Failure

• SpringError::Unavailable when:
  • queue named queue does not exist.

pub fn pop_non_blocking(&self, queue: &str) -> Result<Option<SpringSinkRow>>

Pop a row from an in memory queue. This is a non-blocking function.

Returns

• Ok(Some) when at least a row is in the queue.
• None when no row is in the queue.

Failure

• SpringError::Unavailable when:
  • queue named queue does not exist.

pub fn push(&self, queue: &str, row: SpringSourceRow) -> Result<()>

Push a row into an in memory queue. This is a non-blocking function.

Failure

• SpringError::Unavailable when:
  • queue named queue does not exist.

Trait Implementations

impl Debug for SpringPipeline

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

Formats the value using the given formatter.