The Administration Command Line Interface

The Administration command line interface (CLI) is the primary tool used to manage your store. It is used to configure, deploy, and change store components. It can also be used to verify the system, check service status, check for critical events and browse the store-wide log file. Alternatively, you can use a browser-based graphical user interface to do read-only monitoring. (Described in the next section.)

The CLI can also be used to get, put, and delete store records or tables, retrieve schema, and display general information about the store. It can also be used to diagnose problems or potential problems in the system, fix actual problems by adding, removing or modifying store data and/or verify that the store has data. It is particularly well-suited for a developer who is creating a Oracle NoSQL Database application, and who needs to either populate a store a with a small number of records so as to have data to develop against, or to examine the store's state as part of development debugging activities.

The command line interface is accessed using the following command:

java -Xmx256m -Xms256m -jar KVHOME/lib/kvstore.jar runadmin


To avoid using too much heap space, you should specify -Xmx and -Xms flags for Java when running administrative and utility commands.

For a complete listing of all the commands available to you in the CLI, see CLI Commands and Subcommands.