Controls and gets information from a running Event Stream Processor instance.


esp_client -p [<host>:]<port>/workspace-name/project-name [OPTION...] [COMMAND...]



Enclose arbitrary values that a command takes as parameters in single back quotes(`) for Windows and curly braces {} for Linux or Solaris. For example, `parameter` or {parameter}. Separate commands with a semicolon.

Note: Back quotes (`) are used to avoid confusion with the normal single (') and double quotes (") that are used in the syntax of the shell and SPLASH expressions.

Strings enclosed in back quotes cannot use back quotes within the string itself. You cannot use double quotes on esp_client commands on the command line, because the UNIX shell attempts to interpret them. To prevent this, shield back quotes with curly braces ({}). For example:

esp_client -p localhost:19022/w1/p1 "help;addrsize;streams;endian;datesize;clock;idx {allTypes1};stream {allTypes2}"
 esp_client -p "history {175}"

The strings enclosed in curly braces ({}) must have a balanced number of braces inside of them. For example:

{ currow.value = '{a}' }

You cannot use back ticks and curly braces for multiline values. There is another quoting style that is intended for the large multiline parameters, such as the configuration files. These parameters start with <<!, then the inline text of the parameter, and finally a line containing only ! (with no whitespace before or after). This syntax is similar to the shell's "<<" syntax but the terminating word "!" cannot be changed. The line breaks after the "<<!" and before the terminating "!" are not part of the parameter, so you can specify single-line values through the syntax as well. You can specify multiple inline parameters by separating them with lines containing !<<!. For example:

load_config_inline_conv {nobackup,nocompat} <<!
... text of the model ...
... text of the conversion model ...
Note: This syntax can be used with any command.

Many commands can redirect output to a file using:

command > `outfile.dat`
command >> `outfile.dat`
command | `filter-program`

The ">" operator overwrites an existing file, and ">>" appends to an existing file. The operator "|" pipes the output to a UNIX command pipeline. Use either back quotes or braces to quote the file name or the filter program.

General commands are:

Commands Requiring Trace Mode

Output Control Flags

Put Command Notes

The putd and putx commands use the sphdr StreamName and OpCode prefix. The date strings are in the format:


The TZ environment variable is set to "UTC" before the record is uploaded to the Gateway interface.

Usage Notes

In console mode, you can issue commands from the console, which allows for command-line editing and command history retrieval. Enter this mode using the following command:

esp_client -p localhost:19011/default/prj1 -c user:password

In command-string mode, feed in a double-quoted string containing one or more commands. If you specify multiple commands in the double-quoted string, terminate each command with a semicolon character. When setting the field separator from the command line, enclose the new field separator character within single quotes, and place a space character between the ending single quote and the semicolon.