Home
Developing
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
Developing stream applications
Try out tutorials and explore details about stream application development, SPL features, and best practices.
Compiling stream applications
Stream applications must be compiled before they can be run. Teracloud® Streams offers the SPL compiler (sc program) to compile SPL applications into a Streams application bundle file (SAB) that contains artifacts needed to run the application.
Working with toolkit paths
If an application uses logic from a toolkit other than the SPL standard toolkit, the compiler must be instructed to find the toolkit.

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.
- Development concepts
  Development of stream applications consists of several components such as operators, streams, tuples, Streams Processing Language, toolkits, and more.
- Developing stream applications
  Try out tutorials and explore details about stream application development, SPL features, and best practices.
  - Tutorials
    Learn how to create simple stream applications by completing the tutorials.
  - Application directory files and structure
    Learn about the different files and common directories that make up an SPL application. View the recommended structure so the SPL compiler and other Teracloud® Streams development tools work best.
  - Compiling stream applications
    Stream applications must be compiled before they can be run. Teracloud® Streams offers the SPL compiler (sc program) to compile SPL applications into a Streams application bundle file (SAB) that contains artifacts needed to run the application.
    - Reserved names
      The SPL compiler reserves a few names for its internal use and does not allow these names to appear in certain locations within your SPL source.
    - Auto-generated makefiles
      The SPL compiler can generate a sample makefile that can be used to easily manage compiler options and compile the application quickly from the command line.
    - Working with toolkit paths
      If an application uses logic from a toolkit other than the SPL standard toolkit, the compiler must be instructed to find the toolkit.
    - Working with multiple applications
      Different main composites can be compiled under the same application directory by customizing the output directory for the individual invocations of the SPL compiler.
  - Application bundle files
    A Streams application bundle file (SAB) is a single, relocatable file that contains artifacts needed to run your application. The file can be invoked directly to run the application on a single host or submitted to a Streams instance.
  - SPL features
    SPL provides features and functions to help you write your applications to fulfill your business needs.
  - Best practices
    Use these tips to write operators that perform effectively in their application, and in other applications.
  - Performance recommendations
    You can use these performance options and recommendations to improve your stream application.
- Developing native functions
  Extend SPL's computational capabilities by creating native functions written in C++ or Java.
- Developing custom operators
  Create custom operators if shipped toolkits do not provide the necessary logic or behavior needed for your stream applications.
- Developing custom toolkits
  Bundle and reuse custom functions and operators across several stream applications by creating custom toolkits.
- Working with files
  Applications and operators can read and write to files in several ways. If relative paths are used, the data directory is used as the root of relative paths. To enable logic to access the runtime application or toolkit directory hierarchies, language-specific functions can be used.
- Enabling Streams data exchange
  Teracloud® Streams provides a data exchange REST API for inserting and retrieving tuples within a job to easily integrate with other data services and external applications. Stream applications can enable the data exchange feature by using one or more Endpoint operators.
- Debugging stream applications
  Debug stream applications using the interactive, command line-based Streams Debugger (sdb).
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.

Working with toolkit paths

If an application uses logic from a toolkit other than the SPL standard toolkit, the compiler must be instructed to find the toolkit.

Note: In order for a toolkit to be recognized by the compiler, it must already be indexed and have an up-to-date toolkit.xml file.

The sc command searches for toolkits using the SPL path. The SPL path is a list of colon : separated paths to one of the following items:

A toolkit directory
A directory of toolkit directories, which is equivalent to listing the toolkit directories individually
A toolkit list file

The SPL path can be specified by using one or more -t, --spl-path options, or if no -t options are specified, the value of the STREAMS_SPLPATH environment variable is used.

If multiple versions of a toolkit exist in the SPL path, the one with the highest version number is picked. If the versions are the same, the toolkit that appears earlier in the path is selected.

If the application uses multiple toolkits and there are inter-dependencies between the toolkits, then the highest toolkit version of each toolkit that satisfies all the inter-dependencies is picked. This version might not be the highest version of a toolkit.

Toolkit list file

The toolkit list file is an XML document that specifies a list of paths to one of the three SPL path items. The following example showcases how to specify each of the items:

<toolkitList xmlns="http://www.teracloud.com/xmlns/prod/streams/spl/toolkitList"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.teracloud.com/xmlns/prod/streams/spl/toolkitList
        toolkitListModel.xsd">
  <toolkit directory="path/to/toolkitDir" />
  <toolkit listFile="path/to/toolkitList.xml" />
  <toolkit directory="/absolute/path/to/dirOfToolkitDirs" />
</toolkitList>

Examples

Specifying a toolkit directory:

sc -M my.sample::Main -t "/storage/toolkits/exampletoolkit"

Specifying a directory of toolkits:

sc -M my.sample::Main -t "$STREAMS_INSTALL/toolkits"

Using STREAMS_SPLPATH:

export STREAMS_SPLPATH="$STREAMS_INSTALL/toolkits:/storage/toolkits/exampletoolkit"
sc -M my.sample::Main