Working with command results in interactive mode
In interactive mode, commands display their output in the prompt window.
There are six results for a command:
- Success with no results—The command executes with no output and the interactive prompt returns to Repl >. Most commands that add or modify configuration use this method. For example, the command add subscription does not display any output if the subscription was added successfully.
- Success with a text value—The interactive prompt displays a formatted output string for a command. Commands like show datastore event details use this method. The command documentation identifies this result type as ResultStringValue.
- Success with a list of values—The interactive prompt displays a list of strings. The command help uses this output. The command documentation identifies this result type as ResultStringList.
- Success with a table of key pairs or value pairs—The interactive prompt displays a table of key pairs or value pairs containing the output of the command. Commands like show subscription use this method. The command documentation identifies this result type as ResultStringKeyValues.
- Success with a table of records—The interactive prompt displays a table of results with column headers and a row for each record. Commands like list subscriptions use this method. The command documentation identifies this result type as ResultStringTable.
- Failure—The command fails to execute and displays an error code and message.