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 composite operator graphs
The spl-make-doc command generates images of composite operator graphs.

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
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
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.
- Metrics
  Teracloud® Streams provides metrics to help evaluate the health of Teracloud Streams services, to aid in diagnosing performance issues, and to analyze throughput of requests. You can use the streamtool checkinstancemetrics, streamtool checkdomainmetrics, streamtool getdomainmetrics, and streamtool checkresourcemetrics commands to view the metrics data.
- 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.
- SPL Compiler
  The SPL compiler is an incremental compiler that generates artifacts needed to run your stream application. These artifacts include, for example, C++ code for several entities in your SPL program and an application bundle file.
- 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 composite operator graphs

The spl-make-doc command generates images of composite operator graphs.

The composite operator graph image is generated in the documentation for an SPL file that contains a composite operator definition. The image includes the following information:

A title for the name of the composite operator, such as the Vwap.
Nodes that represent the operators in the graph.
Edges that represent the stream connections.
An upper label in the operator that represents the operator name and a label under it that represents the operator type.
Small yellow boxes on the left and right sides of an operator that represent the input and output ports of the operator.
One level of detail only. Any composite operators that are contained in the graph are not displayed.

The following image is the graph that is generated for the Vwap composite operator from the vwap.spl sample SPL file.
An image of the Vwap composite operator graph.

An image of the Vwap composite operator graph.