14.3.9 listkey（keyの一覧表示）
- 〈この項の構成〉
(1) 機能
キャッシュに格納されているkeyの一覧を表示します。
(2) 規則
-
このサブコマンドは，EADSサーバが稼働状態（running）のときに実行できます。
-
EADSサーバの位置（Position）の降順に実行します。
-
サブコマンド実行前のチェックの時点で，対象範囲に存在するkeyの数が1,000個以下の場合に実行できます。
(3) 形式
eztool listkey ［-g ＜グループ名＞|-s］ ［-f ＜強制実行時のkeyの数の上限＞］
＜キャッシュ名＞
［--format ＜フォーマット名＞］
［--columns ＜列名＞［,＜列名＞］…］
［--filter ＜フィルタの条件＞］
［--match ＜一致条件＞］
(4) オプションおよび引数
(a) -gまたは--group ＜グループ名＞
グループに属しているkeyだけを表示したい場合に指定します。
グループ名として指定できるデータについては，「15.2.2(2) グループ名として指定できるデータ」を参照してください。
(b) -sまたは--single
サブコマンドを実行するEADSサーバに格納されているkeyだけを表示したい場合に指定します。
(c) -f または--force ＜強制実行時のkeyの数の上限＞
対象範囲に存在するkeyの数が1,000個より多い場合に，サブコマンドを実行できるkeyの数の上限値を引き上げて，強制的にサブコマンドを実行したいときに指定します。
ただし，このオプションで上限値を引き上げて実行すると，サブコマンドが最後まで適切に実行できなくなったり，EADSサーバのリソースを大量に消費したりするおそれがあります。
keyの数の上限には，1001〜10000の整数を指定します。
- 注意事項
-
対象範囲に存在するkeyの数が，1,000個より僅かに多い場合などに，このオプションを指定することを検討してください。
-
各EADSサーバに格納されているkeyの総数が1,000個以内の場合
このオプションではなく-sまたは--singleオプションを指定して，各EADSサーバで順番にeztool listkeyコマンドを実行してください。
-
各最上位階層のグループに属するkeyの総数が1,000個以内の場合
eztool listgroupコマンドで確認した最上位階層のグループ階層名を，eztool listkeyコマンドの-gまたは--groupオプションの引数に指定して，各グループで順番に実行してください（ただし，グループに属さないkeyは，この方法では確認できません）。
-
(d) ＜キャッシュ名＞
keyの一覧を表示するキャッシュの名称を指定します。
キャッシュ名に指定できる文字を次に示します。
-
キャッシュ作成時にキャッシュ定義ファイルを使用しなかった場合
半角32文字までの，ASCIIコード「0x20」〜「0x7E」の文字が指定できます。
-
キャッシュ作成時にキャッシュ定義ファイルを使用した場合
半角32文字までの，半角英数字（0〜9，A〜Z，およびa〜z）が指定できます。
(e) --format ＜フォーマット名＞
このオプションの詳細については，「14.4.2 表示形式の指定方法」を参照してください。
(f) --columns ＜列名＞［,＜列名＞］…
このオプションの詳細については，「14.4.3 列のフィルタリングの指定方法」を参照してください。
(g) --filter ＜フィルタの条件＞
このオプションの詳細については，「14.4.4 行のフィルタリングの指定方法」を参照してください。
(h) --match ＜一致条件＞
このオプションの詳細については，「14.4.5 条件一致の指定方法」を参照してください。
(5) 出力例
eztool listkeyコマンドの実行結果の出力例を次に示します。
表示の構成要素については，「14.4.1 表示内容の構成要素」を参照してください。
![[図データ]](GRAPHICS/ZU111000.GIF)
サマリとメインの表示内容を，それぞれ次の表に示します。
|
項番 |
サマリ名 |
説明 |
|---|---|---|
|
1 |
KeyCount |
指定した範囲に存在するkeyの数 |
|
項番 |
列名 |
説明 |
|---|---|---|
|
1 |
Server |
EADSサーバのIPアドレス，およびEADSクライアントとの通信に使用するEADSサーバのポート番号※ 次の形式で表示されます。 IPアドレス:ポート番号 |
|
2 |
Position |
EADSサーバの位置（ハッシュ値）※ |
|
3 |
ID |
EADSサーバID※ |
|
4 |
Key |
指定した範囲に存在するkey |
- 注
-
実行結果は，次の優先順位に従って表示されます。
-
Positionの値の降順で表示されます。
-
Positionの値が同じ行は，Keyの値の自然順序順に表示されます。
-
- 注※
-
実行結果に，同じ値のセルが続く場合，2行目以降のセルの値は表示が省略されます。
(6) リターンコード
次の表に示すリターンコードが返却されます。
|
項番 |
リターンコード |
リターンコードの説明 |
|
|---|---|---|---|
|
コマンド定義のeads.command.compatパラメタを指定していない場合 |
コマンド定義のeads.command.compatパラメタに0300を指定した場合 |
||
|
1 |
0 |
0 |
コマンドの実行に成功しました。 |
|
2 |
101 |
101 |
コマンドの初期化に失敗しました。 |
|
3 |
120 |
構文不正で失敗しました。 |
|
|
4 |
150 |
コマンド実行中に失敗しました。 |
|
|
5 |
200 |
コマンドタイムアウトで失敗しました。 |
|
- --matchオプションを指定した場合
-
条件に一致した場合は0，一致しなかった場合は1を，リターンコードとして返します。ただし，コマンドの実行に失敗したときは，--matchオプションを指定しなかった場合と同じになります。
(7) 注意事項
-
このサブコマンドを実行すると，APを作成しなくても，keyの一覧を確認できます。ただし，対象範囲に存在するkeyの数が1,000個を超える場合は，APを作成する必要があります。
-
このサブコマンドの実行中にkeyが追加された場合，追加されたkeyが格納された領域によって，次のように動作します。
-
keyの一覧を取得済みの領域にkeyが格納されたとき
追加されたkeyは一覧に表示されません。
-
keyの一覧を取得していない領域にkeyが格納されたとき
追加されたkeyは一覧に表示されます。
なお，keyの数の確認は実際にkeyの一覧を取得する前に行うため，確認後に大量のkeyを追加すると，上限数を超えるkeyが表示されます。
-
-
出力処理中にコマンドがタイムアウトした場合，出力結果が欠落することがあります。また，出力処理が完了していても，コマンドがタイムアウトになることがあります。このような場合には，コマンドのタイムアウト時間を大きくしてから再実行してください。
-
大量のデータを格納している場合，リソースの使用量が増加するため，注意してください。
-
このサブコマンドの実行中に，EADSサーバがクラスタに追加または復旧された場合，追加または復旧されたEADSサーバが実行対象から外れて，一部のkeyが表示されないことがあります。その場合は，このサブコマンドを再実行してください。