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 spl 2.0.0
Namespace spl

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.

Namespace spl

The SPL standard toolkit defines several types in the composite operator spl::Sys. These types are used in the config specifications and the built-in functions. Two additional composite operators define types that are used by specific built-in functions: spl::Log and spl::Trace.

Types

Log.Level: This type, when it is used with the appLog function, species the logging level.
Sys.CongestionPolicy: CongestionPolicy is used for the config threadedPort clause.
Sys.Kind: This enum is used when custom metrics are created.
Sys.LogLevel: The Log level for message logging.
Sys.OperatorInputPortMetricName: This enum is used when input port metrics are accessed.
Sys.OperatorOutputPortMetricName: This enum is used when output port metrics are accessed.
Sys.OperatorSystemMetricName: This enum is used when operator system metrics are accessed.
Sys.PEConnection: This tuple type gets connection information for a processing element output port.
Sys.PEConnections: This type is a list of PEConnection tuple types.
Sys.PaneTiming: The timing of a window pane triggering in relation to the enclosing operator's watermark that is used for predicting pane completion.
Sys.PartitionEvictionKind: This enum is used to specify the partition eviction policy for a window.
Sys.PartitionEvictionSelection: This enum is used to specify the method for evicting a partition from a window.
Sys.PoolSharingMode: This enum is used with SPL config specifications.
Sys.Punctuation: Punctuation types returned by currentPunct().
Sys.Resolution: This is the resolution of the event time of an event-time window.
Sys.TimestampFormat: This enum is used to specify the format used for the toTimestamp built-in function.
Sys.tm: tm is used for the time and gmtime built-in functions.
Trace.Level: This type, when it is used with the appTrc function, specifies the tracing level.