kvlite

KVLiteは、簡易版のOracle NoSQL Databaseです。レプリケートされない単一のストレージ・ノード、単一のシャード・ストアを提供します。単一プロセスで実行され、管理インタフェースを必要としません。

kvliteユーティリティで使用できるコマンドライン・オプションを次に示します。
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]
KVLiteを初めて起動するときに、パラメータ値を指定できます。それらのパラメータ値は構成ファイル内に記録され、KVLiteの再起動時に使用されます。この構成ファイルはルート・ディレクトリに格納されています。初期値を変更するには、KVLiteを起動する前にルート・ディレクトリを削除するか、最初に使用したのとは別のルート・ディレクトリを使用して-rootオプションを指定します。コマンドライン・オプションの説明を次に示します:

  • root <path>: ルート・ディレクトリへのパスを指定します。指定するパスとしては、絶対パスか相対パスを使用できます。データベース・ファイルはこの場所に格納されます。データベース・ファイルが存在しない場合は、自動的にそれらが作成されます。

    デフォルト値: ./kvroot

  • -store <storename>: データ・ストアの名前を指定します。データ・ストア名に、ファイル・パス内でのその使用の妨げになる可能性がある文字を使用しないでください。有効な文字は、英数字すべて、ハイフン、アンダースコアおよびピリオドです。

    デフォルト値: kvstore

  • -host <hostname>: KVLiteを実行するホストの名前を指定します。リモート・マシンからKVLiteのこのインスタンスにアクセスする場合は、マシンの実際のホスト名を指定する必要があります。そうでない場合は、このオプションにlocalhostを指定します。

    デフォルト値: <マシンのホスト名>

  • -port <port>: KVLiteでクライアント接続をリスニングするポートを指定します。これは、レジストリ・ポートと呼ばれる場合もあります。

    デフォルト値: 5000

  • -storagedirsizegb <GB>: KVLiteデータベース用の使用可能なディスク領域の最大量をGB単位で指定します。KVLiteデータベースのディスク使用量が、指定した値より5GB小さい値を超えると、既存のレコードを削除してディスク・ストレージ要件を満たすのに十分な領域を解放するまで、KVLiteですべての書込み操作が一時停止されます。storagedirsizegbを0に設定すると、KVLiteによって、使用可能なすべての領域が適宜使用されるようになります。

    システムによって、構成されているディスク制限を超えた場合に備えて、リカバリ用に5 GBの空き領域が保持されます。

    デフォルト値: 10

  • -noadmin: 管理サービスを起動する必要があるかどうかを指定します。-noadminパラメータが指定されている場合、管理サービスは起動されません。

    管理サービスとは、様々な管理CLIコマンドを実行するサービスです。

  • secure-config: ストアに対してセキュリティを有効にする必要があるかどうかを指定します。有効にした場合は、ストアに接続するクライアントすべてでセキュリティ資格証明を提示する必要があります。

    デフォルト値: enable

  • -restore-from-snapshot:
    ストアのリストア元となるスナップショットを指定します。スナップショットからストアを直接リストアできます。たとえば:
    -restore-from-snapshot 240424-104506-mySnapshot

    ここでの240424–104506–mySnapshotは、リストアするスナップショットのディレクトリ名を表しています。この手順によって、ストアがスナップショットの作成時点までリストアされます。スナップショットの作成後にストアがアクティブだった場合、そのスナップショット以降に行われた変更はすべて失われます。

    デフォルト値: null

  • -admin-web-port <admin web service port>: 管理Webサービスを起動するTCP/IPポートを指定します。正の整数値を指定しなかった場合、管理Webサービスは起動されません。管理Webサービスの詳細は、『Oracle NoSQL Databaseの管理のためのREST API』を参照してください。

    デフォルト値: -1

  • -version: KVLiteデータベースのバージョン、インストールされた日時、ビルドIDおよびエディション(Community/Enterprise)を指定します。

  • -harange <startPort, endPort>: 通信目的でレプリケーション・ノードで使用されるharange (高可用性範囲)ポートを指定します。

  • -servicerange <startPort,endPort>: ストレージ・ノードがその管理サービスおよびマネージド・サービスとの通信に使用するポートの範囲を指定します。このパラメータは、ストレージ・ノード上のサービスがファイアウォールまたはその他のセキュリティの理由で特定のポートを使用する必要がある場合に役立ちます。デフォルトでは、サービスは匿名ポートを使用します。

  • -storagedir <path>: レプリケーション・ノードが格納に使用できるディレクトリへのパスを指定します。これは絶対パスである必要があります。ストレージ・ディレクトリを明示的に指定しない場合、レプリケーション・ノードではルート・ディレクトリの下のディレクトリが使用されます。

  • -memorymb: レプリケーション・ノードのマシンで使用可能なメモリーの合計数(MB単位)を指定します。システムでは、memory_mb値を使用して、レプリケーション・ノードのヒープ・サイズとキャッシュ・サイズの指定が決定されます。値が0の場合、ストアはマシン上のメモリー量を判別しようとします。最善の結果を得るには、このパラメータを指定しないでください。KVLiteではデフォルトで適切な値が特定されます。このパラメータは慎重に使用する必要があり、例外的な状況にのみ使用してください。

    デフォルト値: 0

  • -printstartupok: KVLiteプロセスの起動が成功したかどうかを示すメッセージを表示します。