Administration

The Administration command line interface (CLI) is the primary tool you use to manage your store. You use it to configure, deploy, and change store components. Use the CLI to verify the system, check the service status, check for critical events and browse the store-wide log file.

You can use the CLI 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. The CLI is particularly well-suited for a developer who is creating an Oracle NoSQL Database application. Developers can use the CLI to populate a store with a small number of records to use for development purposes or to examine the store's state as part of debugging activities.

Access the command line interface using this command:

java -Xmx64m -Xms64m \
  -jar KVHOME/lib/kvstore.jar runadmin \
  -host <hostname> -port <portname>

Note:

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

For a complete list of all CLI commands and their usage, see Admin CLI Reference in the Administrator's Guide.

KVLite

KVLite is a simplified version of Oracle NoSQL Database. It provides a single-node store that is not replicated. It runs in a single process without requiring any administrative interface. You configure, start, and stop KVLite using a command line interface.

KVLite is intended for use by application developers who need to unit test their Oracle NoSQL Database application. It is not intended for production deployment, or for performance measurements.

KVLite is installed when you install KVStore. It is available in the kvstore.jar file in the lib directory of your Oracle NoSQL Database distribution.

For more information on KVLite, see Quick Start to KVLite.

Saving Admin CLI History

By default, Oracle NoSQL Database uses the Java Jline library to support CLI history that you can save. To disable this feature, set the following Java property while starting the runadmin program:

java -Xmx64m -Xms64m \
-Doracle.kv.shell.jline.disable=true -jar KVHOME/kvstore.jar \
runadmin -host <hostname> -port <portname> 

Unless you disable the feature, CLI history is saved to a file so that it is available after restart. By default, Oracle NoSQL Database attempts to save 500 lines of history in the following file, which is created and opened automatically:

KVHOME/.jlineoracle.kv.impl.admin.client.CommandShell.history

Note:

If the Admin CLI cannot open the history file, it fails silently. The CLI runs without saving any history.

To change the default history file path, set the location of the oracle.kv.shell.history.file="path" Java property.

To change the default number of lines, set the value of the oracle.kv.shell.history.size=<int_value> Java property.