MSHRemoveMessage(永続化メッセージ削除)
形式
MSHRemoveMessage [-m <メッセージングコンテキスト識別子>]
[-d <メッセージ交換定義識別子>]
[-f <開始時間>]
[-t <終了時間>]
[-c <コミットサイクル>]
機能
データベースサーバで管理している永続化メッセージを削除します。
削除対象となるのは,CLOSED状態となっていて,かつ,永続期限を超過している永続化メッセージだけです。ただし,メッセージングコンテキスト識別子をオプションで指定すると,永続期限を超過していないCLOSED状態の永続化メッセージを削除できます。
このコマンドを実行して出力されるメッセージは,共通トレースに出力されます。
オプション
オプションを指定していない場合は,送受信したすべての永続化メッセージのうち,CLOSED状態となっていて,かつ,永続期限を超過しているものをすべて削除します。
- -m <メッセージングコンテキスト識別子>
- 削除対象となる永続化メッセージのメッセージングコンテキスト識別子を指定します。メッセージングコンテキスト識別子を指定すると,永続期限を超過していなくても対象となる永続化メッセージを削除できます。ただし,指定された永続化メッセージがOPEN状態の場合は削除できません。
- メッセージングコンテキスト識別子は,運用支援GUIから参照できます。運用支援GUIの詳細については,「5.5 運用支援GUIでのビジネスメッセージの照会」を参照してください。
- -d <メッセージ交換定義識別子>
- 削除対象となる永続化メッセージのメッセージ交換定義識別子を指定します。指定された永続化メッセージの状態がCLOSED状態となっていて,かつ,永続期限を超過している場合だけ削除できます。
- -f <開始時間>
- 削除対象となる永続化メッセージの送信または受信処理完了日時を指定します。指定された日時以降に送信または受信したビジネスメッセージのうち,CLOSED状態となっていて,かつ,永続期限を超過しているものだけを削除します。指定した時刻に送受信したビジネスメッセージも,削除対象に含まれます。
- 開始時間は,次の形式で指定します。
YYYY[MM[DD[HH[mm[SS]]]]]
- YYYY:年(1970~2038)
- MM:月(01~12)
- DD:日(01~31)
- HH:時(00~23)
- mm:分(00~59)
- SS:秒(00~59)
- -t <終了時間>
- 削除対象となる永続化メッセージの送信または受信処理完了日時を指定します。指定された日時以前に送信または受信したビジネスメッセージのうち,CLOSED状態となっていて,かつ,永続期限を超過しているものだけを削除します。
- 指定した時刻に送受信したビジネスメッセージも,削除対象に含まれます。
- 終了時間の指定形式は,開始時間の指定形式と同じです。
- -c <コミットサイクル>
- ビジネスメッセージをまとめて削除するサイクル(コミットサイクル)を,10~1000の範囲で指定します。デフォルト値は50です。コミットサイクルに大きい値を指定すると,送受信したビジネスメッセージを早く削除できますが,データベース処理のためにメモリを消費します。
- 通常の運用では,デフォルト値のままにしておくことを推奨します。
戻り値
- Windowsの場合
0:正常終了しました。コマンドとしての処理がすべて正常終了しました。
1:警告付きで正常終了しました。対象の永続化メッセージがありません。
-1:引数エラーです。コマンド実行時の引数に過不足があるか,または引数の指定方法に誤りがあります。
-2:実行エラーです。メモリ不足など,コマンド処理を継続できないエラーが発生しました。
-3:システム定義不正です。システム定義に不正があり,コマンド実行に必要な情報が取得できません。
- UNIXの場合
0:正常終了しました。コマンドとしての処理がすべて正常終了しました。
1:警告付きで正常終了しました。対象の永続化メッセージがありません。
2:引数エラーです。コマンド実行時の引数に過不足があるか,または引数の指定方法に誤りがあります。
3:実行エラーです。メモリ不足など,コマンド処理を継続できないエラーが発生しました。
4:システム定義不正です。システム定義に不正があり,コマンド実行に必要な情報が取得できません。
注意事項
- オプションは,すべてAND条件になります。例えば-mオプションおよび-fオプション,または-mオプションおよび-tオプションを同時に指定した場合で,-mオプションに指定した永続化メッセージが-fオプションまたは-tオプションで指定した日時期間に該当しないときは,対象メッセージはないものとされます。
- -mオプションをほかのオプションと一緒に指定した場合,永続化メッセージは永続期限に関係なく削除されます。
- -fオプションと-tオプションは,片方だけ指定してもかまいません。-fオプションだけ指定した場合は,指定日時以降の削除対象の永続化メッセージすべて,-tオプションの場合は,指定日時以前の削除対象の永続化メッセージすべてが削除されます。
実行例
- すべての削除対象メッセージを削除する場合の実行例を,次に示します。
MSHRemoveMessage
- メッセージングコンテキスト識別子(009f90e3-000000fead8741e6-8008-00000000000000000000ffff0ad2191f)の永続化メッセージを削除する場合の実行例を,次に示します。
MSHRemoveMessage -m 009f90e3-000000fead8741e6-8008-00000000000000000000ffff0ad2191f
- メッセージ交換定義識別子(cpa001-partyA)で送受信完了日時が2005/1/1から2005/1/7に対するすべての削除対象メッセージを削除する場合の実行例を,次に示します。
MSHRemoveMessage -d cpa001-partyA -f 20050101 -t 20050107