付録C.6 文書の整合性確保コマンドBIBadjustmentDocコマンド)の文法

文書の整合性を確保するには,文書の整合性確保コマンド(BIBadjustmentDocコマンド)を実行します。

ここでは,BIBadjustmentDocコマンドについて説明します。

<この項の構成>
(1) 機能
(2) 形式
(3) オプション
(4) 戻り値
(5) 注意事項

(1) 機能

収集先とデータベースの文書の整合性を確保します。収集した文書が,収集先から削除されている場合に,その文書をデータベースから削除します。

(2) 形式

BIBadjustmentDoc -c CollectorName
             〔-m {new|next}〕
             〔-f MaxDocNum〕〔-t TimeOut〕〔-p ErrorLevel〕〔-v〕

(3) オプション

-c CollectorName
文書の整合性確保を実行する収集環境の名前を指定します。
-m{new|next
文書の整合性確保を実行する際の動作モードを,新規または継続から選択して指定します。このオプションを省略した場合は,継続で整合性確保を実行します。
new
新規に文書の整合性確保を実行します。新規に文書の整合性確保を実行すると,整合性確保の対象となっているすべての文書に対して,整合性確保を実行します。また,すでに整合性が確保されている文書に対しても,再び整合性確保を実行します。
-mオプションにnewを指定した上で,-fオプションまたは-tオプションで文書数または処理時間を指定した場合は,指定した文書数または処理時間まで整合性確保を実行します。
next
前回からの継続で文書の整合性確保を実行します。整合性確保を実行する単位は,整合性を確保する文書数,または整合性確保の処理を続ける時間から選択できます。整合性確保を実行する単位を文書数とする場合は,-fオプションで文書数を指定し,処理時間とする場合は-tオプションで時間を指定する必要があります。
初めてBIBadjustmentDocコマンドを実行する場合,および前回の整合性確保が完了している場合は,指定した文書数または指定した時間まで,新規の場合と同様に整合性確保を実行します。
2回目以降のコマンド実行時,再び-mオプションにnextを指定することで,前回の続きから整合性確保を再開します。
-f MaxDocNum
整合性を確保する文書数を,1~2,147,483,647の範囲で指定します。
このオプションに指定した件数の文書に対して,収集先ごとに整合性確保を実行します。省略した場合は,-cオプションで指定した収集環境のすべての文書を対象にします。
-t TimeOut
時間を表すhhmm形式の4けたの数字で,整合性確保の処理を続ける経過時間を指定します。hhmmで0001~2359の範囲で指定します。hhには時間を表す00~23の範囲の数字を指定し,mmには分を表す00~59の範囲の数字を指定してください。
なお,TimeOutの指定値の時点で,ある文書の整合性確保の処理をしている最中であった場合は,その文書の処理が完了してから整合性確保を終了します。省略した場合は,時間の制限はありません。
-p ErrorLevel
コマンドの動作(戻り値)を詳細化するオプションです。
0:分割実行機能により中断した場合かどうかを戻り値で判定しません。
1:分割実行機能により中断した場合かどうかを戻り値で判定可能とします。
-v
コマンド実行時点で収集先に文書が存在するかどうかの確認はしません。このため,短時間で整合性確保を行えます。ただし,収集コマンドを実行したあとに収集先から削除された文書が,整合性確保の対象に含まれない場合があります。

(4) 戻り値

戻り値を次に示します。

戻り値意味
-1異常終了
0-pの指定が0の場合:正常終了
-pの指定が1の場合:正常終了(対象文書をすべて処理)
1-pの指定が0の場合:警告付き正常終了
-pの指定が1の場合:警告付き正常終了(対象文書をすべて処理)
2引数不正
3メモリ不足
4I/Oエラー
5パーミッションエラー
6多重実行
7定義不正
8-pの指定が1の場合:正常終了(分割実行機能により中断)
9-pの指定が1の場合:警告付き正常終了(分割実行機能により中断)

(5) 注意事項