GridDB 運用管理ガイド

GridDBのサービスの動作を制御するパラメータを用意しています。デフォルトでは、OS起動にノードを起動・クラスタの参加、停止時にクラスタから離脱・ノードを停止する設定になっています。

パラメータの一覧は以下のとおりです。

パラメータ	デフォルト	説明
GS_USER	admin	GridDBのユーザ名
GS_PASSWORD	admin	GS_USER のパスワード
CLUSTER_NAME	INPUT_YOUR_CLUSTER_NAME_HERE	参加するクラスタ名
MIN_NODE_NUM	1	参加するクラスタの構成ノード数

パラメータを変更するには起動設定ファイル( /etc/sysconfig/gridstore/gridstore.conf )を編集します。

サーバパッケージのアップデートインストールやアンインストールのとき、起動設定ファイルは上書き・アンインストールされません。

【注意点】

• サービススクリプトに記載されているパラメータは直接編集しないでください。アンインストールやアップデートインストールの際に編集したファイルは失われます。パラメータを変更するときは、起動設定ファイルを編集してください。
• 複数ノードでクラスタを構成する場合、参加する各ノードの起動設定ファイルは同一のものにしてください。特に、システム稼働中に運用管理コマンド、コマンド・インタプリタなどでクラスタを拡張した場合、すべてのノードの MIN_NODE_NUM を拡張後のクラスタ構成ノード数に変更する必要があります。

サービスのログに関しては、ブートログ( /var/log/boot.log )や運用コマンドのログ( $GS_HOME/log )を参照してください。

動作：

• ノードを起動し、クラスタへ参加します。

  # service gridstore start
  

• ノードの起動はgs_startnodeコマンド、クラスタへの参加はgs_joinclusterコマンドをそれぞれ用います。
• gs_startnodeコマンド実行時、リカバリ処理の終了を待合せます。
• gs_joinclusterコマンド実行時、クラスタ稼働まで待合せません。
• CLUSTER_NAME にクラスタ名を設定します。
• MIN_NODE_NUM にクラスタを構成するノード台数を設定します。

【注意点】

• クラスタを稼働する途中にエラーが発生した場合は、プロセスの終了処理が行われます。

動作：

• クラスタから離脱してからノードを停止します。

  # service gridstore stop
  

• プロセスが無くなったら完了、タイムアウト時間が経過したらエラーとします(終了コード150)。
• サービスで起動したプロセスが無ければ、終了コード0とします。
• クラスタからの離脱はgs_leaveclusterコマンドを用います。
• ノードの停止前にgs_leaveclusterコマンドを実行します。
• gs_leaveclusterコマンド実行時、クラスタ離脱を待合せます。
• gs_leaveclusterの終了コードにかかわらず、ノード停止処理を行います。

【注意点】

• 運用コマンドやコマンド・インタプリタ(gs_sh)で起動したノードはサービスのstopで停止することはできません。それぞれのツールで停止を行ってください。
• 複数ノードでクラスタを構成している場合、1つのノードにstopを実行してもクラスタは停止しません。クラスタを停止させる場合は、gs_stopclusterコマンドを利用してください。

動作：

• ノードのプロセスが実行中かどうかを表示します。

  # service gridstore status
  

動作：

• stopとstartを連続で行います。

動作：

• ロックファイルがあればrestartを行います。

障害対策機能は、以下の動作となります。

障害対策機能の設定は以下になります。

パラメータ	デフォルト	設定値
SVC_ENABLE_AUTO_RESTART	true	true(有効)/false(無効)
GS_USER	admin	適宜
GS_PASSWORD	admin	適宜

パラメータを変更するには起動設定ファイル( /etc/sysconfig/gridstore/gridstore.conf )を編集します。

SVC_ENABLE_AUTO_RESTART

• GridDBノードの起動時（再起動時）に設定が有効になります。
• 別の監視システムで、GridDBの障害復旧の制御を行いたい場合は、本障害対応機能を無効にして下さい。

GS_USER/GS_PASSWORD

• GridDBの管理者ユーザ、およびパスワードを設定します。
• ユーザ/パスワードは以下のケースで利用します。
  • Ａ．サービスによる起動、停止、再起動する場合
  • Ｂ．gs_startnodeで、-uオプションが指定されていない場合

【注意点】

• 指定したGS_USER/GS_PASSWORDに誤りがある、もしくはユーザ/パスワードが指定されていない場合には、GridDBノードの起動に失敗します。

gs_adminは、クラスタにアクセスするために、クラスタを構成するノードを起動しているマシン、もしくはサブネットが等しく、マルチキャストが配送されるネットワーク上のマシンに配置する必要があります。

GridDBのクライアントパッケージ(griddb-xx-client-X.X.X-linux.x86_64.rpm)をインストールします。

Webアプリケーションを配置するマシンにrootユーザでログインし、以下のコマンドでパッケージをインストールします。

# rpm -Uvh griddb-xx-client-X.X.X-linux.x86_64.rpm

※xxはGridDBのエディション(se, ae, ve)※X.X.XはGridDBのバージョン

クライアントパッケージをインストールすると、GridDBホームディレクトリ( /var/lib/gridstore/admin )にadminというディレクトリが作成されます。このディレクトリ( /var/lib/gridstore/admin )を、以降では adminHome と記載します。

adminHomeにはgs_adminの設定情報やgs_adminで利用するデータが配置されます。gs_adminにはadminHomeのファイルを操作する機能があるため、適切な権限設定が必要です。権限設定に関しては後述します。

adminHome下の構成は以下のとおりです。

capture/                                                # スナップショットの保存ディレクトリ(※)
        ノードアドレス_ポート番号/YYYYMMDDHHMMSS.json   # スナップショットファイル(※)
conf/                                                   # 設定ファイルディレクトリ
     gs_admin.properties                                # 初期設定する静的パラメータファイル
     gs_admin.settings                                  # 表示に関する設定をする動的パラメータファイル
     password                                           # gs_adminユーザ定義ファイル
     repository.json                                    # ノードリポジトリファイル
log/                                                    # gs_adminのログファイルディレクトリ(※)
    gs_admin-YYYYMMDD.log                               # ログファイル(※)
tree/                                                   # コンテナツリーの構造ファイルディレクトリ(※)
     foldertree-クラスタ名-ユーザ名.json                # フォルダツリーファイル(※)

(※)のファイルおよびディレクトリはgs_adminが自動的に作成します。

【注意点】

• adminHome以下のファイルおよびディレクトリは、クライアントパッケージをアンインストールしても削除されません。ファイルが不要の場合は手動で削除してください。

gs_adminはTomcat上で動作するWebアプリケーションです。gs_adminを利用するには、Tomcatへgs_adminのwarファイルをデプロイする必要があります。本節では、Tomcatの設定については割愛します。

デプロイの手順は以下のとおりです。

GridDBのクライアントパッケージ(griddb-xx-client-X.X.X-linux.x86_64.rpm)に含まれるwarファイルをTomcatにデプロイします。

クライアントパッケージをインストールすると、warファイルは以下にインストールされます。

• /usr/griddb/web/gs_admin.war

gs_admin.warをTomcatインストールディレクトリのwebappsディレクトリ下にコピーします。

$ cp /usr/griddb/web/gs_admin.war [Tomcatインストールディレクトリ]/webapps

gs_adminの利用の際、gs_admin利用ユーザで認証を行います。

管理対象のGridDBクラスタの管理ユーザをgs_admin利用ユーザとして設定する必要があります。

gs_adminのユーザ定義ファイルは、 /var/lib/gridstore/admin/conf/password です。

クライアントパッケージのインストール時、このファイルは作成されません。

簡単に利用するには、管理したいクラスタのノードのユーザ定義ファイル( /var/lib/gridstore/conf/password )をgs_adminのユーザ定義ファイル( /var/lib/gridstore/admin/conf/password )へコピーしてください。この場合、コピーしたユーザ定義ファイルに記載されている管理ユーザすべてがgs_admin利用ユーザとなります。

【メモ】

• GridDBのユーザ管理についてはユーザ管理を参照ください。
• gs_adminで複数クラスタを管理したい場合は、複数クラスタを管理するを参照ください。

設定ファイルは、 /var/lib/gridstore/admin/conf/gs_admin.properties です。gsadmユーザでGridDBクラスタ構成に合わせて設定します。

プロパティファイルを書き換えた場合は、Webアプリケーションを再ロードしてください。

gs_admin.propertiesには以下の設定項目があります。

パラメータ	初期設定値	説明
adminUser	admin	gs_adminの管理ユーザを設定します。カンマで区切ることで、
		複数のユーザ名を設定することができます。gs_adminの管理ユーザは、下記の
		機能を利用することができます。
		・クラスタ操作機能
		・リポジトリ管理機能
ospassword	なし	ノードのgsadmユーザ(OSユーザ)のパスワードを設定します。
		設定すると下記の機能を利用することができます。
		・クラスタ操作機能のノード起動操作(Start)
		・OS情報表示画面

【メモ】

• GridDBインストール時、GridDBを利用するためのOSユーザとしてgsadmが登録されます。gsadmユーザにはパスワードが設定されていないため、gs_adminで ospassword を設定したい場合は、あらかじめ設定しておく必要があります。

ノードリポジトリファイル( /var/lib/gridstore/admin/conf/repository.json )は、クラスタ構成情報とノード情報を一元管理するファイルです。管理対象のクラスタの指定や、クラスタ操作機能に用いられます。gsadmユーザでGridDBクラスタ構成に合わせて設定します。

デフォルトのファイル内容は下記のとおりです。

{
        "header" : {
                "lastModified" : "",
                "version" : "2.7.0"
        },
        "clusters" : [
                {
                        "name" : "INPUT_YOUR_CLUSTER_NAME_HERE",
                        "address" : "239.0.0.1",
                        "port" : 31999,
                        "jdbcAddress" : "239.0.0.1",
                        "jdbcPort" : 41999
                }
        ],
        "nodes" : [
                {
                        "address" : "192.168.1.10",
                        "port" : 10040,
                        "sshPort" : 22,
                        "clusterName" : "INPUT_YOUR_CLUSTER_NAME_HERE"
                }
        ]
}

ノードリポジトリを設定するには、ファイルを直接編集するか、リポジトリ管理画面を利用します。リポジトリ管理画面を利用した設定を行う場合は、リポジトリ管理画面の機能 およびgs_adminで稼働中のクラスタの管理を始めるを参照ください(推奨)。

クラスタ構成を初めて行う場合は、運用管理コマンドやコマンドインタプリタ(gs_sh)を利用することを推奨します。

adminHome下にはgs_adminがファイルやディレクトリを自動的に作成します。そのため、Tomcat実行ユーザにadminHomeに対する読込み・書込み権限が必要となります。そこで、あらかじめadminHome下のファイルやディレクトリの所有者をTomcat実行ユーザ(デフォルトではtomcat)に変更します。

rootユーザで所有者を変更します。

# chown -R tomcat.tomcat /var/lib/gridstore/admin

【メモ】

• adminHomeのデフォルトは /var/lib/gridstore/admin ですが、Webアプリケーションの設定を変更することでディレクトリを変更できます。Tomcatホーム(デフォルトでは /usr/local/tomcat )下の /webapps/gs_admin/WEB-INF/classes/conf/gs_adminPath.properties の adminHome の値を変更します。

【注意点】

• gs_adminのバージョンアップの際、warファイルを再配置するとgs_adminPath.propertiesは再作成されます。gs_adminPath.propertiesの値を変更して運用する場合、再設定が必要となります。

gs_adminにアクセスするには以下のアプリケーションURIにアクセスします。

http://Tomcat動作マシンアドレス:8080/gs_admin

gs_adminのアプリケーションURIにアクセスすると、ログイン画面が表示されます。

cluster欄で管理対象クラスタを選択してログインした場合は統合運用管理画面へログインします。

repository managerを選択してログインした場合はリポジトリ管理画面へログインします。

ログインする際、userとpasswordにgs_admin利用ユーザ名とパスワードをそれぞれ入力し、Loginボタンを押してください。

【メモ】

• Tomcat動作マシンのポート番号は環境により異なります。デフォルト値は8080です。
• gs_admin Ver.2.0以上では、ノードを起動していなくても統合運用管理画面にログインが可能です。

統合運用管理画面は、以下の画面です。

統合運用管理画面は以下の要素で構成されます。

要素	略称	位置	機能
ツリービュー	Tree	左部	操作対象の一覧表示、選択
情報表示・入力部	View	右部	操作対象の情報表示、情報入力
メニュー領域	—	上部	ログアウト
メッセージ領域	—	下部	—

Treeの機能

Treeでは、主な操作対象をクラスタとするかコンテナとするかを上部のタブで切り替えることができます。

タブ	ツリーの名前	主な機能
ClusterTree	クラスタツリー	クラスタやノードの一覧表示、操作対象の選択
ContainerTree	コンテナツリー	データベースの一覧表示、コンテナの検索、操作対象の選択

Viewの機能

Viewでは、Treeで選択した操作対象ごとにViewの上部に表示されるタブが異なります。機能を上部のタブで切り替えることができます。

詳しくは各ツリーおよび画面の項目を参照ください。

gs_adminの管理ユーザのみ、この機能を使用できます。

ログイン画面でrepository managerを選択してgs_adminの管理ユーザでログインすると、リポジトリ管理画面に移動します。

リポジトリ管理画面は、以下の画面です。

リポジトリ管理画面には以下の機能があります。

• リポジトリ情報の表示
  • ノードリポジトリファイル( /var/lib/gridstore/admin/conf/repository.json )の情報をクラスタ情報とノード情報に分けてそれぞれ表で表示します。
• リポジトリ情報の編集
  • 編集した情報は保存を行わない限り、ノードリポジトリファイルには反映されません。
  • クラスタ情報、ノード情報のそれぞれ上部にある入力欄にデータを入力し、Addボタンを押すことでクラスタおよびノードをリポジトリに追加します。
    • クラスタは、クラスタ名が重複する場合には追加、置換できません。
    • ノードは、IPアドレスとポートの組が重複する場合には追加、置換できません。
  • 表の行を選択した場合はReplace（置換）、Delete（削除）が行えます。
    • 行を選択すると、行の内容が入力欄にコピーされます。
    • 複数行の選択はできません。
  • クラスタ追加、置換にはクラスタ名のほかに、クラスタ接続方式に応じて以下のいずれかの情報が必要となります。
    • クラスタ接続方式が"MULTICAST"の場合：マルチキャストアドレス、マルチキャストポート
    • クラスタ接続方式が"FIXED_LIST"の場合：固定リスト方式の接続先リスト
    • クラスタ接続方式が"PROVIDER"の場合：プロバイダ方式のプロバイダURL
  • ノード追加、置換にはIPアドレス、ポートが必要となります。
  • クラスタを削除する場合、削除後に、削除したクラスタに登録されているノードがあれば、それらのノードからクラスタを削除するかの確認ダイアログを表示します。Yesを選択すると削除します。
• クラスタ同期
  • 稼働中のクラスタの情報を取得して、リポジトリに登録することができます。
  • Syncボタンを押すと、IPアドレスとポートを入力するダイアログが表示されます。ここに、クラスタを構成しているいずれかのノードの、IPアドレスおよびポートを入力してSyncを選択し、確認ダイアログでYesを押すとリポジトリ管理画面の表示が上書き更新されます。
    • 指定するノードはマスタノードでなくて構いません。
    • IPアドレスにはノード定義ファイル(gs_node.json)の /system/serviceAddress を指定します。
    • ポートにはノード定義ファイル(gs_node.json)の /system/servicePort を指定します。
    • SSHポートはデフォルトの22で登録されます。
• リポジトリ情報の更新
  • Refreshボタンを押すと、ノードリポジトリファイルの再読込を行います。
  • 保存していない内容は破棄されます。
• リポジトリ情報の保存
  • Saveボタンを押すと、表示されている内容をノードリポジトリファイルへ保存します。
  • この機能により保存しない限りは、ノードリポジトリファイルに変更は行われません。

入力欄の仕様は以下のとおりです。

クラスタ

• クラスタ名(Name)
  • クラスタ定義ファイル(gs_cluster.json)の /cluster/clusterName を指定します。
• クラスタ接続方式(Notification Mode)
  • セレクトボックスで下記のいずれかを選択します。
    • マルチキャスト方式:MULTICAST
    • 固定リスト方式:FIXED_LIST
    • プロバイダ方式:PROVIDER
• マルチキャストアドレス(Multicast Address)
  • クラスタ定義ファイル(gs_cluster.json)の /transaction/notificationAddress を指定します。
  • マルチキャスト方式の時、入力は必須です。
• マルチキャストポート(Multicast Port)
  • クラスタ定義ファイル(gs_cluster.json)の /transaction/notificationPort を指定します。
  • マルチキャスト方式の時、入力は必須です。
• JDBCアドレス(JDBC Address)
  • クラスタ定義ファイル(gs_cluster.json)の /sql/notificationAddress を指定します。
  • マルチキャスト方式の時に指定します。(任意)
  • GridDB Advanced Edition / Vector EditionでSQL画面を使うときに必要です。
• JDBCポート(JDBC Port)
  • クラスタ定義ファイル(gs_cluster.json)の /sql/notificationPort を指定します。
  • マルチキャスト方式の時に指定します。(任意)
  • GridDB Advanced Edition / Vector EditionでSQL画面を使うときに必要です。
• 固定リスト方式の接続先リスト(Transaction Member)
  • クラスタ定義ファイル(gs_cluster.json)の /cluster/notificationMember/transaction/address と /cluster/notificationMember/transaction/port を:で連結して、各ノードの値をカンマ区切りで指定します。
  • 例: 192.168.10.1:10001,192.168.10.2:10001,192.168.10.3:10001
• 固定リスト方式の接続先リスト(SQL Member)
  • クラスタ定義ファイル(gs_cluster.json)の /cluster/notificationMember/sql/address と /cluster/notificationMember/sql/port を:で連結して、各ノードの値をカンマ区切りで指定します。
  • 例: 192.168.10.1:20001,192.168.10.2:20001,192.168.10.3:20001
• プロバイダ方式のプロバイダURL(Provider URL)
  • クラスタ定義ファイル(gs_cluster.json)の /cluster/notificationProvider/url を指定します。
  • プロバイダ方式の時、入力は必須です。

ノード

• クラスタ(Cluster)
  • セレクトボックスで登録されているクラスタを選択します。
• IPアドレス(IP Address)
  • ノード定義ファイル(gs_node.json)の /system/serviceAddress を指定します。
• ポート(Port)
  • ノード定義ファイル(gs_node.json)の /system/servicePort を指定します。
• SSHポート(SSH Port)
  • ノードが動作するマシンのSSHポートを指定します。デフォルト値は22です。

概要

クラスタツリーでは、管理対象クラスタを構成するノード、つまり、リポジトリのノード（clusterNameが管理対象クラスタ）をツリー形式で表示します。

リポジトリに登録されていないノードの先頭には*が表示されます。

クラスタツリーに表示されるアイコンの説明は以下のとおりです。

アイコン	説明
	クラスタ
	マスタノード
	フォロワノード
	起動済みノード
	未起動ノード
	状態未確認ノード
	メッセージ

コンテキストメニュー

ツリー内の要素を右クリックすると要素に応じたコンテキストメニューが表示されます。メニューから項目を選択することで、情報更新や要素に対する操作ができます。

それぞれの選択要素に対するメニューと機能は以下のとおりです。

選択要素	メニュー	機能
クラスタ	refresh	Treeのノード一覧の再取得
ノード	refresh	Viewにノードの最新情報を表示

操作対象とViewのタブ

ツリー内の要素を左クリックすると、要素に応じた機能がViewに表示されます。機能はViewの上部のタブで切り替えます。

選択要素	タブ	画面の名前	機能
クラスタ	Dashboard	ダッシュボード画面	クラスタ全体の様々な情報が表示されます。
	Status	クラスタステータス画面	管理対象クラスタの構成情報やデータ情報が表示されます。
	Monitor	OS情報表示画面	ノードが動作するマシンのOS情報が表示されます。
	Configuration	クラスタ操作画面	ノードの起動、終了を含む、クラスタ操作を行うことができます。
ノード	System	システム情報画面	ノードのシステム情報が表示されます。
	Container	コンテナ一覧画面	ノードが格納しているコンテナの一覧が表示されます。
	Performance	性能情報画面	ノードの性能情報がグラフで表示されます。
	Snapshot	スナップショット画面	採取した性能値を表に表示します。以前に採取した値と比較することができます。
	Log	ログ画面	ノードのイベントログの表示や、イベントログの出力レベルの設定ができます。

【メモ】

• クラスタのマスタノードが変わった場合、ノード一覧の再取得に失敗することがあります。一度ログアウトして再度ログインしてください。

概要

クラスタ全体の様々な情報が表示されます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	クラスタ	Dashboard

画面

機能

ダッシュボード画面には以下の機能があります。

• クラスタの全データ量表示 (◆Total Stored)
  • 稼働中のクラスタの全データ量を単位付きで表示します。(KB〜TB)
  • 全データ量の何％がメモリ上にあるかも表示します。
• メモリ使用量表示 (◆Store Memory Usage)
  • ストアメモリとして利用できるメモリの使用率を円グラフで表示します。
• クラスタ健康度表示 (◆Cluster Health)
  • 稼働ノードと非稼働ノード数の割合を円グラフで表示します。
• クラスタへのネットワーク接続情報表示 (◆Current Connections)
  • クラスタに対する現在のコネクション、セッション、トランザクション数を棒グラフで表示します。
