Find details on the SPL language, toolkits, APIs, commands, and more.
Teracloud® Streams provides a number of commands you use to perform tasks.
Streamtool is the Streams command-line interface.
Commands in this section are related to submitting and managing jobs for Streams applications.
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
streamtool
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Application programming interfaces (APIs) provide functions that simplify applications development.
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.
submitjob
updateoperators
Commands in this section are related to the creation and configuration of Streams domains and instances.
Commands in this section are related to starting and managing running Streams domains and instances.
Commands in this section are related to managing the security policy that is associated with an Streams domain or instance.
Commands in this section are related to managing the certificates that are used by Streams services.
Teracloud® Streams provides metrics to help evaluate the health of Teracloud Streams services, to aid in diagnosing performance issues, and to analyze throughput of requests. You can use the streamtool checkinstancemetrics, streamtool checkdomainmetrics, streamtool getdomainmetrics, and streamtool checkresourcemetrics commands to view the metrics data.
There is a syntax convention for how parameters and values are represented in the command syntax diagrams in the Teracloud® Streams documentation.
The sc command compiles SPL applications.
The spl-app-info command reports information about a application bundle file.
The spl-make-doc command generates documentation for your toolkits.
The spl-make-operator command creates code generator modules from template files. The command can also create skeleton code generator templates and a default operator model if they do not exist.
The spl-make-toolkit command indexes a toolkit and makes the functions and operators it contains ready for use by SPL programs.
The spl-schema-from-xml command creates an SPL tuple declaration from an XML document.
The spl-transport-stats command creates a transport statistics model by running a transport performance test.
An operator model is an XML document that describes the basic properties of a primitive operator.
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.
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.
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.
Use this glossary to find terms and definitions for Teracloud® Streams.
