Home
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Developing toolkits and operators
You can create custom toolkits and operators for your applications.
Developing operators
You can develop many stream applications with only the operators available in the SPL standard toolkit or in the specialized toolkits. If these toolkits do not provide all of the function you need to implement your application, you can develop new operators as required.
Developing primitive operators
You develop new primitive operators by implementing them in the C++ or Java™ language. You must define an operator model that describes the syntax and semantics of the operator and implement the operator logic by creating the header and implementation code generator templates.
Developing C++ primitive operators
The SPL language supports writing two styles of primitive operators, namely: generic operators and non-generic operators.
Advanced code generation
When you create generic operators, you can use advanced code generation techniques for more operator customization and control.
Accessing paths at compile time
The SPL code generation APIs provide the methods to access special paths at code generation time.

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.
- Development concepts
  Development of stream applications consists of several components such as operators, streams, tuples, Streams Processing Language, toolkits, and more.
- Writing stream applications
  Teracloud® Streams provides features and functions to help you write your applications to fulfill your business needs.
- Enabling Streams data exchange
  Teracloud® Streams provides a data exchange REST API for inserting and retrieving Streams job data. You can add one or more endpoint operators to your Streams application to enable Streams data exchange. Providing a standard REST interface for Streams data exchange eases the integration of Streams data with other data services and externally hosted applications.
- Compiling stream applications
  The Streams Processing Language (SPL) Compiler is called sc and is included with the Teracloud® Streams installation package. You compile SPL to create files to run on your Teracloud Streams instance.
- Performance improvements for stream applications
  You can improve the processing of your stream application by following these guidelines and tips.
- Debugging stream applications
  The Streams Processing Language (SPL) Streams Debugger (sdb) provides a command line-based interactive debugger for debugging stream applications.
- Developing toolkits and operators
  You can create custom toolkits and operators for your applications.
  - Developing toolkits
    Toolkits contain the building blocks for stream applications. In addition, you can add specialized toolkits or create your own toolkits.
  - Developing operators
    You can develop many stream applications with only the operators available in the SPL standard toolkit or in the specialized toolkits. If these toolkits do not provide all of the function you need to implement your application, you can develop new operators as required.
    - Types of operators
      When developing new operators, developers need to choose the kind of operator to implement based on the task they want to accomplish, the programming language they want to use and the trade-offs they are willing to make between generality and ease of implementation.
    - Developing primitive operators
      You develop new primitive operators by implementing them in the C++ or Java™ language. You must define an operator model that describes the syntax and semantics of the operator and implement the operator logic by creating the header and implementation code generator templates.
      - Developing C++ primitive operators
        The SPL language supports writing two styles of primitive operators, namely: generic operators and non-generic operators.
        Operator implementation
        You use skeleton template files that are generated by the spl-make-operator script as the basis for operator implementations.
        Advanced operator implementation
        Advanced operator implementation techniques provide additional runtime operator control.
        Advanced code generation
        When you create generic operators, you can use advanced code generation techniques for more operator customization and control.
        Code sharing
        To share code between different operators in a toolkit, use one of the supported sharing methods.
        Error reporting
        SPL code generation APIs provide four different families of functions that are related to error reporting. These functions are the print, warn, error, and exit family of functions that are supplied by the SPL::CodeGen module.
        Type inspection
        The SPL code generation APIs include various type inspection functions, which are supplied by the SPL::CodeGen::Type module.
        Checking schemas
        Some primitive operators require that the output port has the same schema as the input port. To comply with this requirement, you must check the schema.
        Helper class generation
        When you develop generic operators, you often need to emit a class, which contains member variables with a list of types. The SPL code generation framework provides an emitClass function within the SPL::CodeGen module for this purpose.
        Parameter helpers
        When you write generic operators, you often must obtain the list of types and expressions that are associated with the parameter expressions. The SPL code generation framework provides helper functions within the SPL::CodeGen module to simplify this task.
        Output tuple helpers
        During code generation for generic operators, you often must initialize or assign an output tuple that is based on output attribute assignments that are captured in the operator instance model. SPL provides helper functions within the SPL::CodeGen module simplify this task.
        Window handling
        The SPL code generation framework provides code generation APIs to ease the common tasks that are associated with window handling.
        Accessing paths at compile time
        The SPL code generation APIs provide the methods to access special paths at code generation time.
        Generating C++ code from an SPL expression tree
        An SPL expression tree represents the SPL expression for a parameter or output expression in a form that can be easily traversed in a C++ primitive operator. To use SPL expression trees, the context of the primitive operator must include an <splExpressionTree [param="true|false"] [output="true|false"] [cppCode="true|false"]/> element.
      - Developing Java™ primitive operators
        To create a Java™ primitive operator inside an SPL toolkit, you must provide an operator model. The process is similar to how you provide operator models for C++ primitive operators.
      - Developing Python primitive operators
        To create a Python primitive operator inside an SPL toolkit, you must provide an operator model. The process is similar to how you provide operator models for C++ primitive operators.
    - Creating C++ libraries for operators and native functions
      To enable operators and native functions, you must compile with the appropriate include file paths and options and link any shared libraries against the correct runtime libraries.
    - Fusing multiple Java™ operators into a single PE
      If multiple Java™ primitive operators and JavaOp operator invocations have compatible vmArg parameter lists, you can fuse them together into a single processing element (PE) or run them in stand-alone mode.
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.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Accessing paths at compile time

The SPL code generation APIs provide the methods to access special paths at code generation time.

These methods are provided as part of the SPL::Operator::Instance::Context class.

getApplicationDirectory(): The absolute path to the application directory, in which the compilation is being performed.
getDataDirectory(): The absolute path to the directory that contains the application data.
getOperatorDirectory(): The absolute path to the directory that contains the operator model. This directory is within the toolkit.
getOutputDirectory(): The absolute path to the output directory, into which the results of the compilation is being produced.