• クラスタのイベント数表示(過去5分間) (◆Event Count)
  • クラスタにおける過去5分間の読込命令、書込命令、スワップ読込、スワップ書込、ロック競合発生のイベント数を表示します。
  • ※過去5分間とはログに最新の性能情報が出力された時点から過去5分間のことを指します。
• ログ解析情報表示 (◆Log Information)
  • クラスタを構成する各ノードのWARNING、ERRORのログを表示します。
  • 左側の詳細アイコンにカーソルを合わせると、対象ログの情報を表示します。

概要

管理対象クラスタの構成情報やデータ情報が表示されます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	クラスタ	Status

画面

機能

クラスタステータス画面には以下の機能があります。

• クラスタの情報表示 (◆Cluster Information)
  • マスタノードから取得した以下の情報を表示します。
    • クラスタ名、稼働ノード数、構成ノード数、パーティション状態、マルチキャストアドレスおよびポート
• データに関する情報表示 (◆Stored Data Information)
  • クラスタから取得した以下の情報を表示します。
    • パーティション数、総コンテナ数
• クラスタを構成するノードの情報表示 (◆Node Information)
  • 各ノードの以下の情報を表示します。
    • IPアドレスおよびポート、ノード状態、クラスタ状態、複合状態、ノードのバージョン
    • 複合状態は、クラスタ操作画面で表示されるノードの状態です。

概要

ノードの動作するマシンのリソース情報やOS性能が表示されます。GridDBの性能分析やCPUやネットワークなどの負荷状況が分かります。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	クラスタ	Monitor

画面

機能

OS情報表示には以下の機能があります。

• ノードのリソース情報表示(◆Resource Information)
  • ノードから取得した以下の情報を表示します。
    • CPU使用率
    • メモリ、スワップメモリの容量、使用率
    • データディレクトリおよびバックアップディレクトリの容量、ディスク使用率
• OS性能情報表示(◆OS Performance)
  • Startボタンを押すと、cycleで指定した秒数ごとにノードから性能情報を取得し、2つのグラフを描画します。
    • CPU使用率
    • ネットワーク転送量

【メモ】

• gs_admin.propertiesに ospassword を設定していない場合、本機能は利用できません。
• gs_admin実行環境からノード実行環境へOSユーザ「gsadm」でSSH接続するための設定が必要となります。SSH接続の手順の詳細に関しては、各OSのマニュアルを参照ください。

この機能はgs_admin管理者のみ利用可能です。

概要

ノードの起動、終了を含む、クラスタ操作を行うことができます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	クラスタ	Configuration

画面

機能

クラスタ操作画面には以下の機能があります。

• ノードの一覧表示
  • ノードリポジトリから取得した以下のノードを表示します。
    • 実際にクラスタを構成しているノード(表の一番上に表示)
    • クラスタを構成していないが管理対象クラスタに属するノード
    • クラスタに属さないノード
• ノードの情報表示
  • 各ノードの以下の情報を表示します。
    • クラスタ登録状態(チェックボックス)
    • クラスタにおける役割(Role)
    • IPアドレスおよびポート、SSHポート
    • ノードステータス
  • クラスタ登録状態は、そのノードが管理対象クラスタに登録されているかどうかを示します。
  • 役割は、マスタノード(M)、フォロワノード(F)、役割無し(-)の3種類です。
  • ノードステータスは、実際にクラスタを構成しているノード、クラスタを構成していないが管理対象クラスタに属するノードのみ取得します。
• クラスタへの登録、クラスタからの削除
  • ※本機能ではノードリポジトリの内容が編集されます。
  • クラスタ登録状態のチェックボックスをクリックすることで、クラスタへ登録したり、クラスタから削除したりすることができます。
  • 本画面では、クラスタに登録されているノードのみ操作を行えます。
  • クラスタが稼働中の場合、チェックボックスは操作できません。
• クラスタ単位の操作
  • クラスタの起動 (Start Cluster)
    • クラスタに登録されているすべてのノードでクラスタを構成します。
    • すべてのノードのノードステータスがSTARTEDのときのみ実行可能です。
  • クラスタの停止 (Stop Cluster)
    • 稼働しているクラスタを停止します。
    • クラスタが稼働しているときのみ実行可能です。
• ノード単位の操作
  • 各ノードのOperations欄に実行できる操作のボタンが表示されます。
    • 表示されるボタンはノードステータスによって異なります。
  • ノードの起動 (Start)
    • 停止状態(STOPPED)のノードを起動します。
  • クラスタへの参加 (Join)
    • Leaveや障害などによってクラスタから一旦離脱したノードをクラスタに再参加させます。
  • クラスタからの離脱 (Leave)
    • 稼働中のクラスタから離脱させます。
  • クラスタへの増設 (Append)
    • 稼働中のクラスタへ増設します。
  • ノードの停止 (Stop)
    • 起動中のノードを停止します。
    • クラスタ稼働中は実行できません。クラスタから離脱させた後に停止させてください。

【メモ】

• ノードの起動(Start)を行うためには、gs_admin実行環境からノード実行環境へOSユーザ「gsadm」でSSH接続するための設定が必要となります。SSH接続の手順の詳細に関しては、各OSのマニュアルを参照ください。

概要

ノードのシステム情報が表示されます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	ノード	System

画面

機能

システム情報画面には以下の機能があります。

• ノードの情報表示 (◆Configuration Information)
  • ノードから取得した以下の情報を表示します。
    • ノードのバージョン、IPアドレスおよびポート、ノード状態
• チェックポイント、バックアップ情報表示(◆ CheckPoint/Backup Information)
  • チェックポイントの実行回数、バックアップの実行回数などを表示します。

概要

ノードが格納しているコンテナの一覧が表示されます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	ノード	Container

画面

機能

コンテナ一覧画面には以下の機能があります。

• コンテナ一覧表示 (◆Own Containers Information)
  • ノードが格納しているコンテナの一覧を表示します。
    • データベース名、コンテナ名、パーティションIDを表示します。
• コンテナ詳細画面への移動
  • コンテナ名をクリックすると、コンテナ詳細画面へ移動できます。

【メモ】

• コンテナ詳細画面へ移動する際には、コンテナツリーの初期化が必要です。コンテナ詳細情報の表示ができない場合、 TreeのContainerTreeタブを1度クリックして、コンテナツリーを初期化してください。

概要

ノードの性能情報がグラフで表示されます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	ノード	Performance

画面

機能

性能情報画面には以下の機能があります。

• グラフ描画 (◆Performance Capture)
  • Startボタンを押すと、cycleで指定した秒数ごとにノードから性能情報を取得し、3つのグラフを描画します。
  • Stopボタンで停止することができます。
• Memory/Storage Information
  • メモリに保持されているデータ量やディスクに永続化された量を表示します。
  • 単位はMBです。
• Read/Write Count Information
  • メモリやディスクの読み込み、書き込み回数をcycleで指定した時間の差分値で表示します。
• Misc Count Information
  • 現在のコネクション、セッション、トランザクション、ロック競合発生の数を表示します。

概要

採取した性能値を表に表示します。以前に採取した値と比較することができます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	ノード	Snapshot

画面

機能

スナップショット画面には以下の機能があります。

• 性能情報の採取
  • Captureボタンを押すと、ノードの現在の性能情報が採取されます。
• 差分表示
  • 複数回Captureボタンを押すことで、前回(Start)と現在(End)との差分(Diff)と、
• Baselineの保存、表示
  • Baselineボタンを押すと、表示されている1秒間当たりの差分値をBaselineとして保存できます。
  • 保存したデータはセレクトボックスから選択できます。セレクトボックスに表示されるのは最新の10件のみです。
  • Baselineは、Startで表示される時刻名でadminHomeのcaptureディレクトリに保存されます。

概要

ノードのイベントログの表示や、イベントログの出力レベルの設定ができます。

利用方法

ツリーの種類	操作対象	タブ名
クラスタツリー	ノード	Log

画面

機能

ログ画面には以下の機能があります。

• イベントログ表示 (◆Log Information)
  • ノードの最新イベントログを30件表示します。
  • Reloadボタンで再取得できます。
• イベントログの出力レベル表示、設定 (◆Current Capture Level)
  • カテゴリごとの現在のイベントログ出力レベルを確認できます。
  • ログ出力レベルはERROR、WARNING、INFO、DEBUGです。
  • ノードの再起動により、変更したログレベルは初期化されます。
    • 永続化するには対象ノードのノード定義ファイル(gs_node.json)を編集してください。

【注意点】

• ログ出力レベルの変更は、必ずサポート窓口の指示に従ってください。

概要

コンテナツリーでは、管理対象クラスタ上に存在するデータベースやコンテナをツリー形式で表示します。

ツリーの一番上には、管理対象クラスタが表示されます(（）内はクラスタの総データベース数)。

コンテナツリーに表示されるアイコンの説明は以下のとおりです。

アイコン	説明
	クラスタ
	データベース
	データベース(存在しない)
	コンテナ(コレクション)
	コンテナ(時系列コンテナ)
	パーティションテーブル(コンテナ)
	検索フォルダ
	一時ワークフォルダ
	メッセージ

機能

コンテナツリーには以下の機能があります。

• クラスタを操作する機能の表示
  • クラスタを選択すると、Viewにはデータベース作成などの機能を表示します。
• データベースの自動検出
  • クラスタ上に存在するすべてのデータベースを自動検出し、クラスタの下に表示します。
  • 表示しているデータベースがクラスタ上に存在しなくなった場合、表示から削除できます。
• 操作対象データベースの選択
  • データベースを選択すると、Viewにはコンテナ作成などの機能を表示します。
• コンテナの検索
  • 各データベース上のコンテナをキーワードで検索できます。半角スペースで区切ることで、検索条件を追加できます。
  • 検索は、データベースまたは検索フォルダを選択して、上部の検索バーにキーワードを入力し、検索ボタンをクリックするか、Enterキーを押すことで行います。
  • 検索時に検索フォルダが作成されます。()内はヒットしたコンテナ数を示します。
  • 検索フォルダは階層化して検索結果を絞り込むことができます。
  • 検索フォルダはコンテキストメニューまたはDeleteキーで削除することができます。検索フォルダを削除しても、フォルダ内に表示されているクラスタ上のコンテナは削除されません。
• コンテナの削除
  • コンテキストメニュー、またはDeleteキーでコンテナをクラスタから削除できます。削除する前に確認ダイアログを表示します。
• 操作対象コンテナの選択
  • コンテナの種類によってアイコンが変わります。
  • コンテナを選択すると、Viewには詳細情報などを表示します。
• 一時ワークフォルダ
  • コンテナ作成画面でコンテナを作成した時や、コンテナ情報画面からコンテナ名をクリックしたときにデータベースの下に作成されます。
  • コンテキストメニューまたはDeleteキーで削除することができます。一時ワークフォルダを削除しても、フォルダ内に表示されているクラスタ上のコンテナは削除されません。
• ツリー構造の保存
  • 検索後のツリー構造は保存され、次回ログイン時に読込まれます。(クラスタ、ユーザごとにファイルが異なります)
  • 保存対象は、クラスタ、データベース、検索フォルダです。検索結果やコンテナ、一時ワークフォルダは保存されません。
  • Tomcat動作マシンの /var/lib/gridstore/admin/tree/foldertree-クラスタ名-ユーザ名.json に保存されます。

ログイン後にはClusterTreeタブとノード一覧が自動的に表示されます。ContainerTreeタブに切替えると、コンテナツリーのツリー構造が保存されている場合、ツリー構造が自動的に追加されます。ただし、検索フォルダの再検索は自動では行われません。

コンテナツリーでは以下の操作は行えません。

• データベースを横断するコンテナ検索
  • データベースを横断してクラスタ上のコンテナを検索することはできません。
• データベースの作成、削除
  • データベース管理画面から行ってください。
• コンテナの作成
  • コンテナ作成画面から行ってください。
• パーティションテーブル(コンテナ)の削除
  • SQL画面からSQL文で行ってください。

コンテキストメニュー

ツリー内の要素を右クリックすると要素に応じたコンテキストメニューが表示されます。メニューから項目を選択することで、情報更新や要素に対する操作ができます。

それぞれの選択要素に対するメニューと機能は以下のとおりです。

選択要素	メニュー	機能
クラスタ	refresh	Treeのツリー構造再読込、データベース自動検出
データベース	refresh	データベース存在確認、コンテナの再検索
コンテナ	refresh	Viewにコンテナの最新情報を表示
	drop	コンテナの削除(確認ダイアログあり)
検索フォルダ	refresh	コンテナの再検索
	remove	フォルダの削除
一時ワークフォルダ	remove	フォルダの削除

【メモ】

• コンテナツリーの各機能は、クラスタが稼働中のときのみ利用できます。

操作対象とViewのタブ

ツリー内の要素を左クリックすると、要素に応じた機能がViewに表示されます。機能はViewの上部のタブで切り替えます。

選択要素	タブ	画面の名前	機能概要
クラスタ	Database	データベース管理画面	データベースの作成、削除、権限操作ができます。
	User	ユーザ管理画面	一般ユーザの作成、削除、パスワード変更ができます。
	SQL	SQL画面	データベースに対してSQLを実行し、その結果を表示できます。
データベース	Create	コンテナ作成画面	データベースにコンテナを作成できます。
	SQL	SQL画面	データベースに対してSQLを実行し、その結果を表示できます。
コンテナ	Details	コンテナ詳細画面	コンテナのカラムや索引の設定情報が表示されます。
	Index	索引設定画面	コンテナのカラムごとの索引の作成、削除ができます。
	Trigger	トリガ設定画面	コンテナのトリガ作成、編集、削除ができます。
	TQL	TQL画面	コンテナに対してTQL(問合せ言語)を実行し、その結果を表示します。
パーティション	Details	コンテナ詳細画面	コンテナのカラムや索引の設定情報が表示されます。
テーブル(コンテナ)

概要

データベースの作成、削除、権限操作ができます。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	クラスタ	Database

画面

機能

データベース管理画面には以下の機能があります。

• データベースの作成 (◆Create Database)
  • データベース名を入力し、Createボタンを押すと、クラスタにデータベースを作成できます。
• データベースの一覧表示 (◆Database List)
  • クラスタ上に存在するデータベースの一覧を表示します。
    • データベース名、アクセス権(Privilege)、データベースへの操作(Operations)を表示します。
  • アクセス権(Privilege)の欄には、そのデータベースにアクセス権を持つ一般ユーザを表示します。
  • publicデータベースは操作することができません。
• データベースの削除 (Drop)
  • データベースをクラスタから削除します。
  • データベース上にコンテナが存在する場合はエラーとなります。
• アクセス権の付与 (Grant)
  • 一般ユーザに対して、データベースのアクセス権を付与します。
  • Grantを押すとユーザ選択ダイアログが表示されます。クラスタ上に存在する一般ユーザがセレクトボックスから選択できます。
  • データベースに対してアクセス権を持てる一般ユーザは1人のみです。(Ver.2.7現在)
  • 1人のユーザは複数のデータベースにアクセス権を持つことができます。
• アクセス権の剥奪 (Revoke)
  • 一般ユーザから、データベースのアクセス権を剥奪します。
  • ユーザ管理画面で一般ユーザが削除されると、自動的にそのユーザのアクセス権がすべて剥奪されます。

概要

一般ユーザの作成、削除、パスワード変更ができます。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	クラスタ	User

画面

機能

• ユーザの作成 (◆Create User)
  • ユーザ名とパスワードを入力し、Createボタンを押すと、クラスタに一般ユーザを作成できます。
• ユーザの一覧表示 (◆User List)
  • クラスタ上に存在する一般ユーザの一覧を表示します。
    • ユーザ名、ユーザへの操作(Operations)を表示します。
• ユーザの削除 (Drop)
  • 一般ユーザをクラスタから削除します。
  • データベースにアクセス権を持っていた場合、自動的にすべてのアクセス権が剥奪されます。
• パスワードの変更 (Change Password)
  • ユーザのパスワードを変更できます。元のパスワードを入力する必要はありません。
  • Change Passwordを押すと新しいパスワードの入力ダイアログが表示されます。新しいパスワードを入力し、Changeを押すと、パスワードが変更されます。

この機能はGridDB Advanced Edition / Vector Editionでのみ利用可能です。

概要

データベースに対してSQLを実行し、その結果を表示できます。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	クラスタ	SQL
コンテナツリー	データベース	SQL

画面

機能

SQL画面には以下の機能があります。

• 実行対象のデータベースの選択 (◆Database)
  • クラスタ上に存在するデータベースをセレクトボックスで選択できます。
  • コンテナツリーでデータベースを選択した場合は、選択したデータベースで固定されます。
• SQL実行 (◆SQL)
  • SQL文を入力し、Executeボタンを押すと実行されます。結果は◆Resultに表示されます。
    • 改行して入力できますが、実行できるSQL文は1文のみです。
    • Clearボタンで入力を削除できます。
  • Display Limitで表示する行数の制限を行います。
  • 使用できるSQL構文については、『GridDB Advanced Edition SQLリファレンス』(GridDB_AE_SQL_Reference.pdf)を参照ください。
• リザルト表示 (◆Result)
  • SELECT文を実行した場合は、ヒット件数と、実行時間(ミリ秒)、ヒットしたロウ(表形式)を表示します。
    • 実行時間はSQL文の実行時間がミリ秒で表示されます。
    • NULL値や配列型のカラム値は(NULL)と表示されます。BLOB型のカラム値は(BLOB)と表示されます。
  • INSERT/DELETE/UPDATE文であれば実行対象のロウ数、その他のDCL文やDDL文の場合はSUCCESSをそれぞれ結果として表示します。

【メモ】

• 本画面を利用する場合は、ノードリポジトリのクラスタ情報にJDBCアドレスおよびポートを追加する必要があります。
  • ノードリポジトリへの設定は、リポジトリ管理画面より実行できます。

概要

データベースにコンテナを作成できます。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	データベース	Create

画面

機能

コンテナ作成画面には以下の機能があります。

• コンテナの作成
  • コンテナ名、コンテナタイプを指定し、コンテナタイプに応じたパラメータを指定してCreateボタンを押すことでデータベースにコンテナを作成できます。
• コンテナタイプの選択
  • コンテナタイプをコレクション(Collection)と時系列コンテナ(TimeSeries)から選択できます。
  • コンテナタイプによって、設定できるパラメータやカラムの内容が変わります。
• カラムの設定
  • コンテナを作成する際のカラムを設定できます。
  • Add Columnボタンでカラムを追加でき、カラム右端のDelボタンでカラムを削除できます。
  • Resetボタンでコンテナタイプ以外の設定が初期状態に戻ります。
  • コンテナタイプにコレクションを選択した際にRow Key Assignedをtrueに設定すると、1行目のカラムがロウキーに設定されます。
    • ロウキーを設定すると1行目のカラムのデータ型は使用可能な型に制限されます。また、NOT NULL制約が付加されます。
  • コンテナタイプに時系列コンテナを選択した場合、1行目のカラムのデータ型はTIMESTAMPで固定され、索引の設定は行えなくなります。また、NOT NULL制約が付加されます。
• コンテナツリーへの追加
  • コンテナの作成に成功すると、コンテナツリーのデータベースの下に一時ワークフォルダが作成され、その下に作成したコンテナが自動的に追加されます。

【メモ】

• 設定項目の詳細は『GridDB APIリファレンス』(GridDB_API_Reference.html)を参照ください。

概要

コンテナのカラムや索引の設定情報が表示されます。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	Container	Details

画面

機能

コンテナ詳細画面には以下の機能があります。

• コンテナのパラメータ表示
  • コンテナ名やコンテナタイプなど、コンテナのパラメータを表示します。
• コンテナのカラム情報表示
  • コンテナのカラム情報として以下の情報を表示します。
    • カラム名、データ型、カラム制約、索引、圧縮情報(時系列コンテナのみ)

概要

コンテナのカラムごとの索引の作成、削除ができます。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	Container	Index

画面

機能

索引設定画面には以下の機能があります。

• カラムへの索引設定 (◆Build/Rebuild Index)
  • チェックボックスを選択/選択解除し、Applyボタンを押すことで対象の索引を作成/削除できます。
  • テキストボックスで索引名を設定することができます。
  • Resetボタンを押すと、変更した内容が初期状態に戻ります。

【メモ】

• 索引名を変更して設定した場合、索引は再作成されます。

概要

コンテナのトリガ作成、編集、削除ができます。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	Container	Trigger

画面

機能

トリガ設定画面には以下の機能があります。

• トリガの作成 (◆Create Trigger)
  • Newを押すと新規トリガの設定入力部が表示されます。設定後にApplyボタンを押すことで、コンテナにトリガを作成できます。
  • 設定入力部でClearボタンを押すと、設定が初期状態に戻ります。
  • トリガ名(Name)、監視対象操作(Action)、通知先URI(Destination URI)は必須項目です。通知方法(Type)をJMSに設定した場合は、JMS設定の通知名(Destination Name)が必須となります。
  • 通知方法(Type)にはRESTとJMSがあります。通知方法によって、設定項目が変わります。
  • 監視対象操作(Action)はPUT、DELETEをチェックボックスで設定します。
  • 監視対象カラム(Notify Column members)はチェックボックスで設定します。
• トリガの編集 (◆Edit Trigger)
  • 作成済みのトリガが表示され、トリガ名を押すとトリガの編集部が表示されます。
  • 編集できるのは通知先URI(Destination URI)と、JMS設定のみです。
  • Applyボタンを押すと編集内容が保存されます。
  • Deleteボタンを押すとトリガを削除できます。
  • Clearボタンを押すと編集できる項目の内容が空になります。

