Home
Developing
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
Developing custom toolkits
Bundle and reuse custom functions and operators across several stream applications by creating custom toolkits.
Indexing a toolkit
Index a toolkit to make its artifacts available for use in applications or 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
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.
- 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.
  - Toolkit directory files and structure
    Toolkit directories are structured identically to application directories. The only difference between the two is that toolkit directories do not contain any main composite operators.
  - Indexing a toolkit
    Index a toolkit to make its artifacts available for use in applications or other toolkits.
  - Packaging a toolkit
    Package a toolkit to allow other SPL application developers to access the operators and functions that are defined in the toolkit.
  - Installing a toolkit
    Custom toolkits can be installed by unpacking a packaged toolkit directory to a location on a file system.
  - Creating toolkit artifacts for use on multiple platforms
    Teracloud® Streams supports a varied set of hardware architectures and Linux™ distributions such as Red Hat Enterprise Linux (RHEL). If you plan to deploy a toolkit on multiple platforms, you can create toolkit artifacts that simplify the management of the various C++ libraries. These examples show how to maintain a common infrastructure that works across multiple Linux distributions and hardware platforms.
  - Best practices
    Use these tips to write conventional toolkits for better usability and maintainability.
- 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.

Indexing a toolkit

Index a toolkit to make its artifacts available for use in applications or other toolkits.

About this task

The spl-make-toolkit command is used to index and re-index a toolkit. When instructed to index a toolkit directory, the command performs the following steps:

Recursively searches the specified directory for SPL files, C++ code generation templates, function and operator model XML files, and compiled Java classes.
Note: The command searches all directories except those with a leading .. The command will also not interpret common organizational directories as namespace directories.
Creates C++ code generators from code generation templates, if any.
Creates native.function directories and Java native function XML files in appropriate namespace directories if Java native functions are found.
Creates primitive operator directories and operator model XML files within appropriate namespace directories if Java primitive operators are found.
Creates a toolkit.xml file containing the list of public types, functions, and operators.

Warning: Some additional build steps may need to be performed prior to indexing the toolkit. For example, if the toolkit contains primitive Java operators, the Java classes need to be compiled before; otherwise spl-make-toolkit will not find them.

Procedure

To index a toolkit, run the following command:
```
spl-make-toolkit -i <toolkit-directory>
```
For example, if the current working directory is a toolkit directory, the following command will index it:
```
# cd toolkit-directory
spl-make-toolkit -i .
```
To clean up artifacts created by spl-make-toolkit, run the same command with -c:
```
spl-make-toolkit -i . -c
```

What to do next

To start building applications with the toolkit locally, see working with toolkit paths to inform the SPL compiler about the toolkit.

If the toolkit needs to be bundled up and installed on another system, see Packaging a toolkit and Installing a toolkit.