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
For a complete listing of all the commands available to you in the CLI as well as its usage, see the Oracle NoSQL Database Administrator's Guide.
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.
Note that KVLite cannot be configured as a secure store.
For more information on KVLite, see either Oracle NoSQL Database Getting Started with the Table API or Oracle NoSQL Database Getting Started with the Key/Value API.
By default Oracle NoSQL Database uses the Java Jline library to support saveable command line history in the CLI. If you want to disable this feature, the following Java property should be set while running runadmin:
java -Doracle.kv.shell.jline.disable=true -jar KVHOME/kvstore.jar \ runadmin -host <hostname> -port <portname>
Command line history is saved to a file so that it is available after restart. By default, Oracle NoSQL Database attempts to save the history in a KVHOME/.jlineoracle.kv.impl.admin.client.CommandShell.history file, which is created and opened automatically. The default history saved is 500 lines.
The default history file path can be overridden by setting the
oracle.kv.shell.history.file="path" Java property.
The default number of lines to save to the file can be modified by setting
the oracle.kv.shell.history.size=<int_value> Java property.