Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
Toolkits
Toolkit com.teracloud.streams.topology 4.0.0
Namespace com.teracloud.streams.topology.topic

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Namespace com.teracloud.streams.topology.topic

Topic based publish-subscribe model supporting a microservice architecture style for Streams applications.

Publish-subscribe Overview: Applications can publish streams to a topic name which can then be subscribed to by other applications (or even the same application).

Relationship to Export & Import: Publish-subscribe is a simplification of Streams Export and Import.

Operators

Buffered: Connect subscriber to publisher using a buffer.
Direct: Directly connect subscriber to publisher.
FilteredSubscribe: Filtered subscribe to a topic.
Publish: Publish a stream to a topic.
Subscribe: Subscribe to topics using a topic filter.

Functions

addUDPSubscription(rstring): Take a subscription and modify it to account for parallel regions in the publisher or subscriber.
andFilter(rstring, rstring): Return a string representation of cond1 && cond2.
checkTopicFilter(rstring): Check a topic filter is valid.
checkTopicName(rstring): Check a topic name is valid.
equalsFilter(rstring, float64): Return a string representation of name == value for a float64 attribute.
equalsFilter(rstring, int64): Return a string representation of name == value for a int64 attribute.
equalsFilter(rstring, rstring): Return a string representation of name == value for a rstring attribute.
getTopicSubscription(rstring): Get the subscription that matches a topic for topic based subscription.
getTopicSubscription(rstring, boolean): Get the subscription that matches a topic for topic based subscription with explicit matching for the publisher allowing filters.
inFilter(rstring, list<rstring>): Return a string representation of filter name in values for a rstring attribute.
orFilter(rstring, rstring): Return a string representation of cond1 || cond2.
setSubscribeFilter(rstring): Set filter for input port zero.
setSubscribeSubscription(rstring): Set a subscription expression adding in UDP channel based matching if the subscriber is in a parallel region.