Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
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.
Toolkits
Toolkit com.teracloud.streams.mqtt 3.0.0
Developing and running applications that use the MQTT 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
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.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- 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.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Developing and running applications that use the MQTT Toolkit

To create applications that use the MQTT Toolkit, you must configure the SPL compiler to be aware of the location of the toolkit.

Before you begin

Configure the product environment variables by entering the following command:


<source product-installation-root-directory>/7.2.0.0/bin/streamsprofile.sh

About this task

After the location of the toolkit is communicated to the compiler, the SPL artifacts that are specified in the toolkit can be used by an application. The application can include a use directive to bring the necessary namespaces into scope. Alternatively, you can fully qualify the operators that are provided by toolkit with their namespaces as prefixes.

Procedure

Review the list of restrictions for the Streams specialized toolkits in the product documentation.
Develop your application. To avoid the need to fully qualify the operators, add a use directive in your application.
- For example, you can add the following clause in your SPL source file:
```
use com.teracloud.streams.mqtt::*;
```
  You can also specify a use clause for individual operators by replacing the asterisk (*) with the operator name. For example:
```
use com.teracloud.streams.mqtt::MQTTSink;
```
Configure the SPL compiler to find the toolkit root directory. Use one of the following methods:
- Set the STREAMS_SPLPATH environment variable to the root directory of a toolkit or multiple toolkits (with : as a separator). For example:
```
export STREAMS_SPLPATH=$STREAMS_INSTALL/toolkits/com.teracloud.streams.mqtt
```
- Specify the -t or --spl-path command parameter when you run the sc command. For example:
```
sc -t $STREAMS_INSTALL/toolkits/com.teracloud.streams.mqtt -M MyMain
```
  where MyMain is the name of the SPL main composite.
  Note: These command parameters override the STREAMS_SPLPATH environment variable.
Build your application using the sc command.
Run the application.
- You can launch the application in stand-alone mode using the standalone program located in the output directory.
- You can submit the application in a distributed environment, as a job, to a running Streams instance using the streamtool submitjob command or Streams Console.