datadumper/出力

datadumperコマンドは、bounceHammerデータベースのバウンス記録テーブル(BounceLogs)の読出し専用コマンドです。複雑な条件指定はできませんが、ある程度の条件を指定してそれに該当するものだけを出力する事も出来ます。 このコマンドはインストールしたディレクトリ/bin/datadumperにあります。

• コマンドの使用例
• 利用可能なオプション
• コマンド実行結果のスクリーンショットでの説明

使用例

datadumperは、tablectlやdatabasectlと同様、BounceHammerのデータベース/マスターテーブルに対してSQL文を発行せずともある程度の操作が出来るようになっています。また、datadumperコマンドとほぼ同等の操作が管理画面(WebUI)でも可能です。

検索条件指定オプション

-A, --alldata

datadumperをオプション無しで起動すると、disabled=1になっているデータは除外されて出力されます。このオプションを付けるとdisabledが1になっているものも含めて、データベースに存在する全てのデータが出力されます。

-a, --addresser 発信者アドレス

addresser(発信者アドレス)を指定します。指定した発信者アドレスに完全一致するデータのみ出力されます。

-r, --recipient 受信者アドレス

recipient(受信者アドレス)を指定します。指定した受信者アドレスに完全一致するデータのみ出力されます。

-s, --senderdomain 発信者ドメイン

senderdomain(発信者ドメイン)を指定します。指定した発信者ドメインに完全一致するデータのみ出力されます。

-d, --destinaiton 受信者ドメイン

destination(受信者ドメイン)を指定します。指定した受信者ドメインに完全一致するデータのみ出力されます。

-w, --reason 差戻理由

reason(差戻理由)を指定します。指定した差戻理由に完全一致するデータのみ出力されます。指定できる値は、tablectl -tw --list で得られる一覧の"why"の値のいずれかです。

-g, --hostgroup 宛先分類

hostgroup(宛先分類)を指定します。指定した宛先分類に完全一致するデータのみ出力されます。指定できる値は、tablectl -th --list で得られる一覧の"name"の値のいずれかです。

-p, --provider 宛先所属

provider(宛先所属)を指定します。指定した宛先所属に完全一致するデータのみ出力されます。指定できる値は、tablectl -tp --list で得られる一覧の"name"の値のいずれかです。

-t, --token メッセージトークン

token(メッセージトークン)を指定します。指定したメッセージトークンに完全一致するデータのみ出力されます。メッセージトークンはmessagetokenコマンドで生成する事も出来ます。あるいは、--addresser, --recipientの双方を指定した場合と等価です。

-h, --howrecent 数値/単位

バウンスが発生した最古の期間を指定します。指定した期間よりも後にバウンスしたデータのみ出力されます。

指定できる数値は正の整数または浮動小数点数(いずれも10進数表記のみ、指数表記不可)、単位は s:秒(seconds), m:分(minutes), h:時間(hours), d:日(days), w:週(weeks), y:年(years)です。単位を省略した場合はd(日)として扱われます。 e.g.) 2w = 2週間、3d = 3日、 1y = 1年

-f, --frequency 差戻回数下限 (Ver.2.6.3以降)

差戻回数(バウンスした回数)の下限値を指定します。例えば --frequency 6と指定した場合は、差戻回数が6回以上である記録のみが出力されます。

出力形式オプション

-o, --orderby カラム名

指定したカラム名(addresser, recipient等)で昇順で並べた結果が出力されます。未指定時はIDの値で昇順ソートされます。

-O, --orderbydesc カラム名

指定したカラム名(addresser, recipient等)で降順で並べた結果が出力されます。未指定時はIDの値で昇順ソートされます。

--count

条件に一致するデータを出力するかわりに、該当するデータの件数を出力します。SQLのSELECT count(*)に相当します。

--comment

出力されるデータの先頭にコメントとして実行(検索・出力)した日時とプログラム名datadumperが加えられます。特に役に立つオプションではありませんので、bounceHammerの将来のバージョンでは削除されるかもしれません。

その他のオプション

-C, --conf 設定ファイル

読み込む設定ファイルを指定します。このオプションを使用しない場合、インストール先/etc/bouncehammer.cfが使用されます。複数の設定ファイルを処理毎に使い分ける場合などでは有用でしょう。

-T, --test

テストモードで動作します。通常は動作に必要な設定値をインストール先/etc/bouncehammer.cfから読出しますが、このオプションを指定するとbouncehammer.cfが無くても動作します。-C test-run.cf と等価です。

-F, --fotmat 文字

検索結果を指定したフォーマットで出力します。このオプションを指定しない場合は、アスキーテーブル形式で出力されます。利用可能なフォーマットは次の通りです。yaml: YAML形式, asciitable: アスキーテーブル形式, csv: CSV形式(Ver. 2.4.0以降)

--silent

このオプションを付けると、次の-v, --verboseオプションの有無にかかわらず冗長なメッセージおよびエラーの出力がなくなります。また、コマンドをsendmail等のデーモンが実行した場合、エラーが起きてもexit(0)=成功で終了します。--silentオプションを付けずにsendmail等MTAがコマンドを起動し、エラーが発生した場合はexit(75)=EX_TEMPFAILで終了します。

-v, --verbose

処理過程が冗長に表示されます。

--help

コマンドのヘルプが表示されます。

--version

バージョン番号が表示されます。

datadumper --count 他2つの実行例

下記のスクリーンショットは、いくつかの検索条件を指定してそれに一致するデータをYAML形式で出力するコマンドと出力内容の説明です。