【メモ】

• 詳細は『GridDB APIリファレンス』(GridDB_API_Reference.html)を参照ください。

概要

コンテナに対してTQL(問合せ言語)を実行し、その結果を表示します。

利用方法

ツリーの種類	操作対象	タブ名
コンテナツリー	Container	TQL

画面

機能

TQL画面には以下の機能があります。

• TQL実行 (◆TQL)
  • TQL文を入力し、Executeボタンを押すと実行されます。結果は◆Resultに表示されます。
  • 改行して入力できますが、実行できるTQL文は1文のみです。
  • 操作対象のコンテナに対して実行するため、from句は省略できます。
  • Clearボタンで入力を削除できます。
  • Display Limitで表示する行数の制限を行います。
• リザルト表示 (◆Result)
  • ヒット件数と、実行時間(ミリ秒)、ヒットしたロウ(表形式)を表示します。
    • 実行時間はTQL文の実行時間がミリ秒で表示されます。
    • NULL値は(NULL)と表示されます。BLOB型のカラム値は(BLOB)と表示されます。

【メモ】

• TQLに関する詳細は『GridDB APIリファレンス』(GridDB_API_Reference.html)を参照ください。

既に稼働中のクラスタをgs_adminで管理するには、リポジトリ管理機能を活用します。以下の手順を実施します。

1. ログイン画面でrepository managerを選択し、gs_adminの管理ユーザでログインします。
2. Syncボタンを押し、稼働中のクラスタのいずれかのノードの下記の情報を入力してSyncを押して同期を行います。
   • IPアドレスにはノード定義ファイル(gs_node.json)の /system/serviceAddress を指定します。
   • ポートにはノード定義ファイル(gs_node.json)の /system/servicePort を指定します。
3. 稼働中のクラスタの情報がクラスタ一覧とノード一覧に反映されます。
4. Saveボタンを押してリポジトリ情報を保存します。
5. Logoutボタンを押してログイン画面に戻ります。
6. ログイン画面のclusterから稼働中のクラスタ名を選択します。
7. gs_adminの管理ユーザまたは利用ユーザでログインして運用機能の利用を開始します。

1つのgs_adminで複数クラスタの管理を行う場合には、gs_admin利用ユーザの設定に注意が必要です。

gs_admin利用ユーザは単一のファイルで管理を行うため、例えば、複数のクラスタで別々のパスワードを使っている管理ユーザを、すべてのクラスタを管理するgs_admin利用ユーザとして指定することはできません。

そのため、管理の方法によって適切な設定を行う必要があります。

• 複数クラスタをそれぞれ別の利用者が管理する場合
  • それぞれのgs_admin利用ユーザを異なる名前としてください。
• 複数クラスタを1人の利用者が管理する場合
  • 管理したいすべてのクラスタで、同じパスワードのgs_admin利用ユーザを登録してください。

以下では、新たにgs_admin利用ユーザを登録する手順を示します。

1. 新しいユーザで管理したいクラスタのうち1つのノードで、gs_adduserコマンドを使用し、管理ユーザを追加します。

   例：新規ユーザ名/パスワードがgs#newuser/newuserの場合

   $ su - gsadm
   $ gs_adduser gs#newuser -p newuser
   $ cat /var/lib/gridstore/conf/password
   admin,8c6976e5b5410415bde908bd4dee15dfb167a9c873fc4bb8a81f6f2ab448a918
   gs#newuser,9c9064c59f1ffa2e174ee754d2979be80dd30db552ec03e7e327e9b1a4bd594e
   system,6ee4a469cd4e91053847f5d3fcb61dbcc91e8f0ef10be7748da4c4a1ba382d17
   

2. そのユーザで管理したいクラスタの他のすべてのノードに、上記のユーザ定義ファイルを配布します。
3. すべてのノードを再起動、クラスタを再構成します。
4. Tomcat実行ユーザで、上記で追加したユーザ名およびパスワードを、gs_adminのユーザ定義ファイルに追加します。

   例：新規ユーザ名/パスワードがgs#newuser/newuserの場合

   $ echo gs#newuser,9c9064c59f1ffa2e174ee754d2979be80dd30db552ec03e7e327e9b1a4bd594e >> /var/lib/gridstore/admin/conf/password
   

gs_shを利用するには、あらかじめ以下を実施ください。

• GridDBのセットアップ
  • GridDBノード、クライアントライブラリのインストール
  • ユーザ作成
  • ネットワーク設定（GridDBクラスタ定義ファイル、ノード定義ファイル）

  　※　手順の詳細に関しては、『GridDB クイックスタートガイド』(GridDB_QuickStartGuide.html)の「システム設計・構築」の章を参照ください。

• SSHによるリモート接続設定
  • gs_sh実行環境から各GridDBノード実行環境へ、OSユーザ「gsadm」でSSH接続するための設定

  　※　SSH接続の手順の詳細に関しては、各OSのマニュアルを参照ください。

gs_shには2種類の起動モードがあります。

• 対話モードで起動
  • gs_shを引数なしで実行すると、対話モードで起動されます。gs_shのプロンプトが表示され、サブコマンドの入力が可能になります。
  • 例)

  $ gs_sh
  //サブコマンド「version」の実行
  gs> version
  gs_sh version 2.0.0
  

  【メモ】

  • 対話モードでサブコマンドを起動すると、
    • 実行ユーザのホームディレクトリに.gssh_historyファイルが作成され、履歴が保存されます。
    • 矢印キーを押すと以前起動したサブコマンドを20個まで、表示/実行することができます。
    • サブコマンドの一部を入力しTabキーを押すと、サブコマンドの入力候補が一覧表示されます。
• バッチモードで起動
  • gs_shにユーザ作成のスクリプトファイルを指定すると、バッチモードで起動されます。スクリプトファイルに記述した一連のサブコマンドをバッチ処理します。バッチ処理実行後に、gs_shは終了します。
  • 例)

  //スクリプトファイル(test.gsh)を指定して実行
  $ gs_sh test.gsh
  

【メモ】

• gs_shは、OSユーザ「gsadm」で実行してください。
• gs_sh起動時に、gsadmユーザホームディレクトリ下の.gsshrcスクリプトファイルを自動的に読み込みます。.gsshrcの内容は、他のスクリプトファイルよりも先に読み込みます。
• スクリプトファイルの拡張子はgshです。
• スクリプトファイルは、文字コードUTF-8で記載します。

GridDBノードのIPアドレスとポート番号を、ノード変数に定義します。

• サブコマンド

  setnode

  ノード変数名　IPアドレス　ポート番号　[SSHポート番号]

• 各引数の説明

  引数	説明
  ノード変数名	ノード変数名を指定します。既に同じ変数名が存在する場合は、定義を上書きします。
  IPアドレス	GridDBノードのIPアドレス（運用管理ツール接続用）を指定します。
  ポート番号	GridDBノードのポート番号（運用管理ツール接続用）を指定します。
  SSHポート番号	SSHのポート番号を指定します。省略する場合は22番を使用します。

• 例)

  //4つのGridDBノードを定義
  gs> setnode node0 192.168.0.1 10000
  gs> setnode node1 192.168.0.2 10000
  gs> setnode node2 192.168.0.3 10000
  gs> setnode node3 192.168.0.4 10000
  

【メモ】

• ノード変数名に利用できるのは半角英数字と記号"_"のみです。
• 運用管理ツール接続用GridDBノード「IPアドレス」および「ポート番号」は、各ノードの ノード定義ファイル で確認ください。
  • 「IPアドレス」：　/system/serviceAddress
  • 「ポート番号」：　/system/servicePort

　

GridDBクラスタの構成を、クラスタ変数に定義します。

• サブコマンド

  setcluster	<クラスタ変数名> <クラスタ名> <マルチキャストアドレス> <ポート番号> [<ノード変数>...]
  setcluster	<クラスタ変数名> <クラスタ名> FIXED_LIST <固定リスト方式のアドレスリスト> [<ノード変数>...]
  setcluster	<クラスタ変数名> <クラスタ名> PROVIDER <プロバイダ方式のURL> [<ノード変数>...]

• 各引数の説明

  引数	説明
  クラスタ変数名	クラスタ変数名を指定します。既に同じ変数名が存在する場合は、定義を上書きします。
  クラスタ名	クラスタ名を指定します。
  マルチキャストアドレス	[マルチキャスト方式の場合] GridDBクラスタのマルチキャストアドレス（クライアント接続用）を指定します。
  ポート番号	[マルチキャスト方式の場合]GridDBクラスタのマルチキャストポート番号（クライアント接続用）を指定します。
  ノード変数...	GridDBクラスタを構成するノードをノード変数で指定します。
  	データ操作サブコマンドでクラスタ変数を利用する場合、ノード変数の指定は省略可能です。
  固定リスト方式のアドレスリスト	[固定リスト方式の場合] gs_cluster.jsonのcluster.notificationMemberのtransactionのアドレスとポートのリストを指定します。例) 192.168.15.10:10001,192.168.15.11:10001
  プロバイダ方式のURL	[プロバイダ方式の場合] gs_cluster.jsonのcluster.notificationProviderの値を指定します。

• 例)

  //GridDBクラスタ構成を定義
  gs> setcluster cluster0 name 200.0.0.1 1000 $node0 $node1 $node2
  

【メモ】

• クラスタ変数名に利用できるのは半角英数字と記号"_"のみです。
• ノード変数を利用する際には、変数名の先頭に"$"をつけます。
• クラスタ変数に定義する「クラスタ名」、「マルチキャストアドレス」、「ポート番号」は、各GridDBノードのクラスタ定義ファイルで確認ください。
  • 「クラスタ名」 ：　 /clustergs/clusterName
  • 「マルチキャストアドレス」：　 /transaction/notificationAddress
  • 「ポート番号」 ：　 /transaction/notificationPort

  ※GridDBクラスタを構成するノードのクラスタ定義ファイルは、すべて同一の設定内容である必要があります。設定内容が異なる場合、クラスタを構成することはできません。

　

また、定義したクラスタ変数に対して、ノード変数の追加、削除を行うことができます。

• サブコマンド

  modcluster

  クラスタ変数名　add｜remove　ノード変数名...

• 各引数の説明

  引数	説明
  クラスタ変数名	ノードの追加、削除を行うクラスタ変数名を指定します。
  add｜remove	ノード変数を追加する場合にはadd、ノード変数を削除する場合にはremoveを指定します。
  ノード変数...	クラスタ変数に追加、もしくは削除するノード変数を指定します。

• 例)

  //定義済みのGridDBクラスタ構成にノードを追加
  gs> modcluster cluster0 add $node3
  //定義済みのGridDBクラスタ構成からノードを削除
  gs> modcluster cluster0 remove $node3
  

【メモ】

• ノード変数を利用する際には、変数名の先頭に"$"をつけます。

　

GridDBクラスタ構成にSQLの接続先を定義します。 GridDB NewSQLインターフェースを使用する場合のみ設定します。

• サブコマンド

  setclustersql	<クラスタ変数名> <クラスタ名> <SQLアドレス> <SQLポート番号>
  setclustersql	<クラスタ変数名> <クラスタ名> FIXED_LIST <固定リスト方式のSQLアドレスリスト>
  setclustersql	<クラスタ変数名> <クラスタ名> PROVIDER <プロバイダ方式のURL>

• 各引数の説明

  引数	説明
  クラスタ変数名	クラスタ変数名を指定します。既に同じ変数名が存在する場合は、SQL接続情報を上書きします。
  クラスタ名	クラスタ名を指定します。
  SQLアドレス	[マルチキャスト方式の場合] SQLクライアント接続用の受信アドレスを指定します。
  SQLポート番号	[マルチキャスト方式の場合] SQLクライアント接続用のポート番号を指定します。
  固定リスト方式のSQLアドレスリスト	[固定リスト方式の場合] gs_cluster.jsonのcluster.notificationMemberのsqlのアドレスとポートのリストを指定します。 例) 192.168.15.10:20001,192.168.15.11:20001
  プロバイダ方式のURL	[プロバイダ方式の場合] gs_cluster.jsonのcluster.notificationProviderの値を指定します。

• 例)

  // NewSQLサーバに対して、NoSQLインタフェースとNewSQLインタフェースの両方を用いて接続する場合の定義方法
  gs> setcluster    cluster0 name 239.0.0.1 31999 $node0 $node1 $node2
  gs> setclustersql cluster0 name 239.0.0.1 41999
  

【メモ】

• クラスタ変数名に利用できるのは半角英数字と記号"_"のみです。
• GridDB NewSQLインターフェースを使用する場合のみ設定します。
• 既存のクラスタ変数名を指定するとSQL接続情報部分のみ上書きします。上書きする際は、既存の接続方式と同じ方式を指定する必要があります。
• SQLのみ使用する場合はこのコマンドだけ実行します。
• クラスタ変数に定義する「SQLアドレス」、「SQLポート番号」は、各GridDBノードのクラスタ定義ファイルで確認ください。
  • 「SQLアドレス」 ：　 /sql/notificationAddress
  • 「SQLポート番号」 ：　 /sql/notificationPort

GridDBクラスタにアクセスするユーザおよびパスワードを定義します。

• サブコマンド

  setuser

  ユーザ名　パスワード　[gsadmパスワード]

• 各引数の説明

  引数	説明
  ユーザ名	GridDBクラスタにアクセスするユーザ名を指定します。
  パスワード	対応するパスワードを指定します。
  gsadm パスワード	OSユーザ gsadmのパスワードを指定します。
  	ノード起動(startnodeサブコマンド)を実行しない場合は、省略可能です。

• 例)

  //GridDBクラスタにアクセスするユーザ、パスワード、およびgsadmのパスワードを定義
  gs> setuser admin admin gsadm
  

【メモ】

• ユーザ定義は以下の変数に分割して格納します。

  変数名	格納する情報
  user	ユーザ名
  password	パスワード
  ospassword	gsadmパスワード

• 複数ユーザは定義できません。後から定義したユーザ、パスワードで上書きします。gs_shで複数のGridDBクラスタを操作する場合には、接続先クラスタを変更する度にsetuserサブコマンドでユーザ、パスワードを再設定ください。

　

任意の変数を定義します。

• サブコマンド

  set

  変数名　[値]

• 各引数の説明

  引数	説明
  変数名	変数名を指定します。
  値	設定値を指定します。指定を省略することで、当該変数の設定値をクリアできます。

• 例)

  //変数を定義
  gs> set GS_PORT 10000
  //変数の設定をクリア
  gs> set GS_PORT
  

【メモ】

• setサブコマンドにより、ノード変数やクラスタ変数の設定もクリアできます。
• 変数名に利用できるのは半角英数字と記号"_"のみです。

　

指定した変数の定義内容を表示します。

• サブコマンド

  show

  [変数名]

• 各引数の説明

  引数	説明
  変数名	定義内容を表示する変数名を指定します。指定を省略すると、すべての定義済み変数の内容を表示します。

• 例)

  //定義した全変数を定表示
  gs> show
  ノード変数:
    node0=Node[192.168.0.1:10000,ssh=22]
    node1=Node[192.168.0.2:10000,ssh=22]
    node2=Node[192.168.0.3:10000,ssh=22]
    node3=Node[192.168.0.4:10000,ssh=22]
  クラスタ変数:
    cluster0=Cluster[name=name,200.0.0.1:1000,nodes=(node0,node1,node2)]
  その他の変数:
    user=admin
    password=*****
    ospassword=*****
  

【メモ】

• パスワード文字列は表示しません。"*****"に置き換えて表示します。

　

変数に定義した内容をスクリプトファイルに保存します。

• サブコマンド

  save	[スクリプトファイル名]

• 各引数の説明

  引数	説明
  スクリプトファイル名	保存先となるスクリプトファイル名を指定します。スクリプトファイルの拡張子はgshです。
  	指定を省略すると、gsadmユーザホームディレクトリの.gsshrcファイルに保存します。

• 例)

  //定義した変数をファイルに保存
  gs> save test.gsh
  

【メモ】

• 保存先スクリプトファイルが存在しない場合、ファイルを新規作成します。保存先スクリプトファイルが存在する場合、内容を上書きします。
• スクリプトファイルは、文字コードUTF-8で記載します。
• ユーザ定義に関する内容（ユーザ、パスワード、gsadmパスワード）はスクリプトファイルに出力しません。
• .gsshrcスクリプトファイルの内容は、gs_sh起動時に自動的に読み込みます。

　

スクリプトファイルを読み込み実行します。

• サブコマンド

  load	[スクリプトファイル名]

• 各引数の説明

  引数	説明
  スクリプトファイル名	実行するスクリプトファイルを指定します。
  	指定を省略すると、gsadmユーザホームディレクトリの.gsshrcファイルを再度読み込みます。

• 例)

  //スクリプトファイルを実行
  gs> load test.gsh
  

【メモ】

• スクリプトファイルの拡張子はgshです。
• スクリプトファイルは、文字コードUTF-8で記載します。

　

本節では、GridDBノードとGridDBクラスタのステータスについて説明します。

クラスタは、1台以上のノードから構成されます。
ノードは、起動・停止などのノード自身の状態をステータスとして持ちます。
クラスタは、クライアントからのデータ操作の受付可否の状態を表すステータスを持ちます。クラスタステータスは、クラスタを構成するノード群のステータスに応じて決まります。

以下は、gs_shのサブコマンド操作による、ノードステータスとクラスタステータスの遷移の例です。
クラスタはノード4台で構成されています。
クラスタを構成するノードを起動(startnode)すると、ノードステータスが「起動」になります。ノードを起動したうえでクラスタを開始(startcluster)すると、各ノードステータスがクラスタへの「参加」に変わり、さらに、クラスタステータスが「稼働」になります。

以下、ノードステータスとクラスタステータスについての詳細を説明します。

• ノードステータス

ノードの起動・停止・参加・離脱の操作により、ノードのステータスが「停止」「起動」「参加」に遷移します。
ノードがクラスタに参加した場合には、参加したクラスタのステータスに応じて2種類の状態があります。

ステータス	ステータス名	説明
参加	SERVICING	ノードはクラスタに参加済みで、参加しているクラスタのステータスが「稼働」
	WAIT	ノードはクラスタに参加済みで、参加しているクラスタのステータスが「中断」
起動	STARTED	ノードは起動済みで、クラスタには参加していない
	STARTING	ノード起動中
停止	STOP	ノード停止
	STOPPING	ノード停止処理中

　

• クラスタステータス

  GridDBクラスタの稼働開始・稼働停止、または、GridDBノードの参加・離脱の操作により、GridDBクラスタの状態が、「停止」、「中断」、「稼働」のステータスに遷移します。GridDBクラスタのステータスが「稼働」の場合のみ、クライアントからのデータ操作を受け付けることが可能です。

  

  クラスタステータス

  ステータス	ステータス名	説明
  稼働	SERVICE_STABLE	クラスタ構成に定義されているすべてのノードがクラスタに参加している
  	SERVICE_UNSTABLE	クラスタ構成に定義されているノードの半数超がクラスタに参加している
  中断	WAIT	クラスタ構成に定義されているノードの半数以上がクラスタから離脱している
  	INIT_WAIT	クラスタ構成に定義されているノードの1台以上がクラスタから離脱している（初めてクラスタを稼働するときは、すべてのノードがクラスタに参加しなければ「稼働」状態にならない）
  停止	STOP	クラスタ構成に定義されているすべてのノードがクラスタから離脱している

  GridDBクラスタを構成する全ノードをクラスタへ参加させることで、GridDBクラスタのステータスが「停止」から「稼働」へ遷移します。また、半数以上のノード離脱でGridDBクラスタは「中断」、全ノード離脱でGridDBクラスタは「停止」します。

  クラスタステータスを遷移させる参加・離脱の操作については、クラスタ構成の全ノードに対して行われる操作と、1台のノードに行われる操作の2種類があります。

  		操作対象が全ノードの場合	操作対象がノード1台の場合
  操作	参加	startcluster　未参加の稼働ノード群を一括参加	joincluster　未参加の稼働ノードを参加
  	離脱	stopcluster　参加中のノード群を一括離脱	leavecluster　参加中のノードを離脱

【メモ】

• 稼働中のノードのみ、クラスタの参加および離脱操作を行うことができます。
• 障害が発生したノードは、自動的にGridDBクラスタから離脱します。
• GridDBクラスタのステータスは、クラスタステータス情報表示サブコマンド(configcluster)で確認することができます。

　

各操作方法について、以下に説明します。　

指定ノードを起動します。

• サブコマンド

  startnode

  ノード変数｜クラスタ変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  ノード変数｜クラスタ変数	起動するノードを、ノード変数もしくはクラスタ変数で指定します。
  	クラスタ変数を指定した場合、クラスタ変数に定義された全ノードを起動します。
  タイムアウト秒数	ノード起動完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //ノードの起動
  gs> startnode $node1
  ノード node1 を起動します。
  すべてのノードが起動しました。
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• 起動完了を待ち合わせることで、クラスタ起動処理（startclusterサブコマンド）をバッチ実行できます。

　

指定ノードを停止します。

• サブコマンド

  stopnode

  ノード｜クラスタ変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  ノード｜クラスタ変数	停止するノードを、ノード変数もしくはクラスタ変数で指定します。
  	クラスタ変数を指定した場合、クラスタ変数に定義された全ノードを停止します。
  タイムアウト秒数	ノード停止完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //ノードの停止
  gs> stopnode $node1
  ノード node1 を停止します。
  ノード node1 が停止処理を開始しました。
  ノードの停止処理の完了を待っています。
  すべてのノードが停止しました。
  

また、指定ノードを強制停止することもできます。

