get_community(コミュニティ情報一覧の出力)
機能
データベースのコミュニティ情報の一覧を出力します。コミュニティポリシーでメンバだけ参照できるようにしているコミュニティの情報も出力できます。
形式
get_community [-o 出力ファイル名] [-i 文字コード] [-q] [-e ログファイル名] [-c | -l コミュニティ情報一覧ファイル名]
オプション
- -o 出力ファイル名
- 指定したファイルに標準出力データを出力します。ただし,出力メッセージのうち,KDCM00071-E~KDCM00076-Eは出力しません。
- 出力ファイル名の指定方法の詳細は,「5.2(3)-oオプションに指定する出力ファイル」を参照してください。
- -i 文字コード
- -lオプションを指定した場合や,-lオプションと-cオプションの両方を省略した場合に出力されるコミュニティ情報一覧ファイルを,指定した文字コードでエンコードします。
- 指定できる文字コードは「Windows-31J」および「UTF-8」です。文字コードは半角英数字で指定してください。Javaでサポートされていない文字コードを指定した場合はエラーメッセージが出力され,コミュニティ情報一覧ファイルは出力されません。「Windows-31J」または「UTF-8」以外のJavaでサポートされている文字コードを指定した場合は,指定した文字コードでファイルが出力されますが,動作は保障されません。
- このオプションを省略した場合は,「Windows-31J」でエンコードされます。
- なお,「UTF-8」を指定した場合,UTF-8エンコード表示に対応しているアプリケーションを使用しないと正しく表示されません。
- -q
- 標準出力および標準エラー出力への出力を抑制します。
- -e ログファイル名
- 指定したログファイルに,次の情報を出力します。
- SQLクエリ発行直前および発行直後のSQLクエリ文字列
- SQLクエリ発行時のエラーメッセージ
- ログファイル名の指定方法の詳細は,「5.2(4)-eオプションに指定するログファイル」を参照してください。
- -c
- 現在データベースに登録されているコミュニティの数を標準出力に出力します。ほかのコミュニティ情報は出力しません。
- 出力例
- 現在のコミュニティ数:1000
- 削除済みコミュニティ数:2000
- このオプションを指定しない場合は,-lオプションを指定してください。
- -l コミュニティ情報一覧ファイル名
- 指定したファイルに,コミュニティ情報の一覧をCSV形式で出力します。
- このオプションを指定しない場合は,-cオプションを指定してください。
- ファイル名の指定方法
- コミュニティ情報一覧ファイル名は,絶対パス,またはコマンドを実行するディレクトリからの相対パスで指定します。ファイル名は,220バイト以内の文字列で指定します。ただし,絶対パスで表したときに220バイト以内(CSVファイルをMicrosoft Excelで開く場合は202バイト以内)の文字列になるように指定してください。
- コミュニティ情報一覧ファイルに出力される項目
- コミュニティ情報一覧ファイルには,次の項目が出力されます。
- コミュニティID
- コミュニティ名
- 削除フラグ
- コミュニティ作成者(uniqueid)
- コミュニティ参照可能フラグ(outcommuflagの値)
- ワークプレースID一覧
- コミュニティメンバ数
- コミュニティ管理者数
- コミュニティ管理者一覧(uniqueid)
- コミュニティ情報一覧ファイルの出力形式については,「7.2.10 コミュニティ情報一覧ファイル」を参照してください。
-
- ファイル名の形式
- 新規に作成される出力ファイルのファイル名は,次のようになります。
- aaa_yyyyMMdd_HHmmss.bbb
- 文字列の意味
- aaa:-lオプションに指定したファイル名から拡張子を除いた文字列
- yyyy:実行日付(年)
- MM:実行日付(月)
- dd:実行日付(日)
- HH:実行時刻(時)
- mm:実行時刻(分)
- ss:実行時刻(秒)
- bbb:-lオプションに指定したファイル名の拡張子
- 例えば,-lで指定したファイル名が「option_community.csv」,コマンドの実行日時が「2003年12月31日20:32:10」の場合,「option_community_20031231_203210.csv」となります。
-
- -lオプションおよび-cオプションの両方を省略した場合
- hptl_clb_ccm_cmd.propertiesファイルのhptl_clb_ccm_cmd_community_fileの値がファイル名となります。
- 例えば,hptl_clb_ccm_cmd_community_fileの指定文字列がproperty_community.csv,コマンドの実行日時が2003年12月31日20:32:10の場合,「property_community_20031231_203210.csv」となります。この場合,ファイルの出力先はコマンドを実行するときのカレントディレクトリになります。同じファイルがすでに存在する場合は,別ファイルに出力します。
-
- -lオプションを省略しhptl_clb_ccm_cmd_community_fileを指定していない場合
- プログラムのデフォルトである「community.csv」がファイル名となります。
- 例えば,コマンドの実行日時が2003年12月31日20:32:10の場合,「community_20031231_203210.csv」となります。
- この場合,ファイルの出力先はコマンドを実行するときのカレントディレクトリになります。
戻り値
get_communityコマンドの戻り値を次に示します。
表5-10 get_communityコマンドの戻り値
戻り値 | 意味 |
---|
0 | 正常終了しました。 |
1 | ユーザによる強制終了が発生したか,またはコマンド用jarが見つかりません。 |
2 | hptl_clb_ccm_cmd.propertiesが見つかりません。 出力ファイル,ログファイル,またはコミュニティ情報一覧ファイルを生成できません。 |
4 | 排他のオプションが重複して指定されています。 |
12 | 出力ファイル名,ログファイル名,またはコミュニティ情報一覧ファイル名が長過ぎます。 |
14 | hptl_clb_ccm_cmd.propertiesの属性値が適切な範囲にありません。 |
21 | データベースからの応答がありません。 |
22 | データベースへの接続に失敗しました。 |
23 | SQLクエリの実行に失敗しました。 |
24 | JDBCドライバがインストールされていません。または,パスが通っていません。 |
31 | 入出力処理中にエラーが発生しました。 |
32 | トレース処理中にエラーが発生しました。 |
33 | コマンドの書式が違います。 |
34 | システム情報の取得に失敗しました。 |
35 | nullが指定されました。 |
36 | 内部矛盾が発生しました。 |
39 | 次の意味が考えられます。
- コマンドが実行できる状態ではありません。
- 環境変数が設定されていません。
- システムコールでエラーが発生しました。
|
40 | ファイル出力時にエンコードに失敗しました。 |
実行結果
-cオプションを指定した場合は,データベース上のコミュニティの数が標準出力に出力されます。
-lオプションを指定した場合は,指定したコミュニティ情報一覧ファイルに,コミュニティ情報の一覧が出力されます。
-cオプションおよび-lオプションの両方を省略した場合は,プロパティファイルのhptl_clb_ccm_cmd_community_fileの値をファイル名として,コミュニティ情報の一覧が出力されます。
使用例
get_communityコマンドの使用例を紹介します。ここでは,次のような環境を想定しています。
- ソフトウェア環境
get_communityコマンドを実行できる環境
- コマンドプロンプトのカレントディレクトリ
<Collaboration - Serverインストールディレクトリ>¥community¥command¥bin
- コミュニティ情報一覧ファイル
C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥bin¥community_list.csv
- コミュニティ情報一覧をCSVファイルに保存する場合
- 指定したCSVファイルにコミュニティ情報一覧を出力する場合,get_communityコマンドを次のように実行します。
get_community -l "C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥bin¥community_list.csv" |
- 実行例は,紙面の都合上,改行されているように表示されていますが,実際に実行するときは,1行で記述する必要があります。
- 現在存在しているコミュニティの個数を表示する場合
- 現在存在しているコミュニティの個数を表示する場合,get_communityコマンドを次のように実行します。
注意事項
- get_communityコマンドの実行中に作成されたコミュニティについては,コミュニティの情報が出力されないことがあります。
- get_communityコマンドの実行中にメンバ数やワークプレース数などの情報が変更された場合は,変更前の情報が出力されることがあります。
- get_communityコマンドの実行中にコミュニティを作成すると,メッセージ(KDCM00037-WやKDCM00038-W)が出力されることがあります。この場合,作成中のコミュニティはコミュニティ情報一覧ファイルに出力されないため,必要に応じてget_communityコマンドを再度実行してください。再度実行しても同じメッセージが出力される場合は,「付録F.2 メッセージ一覧」のKDCM00037-WやKDCM00038-Wの対処に従って,不正なレコードを削除してください。