2.5. コマンドラインツール

AMQ Broker にはコマンドラインインターフェース(CLI)ツールのセットが含まれるため、メッセージングジャーナルを管理できます。以下の表は、各ツールの名前と対応する説明を一覧表示しています。

ツール説明

address

ツールグループのアドレス指定(create/delete/update/show) (例: ./artemis address create)

ブラウザー

インスタンスのメッセージを参照します。

consumer

インスタンスでメッセージを消費します。

data

ジャーナルレコードとデータの圧縮に関するレポートを出力します。

decode

エンコードから内部ジャーナル形式をインポートします。

encode

String にエンコードされるジャーナルの内部形式を示しています。

exp

特別な XML 形式および独立した XML 形式を使用して、メッセージデータをエクスポートします。

help

ヘルプ情報を表示します。

imp

exp によって提供された出力を使用して、ジャーナルを稼働中のブローカーにインポートします。

kill

--allow-kill で開始するブローカーインスタンスを強制終了します。

mask

パスワードをマスクし、これを出力します。

perf-journal

現在のデータフォルダーで使用する journal-buffer タイムアウトを計算します。

queue

キューのツールグループ (create/delete/update/stat) (例: ./artemis queue create)

run

ブローカーインスタンスを実行します。

stop

ブローカーインスタンスを停止します。

user

デフォルトのファイルベースのユーザー管 (add/rm/list/reset) (例: ./artemis user list)

各ツールで利用可能なコマンドの全一覧については、help パラメーターの後にツール名を使用してください。たとえば、以下の例で CLI 出力には、ユーザーが ./artemis help data コマンドを入力すると、data ツールで利用可能なコマンドがすべて表示されます。 

$ ./artemis help data

NAME
        artemis data - data tools group
        (print|imp|exp|encode|decode|compact) (example ./artemis data print)

SYNOPSIS
        artemis data
        artemis data compact [--broker <brokerConfig>] [--verbose]
                [--paging <paging>] [--journal <journal>]
                [--large-messages <largeMessges>] [--bindings <binding>]
        artemis data decode [--broker <brokerConfig>] [--suffix <suffix>]
                [--verbose] [--paging <paging>] [--prefix <prefix>] [--file-size <size>]
                [--directory <directory>] --input <input> [--journal <journal>]
                [--large-messages <largeMessges>] [--bindings <binding>]
        artemis data encode [--directory <directory>] [--broker <brokerConfig>]
                [--suffix <suffix>] [--verbose] [--paging <paging>] [--prefix <prefix>]
                [--file-size <size>] [--journal <journal>]
                [--large-messages <largeMessges>] [--bindings <binding>]
        artemis data exp [--broker <brokerConfig>] [--verbose]
                [--paging <paging>] [--journal <journal>]
                [--large-messages <largeMessges>] [--bindings <binding>]
        artemis data imp [--host <host>] [--verbose] [--port <port>]
                [--password <password>] [--transaction] --input <input> [--user <user>]
        artemis data print [--broker <brokerConfig>] [--verbose]
                [--paging <paging>] [--journal <journal>]
                [--large-messages <largeMessges>] [--bindings <binding>]

COMMANDS
        With no arguments, Display help information

        print
            Print data records information (WARNING: don't use while a
            production server is running)

        ...

各コマンドを実行する方法の詳細については、help パラメーターを使用します。たとえば、CLI は、ユーザーが ./artemis help data print の入力後に data print コマンドに関する詳細情報を一覧表示します。 

$ ./artemis help data print

NAME
        artemis data print - Print data records information (WARNING: don't use
        while a production server is running)

SYNOPSIS
        artemis data print [--bindings <binding>] [--journal <journal>]
                [--paging <paging>]

OPTIONS
        --bindings <binding>
            The folder used for bindings (default ../data/bindings)

        --journal <journal>
            The folder used for messages journal (default ../data/journal)

        --paging <paging>
            The folder used for paging (default ../data/paging)