• サブコマンド

  stopnodeforce

  ノード｜クラスタ変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  ノード｜クラスタ変数	強制停止するノードを、ノード変数もしくはクラスタ変数で指定します。
  	クラスタ変数を指定した場合、クラスタ変数に定義された全ノードを強制停止します。
  タイムアウト秒数	ノード停止完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //ノードの強制停止
  gs> stopnodeforce $node1
  ノード node1 を停止します。
  ノード node1 が停止処理を開始しました。
  ノードの停止処理の完了を待っています。
  すべてのノードが停止しました。
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• stopnodeサブコマンドでは、GridDBクラスタに参加中のノードは停止できません。stopnodeforceコマンドではGridDBクラスタに参加中のノードも停止できますが、データがロストする恐れがあります。

　

指定クラスタを稼働状態にするため、クラスタ未参加の稼働ノード群を一括参加させます。

• サブコマンド

  startcluster

  クラスタ変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  クラスタ変数	GridDBクラスタを、クラスタ変数で指定します。
  タイムアウト秒数	クラスタへのノード参加の完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //GridDBクラスタの起動
  gs> startcluster $cluster1
  クラスタの開始を待っています。
  クラスタが開始しました。
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• 「停止」状態のGridDBクラスタを「稼働」状態にするには、全ノードをクラスタに参加させる必要があります。あらかじめGridDBクラスタを構成する全ノードが稼働中であることを確認下さい。

GridDBクラスタを停止するために、GridDBクラスタ参加中のノード群を一括離脱させます。

• サブコマンド

  stopcluster

  クラスタ変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  クラスタ変数	GridDBクラスタを、クラスタ変数で指定します。
  タイムアウト秒数	クラスタの離脱完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //GridDBクラスタを停止
  gs> stopcluster $cluster1
  クラスタの停止を待っています。
  クラスタが停止しました。
  

　

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。

　

leaveclusterサブコマンドや障害などによってGridDBクラスタから一旦離脱したノードを、GridDBクラスタに再度参加させます。

• サブコマンド

  joincluster

  クラスタ変数　ノード変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  クラスタ変数	GridDBクラスタを、クラスタ変数で指定します。
  ノード変数	参加させるノードを、ノード変数で指定します。
  タイムアウト秒数	クラスタへの参加完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //ノード起動
  gs> startnode $node2
  ノード node2 を起動します。
  すべてのノードが起動しました。
  //ノード参加
  joincluster $cluster1 $node2
  ノードがクラスタに参加するのを待っています。
  ノードがクラスタに参加しました。
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• GridDBクラスタに参加できるのは、稼働中のノードのみです。参加させるノードが稼働中であることを確認ください。
• クラスタ変数に定義していないノードを参加させる場合には、appendclusterサブコマンドを利用します。

　

指定ノードを稼働中のGridDBクラスタから離脱させます。

• サブコマンド

  leavecluster	ノード変数　[ タイムアウト秒数 ]
  leaveclusterforce	ノード変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  ノード変数	離脱するノードを、ノード変数で指定します。
  タイムアウト秒数	クラスタからのノード離脱完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //ノードの離脱
  gs> leavecluster $node2
  ノードがクラスタから離脱するのを待っています。
  ノードがクラスタから離脱しました。
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• GridDBクラスタから安全にノードを離脱できるのは他ノードにデータが複製されている場合ですが、leaveclusterサブコマンドは複製の有無にかかわらずノードを強制的に離脱するため、常にデータがロストする恐れがあります。安全にノードを離脱するにはgs_leaveclusterコマンドを使用ください。データ複製に関する設定の詳細は、『GridDB クイックスタートガイド』(GridDB_QuickStartGuide.html)の「システム設計・構築 - チューニングパラメータを設計する 」の節を参照ください。
• leaveclusterforceは、離脱によってデータをロストする恐れがある場合でも、ノードを強制的に離脱させます。

クラスタ変数に定義していないノードを、稼働中のGridDBクラスタに参加させます。

• サブコマンド

  appendcluster

  クラスタ変数　ノード変数　[ タイムアウト秒数 ]

• 各引数の説明

  引数	説明
  クラスタ変数	GridDBクラスタを、クラスタ変数で指定します。
  ノード変数	参加させるノードを、ノード変数で指定します。
  タイムアウト秒数	クラスタへノード増設完了の待合わせ時間を指定します。
  	-1を指定した場合、即時復帰します。指定がない、または0を指定した場合、時間制限無しで待ち合わせます。

• 例)

  //ノードを定義
  gs> setnode node5 192.168.0.5 10044
  //ノードを起動
  gs> startnode $node5
  //ノードを増設
  gs> appendcluster $cluster1 $node5
  ノードがクラスタに追加されるのを待っています。
  ノードがクラスタに追加されました。
  クラスタ変数 $cluster1にノード変数$node5を追加します。(変数の変更を保存する場合 はsaveコマンドを実行してください。)
  
  Cluster[name=name1,239.0.5.111:33333,nodes=($node1,$node2,$node3,$node4,$node5)]
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• 新規ノードを増設するには、GridDBクラスタを構成する全ノードがクラスタに参加している必要があります。GridDBクラスタから離脱しているノードがあれば、予めすべて参加させてください。また、増設する新規ノードは稼働中であることを確認ください。
• appendclusterサブコマンド実行時に、増設対象のノード変数をクラスタ変数に自動追加します。クラスタ変数定義を手動で変更する必要はありません。
• 変数を変更した場合、saveコマンドを実行して情報を保存してください。保存していない内容は破棄されます。
• 新規ノードのセットアップに関しては、『GridDB クイックスタートガイド』(GridDB_QuickStartGuide.html)の「システム設計・構築」の章を参照ください。

GridDBクラスタのステータス、クラスタを構成する各ノードのステータスを表示します。

• サブコマンド

  configcluster

  クラスタ変数

• 各引数の説明

  引数	説明
  クラスタ変数	GridDBクラスタを、クラスタ変数で指定します。

• 例)

  //クラスタの情報を表示
  gs> configcluster $cluster1
  Name                  : cluster1
  ClusterName           : defaultCluster
  Designated Node Count : 4
  Active Node Count     : 4
  ClusterStatus         : SERVICE_STABLE
  
  Nodes:
    Name    Role Host:Port              Status
  -------------------------------------------------
    node1     F  10.45.237.151:10040    SERVICING 
    node2     F  10.45.237.152:10040    SERVICING 
    node3     M  10.45.237.153:10040    SERVICING 
    node4     F  10.45.237.154:10040    SERVICING
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• ClusterStatusは、以下のいずれかになります。
  • INIT_WAIT ：クラスタ構成待ち
  • SERVICE_STABLE ：稼働中
  • SERVICE_UNSTABLE ：中断中(指定した構成ノード数に達していない)
• Roleは、以下のいずれかになります。
  • M：MASTER(マスタ)
  • F：FOLLOWER(フォロワ)
  • S：SUB_CLUSTER(マスタになる候補で一時的な状態)
  • -：未稼働

GridDBクラスタの構成情報を表示します。

• サブコマンド

  config

  ノード変数

• 各引数の説明

  引数	説明
  ノード変数	表示対象のGridDBクラスタに所属するノードを、ノード変数で指定します。

• 例)

  //クラスタの構成情報を表示
  gs> config $node1
  {
    "follower" : [ {
      "address" : "10.45.237.151",
      "port" : 10040
    }, {
      "address" : "10.45.237.152",
      "port" : 10040
    }, {
      "address" : "10.45.237.153",
      "port" : 10040
    }, {
      "address" : "10.45.237.154",
      "port" : 10040
    } ],
    "master" : {
      "address" : "10.45.237.155",
      "port" : 10040
    },
    "multicast" : {
      "address" : "239.0.5.111",
      "port" : 33333
    },
    "self" : {
      "address" : "10.45.237.150",
      "port" : 10040,
      "status" : "ACTIVE"
    }
  }
  

　

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• 出力内容は、GridDBノードのバージョンにより異なります。詳細については、サポート窓口にお問い合わせください。

　

指定ノードの状態および統計情報を表示します。

• サブコマンド

  stat

  ノード変数

• 各引数の説明

  引数	説明
  ノード変数	表示対象のノードを、ノード変数で指定します。

• 例)

  //ノードの状態、統計情報を表示
  gs> stat $node1
  {
    "checkpoint" : {
      "archiveLog" : 0,
      "backupOperation" : 0,
      "duplicateLog" : 0,
      "endTime" : 1413852025843,
      "mode" : "NORMAL_CHECKPOINT",
               :
               :
  }
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• 出力内容は、GridDBノードのバージョンにより異なります。

指定ノードのログを表示します。

• サブコマンド

  logs

  ノード変数

• 各引数の説明

  引数	説明
  ノード変数	表示対象のノードを、ノード変数で指定します。

• 例)

  //ノードのログを表示
  gs> logs $node0
  2013-02-26T13:45:58.613+0900 c63x64n1 4051 INFO SYSTEM_SERVICE ../server/system_service.cpp void SystemService::joinCluster(const char8_t*, uint32_t) line=179 : joinCluster requested (clusterName="defaultCluster", minNodeNum=1) 
  2013-02-26T13:45:58.616+0900 c63x64n1 4050 INFO SYSTEM_SERVICE ../server/system_service.cpp virtual void SystemService::JoinClusterHandler::callback(EventEngine&, util::StackAllocator&, Event*, NodeDescriptor) line=813 : ShutdownClusterHandler called g
  2013-02-26T13:45:58.617+0900 c63x64n1 4050 INFO SYSTEM_SERVICE ../server/system_service.cpp void SystemService::completeClusterJoin() line=639 : completeClusterJoin requested 
  2013-02-26T13:45:58.617+0900 c63x64n1 4050 INFO SYSTEM_SERVICE ../server/system_service.cpp virtual void SystemService::CompleteClusterJoinHandler::callback(EventEngine&, util::StackAllocator&, Event*, NodeDescriptor) line=929 : CompleteClusterJoinHandler called
  

　

また、ログの出力レベル表示、および変更ができます。

• サブコマンド

  logconf

  ノード変数 [カテゴリ名 [ログレベル] ]

• 各引数の説明

  引数	説明
  ノード変数	操作対象のノードを、ノード変数で指定します。
  カテゴリ名	操作対象のログカテゴリ名を指定します。省略した場合、全ログカテゴリの出力レベルを 表示 します。
  ログレベル	ログレベルを指定すると、指定カテゴリのログレベルを 変更 します。
  	省略すると、指定カテゴリのログレベルを 表示 します。

• 例)

  //ノードのログレベルを表示
  gs> logconf $node0
  {
    "CHECKPOINT_SERVICE" : "INFO",
    "CHUNK_MANAGER" : "ERROR",
    "CLUSTER_OPERATION" : "INFO",
    "CLUSTER_SERVICE" : "ERROR",
    "COLLECTION" : "ERROR",
    "DATA_STORE" : "ERROR",
    "EVENT_ENGINE" : "WARNING",
    "HASH_MAP" : "ERROR",
    "IO_MONITOR" : "WARNING",
    "LOG_MANAGER" : "WARNING",
    "MAIN" : "ERROR",
    "OBJECT_MANAGER" : "INFO",
    "RECOVERY_MANAGER" : "INFO",
    "REPLICATION" : "WARNING",
    "REPLICATION_TIMEOUT" : "WARNING",
    "SESSION_TIMEOUT" : "WARNING",
    "SYNC_SERVICE" : "ERROR",
    "SYSTEM_SERVICE" : "INFO",
    "TIME_SERIES" : "ERROR",
    "TRANSACTION_MANAGER" : "ERROR",
    "TRANSACTION_SERVICE" : "ERROR",
    "TRANSACTION_TIMEOUT" : "WARNING",
    "TRIGGER_SERVICE" : "ERROR"
  }
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• ログレベルはERROR、WARNING、INFO、DEBUGです。ログレベルの変更は、必ずサポート窓口の指示に従ってください。
• ノードの再起動により、ログレベルは初期化されます。ログレベルの変更内容は保持されません。
• 複数カテゴリのログレベルを一括変更することはできません。
• 出力内容は、GridDBノードのバージョンにより異なります。詳細については、サポート窓口にお問い合わせください。

データ操作を実行するGridDBクラスタに接続します。

• サブコマンド

  connect

  クラスタ変数 [データベース名]

• 各引数の説明

  引数	説明
  クラスタ変数	接続先となるGridDBクラスタを、クラスタ変数で指定します。
  データベース名	データベース名を指定します。

• 例)

  //GridDBクラスタに接続
  //NoSQLの場合
  gs> connect $cluster1
  接続に成功しました(NoSQL)。
  gs[public]> 
  
  gs> connect $cluster1 userDB
  接続に成功しました(NoSQL)。
  gs[userDB]> 
  
  //NewSQLの場合（NoSQL/NewSQLインタフェースの両方を設定)
  gs> connect $cluster1
  接続に成功しました(NoSQL)。
  接続に成功しました(NewSQL)。
  gs[public]> 
  
  
  

【メモ】

• データベース名が指定されているとそのデータベースに接続します。データベース名省略時は「public」データベースに接続します。
• connectが成功するとプロンプトに接続先データベース名が表示されます。
• 変数を利用する際には、変数名の先頭に"$"をつけます。
• データ操作サブコマンドを実行する場合、GridDBクラスタに接続する必要があります。
• SQL接続先が指定されている場合(setclustersqlサブコマンドの実行)は、SQL接続も行われます。

検索を実行し、検索結果を保持します。

• サブコマンド

  tql	コンテナ名　クエリ　;

• 各引数の説明

  引数	説明
  コンテナ名	検索対象となるコンテナを指定します。
  クエリ　;	実行するTQL文を指定します。TQL文の最後にはセミコロン(;)が必要です。

• 例)

  //検索を実行
  gs[public]> tql c001 select *;
  5 件ヒットしました。
  

【メモ】

• データ操作サブコマンドを実行する場合、GridDBクラスタに接続する必要があります。
• TQL文の途中に改行を挿入可能です。
• 最新の検索結果を保持します。検索結果は、tqlまたはsqlサブコマンド実行時に破棄します。
• TQLの詳細に関しては、『GridDB APIリファレンス』(GridDB_API_Reference.html)の「TQL構文・演算機能」の章を参照ください。
• パーティションテーブル(コンテナ)は非対応です。実行した場合はエラーとなります。

　

SQL文を実行し、検索結果を保持します。 この機能はGridDB Advanced Edition / Vector Editionでのみ実行できます。

• サブコマンド

  sql

  SQL文　;

• 各引数の説明

  引数	説明
  SQL文　;	実行するSQL文を指定します。SQL文の最後にはセミコロン(;)が必要です。

• 例)

  gs[public]> sql select * from con1;          → SQLの検索
  10,000 件ヒットしました。
  gs[public]> get 1                            → SQLの結果表示
  id,name
  ----------------------
  0,tanaka
  
  
  

【メモ】

• sqlコマンド実行前に、SQL接続先を指定して接続connectを行っている必要があります。
• 最新の検索結果を保持します。検索結果は、sqlまたはtqlサブコマンド実行時に破棄します。
• SQL文の種類により、以下のように結果が表示されます。

  処理	正常終了時の実行結果
  検索　SELECT	検索結果の件数を表示します。検索結果はサブコマンドget/getcsv/getnoprintで表示します。
  更新　INSERT/UPDATE/DELETE	更新したロウ数を表示します。
  DDL文	何も表示されません。

• SQLの詳細に関しては、『GridDB APIリファレンス』(GridDB_API_Reference.html)を参照ください。

　

保持する検索結果から、指定件数を取得します。結果の出力方法には以下の３種類があります。

（A）取得した結果を標準出力に表示します。

• サブコマンド

  get

  [取得件数]

• 各引数の説明

  引数	説明
  取得件数	検索結果の取得件数を指定します。省略すると、全ての検索結果を取得して表示します。

（B）取得した結果をCSV形式でファイルに保存します。

• サブコマンド

  getcsv

  CSVファイル名　[取得件数]

• 各引数の説明

  引数	説明
  ファイル名	検索結果を保存するファイル名を指定します。
  取得件数	検索結果の取得件数を指定します。省略すると、全ての検索結果を取得してファイルに保存します。

（C）取得した結果を出力しません。

• サブコマンド

  getnoprint

  [取得件数]

• 各引数の説明

  引数	説明
  取得件数	検索結果の取得件数を指定します。省略すると、全ての検索結果を取得します。

• 例)

  //検索を実行
  gs[public]> tql c001 select *;
  5 件ヒットしました。
  
  //1件目を取得して表示
  gs[public]> get 1
  name,status,count
  mie,true,2
  1 件の取得が完了しました。
  
  //2〜3件目を取得してファイルに保存
  gs[public]> getcsv /var/lib/gridstore/test2.csv 2
  2 件の取得が完了しました。
  
  //4件目を取得
  gs[public]> getnoprint 1
  1 件の取得が完了しました。
  
  //5件目を取得して表示
  gs[public]> get 1
  name,status,count
  akita,true,45
  1 件の取得が完了しました。
  
  

【メモ】

• データ操作サブコマンドを実行する場合、GridDBクラスタに接続する必要があります。
• 検索結果の１行目には、列名を出力します。
• 検索未実行、検索結果の全件取得、もしくは検索結果の破棄後に、検索結果の取得を行うとエラーとなります。
• NULL値はコマンドによってそれぞれ以下のように出力されます。
  • get: (NULL)
  • getcsv: 引用符のない空文字

指定TQL文の実行計画を表示します。検索は実行しません。

• サブコマンド

  tqlexplain

  コンテナ名　クエリ　;

• 各引数の説明

  引数	説明
  コンテナ名	対象となるコンテナを指定します。
  クエリ　;	実行計画を取得するTQL文を指定します。TQL文の最後にはセミコロン(;)が必要です。

• 例)

  //実行計画を取得
  gs[public]> tqlexplain c001 select * ;
  0       0       SELECTION       CONDITION       NULL
  1       1       INDEX   BTREE   ROWMAP
  2       0       QUERY_EXECUTE_RESULT_ROWS       INTEGER 0
  

また、指定TQL文を実際に実行して、実行計画とともに処理行数等の実測値を表示することもできます。

• サブコマンド

  tqlanalyze

  コンテナ名　クエリ　;

• 各引数の説明

  引数	説明
  コンテナ名	対象となるコンテナを指定します。
  クエリ　;	実行計画を取得するTQL文を指定します。TQL文の最後にはセミコロン(;)が必要です。

• 例)

  //検索を実行して実行計画を取得
  gs[public]> tqlanalyze c001 select *;
  0       0       SELECTION       CONDITION       NULL
  1       1       INDEX   BTREE   ROWMAP
  2       0       QUERY_EXECUTE_RESULT_ROWS       INTEGER 5
  3       0       QUERY_RESULT_TYPE       STRING  RESULT_ROW_ID_SET
  4       0       QUERY_RESULT_ROWS       INTEGER 5
  

【メモ】

• データ操作サブコマンドを実行する場合、GridDBクラスタに接続する必要があります。
• 実行計画の詳細に関しては『GridDB APIリファレンス』(GridDB_API_Reference.html)の「TQL構文・演算機能」の章を参照ください。
• 検索結果は保持しないため、検索結果の取得はできず、tqlcloseサブコマンド実行の必要もありません。検索結果が必要な場合は、tqlサブコマンドでクエリを実行してください。
• パーティションテーブル(コンテナ)は非対応です。実行した場合はエラーとなります。

tqlをクローズ、保持する検索結果を破棄します。

• サブコマンド

  tqlclose

クエリをクローズ。保持する検索結果を破棄します。

• サブコマンド

  queryclose

• 例)

  //検索結果を破棄
  gs[public]> tqlclose
  
  gs[public]> queryclose
  

【メモ】

• 検索結果は、下記のタイミングで検索結果は破棄されます。
  • tqlclose　または　querycloseサブコマンド実行時
  • tqlまたはsqlサブコマンドによる新規検索実行時
  • disconnectサブコマンドによるGridDBクラスタからの切断時
• 検索結果の破棄後に検索結果の取得（getサブコマンドなど）を行うとエラーとなります。

GridDBクラスタから切断します。

• サブコマンド

  disconnect

• 例)

  //GridDBクラスタから切断
  gs[public]> disconnect
  gs> 
  
  

【メモ】

• 保持している検索結果は破棄します。
• 切断すると、プロンプトの接続データベース名の表示が無くなります。

指定された名前のデータベースを作成します。

• サブコマンド

  createdatabase

  データベース名

• 各引数の説明

  引数	説明
  データベース名	作成するデータベースの名前を指定します。

• 例)

  //"db1"という名前のデータベースを作成
  gs[public]> createdatabase db1
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 作成直後のデータベースは、管理ユーザのみがアクセスできます。必要に応じて一般ユーザにアクセス権を付与してください。

指定された名前のデータベースを削除します。

• サブコマンド

  dropdatabase

  データベース名

• 各引数の説明

  引数	説明
  データベース名	削除するデータベースの名前を指定します。

• 例)

  //以下のようなデータベースを削除
  //db1：データベース内にコンテナがない
  //db2：データベースが存在しない
  //db3：データベース内にコンテナがある
  
  gs[public]> dropdatabase db1　　　　　　　　　// 正常終了
  gs[public]> dropdatabase db2　　　　　　　　　// 異常終了
  D20340: データベース "db2"は存在しません。
  gs[public]> dropdatabase db3　　　　　　　　　// 異常終了
  D20336: データベース削除でエラーが発生しました。 : msg=[[145045:JC_DATABASE_NOT_EMPTY] Illegal target error by non-empty database.]
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• デフォルト接続先であるpublicデータベースは削除出来ません。

