Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
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.
Images
You can embed image files in the generated document by specifying the image file name and a label for the image.
Images for primitive operator properties
The spl-make-doc command generates an image that summarizes the properties of a primitive operator. These images are generated in the documentation for a primitive operator.

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.
- 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.
  - Quick reference for SPLDOC markup
    SPLDOC markup tags document SPL artifacts in a toolkit.
  - Comments
    This information describes the comment syntax for the SPL artifacts in SPL files. SPLDOC comments are delimited by the forward slash and asterisk characters.
  - Text markup
    You can use SPLDOC markup to format text into pages, sections, paragraphs, lists, and blocks of code. You can also apply different typefaces, such as italics, bold, and monospace.
  - Escape
    To suppress interpretation by the spl-make-doc command, precede the SPLDOC markup character by a backslash ( \ ), which is the escape character.
  - Links
    You can use SPLDOC to mark up different kinds of links.
  - Annotation tags
    You can use the SPLDOC annotation tags to document the interfaces that are exposed by the SPL composite operators and to exclude toolkit artifacts. You can also use SPLDOC annotation tags to document SPL and native functions.
  - Images
    You can embed image files in the generated document by specifying the image file name and a label for the image.
    - Images for composite operator graphs
      The spl-make-doc command generates images of composite operator graphs.
    - Images for primitive operator properties
      The spl-make-doc command generates an image that summarizes the properties of a primitive operator. These images are generated in the documentation for a primitive operator.
  - Formatting conventions
    By following the formatting conventions when you mark up the toolkit artifacts, you ensure that the spl-make-doc command interprets the markup correctly and generates the expected results.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Images for primitive operator properties

The spl-make-doc command generates an image that summarizes the properties of a primitive operator. These images are generated in the documentation for a primitive operator.

When you view these images in a web browser that supports Scalable Vector Graphics (SVG), you can see the hover help when you hover over each icon that represents a property.

The following image represents a condensed version of the properties for the spl.relational.Aggregate primitive operator, which is included in the SPL standard toolkit.

Image of the Aggregate operator properties.

The following properties of the primitive operator are described in the image:

Input port properties:
- i represents the tupleMutationAllowed property, specifies that the tuple is immutable, and indicates that the processing logic associated with the port does not update the tuple. A value of m indicates that the tuple can be modified.
- 1 represents the cardinality of the port, which is the number of input ports in this set of ports.
- ! represents the windowPunctuationInputMode property. The ! value indicates that this port can accept punctuations.
- w represents the windowingMode property. The w value indicates that the operator always has a window.
p indicates that the operator has input parameters.
C++ indicates the language that is used to implement the operator.
wd indicates that the operator is single-threaded when none of the input ports use a time-based window.
Output port properties:
- m represents the tupleMutationAllowed property. The m value indicates that this operator permits downstream operators to update the tuple that are output by this port.
- 1 represents cardinality of the port, which is the number of output ports in this set of ports.
- ! represents the windowPunctuationOutputMode. The ! value indicates that this port can accept punctuations.