streamsx.spl.toolkit

SPL toolkit integration.

Overview

SPL operators are defined by an SPL toolkit. When a Topology contains invocations of SPL operators, their defining toolkit must be made known using add_toolkit().

Toolkits shipped with the IBM Streams product under $STREAMS_INSTALL/toolkits are implictly known and must not be added through add_toolkit.

Module contents

Functions

add_toolkit

Add an SPL toolkit to a topology.

add_toolkit_dependency

Add a version dependency on an SPL toolkit to a topology.

streamsx.spl.toolkit.add_toolkit(topology, location)

Add an SPL toolkit to a topology.

Parameters
  • topology (Topology) – Topology to include toolkit in.

  • location (str) – Location of the toolkit directory.

streamsx.spl.toolkit.add_toolkit_dependency(topology, name, version)

Add a version dependency on an SPL toolkit to a topology.

To specify a range of versions for the dependent toolkits, use brackets ([]) or parentheses. Use brackets to represent an inclusive range and parentheses to represent an exclusive range. The following examples describe how to specify a dependency on a range of toolkit versions:

  • [1.0.0, 2.0.0] represents a dependency on toolkit versions 1.0.0 - 2.0.0, both inclusive.

  • [1.0.0, 2.0.0) represents a dependency on toolkit versions 1.0.0 or later, but not including 2.0.0.

  • (1.0.0, 2.0.0] represents a dependency on toolkits versions later than 1.0.0 and less than or equal to 2.0.0.

  • (1.0.0, 2.0.0) represents a dependency on toolkit versions 1.0.0 - 2.0.0, both exclusive.

Parameters
  • topology (Topology) – Topology to include toolkit in.

  • name (str) – Toolkit name.

  • version (str) – Toolkit version dependency.

New in version 1.12.