現在のカレントデータベース名を表示します。

• サブコマンド

  getcurrentdatabase

• 例)

  gs[db1]> getcurrentdatabase
  db1
  

データベース一覧およびアクセス権情報を表示します。

• サブコマンド

  showdatabase

  [データベース名]

• 各引数の説明

  引数	説明
  データベース名	表示するデータベースの名前を指定します。

• 例)

  gs[public]> showdatabase
  database     ACL
  ----------------------------
  public       ALL_USER
  db1          user1
  db2          user1
  db3          user3
  
  gs[public]> showdatabase db1
  database     ACL
  ----------------------------
  public       ALL_USER
  db1          user1
  

【メモ】

• 一般ユーザの場合は、アクセス権が付与されているデータベースのみが表示されます。管理ユーザの場合は、全てのデータベースの一覧が表示されます。

データベースへのアクセス権を付与します。

• サブコマンド

  grant

  データベース名 ユーザ名

• 各引数の説明

  引数	説明
  データベース名	アクセス権付与の対象となるデータベース名を指定します。
  ユーザ名	アクセス権を付与するユーザの名前を指定します。

• 例)

  gs[public]> grant db1 user001
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 既にアクセス権が付与されている場合は、エラーになります (データベース1つに1ユーザしか、アクセス権が付与できません）。アクセス権の剥奪("revoke"コマンド)を実行後、本コマンドを実行ください。

データベースへのアクセス権を剥奪します。

• サブコマンド

  revoke

  データベース名 ユーザ名

• 各引数の説明

  引数	説明
  データベース名	アクセス権剥奪の対象となるデータベース名を指定します。
  ユーザ名	アクセス権を剥奪するユーザの名前を指定します。

• 例)

  gs[public]> revoke db1 user001
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。

指定された名前の一般ユーザを作成します。

• サブコマンド

  createuser

  ユーザ名　パスワード

• 各引数の説明

  引数	説明
  ユーザ名	作成するユーザの名前を指定します。
  パスワード	作成するユーザのパスワードを指定します。

• 例)

  gs[public]> createuser user01 pass001
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。
• 先頭が"gs#"で始まる名前は管理ユーザ用なので、一般ユーザの名前としては指定できません。
• 管理ユーザを作成する場合、クラスタを構成する全ノードで gs_adduserコマンドを使用して作成してください。

指定された名前のユーザを削除します。

• サブコマンド

  dropuser

  ユーザ名

• 各引数の説明

  引数	説明
  ユーザ名	削除するユーザの名前を指定します。

• 例)

  gs[public]> dropuer user01
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。

パスワードを変更します。

• サブコマンド

  setpassword	パスワード （一般ユーザのみ）
  setpassword	ユーザ名　パスワード （管理ユーザのみ）

• 各引数の説明

  引数	説明
  パスワード	変更するパスワードを指定します。
  ユーザ名	パスワードを変更するユーザの名前を指定します。

【メモ】

• 一般ユーザは、自分のパスワードのみ変更可能です。
• 管理ユーザは、他の一般ユーザのパスワードのみ変更可能です。
  • 例)

  gs[public]> setpassword newPass009
  

ユーザ情報を表示します。

• サブコマンド

  showuser

  [ユーザ名]

• 各引数の説明

  引数	説明
  ユーザ名	表示するユーザの名前を指定します。

• 例)

  gs[public]> showuser
  UserName
  ------------------------------------
  user002
  user001
  user003
  
  gs[public]> showuser user001
  Name     : user001
  GrantedDB: public, userDB
  
  

【メモ】

• 管理ユーザのみが実行可能なコマンドです。

コンテナを作成します。

• サブコマンド
  • 簡易版

    コンテナ(コレクション)
    createcollection	コンテナ名　カラム名　タイプ　[カラム名　タイプ …]
    コンテナ(時系列コンテナ)
    createtimeseries	コンテナ名　圧縮方式　カラム名　タイプ　[カラム名　タイプ …]

  • 詳細版

    createcontainer

    コンテナ情報ファイル　[コンテナ名]

• 各引数の説明

  引数	説明
  コンテナ名	作成するコンテナの名前を指定します。createcontainerコマンドの場合に省略すると、コンテナ情報ファイルに記述されているコンテナ名でコンテナ作成します。
  カラム名	カラム名を指定します。
  タイプ	カラムのタイプを指定します。
  圧縮方式	時系列データの場合、データの圧縮方式を指定します。
  コンテナ定義ファイル	コンテナ情報をJSON形式で格納したファイルを指定します。

  簡易版

  コンテナ名とカラム情報（カラム名とタイプ）を指定してコンテナを作成します。コンテナタイプが時系列コンテナの場合のみ、圧縮タイプの指定も可能です。

  • 圧縮方式は、"NO", "SS"を指定します。"HI"を指定する場合は、詳細版を利用してください。
  • コレクションは、ロウキー指定ありで作成されます。第一カラムがロウキーになります。
  • カラム制約、索引名を指定する場合は、詳細版を利用してください。

  詳細版

  コンテナ定義情報をjsonファイルで指定してコンテナを作成します。

  • コンテナ定義情報は、エクスポートツールで出力されるメタ情報ファイルの定義ど同じです。カラムのタイプやデータの圧縮方式、コンテナ定義の形式などは、コンテナデータファイルの形式のメタデータファイルを参照ください。ただし、以下の情報は、エクスポートコマンドのメタ情報ファイルでは定義されていますが、本コマンドでは無効となります。
    • version　　　　　　　　　エクスポートツールバージョン
    • database 　　　　　　　　データベース名
    • containerFileType　　　　エクスポートデータファイルタイプ
    • containerFile　　　　　　エクスポートファイル名
    • partitionNo　　　　　　　パーティション番号
  • 1つのコンテナ定義ファイルには、1つのコンテナ定義を記述してください。
  • 引数でコンテナ名を省略した場合、コンテナ定義ファイルに記述されているコンテナ名で作成します。
  • 引数でコンテナ名を指定した場合、コンテナ定義ファイルのコンテナ名は無視して引数のコンテナ名で作成します。
  • コンテナ定義ファイルにデータベース名が記述されていてもエラーとはなりませんが、その名前は無視され接続中のデータベース上に作成します。
  • コンテナ定義ファイルを利用する場合、エクスポートの機能で--out オプションを指定するとメタ情報ファイルが出力されます。出力されたメタ情報ファイルを編集して、コンテナ定義ファイルとして流用することができます。

　　(例)　出力されたメタ情報ファイルをコンテナ定義ファイルとして流用する場合

{
    "version":"2.1.00",　　　　　　　　　　　　　　　←無効
    "container":"container_354",
    "database":"db2",　　　　　　　　　　　　　　　　←無効
    "containerType":"TIME_SERIES",
    "containerFileType":"binary",　　　　　　　　　　←無効
    "containerFile":"20141219_114232_098_div1.mc", 　←無効
    "rowKeyAssigned":true,
    "partitionNo":0,　　　　　　　　　　　　　　　　 ←無効
    "columnSet":[
        {
            "columnName":"timestamp",
            "type":"timestamp",
            "notNull":false
        },
        {
            "columnName":"active",
            "type":"boolean",
            "notNull":true
        },
        {
            "columnName":"voltage",
            "type":"double",
            "notNull":true
        }
    ],
    "timeSeriesProperties":{
        "compressionMethod":"NO",
        "compressionWindowSize":-1,
        "compressionWindowSizeUnit":"null",
        "expirationDivisionCount":8,
        "rowExpirationElapsedTime":-1,
        "rowExpirationTimeUnit":"null"
    },
    "compressionInfoSet":[
    ]

コンテナを削除します。

• サブコマンド

  dropcontainer

  コンテナ名

• 各引数の説明

  引数	説明
  コンテナ名	削除するコンテナの名前を指定します。

• 例)

  gs[public]> dropcontainer　Con001
  

【メモ】

• パーティションテーブル(コンテナ)は非対応です。実行した場合はエラーとなります。
  • パーティションテーブル(コンテナ)の削除にはSQLを使用してください。

コンテナ情報を表示します。

• サブコマンド

  showcontainer

  コンテナ名

• 各引数の説明

  引数	説明
  コンテナ名	表示対象のコンテナ名を指定します。省略した場合、全てのコンテナの一覧を表示します。

• 例)

  //コンテナ一覧を表示
  gs[userDB]> showcontainer
  Database : userDB
  Name                  Type         PartitionId
  ------------------------------------------------
  cont001               COLLECTION            10
  col00a                COLLECTION             3
  time02                TIME_SERIES            5
  cont003               COLLECTION            15
  cont005               TIME_SERIES           17
  
  //指定コンテナの情報を表示
  gs[public]> showcontainer cont003
  Database    : userDB
  Name        : cont003
  Type        : COLLECTION
  Partition ID: 15
  DataAffinity: -
  
  Columns:
  No  Name                  Type            CSTR  Index
  ------------------------------------------------------------------------------
   0  string                STRING          NN    TREE(myIndex)   [RowKey]
   1  value                 DOUBLE          NN    HASH() TREE(myIndex2)
  
  

【メモ】

• コンテナ一覧で表示するのは、「コンテナ名」、「コンテナタイプ」、「パーティションID」です。
• 指定コンテナの情報で表示するのは、「コンテナ名」、「コンテナタイプ」、「パーティションID」、「定義したカラム名」、「カラムのデータ型」、「カラム制約」、「カラムの索引設定」です。
• カレントDBのコンテナ情報が表示されます。

テーブル情報を表示します。showcontainerとの互換コマンドです。

• サブコマンド

  showtable

  テーブル名

• 各引数の説明

  引数	説明
  テーブル名	表示対象のテーブル名を指定します。省略した場合、全てのテーブルの一覧を表示します。

指定したコンテナのカラムに索引を作成します。

• サブコマンド

  createindex

  コンテナ名　カラム名　索引タイプ...

• 各引数の説明

  引数	説明
  コンテナ名	索引操作対象のカラムが所属するコンテナ名を指定します。
  カラム名	索引操作対象のカラム名を指定します。
  索引タイプ...	索引タイプを指定します。索引タイプはTREE、HASH、SPATIALのいずれか（または複数）を指定します。

• 例)

  //索引の作成
  gs[public]> createindex cont003 col2 tree hash
  
  gs[public]> showcontainer cont003
  Database    : public
  Name        : cont003
  Type        : COLLECTION
  Partition ID: 15
  DataAffinity: -
  
  Columns:
  No  Name                  Type            Index
  ------------------------------------------------------------
   0  col1                  INTEGER         [TREE] (RowKey)
   1  col2                  STRING          [TREE, HASH]
   2  col3                  TIMESTAMP       []
  

【メモ】

• 作成済みの索引を指定しても、エラーは発生しません。
• 索引名は未対応です。索引名を付加する場合は、コンテナ作成(詳細版)またはSQLを使用してください。

指定したコンテナのカラムの索引を削除します。

• サブコマンド

  dropindex

  コンテナ名　カラム名　索引タイプ...

• 各引数の説明

  引数	説明
  コンテナ名	索引操作対象のカラムが所属するコンテナ名を指定します。
  カラム名	索引操作対象のカラム名を指定します。
  索引タイプ...	索引タイプを指定します。索引タイプはTREE、HASH、SPATIALのいずれか（または複数）を指定します。

• 例)

  //索引の削除
  gs[public]> showcontainer cont003
  Database    : public
  Name        : cont003
  Type        : COLLECTION
  Partition ID: 27
  DataAffinity: -
  
  Columns:
  No  Name                  Type            CSTR  Index
  ------------------------------------------------------------------------------
   0  col1                  INTEGER         NN    TREE()   [RowKey]
   1  col2                  STRING                TREE() HASH(myIndex)
   2  col3                  TIMESTAMP       NN    HASH()
  
  gs[public]> dropindex cont003 col2 hash
  
  gs[public]> showcontainer cont003
  Database    : public
  Name        : cont003
  Type        : COLLECTION
  Partition ID: 27
  DataAffinity: -
  
  Columns:
  No  Name                  Type            CSTR  Index
  ------------------------------------------------------------------------------
   0  col1                  INTEGER         NN    TREE()   [RowKey]
   1  col2                  STRING                TREE()
   2  col3                  TIMESTAMP       NN    HASH()
  

【メモ】

• 作成されていない索引を指定しても、エラーは発生しません。

指定したコンテナのトリガを削除します。

• サブコマンド

  droptrigger

  コンテナ名 トリガ名

• 各引数の説明

  引数	説明
  コンテナ	削除するトリガのコンテナ名を指定します。
  トリガ名	削除するトリガ名を指定します。

• 例)

  gs[public]> droptrigger con01 tri03
  

指定したコンテナのトリガ情報を表示します。

• サブコマンド

  showtrigger

  コンテナ名　[トリガ名]

• 各引数の説明

  引数	説明
  コンテナ	表示対象のコンテナ名を指定します。
  トリガ名	表示対象のトリガ名を指定します。省略した場合、全てのトリガ情報の一覧を表示します。

• 例)

  //指定コンテナのトリガ情報一覧を表示
  gs[public]> showtrigger cont003
  Name                 Type  Columns              Events
  ---------------------------------------------------------------
  rtrig01              REST  [col1, col3]         [PUT]
  
  gs[public]> showtrigger cont003 rtrig01
  Name          : rtrig01
  Type          : REST
  Target Columns: [col1, col3]
  Target Events : [PUT]
  
  Destination URI: http://example.com
  

【メモ】

• トリガ一覧で表示するのは、「トリガ名」、「通知方法」、「通知対象カラム」、「監視対象操作(ロウの新規作成または更新、削除)」です。
• 指定トリガ情報で表示するのは、「トリガ名」、「通知方法」、「通知対象カラム」、「監視対象操作」、「通知先URI」を表示します。また、JMS通知の場合には、「ディスティネーション名」、「ディスティネーションタイプ」、「ユーザ」、「パスワード」も併せて表示します。
• トリガ機能の詳細に関しては、『GridDB APIリファレンス』(GridDB_API_Reference.html)の「トリガ機能」の章を参照ください。

実行したサブコマンドを標準出力に表示します。

• サブコマンド

  echo

  boolean

• 各引数の説明

  引数	説明
  boolean	TRUEを指定すると、実行したサブコマンドを標準出力に表示します。既定値はFALSEです。

• 例)

  //実行したサブコマンドを標準出力に表示
  gs> echo TRUE
  

【メモ】

• gs_shのプロンプト"gs>"は常に標準出力に表示します。

　

指定した文字列、もしくは変数の定義内容を表示します。

• サブコマンド

  print

  メッセージ

• 各引数の説明

  引数	説明
  メッセージ	表示する文字列もしくは変数を指定します。

• 例)

  //文字列の表示
  gs> print printを実行しました。
  printを実行しました。
  

【メモ】

• 変数を利用する際には、変数名の先頭に"$"をつけます。

　

指定した秒数スリープします。

• サブコマンド

  sleep

  秒数

• 各引数の説明

  引数	説明
  秒数	スリープする秒数を指定します。

• 例)

  //10秒間スリープ
  gs> sleep 10
  

【メモ】

• 秒数は正の整数を指定ください。

　

外部コマンドを実行します。

• サブコマンド

  exec	外部コマンド　[ 外部コマンド引数 ]

• 各引数の説明

  引数	説明
  外部コマンド	外部コマンドを指定します。
  外部コマンド引数	外部コマンドの引数を指定します。

• 例)

  //カレントディレクトリのファイル情報を表示
  gs> exec ls -la
  

【メモ】

• パイプ、リダイレクト、ヒアドキュメントは利用できません。

　

gs_shを終了します。

• サブコマンド

  exit
  quit

• 例)

  //gs_shを終了します。
  gs> exit
  

　また、サブコマンドでエラーが発生した場合に、gs_shを終了するように設定できます。

• サブコマンド

  errexit

  boolean

• 各引数の説明

  引数	説明
  boolean	TRUEを指定すると、サブコマンドでエラーが発生した場合に、gs_shが終了します。デフォルトはFALSEです。

• 例)

  //サブコマンドでエラーが発生した場合にgs_shが終了するように設定
  gs> errexit TRUE
  

【メモ】

• exitサブコマンド、quitサブコマンドに機能差はありません。

　

サブコマンドの説明を表示します。

• サブコマンド

  help

  [サブコマンド名]

• 各引数の説明

  引数	説明
  サブコマンド名	説明を表示するサブコマンド名を指定します。省略した場合、サブコマンドの一覧を表示します。

• 例)

  //サブコマンドの説明表示
  gs> help exit
  exit
  gs_shを終了します。
  

【メモ】

• gs_shの説明は、「gs_sh　--help」で取得できます。

　

gs_shのバージョンを表示します。

• サブコマンド

  version

• 例)

  //バージョンの表示
  gs> version
  gs_sh version 2.0.0
  

【メモ】

• gs_shのバージョン情報は、「gs_sh　--version」でも取得できます。

　

• コマンド一覧

  gs_sh	[スクリプトファイル]
  gs_sh	-v｜--version
  gs_sh	-h｜--help

• オプション仕様

  オプション	必須	説明
  -v｜--version		ツールのバージョンを表示します。
  -h｜--help		ヘルプメッセージとしてコマンド一覧を表示します。

【メモ】

• gs_shサブコマンドをバッチ処理するために、スクリプトファイルが作成できます。スクリプトファイルの拡張子はgshです。
• gs_sh起動時に、gsadmユーザホームディレクトリ下の.gsshrcスクリプトファイルを自動的に読み込みます。.gsshrcの内容は、他のスクリプトファイルよりも先に読み込みます。

• GridDBクラスタ定義　サブコマンド一覧

  サブコマンド	引数	説明	*1
  setnode	ノード変数名　IPアドレス	ノード変数を定義します。
  	ポート番号　[ SSHポート番号 ]
  setcluster	クラスタ変数名　クラスタ名	クラスタ変数を定義します。
  	マルチキャストアドレス　ポート番号
  	[ ノード変数... ]
  setclustersql	クラスタ変数名　クラスタ名	クラスタ構成にSQLの接続先を定義します。
  	SQLアドレス　SQLポート番号
  modcluster	クラスタ変数名	クラスタ変数にノード変数を追加、除去します。
  	add｜remove　ノード変数...
  setuser	ユーザ名　パスワード	クラスタにアクセスするユーザおよびパスワードを定義します。
  	[ OSユーザgsadmのパスワード ]
  set	変数名　[ 値 ]	任意の変数を定義します。
  show	[ 変数名 ]	変数の定義内容を表示します。
  save	[ スクリプトファイル名 ]	変数定義をスクリプトファイルに保存します。
  load	[ スクリプトファイル名 ]	スクリプトファイルを読み込み実行します。

　

• GridDBクラスタ操作　サブコマンド一覧

  サブコマンド	引数	説明	*1
  startnode	ノード｜クラスタ変数　[ タイムアウト秒数 ]	指定ノードを起動します。	*
  stopnode	ノード｜クラスタ変数　[ タイムアウト秒数 ]	指定ノードを停止します。	*
  stopnodeforce	ノード｜クラスタ変数　[ タイムアウト秒数 ]	指定ノードを強制停止します。	*
  startcluster	クラスタ変数　[ タイムアウト秒数 ]	指定クラスタに未参加の稼働ノード群を一括参加させます	*
  stopcluster	クラスタ変数　[ タイムアウト秒数 ]	クラスタ参加中のノード群を一括離脱させます。	*
  joincluster	クラスタ変数　ノード変数 　 [ タイムアウト秒数 ]	指定ノードをクラスタに参加させます。	*
  leavecluster	ノード変数　[ タイムアウト秒数 ]	指定ノードをクラスタから離脱させます。	*
  leaveclusterforce	ノード変数　[ タイムアウト秒数 ]	指定ノードをクラスタから強制的に離脱させます。	*
  appendcluster	クラスタ変数　ノード変数　 [ タイムアウト秒数 ]	クラスタ変数に未定義のノードをクラスタに参加させます。	*
  configcluster	クラスタ変数	クラスタステータス情報を表示します。	*
  config	ノード変数	クラスタ構成情報を表示します。	*
  stat	ノード変数	指定ノードのステータスを表示します。	*
  logs	ノード変数	指定ノードのログを表示します。	*
  logconf	ノード変数　[ カテゴリ名　[ 出力レベル ]　]	ログ設定を表示、変更します。	*

　　　　*1 : *は、管理ユーザのみ実行可能なコマンドです。

　

• データベース内データ操作　サブコマンド一覧

  サブコマンド	引数	説明	*1
  connect	クラスタ変数 [データベース名]	GridDBクラスタに接続します。
  tql	コンテナ名　クエリ　;	検索を実行し、検索結果を保持します。
  get	[ 取得件数 ]	検索結果を取得し、標準出力に表示します。
  getcsv	CSVファイル名　[ 取得件数 ]	検索結果を取得し、CSV形式でファイルに保存します。
  getnoprint	[ 取得件数 ]	クエリの結果を取得しますが、標準出力に表示しません。
  tqlclose		保持する検索結果を破棄します。
  tqlanalyze	コンテナ名　クエリ　;	指定TQL文の実行計画を表示します。
  tqlexplain	コンテナ名　クエリ　;	指定TQL文を実行し、実行計画と処理件数等の実測値を表示します。
  sql	SQL文　;	SQL文を実行し、検索結果を保持します。
  queryclose		SQLをクローズします。
  disconnect		GridDBクラスタから切断します。

　　　　 *1 : *は、管理ユーザのみ実行可能なコマンドです。

　

