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.
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.
Samples
You can use an annotation tag to document sample toolkits. Sample toolkits contain examples of how to use other toolkits.

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.
    - Ports
      You can use annotation tags to specify the input and output ports of a composite operator.
    - Parameters
      You can use annotation tags to document the parameters of composite operators, SPL functions, and native functions.
    - Return values
      You can use annotation tags to describe the value that is returned by an SPL or native function.
    - Exceptions
      You can use annotation tags to describe exceptions that are thrown by native functions.
    - Exclude artifacts
      You can use annotation tags to exclude toolkit artifacts from the generated documentation.
    - Samples
      You can use an annotation tag to document sample toolkits. Sample toolkits contain examples of how to use other toolkits.
  - Images
    You can embed image files in the generated document by specifying the image file name and a label for the image.
  - 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.

Samples

You can use an annotation tag to document sample toolkits. Sample toolkits contain examples of how to use other toolkits.

@sample: Indicates a sample toolkit. Add this annotation tag to the description of a toolkit (for example, in the info.xml file). The annotation must be placed at the end of the description.

To generate documentation for sample toolkits, run the spl-make-doc command with the -i option for a single toolkit or the -t option for multiple toolkits, exactly as you do for the main toolkits. You can run the spl-make-doc command on sample toolkits only, on main toolkits only, or on a combination.

In the generated output, sample toolkits are grouped together and labeled as samples. The output for sample toolkits always includes composite operator diagrams and SPL source code.

The following example shows the description for a sample toolkit.

<description>
This toolkit contains samples showing how to use the myToolkit toolkit.
@sample
</description>

The spl-make-doc command for a sample toolkit generates documentation similar to that of a main toolkit.