feat: new CLI parameter to execute a command and quit (without CLI interaction)

[spena]

Description

Fixes #4981

Adds a new paramter to the CLI to execute a command and quit. This without having to interact with the CLI console.

sergio@pop-os:~/Development/ksql$ time ./bin/ksql -e "show streams;"

 Stream Name         | Kafka Topic                 | Format 
------------------------------------------------------------
 KSQL_PROCESSING_LOG | default_ksql_processing_log | JSON   
 TOPIC1              | topic1                      | JSON   
------------------------------------------------------------

real	0m2.250s
user	0m4.604s
sys	0m0.185s

sergio@pop-os:~/Development/ksql$ ./bin/ksql -e "set 'auto.offset.reset'='earliest'; select * from topic1 emit changes;"
Successfully changed local property 'auto.offset.reset' to 'earliest'. Use the UNSET command to revert your change.
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|ID                                                                                                                                                                                                                               |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|1                                                                                                                                                                                                                                |
^CQuery terminated

You can use a different output format to easily parse the command result. For instance, JSON:

$ ./bin/ksql -e "show streams" --output JSON | jq '.[].streams' | jq '.[].name'
"TOPIC1"
"KSQL_PROCESSING_LOG"
"S1"

Testing done

Added unit tests
Verified manually

Reviewer checklist

• Ensure docs are updated if necessary. (eg. if a user visible feature is being added or changed).
• Ensure relevant issues are linked (description should include text like "Fixes #")

[colinhicks]

Adds a new paramter to the CLI to execute a command and quit. This without having to interact with the CLI console.

Just to clarify: For streaming results like push queries without a limit clause, you need to also issue ctrl+c to interrupt the console, correct?

[colinhicks]

• Add new parameter to remove headers and columns from the command output
• Add new parameter to change command output format (i.e. comma-separated and tab-separated)

It might be worth considering a flag to send the raw JSON to stdout. This way it could be piped to other scripts like jq for such formatting.

[spena]

@colinhicks Ctrl+C is part of the stream. The example of the Description shows the ^Query terminated line that was caused by the Ctrl+C.

[rodesai]

LGTM other than a couple minor comments inline. Also, is there a place in the docs we can add this?

[rodesai]

nit: the user may not understand "command" - maybe "run one or more ksql statements and quit."?

[spena]

Done.

[rodesai]

why the empty log message?

[spena]

Done.

[agavra]

LGTM, I think @rodesai meant to check the green tick