streamtool

Streamtool is the Streams command-line interface.

Many streamtool commands require a Streams domain or instance context and a connection to Apache ZooKeeper. You can store that information in the STREAMS_DOMAIN_ID, STREAMS_INSTANCE_ID, and STREAMS_ZKCONNECT environment variables. When you use the interactive streamtool interface, common options and user information is cached so that you do not need to specify them in every command. To enter the interactive mode, run the following command: streamtool. To exit interactive mode, enter exit or quit.

To obtain a list of all the streamtool commands and their syntax, enter streamtool help.

To obtain the help information for a specific streamtool command, enter streamtool man command-name.

To get reference information for the Streams properties, use the following commands:

• streamtool man properties
• streamtool man domainproperties
• streamtool man bootproperties

The help information uses the following command help syntax conventions:

[ ]

Encloses optional parameters.

<>

Encloses variables, which require you to determine and enter the appropriate input.

{ }

Groups items to draw attention to relationships within that group.

|

Separates two or more items, only one of which can be chosen.

,

Separates two, or more items that can be used interchangeably.

/

Indicates the minimal abbreviation that can be used to specify a command.

\

Indicates a special character that must be included in the command.

...

Indicates a repeatable parameter. If a comma precedes these characters, it is a necessary delimiter.

Unless otherwise specified, command and parameter names are case-sensitive; you must use uppercase or lowercase letters as specified in the command help syntax.

The streamtool commands can be grouped into the following logical categories: