Package org.voltdb.stream.api

Interface VoltEnvironment

public interface VoltEnvironment
Defines execution environment in which stream operates. For example the framework provides
invalid reference 
org.voltdb.stream.execution.TestVoltEnvironment
to aid testing and execution of the pipeline in unit tests.

  • Field Details

    • DEFAULT_ASYNC_COMMIT_TIMEOUT

      static final Duration DEFAULT_ASYNC_COMMIT_TIMEOUT
      system consumes batch of data from source and push it to sink, then those operators are committed one by one. Because commit can be asynchronous, system cannot wait forever without making progress.

      Note: When timeout happens, system will halt as it cannot reason about consistency of processed batch.

      Default is 10 seconds

    • ASYNC_COMMIT_TIMEOUT_MS_PROPERTY

      static final String ASYNC_COMMIT_TIMEOUT_MS_PROPERTY
      See Also:

  • Method Details

    • getPipelineClass

      Class<VoltPipeline> getPipelineClass()
      Returns pipeline's class configured for this runtime.
      Returns:
      pipeline's class

    • lookup

      List<Operator> lookup(OperatorConfigurator configurator)
      The framework is looking up possible implementations of registered operators. Not that a producer can produce more than one operator to be chained together if necessary.
      Parameters:
      configurator - to bind operators to
      Returns:
      ordered list of operators to execute

    • register

      <C extends OperatorConfigurator> void register(Class<C> key, ConfigurableOperatorProducer<C> producer)
      The framework can be extended with any logic delivered as source, function or sink. Registration accepts a configurator class and any function that can produce an operator.
      Parameters:
      key - a clas of the configurator
      producer - that produces an operator