Previous Next JavaScript must be enabled to correctly display this content

## kvlite

KVLite is a simplified version of the Oracle NoSQL Database. It provides a single storage node, single shard store, that is not replicated. It runs in a single process without requiring any administrative interface.

Below are the command line options that you can use with the kvlite utility.

    java -jar KVHOME/lib/kvstore.jar kvlite
    [-root <rootDirectory>]
    [-store <storeName>]
    [-host <hostname>]
    [-port <port>]
    [-storagedirsizegb <GB>]
    [-noadmin]
    [-secure-config <enable|disable>]
    [-restore-from-snapshot <name of snapshot>]
    [-admin-web-port <admin web service port>]
    [-version]
    [-harange <startPort, endPort>]
    [-servicerange <startPort, endPort>]
    [-storagedir <path>]
    [-memorymb]
    [-printstartupok]

You can specify the parameter values the first time you start KVLite. The parameter values are recorded in a config file and are used when KVLite is restarted. The config file is stored in the root directory. To change your initial values, either delete your root directory before starting KVLite, or specify the -root option with a different root directory than you initially used. Following are the descriptions of the command line options:

- `root <path>`: Identifies the path to the root directory. The path provided can be an absolute path or a relative path. The database files are stored in this location. If the database files do not exist, they are created for you.

  Default value: ./kvroot

- `-store <storename>`: Identifies the name of the data store. You should avoid using characters in the data store name that might interfere with its use within a file path. Valid characters are all alphanumeric characters, hyphen, underscore, and period.

  Default value: kvstore

- `-host <hostname>`: Identifies the name of the host on which KVLite is running. If you want to access this instance of KVLite from remote machines, you must supply the actual hostname of the machine. Otherwise, specify `localhost` for this option.

  Default value: <host name of the machine>

- `-port <port>`: Identifies the port on which KVLite is listening for client connections. This is sometimes referred to as the registry port.

  Default value: 5000

- `-storagedirsizegb <GB>`: Identifies the maximum amount of available disk space in GB for a KVLite database. If the disk usage of the KVLite database exceeds a value that is 5GB less than the specified value, KVLite suspends all write operations until you delete some existing records and free up enough space to satisfy the disk storage requirement. If you set `storagedirsizegb` to 0, KVLite opportunistically uses all the available space.

  The system maintains 5 GB of free space for recovery purposes in case the configured disk limit is exceeded.

  Default value: 10

- `-noadmin`: Identifies if the administration service needs to be started. If -noadmin parameter is provided, then the administration service is not started.

  The administration service is the service that runs the various admin CLI commands.

- `secure-config`: Identifies if security needs to be enabled for the store. If enabled, all clients connecting to the store must present security credentials.

  Default value: enable

- `-restore-from-snapshot`:
  Identifies the snapshot from which the store can be restored. You can restore a store directly from a snapshot. For example:

      -restore-from-snapshot 240424-104506-mySnapshot

  where, `240424–104506–mySnapshot` represents the directory name of the snapshot to restore. This procedure restores the store to the time you created the snapshot. If your store was active after snapshot creation, all modifications made since the snapshot are lost.

  Default value: null

- `-admin-web-port <admin web service port>`: Identifies the TCP/IP port on which the admin web service is started. If a positive integer value is not specified, then the admin web service does not start up. For more details on the admin web service, see REST API for Administering Oracle NoSQL Database.

  Default value: -1

- `-version`: Provides the KVLite Database version, the date and time it was installed, the build ID and the edition (community/enterprise).

- `-harange <startPort, endPort>`: Identifies the harange (high availability range) ports used by the replication node for communication purposes.

- `-servicerange <startPort,endPort>`: Identifies a range of ports that a storage node uses to communicate with its administrative services and managed services. This parameter is useful when services on a storage node must use specific ports for firewall or other security reasons. By default, the services use anonymous ports.

- `-storagedir <path>`: Identifies the path to the directory that the replication node can use for storage. This should be an absolute path. If you do not specify a storage directory explicitly, the replication node uses a directory under the root directory.

- `-memorymb`: Specifies the total number of megabytes of memory that is available in the machine for the replication node. The system uses the `memory_mb` value to guide the specification of the replication node's heap and cache sizes. If the value is zero, the store attempts to determine the amount of memory on the machine. For best results, do not specify this parameter. KVLite will determine the proper value by default. This parameter should be used sparingly, and only for exceptional situations.

  Default value: 0

- `-printstartupok`: Displays messages that show if the starting up of KVLite processes is successful.