| Linux | /opt/couchbase/bin/couchbase-cli
|
| Windows | C:\Program Files\Couchbase\Server\bin\cli\couchbase-cli.exe
|
このツールは、Couchbase Serverクラスタ、ノードおよびバケットのさまざまな管理操作へのアクセスを提供します。基本的な使用形式は次のとおりです。
couchbase-cli COMMAND CLUSTER [OPTIONS]ここで：
COMMANDには表7.2「couchbaseツールコマンド」の各コマンドを指定します。
CLUSTERは、クラスタの接続情報です。次のいずれかを使用できます。
--cluster=HOST[:PORT]または短縮形：
-c HOST[:PORT]
OPTIONSは、0個以上のオプションです。
表7.2 couchbaseツールコマンド
| コマンド | 内容 |
|---|---|
server-list
| クラスタ内のすべてのサーバーを一覧表示します。 |
server-info
| あるサーバー上の詳細を表示します。 |
server-add
| クラスタに1つ以上のサーバを追加します。 |
server-readd
| フェイルオーバーしたサーバを再度追加します。 |
rebalance
| リバランスを起動します。 |
rebalance-stop
| 実行中のリバランスを停止します |
rebalance-status
| 実行中のリバランスの状態を示します。 |
failover
| １つ以上のサーバーをフェイルオーバーします。 |
cluster-init
| クラスタのユーザ名、パスワード、ポートを設定します。 |
node-init
| ノードの固有パラメータを設定します。 |
bucket-list
| クラスタ内のすべてのバケットの一覧を表示します。 |
bucket-create
| クラスタに新しいバケットを追加します。 |
bucket-edit
| 既存のバケットを修正します。 |
bucket-delete
| 既存のバケットを削除します。 |
bucket-flush
| 指定したバケットをフラッシュします。 |
help
| 詳細な使用法／ヘルプと例を示します。 |
表7.3 標準couchbaseオプション
| オプション | コマンド | 内容 |
|---|---|---|
--user=USERNAME,-u USERNAME
| クラスタにアクセスするための管理者ユーザ名 | |
--password=PASSWORD,-p PASSWORD
| クラスタにアクセスするための管理者パスワード | |
--output=KIND,-o KIND
| 出力形式、JSON形式の場合はjson、コマンド独自形式の場合はstandard
| |
--debug,-d
| デバッグ情報を出力 | |
--server-add=HOST[:PORT]
| server-add,server-readd, rebalance
| 追加するサーバ |
--server-add-username=USERNAME
| server-add,server-readd, rebalance
| 追加するサーバの管理者ユーザ名 |
--server-add-password=PASSWORD
| server-add,server-readd, rebalance
| 追加するサーバの管理者パスワード |
--server-remove=HOST[:PORT]
| rebalance
| 削除するサーバ |
--server-failover=HOST[:PORT]
| failover
| フェイルオーバーするサーバ |
--cluster-init-username=USER
| cluster-init
| 新しい管理者ユーザ名 |
--cluster-init-password=PASSWORD
| cluster-init
| 新しい管理者パスワード（少なくとも6文字でなければなりません） |
--cluster-init-port=PORT
| cluster-init
| 新しいクラスタポート |
--cluster-init-ramsize=300
| cluster-init
| 新しいRAMの割当 |
--bucket=BUCKETNAME
| bucket*
| バケットの指定 |
--bucket-type=TYPE
| bucket*
| MemcachedかMembaseか |
--bucket-port=PORT
| bucket*
| ASCIIプロトコルをサポート、認証なし |
--bucket-password=PASSWORD
| bucket*
| 標準のポートへ接続、bucket-portと同時指定は不可 |
--bucket-ramsize=RAMSIZEMB
| bucket*
| MB単位のRAM割当 |
--bucket-replica=COUNT
| bucket*
| レプリケーション数 |
例：
クラスタ内のサーバ一覧：
shell> couchbase-cli server-list -c 192.168.0.1:8091サーバ情報
shell> couchbase-cli server-info -c 192.168.0.1:8091クラスタにノードを追加、リバランスはしない：
shell> couchbase-cli server-add -c 192.168.0.1:8091 \ --server-add=192.168.0.2:8091クラスタにノードを追加し、リバランスする：
shell> couchbase-cli rebalance -c 192.168.0.1:8091 \ --server-add=192.168.0.2:8091クラスタからノードを削除し、リバランスする：
shell> couchbase-cli rebalance -c 192.168.0.1:8091 \ --server-remove=192.168.0.2:8091クラスタからノードを削除、および追加し、リバランスする：
shell> couchbase-cli rebalance -c 192.168.0.1:8091 \--server-remove=192.168.0.2 \ --server-add=192.168.0.4実行中のリバランスを停止：
shell> couchbase-cli rebalance-stop -c 192.168.0.1:8091ユーザ名、パスワード、ポートを変更：
shell> couchbase-cli cluster-init -c 192.168.0.1:8091 \ --cluster-init-username=Administrator \ --cluster-init-password=password \ --cluster-init-port=8080
クラスタ内のバケット一覧：
shell> couchbase-cli bucket-list -c 192.168.0.1:8091専用ポートで新しいcouchbaseのバケットを作成：
shell> couchbase-cli bucket-create -c 192.168.0.1:8091 --bucket=test_bucket \ --bucket-type=couchbase --bucket-port=11222 --bucket-ramsize=200 \ --bucket-replica=1
新しいSASL memcachedバケットを作成：
shell> couchbase-cli bucket-create -c 192.168.0.1:8091 --bucket=test_bucket \ --bucket-type=memcached--bucket-password=password \ --bucket-ramsize=200
専用ポートのバケットを修正：
shell> couchbase-cli bucket-edit -c 192.168.0.1:8091 --bucket=test_bucket \ --bucket-port=11222 --bucket-ramsize=400
バケットを削除：
shell> couchbase-cli bucket-delete -c 192.168.0.1:8091 --bucket=test_bucket