• データベース管理　サブコマンド一覧

  サブコマンド	引数	説明	*1
  createdatabase	データベース名	データベースを作成します。	*
  dropdatabase	データベース名	データベースを削除します。	*
  getcurrentdatabase		カレントデータベース名を表示します。
  showdatabase	[データベース名]	データベース一覧およびアクセス権情報を表示します。
  grant	データベース名 ユーザ名	データベースへのアクセス権を付与します。	*
  revoke	データベース名 ユーザ名	データベースへのアクセス権を剥奪します。	*

　　　　 *1 : *は、管理ユーザのみ実行可能なコマンドです。

　

• ユーザ管理　サブコマンド一覧

  サブコマンド	引数	説明	*1
  createuser	ユーザ名　パスワード	一般ユーザを作成します。	*
  dropuser	ユーザ名	一般ユーザを削除します。	*
  setpassword	パスワード	自分のパスワードを変更します。
  setpassword	ユーザ名　パスワード	一般ユーザのパスワードを変更します。
  showuser	[ユーザ名]	ユーザ情報を表示します。

　　　　 *1 : *は、管理ユーザのみ実行可能なコマンドです。

　

• コンテナ管理　サブコマンド一覧

  サブコマンド	引数	説明	*1
  createcollection	コンテナ名 カラム名　タイプ [カラム名　タイプ …]	コンテナ(コレクション)を作成します。
  createtimeseries	コンテナ名 圧縮方式 カラム名　タイプ [カラム名　タイプ …]	コンテナ(時系列コンテナ)を作成します。
  createcontainer	コンテナ情報ファイル [コンテナ名]	コンテナ情報ファイルよりコンテナを作成します。
  dropcontainer	コンテナ名	コンテナを削除します。
  showcontainer	[ コンテナ名 ]	コンテナ情報を表示します。
  showtable	[ テーブル名 ]	テーブル情報を表示します。
  createindex	コンテナ名　カラム名　索引タイプ...	指定カラムに索引を作成します。
  dropindex	コンテナ名　カラム名　索引タイプ...	指定カラムの索引を削除します。
  droptrigger	コンテナ名　トリガ名	トリガ情報を削除します。
  showtrigger	コンテナ名　[ トリガ名 ]	トリガ情報を表示します。

　　　　 *1 : *は、管理ユーザのみ実行可能なコマンドです。

　

• その他の操作　サブコマンド一覧

  サブコマンド	引数	説明	*1
  echo	boolean	エコーバックの有無を設定します。
  print	メッセージ	指定した文字列、もしくは変数の定義内容を表示します。
  sleep	秒数	指定した秒数スリープします。
  exec	外部コマンド　[ 外部コマンド引数 ]	外部コマンドを実行します。
  exit		gs_shを終了します。
  quit		gs_shを終了します。
  errexit	boolean	エラー発生時にgs_shを終了するかを設定します。
  help	[ サブコマンド名 ]	サブコマンドの説明を表示します。
  version		バージョン情報を表示します。

　　　　 *1 : *は、管理ユーザのみ実行可能なコマンドです。

　

ノードを実行するマシン上でGridDBノード起動コマンドを実行します。このコマンドはGridDBノード毎に実行する必要があります。

• コマンド

  gs_startnode

  [-w｜--wait [秒数] -u ユーザ名/パスワード]

【メモ】

• 待合わせを行う場合、認証ユーザとパスワードを指定します。
• 起動完了とは、データベースのリカバリ処理完了を意味します。
• 起動完了を待合せることで、gs_joinclusterを続けて正常に行うことができます。

GridDBノードを停止します。ノードを停止するためには、まず、GridDBクラスタ管理処理を停止させる必要があります。

• コマンド

  gs_stopnode	[-f｜--force]
  	[-k｜--kill]
  	[-w｜--wait [秒数]]
  	[-s サーバ[:ポート番号] ｜ -p ポート番号]
  	-u ユーザ名/パスワード

• オプション

  オプション	説明
  -f｜--force	強制的にノードを停止します。
  -k｜--kill	ローカルマシンのノードのプロセスを強制的に停止します。

【メモ】

• 特定のノードを停止する場合、そのノードがクラスタ構成に参加しているとノードの停止を行えません。ノードをクラスタ構成から離脱(gs_leavecluster)させてから、ノードの停止を行ってください。
• すべてのノードを停止する場合、GridDBクラスタ管理処理を停止(gs_stopcluster)した後、順次、ノードを停止してください。
• ノードの停止を始めると、チェックポイント処理のため、実際にプロセスが終了するまでに時間を要することがあります。停止するまでしばらくお待ちください。
• --force オプションや--kill オプションを指定すると強制的にノードを停止できますが、データをロストする恐れがあります。
• --kill オプションによりリモートマシンのノードのプロセスを停止することはできません。

• コマンド

  gs_adduser	ユーザ名
  	[-p｜--password パスワード]

• オプション

  オプション	説明
  ユーザ名	作成する管理ユーザ名を指定します。先頭が"gs#"で始まる名前を指定します。"gs#"以降には1文字以上のASCII英数字、"_"(アンダースコア)のみ使用可能です。
  -p｜--password　パスワード	ユーザのパスワードを指定します。省略時は対話的にパスワードを入力するためのプロンプトが表示されます。

【メモ】

• OSユーザgsadmで実行してください。
• パスワードは登録の際に暗号化されます。
• 管理ユーザの登録を行った場合は、コマンド実行したノードのユーザ定義ファイルを全ノードに配布し、クラスタを停止してノードの再起動、クラスタの再構成を行ってください。
• V2.5以前に登録したユーザは管理ユーザとしてそのまま利用できます。
• 「admin」、「system」のみ、削除しても再登録が可能です。

【例】

