Previous Next JavaScript must be enabled to correctly display this content

## Admin CLI Reference

This appendix describes the following commands:

- aggregate

- await-consistent

- change-policy

- configure

- connect

- delete

- execute

- exit

- get

- help

- hidden

- history

- load

- logtail

- namespace

- page

- ping

- plan

- pool

- put

- repair-admin-quorum

- show

- snapshot

- table

- table-size

- timer

- topology

- verbose

- verify

The Command Line Interface (CLI) is run interactively or used to run single commands. The general usage to start the CLI is:

    java -Xmx64m -Xms64m \
    -jar KVHOME/lib/kvstore.jar runadmin \
    -host <hostname> -port <port> [single command and arguments]
    -security KVROOT/security/client.security

If you want to run a script file, you can use the "load" command on the command line:

    java -Xmx64m -Xms64m \
    -jar KVHOME/lib/kvstore.jar runadmin -host <hostname> -port <port> \
    -security \
    KVROOT/securtiy/client.security \
    load -file <path-to-script>

If none of the optional arguments are passed, it starts interactively. If additional arguments are passed they are interpreted as a single command to run, then return. The interactive prompt for the CLI is:

    "kv-> "

Upon successful completion of the command, the CLI's process exit code is zero. If there is an error, the exit code will be non-zero.

The CLI comprises a number of commands, some of which have subcommands. Complex commands are grouped by general function, such as "show" for displaying information or "ddl" for manipulating schema. All commands accept the following flags:

- -help

  Displays online help for the command or subcommand.

- ?

  Synonymous with -help. Displays online help for the command or subcommand.

- -verbose

  Enables verbose output for the command.

CLI commands have the following general format:

1. All commands are structured like this:

       "kv-> command [sub-command] [arguments]

2. All arguments are specified using flags which start with "-"

3. Commands and subcommands are case-insensitive and match on partial strings(prefixes) if possible. The arguments, however, are case-sensitive.

Inside a CLI script file, you can use `#` to designate a comment. Also, you can terminate a line with a backslash `\` to continue a command onto the next line.