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.teda 4.0.1
Developing TEDA applications
Configuring Solutions
Configuring ITE Applications
Data ingestion

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.
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.
- Metrics
  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.
- 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.
- SPL Compiler
  The SPL compiler is an incremental compiler that generates artifacts needed to run your stream application. These artifacts include, for example, C++ code for several entities in your SPL program and an application bundle file.
- 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.

Data ingestion

Identifying input files: Applications read files from the configured input directory or directories.

Sorting input files by file name: When your business logic relies on a certain order to read the input files, you configure scanning of the directory to report the identified files in a sorted sequence.

Sorting input files by file size: When your business logic relies on a certain order to read the input files, you configure scanning of the directory to report the identified files in a sorted sequence.

Sorting input files by file time: When your business logic relies on a certain order to read the input files, you configure scanning of the directory to report the identified files in a sorted sequence.

Sorting input files by special file time: When your business logic relies on a certain order to read the input files, you configure scanning of the directory to report the identified files in a sorted sequence.

Finding file duplicates: Occasionally, input files arrive more than once in your application's landing zones.

Using load distribution to distribute files: To increase the throughput of your application, you distribute the detected input files to many processing chains, which all work on the data in parallel.

Distributing files to processing chains defined on job submission: To increase the throughput of your application, you distribute the detected input files to many processing chains which all work in parallel on the data.

Using file group split to distribute files: To increase the throughput of your application, you distribute the detected input files to many processing chains which all work in parallel on the data.

Choosing a parser: To read the data from the input files, you need to configure a parser.

Using many parsers: Sometimes a single parser does not do the job, for example in use cases where the logic needs to read many different file types.

Activating the compression parameter for file readers: Sometimes the input files you get are compressed and you need to extract them before processing.

Activating the encoding parameter for file readers: Sometimes the text input files you get use a different encoding and you need to configure your reader.

Using file preprocessing: If you cannot derive the file type easily from the file name and some more processing is necessary, the framework provides a preprocessing class that you customize to your needs.