• 管理ユーザ(「ユーザ名(gs#someone)」、「パスワード(opensesami)」)をユーザ定義ファイルに追加します。

  $ gs_adduser -p opensesami gs#someone 
  $ gs_stopcluster -u admin/admin
  全てのノードで以下を実施
  $ gs_stopnode -u admin/admin
  $ cp [ユーザを追加したユーザ定義ファイル] /var/lib/gridstore/conf/password
  $ gs_startnode
  $ gs_joincluster -c clsA  -n XX -u admin/admin
  

• コマンド

  gs_deluser

  ユーザ名

【メモ】

• OSユーザgsadmで実行してください。
• 管理ユーザの削除を行った場合は、コマンド実行したノードのユーザ定義ファイルを全ノードに配布し、クラスタを停止してノードの再起動、クラスタの再構成を行ってください。

【例】

• 指定した管理ユーザ(gs#someone)を削除します。

  $ gs_deluser gs#someone
  $ gs_stopcluster -u admin/admin　　
  全てのノードで以下を実施
  $ gs_stopnode -u admin/admin
  $ cp [ユーザを削除したユーザ定義ファイル] /var/lib/gridstore/conf/password
  $ gs_startnode
  $ gs_joincluster -c clsA  -n XX -u admin/admin
  

• コマンド

  gs_passwd	ユーザ名
  	[-p｜--password　パスワード]

• オプション

  オプション	説明
  ユーザ名	パスワードを変更する管理ユーザ名を指定します。
  -p｜--password パスワード	管理ユーザのパスワードを指定します。省略時は対話的にパスワードを入力するためのプロンプトが表示されます。

【メモ】

• OSユーザgsadmで実行してください。
• パスワードは登録の際に暗号化されます。
• 管理ユーザのパスワード変更を行った場合は、コマンド実行したノードのユーザ定義ファイルを全ノードに配布し、クラスタを停止してノードの再起動、クラスタの再構成を行ってください。

【例】

• 指定した管理ユーザ(「ユーザ名(gs#someone)」)のパスワードを(foobarxyzに)変更します。

  $ gs_passwd -p foobarxyz gs#someone 
  $ gs_stopcluster -u admin/admin　　
  全てのノードで以下を実施
  $ gs_stopnode -u admin/admin
  $ cp [変更したユーザ定義ファイル] /var/lib/gridstore/conf/password
  $ gs_startnode
  $ gs_joincluster -c clsA  -n XX -u admin/admin
  

GridDBクラスタにノードを参加させてクラスタを構成します。

• コマンド

  gs_joincluster	[-c｜--clusterName クラスタ名]
  	[-n｜--nodeNum 構成ノード数]
  	[-w｜--wait [秒数]]
  	[-s サーバ[:ポート番号]｜ -p ポート番号]
  	-u ユーザ名/パスワード

• オプション

  オプション	説明
  -c｜--clusterName クラスタ名	クラスタ名を指定します。デフォルトは、"defaultCluster"です。
  -n｜--nodeNum 構成ノード数	構成するクラスタのノード数を指定します。デフォルトは、1(シングルノード構成)です。

【メモ】

• クラスタ名はデフォルト以外の名前を指定することを推奨します。
• クラスタ定義ファイルのクラスタ名( /cluster/clusterName )が設定されている場合、指定したクラスタ名が設定した値と一致しないとエラーとなります。
• 安定状態のクラスタに新たにノードを参加させる場合は、クラスタへのノード増設コマンド(gs_appendcluster)を実行してください。
• ノードへの参加をある特定のマシンから行ってクラスタを構成する際、構成完了の待合わせを行う場合は、最後に参加させるノードに-w オプションを指定してください。
• 大規模な拡張を行いたい場合は、一旦クラスタを停止させた後で、構成ノード数に拡張後のノード数を指定してクラスタを再構成してください。

【例】ノードA〜C 3台でクラスタ名「example_three_nodes_cluster」のクラスタを構成する。

• クラスタを構成する各ノードで、ノードの起動およびノードへの参加を行います。

  ノードAで実行
  $ gs_startnode
  $ gs_joincluster -c example_three_nodes_cluster -n 3 -u admin/admin -w
  ノードBで実行
  $ gs_startnode
  $ gs_joincluster -c example_three_nodes_cluster -n 3 -u admin/admin -w
  ノードCで実行
  $ gs_startnode
  $ gs_joincluster -c example_three_nodes_cluster -n 3 -u admin/admin -w
  

• ノードの起動は各ノードから行い、ノードへの参加はある特定のノードから行います。

  ノードA〜Cそれぞれで実行
  $ gs_startnode
  ノードAで実行
  $ gs_joincluster -c example_three_nodes_cluster -n 3 -s ノードBのサーバアドレス -u admin/admin
  $ gs_joincluster -c example_three_nodes_cluster -n 3 -s ノードCのサーバアドレス -u admin/admin
  $ gs_joincluster -c example_three_nodes_cluster -n 3 -u admin/admin -w
  

ノードをクラスタから離脱させます。　

• コマンド

  gs_leavecluster	[-f｜--force]
  	[-w｜--wait [秒数]]
  	[-s サーバ[:ポート番号]｜ -p ポート番号]
  	-u ユーザ名/パスワード

• オプション

  オプション	説明
  -f｜--force	強制的にノードを離脱させます。

【メモ】

• シングルノード構成のクラスタのクラスタ停止には、クラスタ停止コマンド(gs_stopcluster)を使用してください。
• データをロストする恐れがある場合、ノードをクラスタから離脱させることはできません。
  • --force オプションを指定すると強制的にクラスタから離脱させます。 安全にクラスタを離脱させるためには、一度クラスタを停止してください。
• ノードを離脱させることで有効ノード数が構成ノード数の過半数に満たなくなる場合、クラスタは停止します。

【例】

• 離脱させたいノードでクラスタ離脱コマンドを実行します。

  $ gs_leavecluster -u admin/admin
  

クラスタを停止します。　

• コマンド

  gs_stopcluster	[-w｜--wait [秒数]]
  	[-s サーバ[:ポート番号]｜-p ポート番号]
  	-u ユーザ名/パスワード

【メモ】

• クラスタが完全に停止したことを確認する場合は、クラスタを構成していた全ノードの状態を確認してください。
• 稼働していないクラスタから離脱する場合は、クラスタ離脱コマンド(gs_leavecluster)を使用してください。

【例】

• クラスタ停止コマンドを実行します。

  $ gs_stopcluster -u admin/admin
  

クラスタ構成情報(クラスタに参加しているノードの一覧情報)を取得します。　

• コマンド

  gs_config	[-s サーバ[:ポート番号]｜ -p ポート番号]
  	-u ユーザ名/パスワード
  	[-a｜--address-type アドレス種別]

• オプション

  オプション	説明
  -a｜--address-type アドレス種別	表示するアドレス、ポートのサービス種別を指定する
  	system : 運用コマンドの接続アドレス
  	cluster : クラスタ管理のために使用する受信アドレス
  	transaction : トランザクション処理の受付アドレス
  	sync : 同期処理のために使用する受信アドレス

【メモ】

• "master"(マスタノード)、"follower"(フォロワノード)、"self"(コマンドを実行したノード)のアドレスとポート情報が表示されます。
• "multicast"にはクライアントへのマルチキャスト用アドレスとポート情報が表示されます。
• システム状態(status)は、以下のいずれかになります。
  • INACTIVE : 停止
  • ACTIVATING : 稼働開始
  • ACTIVE : 稼働
  • DEACTIVATING : 停止開始
  • ABNORMAL : 異常停止
  • NORMAL_SHUTDOWN : 通常終了開始

【例】

• クラスタが3台のノードで構成されている場合、マスタからクラスタ構成情報取得を行うと以下のような出力となります。

  $ gs_config -u admin/admin
  {
      "follower": [                       // [array] フォロワ情報
          {
              "address": "192.168.11.10", // 　[string] 運用コマンドの接続アドレス
              "port": 10040               // 　[number] 運用コマンドの接続ポート
          },
          {
             "address": "192.168.11.11",
             "port": 10040
          }
      ],
      "master": {                         // マスタ情報
          "address": "192.168.11.12",     // 　[string] 運用コマンドの接続アドレス
          "port": 10040                   // 　[number] 運用コマンドの接続ポート
      },
      "multicast": {                      // マルチキャスト情報
          "address": "239.0.0.20",        // 　[string] クライアントへのマルチキャスト用アドレス
          "port": 31999                   // 　[number] クライアントへのマルチキャスト用ポート
      },
      "self": {                           // 自ノード情報
          "address": "192.168.11.12",     // 　[string] 運用コマンドの接続アドレス
          "port": 10040,                  // 　[number] 運用コマンドの接続ポート
          "status": "ACTIVE"              // 　[string] システム状態
      }
  }
  

クラスタ情報(クラスタ構成情報および内部情報)、または、バックアップ進捗状況を取得します。

• コマンド

  gs_stat	[-t｜--type タイプ]
  	[-a｜--address-type アドレス種別]
  	[--member]
  	[-s サーバ[:ポート番号]｜-p ポート番号]
  	-u ユーザ名/パスワード

• オプション

  オプション	説明
  -t｜--type タイプ	指定されたタイプの情報を表示します。
  	backup：バックアップ状態を表示
  -a｜--address-type アドレス種別	表示するアドレス、ポートのサービス種別を指定します。
  	system : 運用コマンドの接続アドレス
  	cluster : クラスタ管理のために使用する受信アドレス
  	transaction : トランザクション処理の受付アドレス
  	sync : 同期処理のために使用する受信アドレス
  --member	クラスタ構成方式が固定リスト方式またはプロバイダ方式のとき、ノードが現在認識しているクラスタ構成メンバのアドレスリストを表示します。

【メモ】

• クラスタ状態(/cluster/clusterStatus)は、以下のいずれかになります。
  • MASTER　　：　マスタ
  • SUB_MASTER　：　サブマスタ
  • FOLLOWER　：　フォロワ
  • SUB_FOLLOWER　：　サブフォロワ
  • SUB_CLUSTER 　：　クラスタが稼働していない
• システム状態(/cluster/nodeStatus)は、以下のいずれかになります。
  • INACTIVE　：　停止
  • ACTIVATING　：　稼働開始
  • ACTIVE　：　稼働
  • DEACTIVATING　：　停止開始
  • ABNORMAL　：　異常停止
  • NORMAL_SHUTDOWN　：　通常終了開始
• バックアップ状態(/checkpoint/mode)は、実行中もしくは最後に実行されたバックアップの処理名が表示されます。
  • -　：　完了もしくは未稼働
  • NORMAL_CHECKPOINT　：　自動チェックポイント
  • REQUESTED_CHECKPOINT　：　強制チェックポイント
  • BACKUP　　：　フルバックアップ
  • RECOVERY_CHECKPOINT　：　チェックポイント(リカバリ時)
  • SHUTDOWN_CHECKPOINT　：　チェックポイント(シャットダウン時)
  • INCREMENTAL_BACKUP_LEVEL_0: 差分・増分バックアップのベースライン
  • INCREMENTAL_BACKUP_LEVEL_1_CUMULATIVE : 差分バックアップ
  • INCREMENTAL_BACKUP_LEVEL_1_DIFFERENTIAL : 増分バックアップ

【例】

• 稼働しているクラスタに参加しているノードでクラスタ情報取得を行うと以下のような出力となります。

  $ gs_stat -u admin/admin
  {
  　　　　　　　　：
  　　　　　　　　：
      "cluster": {
          "activeCount": 1,
          "clusterName": "defaultCluster",
          "clusterStatus": "MASTER",
          "designatedCount": 1,
          "loadBalancer": "ACTIVE",
          "master": {
              "address": "192.168.10.11",
              "port": 10010
          },
          "nodeList": [
              {
                  "address": "192.168.10.11",
                  "port": 10010
              }
          ],
          "nodeStatus": "ACTIVE",
          "partitionStatus": "NORMAL",
          "startupTime": "2014-08-29T09:56:20+0900",
          "syncCount": 3
      },
  　　　　　　　　：
  　　　　　　　　：
  }
  

稼働中のクラスタに新たにノードを増設します(追加します)。　

• コマンド

  gs_appendcluster	--cluster サーバ:ポート番号
  	[-w｜--wait [秒数]]
  	[-s サーバ[:ポート番号] ｜ -p ポート番号]
  	-u ユーザ名/パスワード

• オプション

  オプション	説明
  --cluster サーバ:ポート番号	増設対象のクラスタに参加しているノードのサーバ名(アドレス)とポート番号を指定します。

【メモ】

• クラスタが稼働中で、安定状態(有効ノード数=構成ノード数)のときのみ動作します。
• 大規模な拡張を行いたい場合は、一旦クラスタを停止させた後で、構成ノード数に拡張後のノード数を指定してクラスタを再構成してください。
• 稼働中のシングルノード構成のクラスタを拡張する場合、一旦クラスタを停止させた後で、クラスタの再構成を行ってください。

【例】

• 稼働中のクラスタに新たにノードを追加します。

  追加対象のクラスタの状態を確認
  $ gs_stat -s 192.168.33.29:10040  -u admin/admin
  {
          :
      "cluster":{                                 //クラスタ関連
          "activeCount":5,                        //有効ノード数
          "clusterName":"function_1",             //クラスタ名
          "clusterStatus":"MASTER",               //クラスタ状態
          "designatedCount":5,                    //構成ノード数
          :
  }
  構成ノード=有効ノード数であることを確認
  構成ノード数>有効ノード数の場合、gs_joincluster(クラスタ構成への参加)を実行
  
  追加したいノードを起動し、稼働中のクラスタに参加しているノードのサーバアドレスおよびポート番号を指定
  $ gs_startnode
  $ gs_appendcluster --cluster 192.168.33.29:10040 -u admin/admin
  
  クラスタに追加できているか、クラスタの状態を確認
  $ gs_stat  -u admin/admin
  {
          :
      "cluster":{                                 //クラスタ関連
          "activeCount":6,                        //有効ノード数
          "clusterName":"function_1",             //クラスタ名
          "clusterStatus":"MASTER",               //クラスタ状態
          "designatedCount":6,                    //構成ノード数
          :
  }
  

GridDBクラスタのフェイルオーバーを実行します。

• コマンド

  gs_failovercluster	[--repair]
  	[-s サーバ[:ポート番号] ｜ -p ポート番号]
  	-u ユーザ名/パスワード

• オプション

  オプション	説明
  --repair	データロストを許容して強制的にフェイルオーバーを実行します。

【メモ】

• クラスタが稼働中のときのみ実行可能です。
• 基本的にはクラスタアルゴリズムの通常処理として実行されるので、以下の場合に有効です。
  • ユーザがクラスタ異常を検知し、即時フェイルオーバーを実行する。
  • バックアップデータからのデータリカバリ終了後、クラスタが保持するパーティションのLSNが最終更新LSNより若い番号でも、データベースリカバリ完了とみなしてシステムを起動する。(データロストを許容する。)

【例】

• クラスタのフェイルオーバーを実行します。

  $ gs_failovercluster -u admin/admin
  

GridDBノードのパーティション情報を表示します。

• コマンド

  gs_partition	[-n｜--partitionId パーティションID]
  	[--loss]
  	[-a｜--address-type アドレス種別]
  	[-s サーバ[:ポート番号] ｜ -p ポート番号]
  	-u ユーザ名/パスワード

• オプション

  オプション	説明
  -n｜--partitionId パーティションID	情報を表示するパーティションIDを指定します。(省略時は全ての情報を表示)
  --loss	欠損パーティションの情報のみ表示します。
  -a｜--address-type アドレス種別	表示するアドレス、ポートのサービス種別を指定する
  	system : 運用コマンドの接続アドレス
  	cluster : クラスタ管理のために使用する受信アドレス
  	transaction : トランザクション処理の受付アドレス
  	sync : 同期処理のために使用する受信アドレス

【メモ】

• --loss オプションは、クラスタが稼働中のときのみ利用できます。
• 欠損パーティションとは、レプリカを保有するパーティションを含め、アクセスできないパーティションを示します。

【例】

• 稼働中のクラスタの特定のノードのパーティション情報を取得します。

  $ gs_partition -u admin/admin
  [
      {
          "backup": [],
          "catchup": [],
          "maxLsn": 300008,
          "owner": {
              "address": "192.168.11.10",
              "lsn": 300008,
              "port": 10010
          },
          "pId": "0",
          "status": "ON"
      },
          ：
  ]
  

GridDBクラスタの構成ノード数を拡張します。

• コマンド

  gs_increasecluster	[-s サーバ[:ポート番号] ｜ -p ポート番号]
  	-u ユーザ名/パスワード

【メモ】

• クラスタが稼働中で、安定状態（有効ノード数=構成ノード数）のときのみ動作します。従って、稼動しているクラスタへノードを増設する場合は、1台ずつ増設する必要があります。
• 大規模な拡張を行いたい場合は、一旦クラスタを停止させた後で、初期構成ノード数に拡張後のノード数を指定してクラスタを再構成してください。
• このコマンドによってクラスタが拡張された際に、増設対象のノードがある場合は、そのノードがクラスタに参加します。増設対象のノードが複数ある場合は、いずれかのノードがクラスタに参加します。
• 増設対象のノードがない状態で、このコマンドによってクラスタが拡張された後で増設対象のノードを指定した場合は、そのノードがクラスタに参加します。
• シングルノード構成のクラスタを稼働中に拡張することはできません。一旦クラスタを停止させた後で、クラスタを再構成してください。

【例】

• クラスタ構成ノード数を拡張して、クラスタにノードを増設します。

  ノードを増設したいクラスタの状態を確認
  $ gs_stat -s 192.168.33.29:10040  -u admin/admin
  {
          :
      "cluster":{                                 //クラスタ関連
          "activeCount":5,                        //有効ノード数
          "clusterName":"function_1",             //クラスタ名
          "clusterStatus":"MASTER",               //クラスタ状態
          "designatedCount":5,                    //構成ノード数
          :
  }
  構成ノード=有効ノード数であることを確認
  
  増設したいノードを起動し、増設後のノード数(6)を指定して、
  gs_joincluster(クラスタ構成への参加)を実行(増設対象に指定)
  $ gs_startnode -u admin/admin -w
  $ gs_joincluster -u admin/admin -c function_1 -n 6
  
  ノードを増設したいクラスタに対して、gs_increasecluster(クラスタ構成ノード数の拡張)を実行
  $ gs_increasecluster -s 192.168.33.29:10040 -u admin/admin
  
  増設対象のノードがクラスタに追加できているか、クラスタの状態を確認
  $ gs_stat  -u admin/admin
  {
          :
      "cluster":{                                 //クラスタ関連
          "activeCount":6,                        //有効ノード数
          "clusterName":"function_1",             //クラスタ名
          "clusterStatus":"MASTER",               //クラスタ状態
          "designatedCount":6,                    //構成ノード数
          :
  }
  

直近のGridDBのイベントログを取得します。　

• コマンド

  gs_logs	[-l｜--lines 取得行数]
  	[-g｜--ignore 除外キーワード]
  	[-s サーバ[:ポート番号] ｜ -p ポート番号]
  	-u ユーザ名/パスワード
  	[第一キーワード [第二キーワード]]

• オプション

  オプション	説明
  -l｜--lines 取得行数	取得行数を指定します。
  -g｜--ignore 除外キーワード	除外キーワードを含む行を無視します。
  第一キーワード [第二キーワード]	キーワードを含む行のみ取得します。

【メモ】

• イベント情報は、以下のような形式で出力されます。
  • 時刻、マシン名、スレッド番号、イベント種別、イベントカテゴリ、発生ソースファイル名、発生メソッド、発生行数 : 後は任意の文字列
• 詳細については、サポート窓口にお問い合わせください。

【例】

• チェックポイントが終了したログを3回分取得します。

  $ gs_logs -u admin/admin CP_END -l 3
  2014-08-04T11:02:52.754+0900 NODE1 1143 INFO CHECKPOINT_SERVICE ../server/checkpoint_service.cpp void CheckpointService::runCheckpoint(EventContext&, int32_t, const std::string&) line=866 : [CP_END] mode=NORMAL_CHECKPOINT, backupPath=, commandElapsedMillis=132
  2014-08-04T11:22:54.095+0900 NODE1 1143 INFO CHECKPOINT_SERVICE ../server/checkpoint_service.cpp void CheckpointService::runCheckpoint(EventContext&, int32_t, const std::string&) line=866 : [CP_END] mode=NORMAL_CHECKPOINT, backupPath=, commandElapsedMillis=141
  2014-08-04T11:42:55.433+0900 NODE1 1143 INFO CHECKPOINT_SERVICE ../server/checkpoint_service.cpp void CheckpointService::runCheckpoint(EventContext&, int32_t, const std::string&) line=866 : [CP_END] mode=NORMAL_CHECKPOINT, backupPath=, commandElapsedMillis=138
  

イベントログ出力レベルの表示または変更します。引数指定なしの場合は設定一覧を取得します。　

• コマンド

  gs_logconf	[-s サーバ[:ポート番号]｜-p ポート番号]
  	-u ユーザ名/パスワード
  	[カテゴリ名 出力レベル]

• オプション

  オプション	説明
  カテゴリ名 　出力レベル	ログ出力レベルを変更したいカテゴリのカテゴリ名と出力レベルを指定します。

【メモ】

• イベントログの出力レベルの一覧を表示する場合は、[カテゴリ　出力レベル]を省略して実行します。
• 出力されるログ情報は、指定した出力レベルよりも高い出力レベルのログがすべて出力されます。例えば、INFOを設定した場合は、INFO、WARNING、ERRORのログが出力されます。
• 出力レベルの一覧はレベルが高いものから低いものの順に以下のとおりとなります。
  • ERROR : エラー
  • WARNING : 警告
  • INFO : 情報
  • DEBUG : デバッグ
• ノードをシャットダウンした場合、コマンド実行により変更した設定は保存されません。
• ログ出力レベルは雛形のgs_node.jsonに記載されているデフォルトか、それより低いレベルを設定することを推奨しています。デフォルトは付録のパラメータ一覧を参照ください。

【例】

• ログの出力レベルを変更し、イベントログの状態を表示します。

  $ gs_logconf -u admin/admin CHUNK_MANAGER INFO
  $ gs_logconf -u admin/admin
  {
      "levels": {
          "CHECKPOINT_SERVICE": "INFO",
          "CHECKPOINT_SERVICE_DETAIL": "ERROR",
          "CHUNK_MANAGER": "INFO",
          "CLUSTER_OPERATION": "INFO",
  　　　　　　：
  　　　　　　：
      }
  }
  

サービスを継続しながら、GridDBのバックアップをノード単位で取得します。

クラスタを構成する全ノードに対して順次行うことで、サービスを継続しながら、クラスタ全体としてのバックアップが行えます。

• コマンド

  gs_backup	[--mode モード]
  	-u ユーザ名/パスワード
  	バックアップ名

• オプション

  オプション	説明
  --mode モード	バックアップモードを指定します。
  	- auto : 自動バックアップ
  	- auto_nostop : 自動バックアップ(エラー時にノード停止無し)
  	- baseline : 差分・増分バックアップのベースラインのフルバックアップを作成
  	- since :ベースライン作成後、更新されたデータブロックをベースラインからの差分バックアップ
  	- incremental：ベースライン作成後、もしくは前回のincremental、sinceバックアップ後に更新されたデータブロックの増分バックアップ。
  バックアップ名	バックアップデータのディレクトリ名を指定します。

＜mode オプション＞

　　auto

データ更新のログファイルが自動的にバックアップディレクトリにコピーされるため、利用者がバックアップを行う必要はありません。ただし、ログファイルの採取によるバックアップのため、障害発生時のリカバリに時間がかかる場合があります。定期的に全バックアップを行うことをお勧めします。

　　auto_nostop

バックアップ側のログ出力でエラーが発生した場合でも、トレースログ出力を行い、二重化出力を停止しますが、ノードを停止しません。auto_nostopを指定していない場合は、システムエラーとしてノードを停止します。

　　baseline

バックアップデータのベースラインを作成します。差分バックアップではベースラインからの更新の差分データをバックアップします。

　　since

baselineを指定したバックアップ実行後、更新が発生したデータをバックアップします(差分バックアップ)。

　　incremental

baselineを指定したバックアップ実行後、もしくは前回のincremental、sinceバックアップ実行後に、更新されたデータブロックをバックアップします(増分バックアップ)。

【メモ】

• バックアップ名は、英数字12文字までで設定します。
• バックアップの詳細については、『GridDB バックアップガイド』(GridDB_BackupGuide.html)を参照ください。
• バックアップファイルは、ノード定義ファイル(gs_node.json)で指定されたバックアップファイルディレクトリの下に作成されます。バックアップファイルはデータディレクトリとは別の物理ストレージを指定することをお勧めします。
• GridDBのクラスタデータベースを正しい状態にリストアする場合、バックアップとリストアの作業をクラスタ全体で行う必要があります。
• コマンド実行後、制御が戻りますが、データ規模、オンライン処理負荷により、バックアップ完了まで数時間以上かかる場合があります。バックアップの進捗状況は、gs_statコマンドで取得できます。
• クラスタ稼働中にバックアップを実行すると、コンテナを複数作成している場合には、クラスタ全体として不整合な状態でバックアップが作成される可能性があります。必要に応じて、トランザクションサービスを禁止し、静止状態でバックアップを実行するようにしてください。
• GridDBでは、障害が発生した場合、自動的にデータ再配置が行われます。そのため、バックアップ中に障害が発生した場合は、再度、1台目のノードからバックアップを取り直してください。

【例】

• 起動中のノードでバックアップを実行します。

  バックアップファイルが保管されるディレクトリ(バックアップディレクトリ)を確認
  $ cat /var/lib/gridstore/conf/gs_node.json         # 設定の確認
  {
      "dataStore":{
          "dbPath":"/var/lib/gridstore/data",
          "backupPath":"/var/lib/gridstore/backup",  # バックアップディレクトリ
          "storeMemoryLimit":"1024MB",
          "concurrency":1,
          "logWriteMode":1,
          "persistencyMode":"NORMAL"
  　　　　　　：
  　　　　　　：
  }
  バックアップを実行
  $ gs_backup -u admin/admin 20150425        # バックアップの実行
  
  データ規模や負荷状態により、バックアップ完了まで数時間以上かかる場合があります。
  バックアップの進捗状況を、gs_statコマンドで確認
  $ gs_stat -u admin/admin --type backup        
  BackupStatus: Processing                          # バックアップの実行中
  

• gs_statで出力されるバックアップ状態(BackupStatus)は、以下のいずれかになります。
  • Processing : フルバックアップ実行中
  • Processing(Baseline) : 差分・増分バックアップのベースライン作成中（フルバックアップ）
  • Processing(Since) : 差分バックアップ中
  • Processing(Incremental)増分バックアップ中
  • - : 完了もしくは未稼働
• バックアップを実行すると、以下のファイルが作成されます。
  • バックアップディレクトリ( /var/lib/gridstore/backup )の下に、BACKUPNAMEに指定した ディレクトリが作成されます。なお、差分・増分バックアップの際は、BACKUPNAME_lv0 （ 差分・増分バックアップのベースラインディレクトリ）、BACKUPNAME_lv1_NNN_MMM（ 差分・増分バックアップの差分（Since）と増分（Incremental)のディレクトリ）が作成されます。
  • 以下のバックアップファイル群が作成されます。
    • チェックポイントファイル(gs_cp_n_p.dat)
    • トランザクションログファイル(gs_logs_n_m.log)
    • バックアップ情報ファイル(gs_backup_info.json,gs_backup_info_digest.json)
    • LSN情報ファイル(gs_lsn_info.json)

ノード定義ファイル(gs_node.json)で設定されているバックアップディレクトリにあるバックアップデータの一覧を取得します。　

• コマンド

  gs_backuplist	[-s サーバ[:ポート番号]｜-p ポート番号]
  	-u ユーザ名/パスワード
  	[--partitionId パーティションID｜バックアップ名]

• オプション

  オプション	説明
  --partitionId パーティションID	指定したパーティションのLSN情報を一覧表示します。
  バックアップ名	バックアップ名を指定します。

【メモ】

• バックアップデータの一覧は、ノードの起動状態に関わらず表示できます。ノードが起動状態で、バックアップ処理中の場合はStatusは"P"と表示されます。
• Statusが"NG"と表示される場合、そのバックアップファイルはファイルが破損している可能性があるため、リストアすることはできません。
• 一覧表示でバックアップ名の先頭に"*"印があるものは、差分・増分バックアップデータです。
• 差分・増分バックアップのステータスは、常に"-"と表示されます。差分・増分バックアップで採取した複数のバックアップをバックアップ名を指定した詳細情報で確認できます。

【例】

• バックアップデータの一覧を確認したいノードで、バックアップデータの確認を実行します。

  
  バックアップ名の一覧を表示します。
  $ gs_backuplist -u admin/admin
  
  BackupName   Status   StartTime                EndTime
  ------------------------------------------------------------------------
  *201504          --  2015-04-01T05:20:00+0900 2015-04-24T06:10:55+0900
  *201503          --  2015-03-01T05:20:00+0900 2015-04-24T06:05:32+0900
    :
   20141025NO2     OK   2014-10-25T06:37:10+0900 2014-10-25T06:37:10+0900
   
   
  個別のバックアップ名を指定し、詳細情報を表示します。
  $ gs_backuplist -u admin/admin 201504
   
  BackupName : 201504
  
  BackupData            Status   StartTime                EndTime
  --------------------------------------------------------------------------------
  201504_lv0                OK  2015-04-01T05:20:00+0900 2015-04-01T06:10:55+0900
  201504_lv1_000_001        OK  2015-04-02T05:20:00+0900 2015-04-01T05:20:52+0900
  201504_lv1_000_002        OK  2015-04-03T05:20:00+0900 2015-04-01T05:20:25+0900
  201504_lv1_000_003        OK  2015-04-04T05:20:00+0900 2015-04-01T05:20:33+0900
  201504_lv1_000_004        OK  2015-04-05T05:20:00+0900 2015-04-01T05:21:15+0900
  201504_lv1_000_005        OK  2015-04-06T05:20:00+0900 2015-04-01T05:21:05+0900
  201504_lv1_001_000        OK  2015-04-07T05:20:00+0900 2015-04-01T05:22:11+0900
  201504_lv1_001_001        OK  2015-04-07T05:20:00+0900 2015-04-01T05:20:55+0900　
  
  
  パーティションの保持するデータのLSN番号を調べる場合。
  $ gs_backuplist -u admin/admin --partitionId=68
   BackupName      ID   LSN
  ---------------------------------------------------------------------------------
  *201504          68   81512
  *201503          68   2349
   20140925        68   0
  
  

GridDBのバックアップファイルをリストアします。

• コマンド

  gs_restore

  [--test]　バックアップ名

• オプション

  オプション	説明
  --test	リストアは行わず、リストアで利用するバックアップの情報を取得します。
  バックアップ名	リストアするバックアップファイルのディレクトリ名を指定します。

【メモ】

• リストアする場合は、ノードを停止させる必要があります。
• クラスタ定義ファイルの、パーティション数と処理並列度のパラメータ値には注意してください。バックアップしたノードの設定値とリストアするノードの設定値は同一にしてください。同一でないと正しくノードが起動できません。
• バックアップした状態を正しくリストアしたい場合、バックアップ、リストアの作業をクラスタ全体で行う必要があります。
• 仮に、一部ノードをリストアしたとしても、それらノードをバックアップ時点の状態に戻すことはできません。リストア後、データを利用するためには稼働中のクラスタに参加させる必要がありますが、バックアップ後にクラスタでデータ更新されていた場合には、リストアしたデータはクラスタの(更新された)データで更新されてしまいます。　特に、バックアップを作成した時点からクラスタの構成が変化している場合には、リストアの効果がありません。そのノードをクラスタに参加させると自律的にデータを再配置するので、リストアしても高い確率でデータが無効になります。
• バックアップ情報ファイルの情報が欠けている場合、または内容を改変した場合は、GridDBノードはサービスを開始できません。
• リストア途中でシグナル(Ctrl+C)を送信して処理を中断した場合、リストア途中のデータは削除されます。

【例】

• バックアップデータをリストアします。リストアを実行するノードが停止した状態で実行します。

    
  データベースファイルディレクトリ内のファイルを移動
  データベースファイルディレクトリは、ノード定義ファイル(gs_node.json)で指定
  $ mv ${GS_HOME}/data/*.{dat,log} ${GS_HOME}/temp    # データベースファイルの移動
  
  
  リストア前にリストアされるデータの確認
  $ gs_restore --test 20150424
  
  BackupName : 20150424
  BackupFolder : /var/lib/gridstore/data/backup
  
  RestoreData           Status   StartTime                EndTime
  --------------------------------------------------------------------------------
  201504_lv0 
  201504_lv1_001_001        OK  2015-04-07T05:20:00+0900 2015-04-01T05:20:55+0900
  
  
  リストアの実行
  $ gs_restore 20150424                       # リストア
  
  

• この例では、リストアを実行すると、バックアップディレクトリ( /var/lib/gridstore/backup )の下にある、201504_lv0ディレクトリから、バックアップファイル群をデータディレクトリ( /var/lib/gridstore/data )にコピー後、同様に201504_lv1_001_001のデータもコピーします。
• リストア完了後、リストアしたノードを通常の起動と同じ手順で起動し、クラスタへ参加させてください。
• 起動後、リストアで配置されたデータベースファイル(バックアップファイル群)を読み込み、読み込み完了後、GridDBノードはサービスを開始します。

ノードのパラメータの表示または変更を行います。

• コマンド

  gs_paramconf	[-s サーバ[:ポート番号]｜-p ポート番号]
  	-u ユーザ名/パスワード
  	--show [パラメータ名] ｜ --set パラメータ名 値

• オプション

  オプション	説明
  --show [パラメータ名]	指定したパラメータを表示します。パラメータを指定しなかった場合は、全パラメータの一覧が表示されます。
  --set パラメータ名 値	指定したパラメータを指定した値に変更します。

【メモ】

• パラメータの変更(--set)は、稼働しているノードのパラメータ値を動的に変更します。ノードをシャットダウンした場合、コマンド実行により変更した設定は保存されません。
• 指定できるパラメータは、以下の2つです。
  • storeMemoryLimit 　：　ストアメモリの上限
  • checkpointMemoryLimit　：　チェックポイントメモリの上限
• パラメータのデータ型など、詳細はパラメータ一覧を参照ください。

【例】

• パラメータ storeMemoryLimit を変更して、値を表示します。

  $ gs_paramconf -u admin/admin --set storeMemoryLimit 2048MB
  $ gs_paramconf -u admin/admin --show storeMemoryLimit
  {
      "module": "dataStore",
      "paramName": "storeMemoryLimit",
      "paramValue": 2048MB
  }
  

コンテナデータファイルは、コンテナ情報を記載した メタデータファイル と、コンテナに格納するデータを記載した ロウデータファイル からなります。

メタデータファイルは、コンテナのタイプや、スキーマ、設定されている索引やトリガの情報を含むjson形式のファイルです。

ロウデータファイルには、コンテナの格納データをCSV形式で記載する CSVデータファイル と、zip形式で記載する バイナリデータファイル の2種類があります。

• CSVデータファイル:
  • コンテナのロウデータをCSVデータとして記載します。可読性が高く、汎用ツールでファイルを読み込んで編集することが可能です。
  • ロウデータがBLOBや空間情報、配列などの特定の型の場合には、外部オブジェクトファイルにデータを記載し、CSVデータファイルには外部オブジェクトファイル名のみ記載します。外部オブジェクトファイルは、ロウデータ毎に作成します。
• バイナリデータファイル：
  • コンテナのロウデータをZip形式で記載します。gs_exportでのみ作成が可能です。 CSVデータファイルに比べてサイズが小さくなります。また外部オブジェクトファイルを作成する必要がないため、ファイル数が少なくて済みます。ただし、バイナリデータファイルには可読性はなく編集することはできません。

各ファイルの記述内容の詳細は、コンテナデータファイルの形式を参照してください。

また、コンテナデータファイルには、記載対象となるコンテナ数によって、以下の２種類があります。

• シングルコンテナ構成：１つのコンテナに対して１つのコンテナデータファイルを持つ
• マルチコンテナ構成：複数のコンテナを１つのコンテナデータファイルにまとめる

以降では、各構成のコンテナデータファイルを シングルコンテナデータファイル 、 マルチコンテナデータファイル と記載します。

シングルコンテナデータファイルで大量のコンテナを指定してエクスポートを実行すると、大量のメタデータファイルとロウデータファイルが作成されるため、管理が煩雑となります。一方、マルチコンテナデータファイルでは大量のコンテナを指定しても、出力されるのは１つのメタデータファイルとロウデータファイルのみです。

そこで、２つの構成は 用途に応じて使い分ける ことを推奨します。

シングルコンテナデータファイルは、以下のようなケースで利用します。

• 特定コンテナの現在のデータを出力しデータ解析したい。
• 既存のコンテナと同様のスキーマのコンテナを多数作成し、データを登録したい。

マルチコンテナデータファイルは、以下のようなケースで利用します。

• 特定コンテナ群のバックアップを採取したい。
• 異なるGridDBクラスタへデータベースを移行したい。

エクスポート実行情報ファイルには、エクスポート実行時の日時、コンテナ数、コンテナ名などの情報を保存します。このファイルはエクスポートしたデータを、そのままGridDBクラスタに復元するために必要です。

【メモ】

• エクスポート実行情報ファイルのファイル名は、gs_export.jsonです。
• エクスポートしたコンテナデータファイルを手動で編集した場合、エクスポート実行情報は削除してください。情報の不一致により、登録エラーが発生する可能性があります。
• エクスポート実行情報ファイルが存在しない場合のインポートでは、コンテナのメタデータファイルの指定が必須です。指定しない場合、インポートは失敗します。
• RDBからのインポートの場合は、エクスポート実行情報ファイルは必要ありません。

エクスポート／インポート機能が含まれているクライアントパッケージおよびJavaライブラリパッケージのインストールが必要です。

【例】

# rpm -Uvh griddb-xx-client-X.X.X-linux.x86_64.rpm
準備中...                ########################################### [100%]
User and group has already been registered correctly.
GridDB uses existing user and group.
   1:griddb-xx-client          ########################################### [100%]

# rpm -Uvh griddb-xx-java_lib-X.X.X-linux.x86_64.rpm
準備中...                ########################################### [100%]
   1:griddb-xx-java_lib        ########################################### [100%]

　　

設定ファイルは、/usr/griddb/prop/gs_expimp.properties　です。gsadmユーザで利用するGridDBクラスタ構成にあわせて設定します。

gs_expimp.properties　には以下のような設定項目があります。

パラメータ	デフォルト	説明
mode	MULTICAST	接続方式の種類を指定します。指定を省略した場合は、マルチキャスト方式になります。
		MULTICAST ・・マルチキャスト方式
		FIXED_LIST・・固定リスト方式
		PROVIDER ・・プロバイダ方式
hostAddress	239.0.0.1	GridDBのクラスタ定義ファイル(gs_cluster.json)の/transaction/notificationAddressを指定します。エクスポート・インポートツールがクラスタにアクセスする際に利用するマルチキャストアドレスです。
hostPort	31999	GridDBのクラスタ定義ファイル(gs_cluster.json)の/transaction/notificationPortを指定します。エクスポート・インポートツールがクラスタにアクセスする際に利用するマルチキャストアドレスのポートです。
notificationProvider.url	−	プロバイダ方式の接続方法を使用する場合は、クラスタ定義ファイルgs_cluster.jsonの/cluster/notificationProvider/urlを指定します。
notificationMember	−	固定リスト方式の接続方法を使用する場合は、クラスタ定義ファイルgs_cluster.jsonの/cluster/notificationMember/transactionを指定します。addressとportを:で繋いで記述します。複数ノードの場合は、カンマで連結してください。
		例）192.168.0.100:10001,192.168.0.101:10001
restAddress	127.0.0.1	GridDBのノード定義ファイル(gs_node.json)の/system/listenerAddressを指定します。将来の拡張用のパラメータです。
restPort	10040	GridDBのノード定義ファイル(gs_node.json)の/system/listenerPortを指定します。将来の拡張用のパラメータです。
clusterName	defaultCluster	クラスタ構成を組む(gs_joinclusterコマンドで指定）際に指定しているクラスタ名を指定します。
logPath	/var/lib/gridstore/log	エクスポート・インポートツールの実行時のエラー情報などのログを出力するディレクトリを指定します。ディレクトリ下に、gs_expimp-YYYYMMDD.log でログが出力されます。
getCount	1000	エクスポートでコンテナデータを取り出す際にデータを取り出す単位として、ロウ件数を指定します。数値を大きくするとデータ処理のためのバッファが大きくなります。ロウサイズが小さい場合は数値を上げ、ロウサイズが大きい場合は数値を下げてください。データエクスポートの取り出し性能に影響するパラメータです。
commitCount	1000	インポートでコンテナデータを登録する際にデータを登録する単位として、ロウ件数を指定します。数値を大きくするとデータ処理のためのバッファが大きくなります。ロウサイズが小さい場合は数値を上げ、ロウサイズが大きい場合は数値を下げてください。データインポートの登録性能に影響するパラメータです。
transactionTimeout	2147483647	トランザクション開始から終了までの時間を指定します。大量データの登録・取得時には、データ量に合わせた大きな数値を設定する必要があります。デフォルトでは、大量データ処理用に最大値が指定されています。(単位：秒)
failoverTimeout	10	ツールがノード障害を検知してからリトライを繰り返すフェイルオーバー時間を指定します。インポート/エクスポートの対象クラスタへの初期接続のタイムアウトにも用いられます。コンテナへの大量データ登録・取得などの処理を行う場合は、値を増やしてください。(単位：秒)
rdb.driver	−	RDB連携用のパラメータです。JDBCドライバのパスを指定します。
rdb.kind	oracle	RDB連携用のパラメータです。RDBの種類 "oracle" を指定します。
rdb.host	−	RDB連携用のパラメータです。RDBにアクセスする際に利用するホスト名(アドレス))を指定します。
rdb.port	−	RDB連携用のパラメータです。RDBにアクセスする際に利用するポート番号を指定します。
rdb.database	−	RDB連携用のパラメータです。対象のデータベース名を指定します。
rdb.url	−	RDB連携用のパラメータです。RDBにアクセスする際の接続文字列を指定します。 RDB接続先には、host, port, databaseの組、または、urlを指定してください。
rdb.user	−	RDB連携用のパラメータです。対象のデータベースにアクセスするユーザを指定します。
rdb.password	−	RDB連携用のパラメータです。対象のデータベースにアクセスするユーザのパスワードを指定します。
load.input.threadNum	1	RDB連携用のパラメータです。RDBから収集する処理のスレッド数を指定します。 (1〜64)
load.output.threadNum	1	RDB連携用のパラメータです。GridDBに登録する処理のスレッド数を指定します。(1〜16)
storeBlockSize	64KB	GridDBクラスタで指定しているブロックサイズを指定します。ブロックサイズによりGridDBに登録できる文字列データ、バイナリデータの上限値が異なります。
maxJobBufferSize	512	収集・登録データを保持するバッファサイズを指定します(MB)。

【メモ】

• GridDBをバージョンアップした場合、定義ファイル(/usr/griddb/prop/gs_expimp.properties)は新しいものになります。
  バージョンアップ時に、以下のメッセージが表示されます。
  警告: /usr/griddb-xx-X.X.X/prop/gs_expimp.properties は /usr/griddb-xx-X.X.X/prop/gs_expimp.properties.rpmsave として保存されました。
  GridDBインストールディレクトリ(/usr/griddb)として参照していたディレクトリのシンボリックリンクが新しくインストールしたディレクトリを参照するようになり、利用していた定義ファイルは、実際にファイルがあった場所(/usr/griddb-xx-X.X.X/prop)にgs_expimp.properties.rpmsaveとして保存されます。
  新たにインストールされた定義ファイル(/usr/griddb/prop/gs_expimp.properties)と、ご利用されていた定義ファイル(/usr/griddb-xx-X.X.X/prop/gs_expimp.properties.rpmsave)とを比較し、適宜反映してご利用ください。
  (X.X.Xは、バージョンアップ前にインストールしていたGridDBのバージョンになります。)

1. コンテナの指定方法

GridDBクラスタからコンテナを取り出すには、クラスタの全コンテナを指定する方法、データベースを指定する方法、コンテナを個別に指定する方法があります。

　　(1) 全てのコンテナの指定

• クラスタ内の全てのデータベースの全てのコンテナが対象。
• --all オプションを指定。

【例】

$ gs_export --all -u admin/admin

【メモ】

• 一般ユーザが実行する時、一般ユーザがアクセス権を持つ全データベース内のコンテナが対象になります。

　　(2) データベースの指定

• 指定したデータベースの全てのコンテナが対象。
• --db オプションでデータベース名を指定。複数のデータベース名を" "(ブランク)で区切って繰返し指定することも可能。

【例】

$ gs_export --db db001 db002 -u admin/admin　//DB名を列挙。DB内のコンテナ

【メモ】

• 一般ユーザが実行する時、--dbで指定したデータベースに対するアクセス権が無い場合は、エラーになります。(--forceを指定していると、処理は継続されます。)

　　(3) コンテナの個別指定

• 指定したコンテナが対象。
• コンテナ名を列挙
  • --container オプションで複数のコンテナ名を" "(ブランク)で区切って繰返し指定。
• コンテナ名の正規表現指定
  • --container オプションでコンテナ名の一部を指定。指定にはJavaの正規表現が利用可能。正規表現で指定する場合は""（ダブルクォーテーション）で指定を括ります。

【例】

$ gs_export --container c001 c002 -u admin/admin　//コンテナ名を列挙
$ gs_export --container "^c0" -u admin/admin　　　//正規表現指定：コンテナ名がc0で始まるコンテナの指定
　　

【メモ】

• --container オプションでは、--prefixdb オプションで対象のデータベース名を指定します。--prefixdb オプションを省略した場合は、デフォルトの接続先データベース「public」内のコンテナが処理対象になります。
• 一般ユーザが実行する時、--container オプションで指定したコンテナが格納されているデータベースに対するアクセス権が無い場合は、エラーになります。(--forceを指定していると、処理は継続されます。)

　

2. ロウの指定方法

コンテナからロウを取り出す検索クエリを指定することで、検索クエリにヒットするロウのみエクスポートすることができます。
検索クエリが指定されていないコンテナは、コンテナに格納されているすべてのロウがエクスポートされます。

　検索クエリの指定

• --filterfile オプションで、コンテナ名と検索クエリを記述した定義ファイルを指定します。定義ファイルには、検索クエリを適用する対象のコンテナと、検索クエリを記述してください。

  【例】実行例

  $ gs_export -c c001 c002 -u admin/admin --filterfile filter1.txt
  　　
  $ gs_export --all -u admin/admin --filterfile filter2.txt
  

  【例】定義ファイルの記述

  ^cont_month     :select * where time > 100  [改行]
  ^cont_minutes_.*:select * where flag = 0    [改行]
  cont_year2014   :select * where timestamp > TIMESTAMP('2014-05-21T08:00:00.000Z') [改行]
  

【メモ】

• コンテナは、Javaの正規表現で指定します。 例) "container1"と記述すると、container1を含むコンテナが該当します(container10, container12など)。完全一致の場合は、"^container1$"と記述してください。
• --allや-c オプションで指定されたエクスポート対象コンテナの中で、定義ファイルに記述された定義に当てはまらないコンテナは、すべてのロウがエクスポートされます。
• コンテナと検索クエリの区切りは":"を指定し、コンテナと検索クエリは1行で記述してください。
• コンテナが複数の定義に該当する場合、最初に記述された定義が適用されます。
• ファイルはUTF-8で記述してください。
• エクスポートのテスト機能を実行すると、定義ファイルの記述が正しいかを確認することができます。

3. ユーザ・アクセス権の指定方法

GridDBクラスタのユーザやアクセス権の情報もエクスポートすることができます。クラスタ上のすべてのデータを移行する場合にご利用ください。

• --all オプションおよび --acl オプションを指定。ただし、エクスポートできるユーザ情報は、一般ユーザのみです。管理ユーザの情報は別途移行（ユーザ定義ファイルをコピー）してください。

  【例】

  $ gs_export --all -u admin/admin --acl
  　　
  

【メモ】

• 管理ユーザで実行する必要があります。

ロウデータファイルの出力形式として、CSVデータファイル、もしくはバイナリデータファイルが指定できます。

　CSVデータファイルでの出力

• --binary オプションを指定せずにエクスポートを実行します。

　バイナリデータファイルでの出力

• --binary [ファイルサイズ上限] オプションを指定します。指定したファイルサイズ上限でバイナリデータファイルを分割してエクスポートします。ファイルサイズ上限はMbytes単位で指定します。ファイルサイズ上限の指定を省略するとサイズ上限は100Mbytesとなります。指定できる最大ファイルサイズは1,000Mbytesです。

【例】

$ gs_export -c c001 c002 -u admin/admin --binary
　　
$ gs_export --all -u admin/admin --binary 500       //500Mbytesごとにバイナリデータファイルを分割
　　

コンテナ単位にコンテナデータファイルを作成するシングルコンテナデータファイル、もしくは全コンテナを１つのコンテナデータファイルに出力するマルチコンテナデータファイルが指定できます。

　シングルコンテナデータファイルでの出力

• エクスポート時に--out オプションを指定しない場合、シングルコンテナデータファイルで出力されます。

　マルチコンテナデータファイルでの出力

• --out [ファイル識別子] オプションを指定します。ファイル識別子の指定により、メタデータファイルのファイル名は「ファイル識別子_properties.json」となります。マルチコンテナデータファイルがCSVデータファイルの場合「ファイル識別子.csv」、バイナリデータファイルの場合「ファイル識別子.mc」となります。
• --out [ファイル識別子] オプションでファイル識別子を省略した場合、日付のマルチコンテナデータファイルが作成されます。（例：20131031_155015_810_properties.json ,20131031_155015_810.csv）

【例】

$ gs_export -c c001 c002 -u admin/admin --out test
　　
$ gs_export --all -u admin/admin --out           //日付でファイルが作成される
　　

コンテナデータファイルの出力先として、ディレクトリを指定できます。指定したディレクトリが存在しなかった場合にはディレクトリを作成します。ディレクトリの指定を省略した場合、コマンド実行時のカレントディレクトリにデータを出力します。出力先の指定は-d オプションを用います。

【例】

$ gs_export --all -u admin/admin --out test -d /tmp
　　　　

【メモ】

• 既にコンテナデータファイルが存在するディレクトリは指定できません。

エクスポートツールで並列にクラスタにアクセスしてデータを取得します。クラスタが複数のノードで構成されている場合に並列実行すると、ノードごとに並列アクセスするので高速に取得することができます。

• --parallel オプションを指定することで、指定された数で並列実行を行います。並列実行を行うと、エクスポートデータは並列実行数と同じ数で分割されます。指定範囲は、2から32までです。

  【メモ】

  • --parallel オプションは、バイナリ形式(--binary オプション)、および、マルチコンテナ形式(--out オプション)を指定した場合のみ指定できます。

  【例】

  $ gs_export --all -u admin/admin --binary --out --parallel 4
  

利用者がコンテナをエクスポートする前に、正しくエクスポートが行えるかを評価することができます。

　テスト実行指定

• 通常のエクスポートコマンドの利用に対して、--test オプションを追加するだけで、エクスポートシーケンスを確認することができます。確認のみで実際の取得処理は行わないので、ファイルは作成されません。

【例】

$ gs_export -u admin/admin --all --test
エクスポートを開始します
[テストモード]
出力ディレクトリ : /var/lib/gridstore/export
対象コンテナ数  : 5

container_2 : 10
container_3 : 10
container_0 : 10
container_1 : 10
container_4 : 10

対象コンテナ数 : 5 ( 成功:5  失敗:0 )
エクスポートを終了しました

別アプリケーションとのロック競合によってロウデータ取得エラーが発生した場合も、エクスポート処理を継続できます。

• --force オプションを指定することで、ロウデータ取得エラーが発生しても、次コンテナのロウデータからエクスポート処理を継続します。

  【例】

  $ gs_export --all -u admin/admin --force
  

  【メモ】

  • エラーによって処理をスキップしたコンテナについても、不完全ですがコンテナデータファイルに情報を出力します。ただし、エクスポート実行ファイルには記録していないため、インポート処理されることはありません。ロウデータ取得エラー解決後、当該コンテナのエクスポート処理を再実行してください。

　動作表示の詳細指定

• --verbose オプションを指定することで、処理の詳細を表示することができます。

【例】

$ gs_export -c "^c0" -u admin/admin --verbose
エクスポートを開始します
サーバーに接続しました:/239.0.0.15:31999
GridStoreからコンテナ名一覧を取得しました
処理対象のコンテナ名一覧を取得しました
コンテナ情報を格納するファイル名リストを作成しました
コンテナ情報からロウデータを取得します
CSV形式ロウデータファイル出力処理を開始します:/data/exp/c001.csv
次のコンテナを処理します:c001
CSV形式ロウデータファイル出力処理を開始します:/data/exp/c002.csv
次のコンテナを処理します:c002
CSV形式ロウデータファイル出力処理を開始します:/data/exp/c010.csv
次のコンテナを処理します:c010
CSV形式ロウデータファイル出力処理を開始します:/data/exp/c003.csv
次のコンテナを処理します:c003
ロウデータの取得を完了しました
コンテナ情報をメタ情報ファイルに出力します
シングルコンテナのメタ情報ファイル作成処理を開始します
シングルコンテナのメタ情報ファイル作成処理を終了しました
コンテナ情報をメタ情報ファイルに出力しました

エクスポートを完了しました

成功:4  失敗:0

　動作表示の抑止指定

• --silent オプションを指定することで、処理状況の表示が抑制できます。

【例】

$ gs_export -c c002 c001 -u admin/admin --silent

Importツールの入力データソースには、以下があります。

• コンテナデータファイル：エクスポート機能で保存したコンテナデータ、またはユーザが作成したコンテナデータ
• RDB：Oracleデータベースデータ

  【メモ】

  • RDB(Oracle)は、Importツールでの入力先としてのみ指定できます。Exportツールの出力先としては指定できません。

エクスポート機能でエクスポートしたデータ形式のデータをGridDBクラスタにインポートします。

処理対象の指定

　コンテナデータファイルの中からインポートする処理対象のデータを指定する必要があります。

1. コンテナの指定方法

コンテナデータファイル内の全コンテナを指定する方法、データベースを指定する方法、コンテナを個別に指定する方法があります。

　　(1) 全てのコンテナの指定

• 全てのデータベースの全てのコンテナが対象。
• --all オプションを指定。

【例】

$ gs_import --all -u admin/admin
　　

　　(2) データベースの指定

• 指定したデータベースの全てのコンテナが対象。
• データベース名を列挙
  • --db オプションで複数のデータベース名を" "(ブランク)で区切って繰返し指定。

【例】

$ gs_import --db db001 db002 -u admin/admin　//DB名を列挙。DB内のコンテナ
　　

　　(3) コンテナの個別指定

• 指定したコンテナが対象。
• コンテナ名を列挙
  • --container オプションで複数のコンテナ名を" "(ブランク)で区切って繰返し指定。
• コンテナ名の正規表現指定
  • --container オプションでコンテナ名の一部を指定。指定にはJavaの正規表現が利用可能。正規表現で指定する場合は""（ダブルクォーテーション）で指定を括ります。

【例】

$ gs_import --container c001 c002 -u admin/admin　//コンテナ名を列挙
$ gs_import --container "^c0" -u admin/admin　　　//正規表現指定：コンテナ名がc0で始まるコンテナの指定
　　

【注意事項】

• GridDB V3.2以前でエクスポートしたデータにNewSQL I/Fで作成したテーブルが含まれる場合、V3.5以降ではコレクションとしてインポートされます。また、テーブルの索引に設定されている索引名はインポートされません。

【メモ】

• 管理ユーザで実行する時、コンテナの格納先のデータベースが存在しない場合はデータベースを作成します。
• 一般ユーザが実行する時、コンテナの格納先のデータベースが存在しない場合、またはアクセス権が無い場合は、エラーになります。(--forceを指定していると、処理は継続されます。)
• --container オプションを指定した場合、--prefixdb オプションで対象のデータベース名を指定します。--prefixdb オプションを省略した場合は、デフォルトの接続先データベース「public」が処理対象になります。
• コンテナデータファイルに格納されているコンテナ一覧は--listオプションで確認してください。

エクスポート機能で--aclオプションを指定してエクスポートしたデータの場合、ユーザやアクセス権の情報もインポートすることができます。クラスタ上のすべてのデータを移行する場合にご利用ください。

• --all オプションおよび --acl オプションを指定。

  【例】

  $ gs_import --all --acl -u admin/admin
  　　
  

【メモ】

• 管理ユーザで実行する必要があります。
• クラスタ上のすべてのデータを移行する場合にご利用ください。移行先にはデータベース・一般ユーザが存在しない状態で実行してください。

コンテナデータファイルの指定

コンテナデータファイルを指定します。指定を省略した場合は、カレントディレクトリのファイルが処理対象となります。

• ディレクトリを指定
  • -d オプションでコンテナデータファイルの配置されているディレクトリを指定します。
  • ディレクトリの指定が省略された場合、コマンド実行時のカレントディレクトリのコンテナデータファイルが対象となります。

  【例】

  //カレントディレクトリから全コンテナを指定
  $ gs_import --all -u admin/admin
  
  //特定ディレクトリからデータベースを複数指定
  $ gs_import --db db002 db001 -u admin/admin  -d /data/expdata
  
  //特定ディレクトリからコンテナを複数指定
  $ gs_import -c c002 c001 -u admin/admin  -d /data/expdata
  
  

【メモ】

• コンテナデータファイルの手動作成等により、エクスポート実行情報ファイル(gs_export.json)が存在しない場合には、-f オプションでメタデータファイル(XXXXX_properties.json)を指定してください。-f オプションを指定しない場合、インポートは失敗します。

コンテナ一覧の取得

コンテナデータファイル内に格納されたコンテナ情報をインポートする前に確認することができます。

【例】

$ gs_import --list
エクスポートデータファイルのコンテナ一覧を表示します
DB            Name              Type            FileName
public        container_2       COLLECTION      container_2.csv
public        container_0       TIME_SERIES     container_0.csv
public        container_1       COLLECTION      container_1.csv
userDB        container_1_db    TIME_SERIES     userDB.container_1_db.csv
userDB        container_2_db    TIME_SERIES     userDB.container_2_db.csv
userDB        container_0_db    COLLECTION      userDB.container_0_db.csv