CdbrDocument::CreateIndexメソッド

機能

全文検索インデクスの作成

形式

DmaBoolean CreateIndex(
 const pDmaString_T         pFilePath)

詳細

指定したパス名のファイルから,全文検索インデクスを作成するメソッドです。パス名にNULLを指定した場合は,登録されている文書(マルチレンディション文書の場合はマスタレンディション)に含まれているコンテントから全文検索インデクスが作成されます。ただし,マルチファイル文書,リファレンスファイル文書またはFile Link文書の場合,NULLを指定するとERR_CONTENTTYPE_MISMATCHのエラーになります。

既存の全文検索インデクスを,別のファイルで更新する場合も,このメソッドを実行してください。これによって,インデクスの遅延更新が実現できます。

このメソッドは,全文検索機能付き文書クラスから作成されているDocVersionオブジェクトを構成要素としたCdbrDocumentオブジェクトにだけ実行できます。それ以外のオブジェクトを対象に実行した場合は,エラーになります。

また,インデクスを作成できるのは,テキストファイルとして作成されたファイルだけです。それ以外の形式の文書を指定してこのメソッドを実行した場合の動作は保証されません。場合によっては,データベースがロールバックする可能性があります。この場合は,データベースエラーが出力されますので,データベースのエラーコードを参照して,データを再登録してください。

なお,登録されている文書とインデクスを作成するためのファイルとの対応づけは,上位で行います。

UNIXの場合に,ファイル/tmp/sample.txtから全文検索インデクスを作成する例を次に示します。Windowsの場合は,ファイルc:¥temp¥sample.txtから全文検索インデクスを作成する例として,例中の"file:///tmp/sample.txt"を"file:///c:¥temp¥sample.txt"に読み替えてください。

全文検索インデクスを作成する例
pDbrDoc->CreateIndex("file:///tmp/sample.txt");

引数

pFilePath(入力)

全文検索インデクスを作成するファイルのパス名を設定します。登録されている文書(マルチレンディション文書の場合はマスタレンディション)に含まれるコンテントからインデクスを作成する場合にはNULLを設定します。それ以外のファイルからインデクスを作成する場合には,ファイルのパス名をURL形式で指定します。例えば,UNIXの場合,全文検索インデクスをファイル"/tmp/sample.txt"から作成するには,"file:///tmp/sample.txt"と指定します。Windowsの場合,全文検索インデクスをファイル"c:¥temp¥sample.txt"から作成するには,"file:///c:¥temp¥sample.txt"と指定します。有効なプロトコルは"file:"だけです。これ以外のプロトコルを指定した場合はエラーになります。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
ERR_DBERR_DB_DEADLOCK_OCCURREDデータベースでデッドロックが発生しました。時間を置いて,再度実行してください。
ERR_DBERR_DB_FAILEDデータベースで障害が発生しました。syslogを参照して,障害の原因を取り除いてください。
ERR_DBERR_DB_LOCKEDオブジェクトがロックされています。時間を置いて,再度実行してください。
ERR_DBRERR_ACCESS_NOT_PERMITTEDアクセス権がありません。この操作は実行できません。
ERR_DBRERR_CONTENTTYPE_MISMATCH指定したレンディションタイプのコンテントに対して実行できません。正しい文書オブジェクトを指定してメソッドを実行してください。
ERR_DBRERR_INVALID_STATUSセッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBRERR_OBJECT_NOT_CONNECTオブジェクトは接続されていません。オブジェクトを接続してください。
ERR_DBRERR_OIID_NOT_SETOIIDが設定されていません。SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_ACCESS_DENIED要求された操作に対してアクセス権がありません。正しいアクセス権を設定してください。
ERR_DMADMARC_BAD_CLASSID指定された識別子は,利用できるオブジェクトのクラスではありません。正しいクラス識別子を指定してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_BAD_URLリソースのURLが不正です。URLの内容を見直してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_RESOURCE_NOT_FOUND指示されたリソースが見つかりません。正しいリソースを指定してください。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMADMARC_URL_PROTOCOL_NOT_SUPPORTEDサポートしていないURLプロトコルです。file:///で始まっているか確認してください。
ERR_DMAEDMRC_FTPSERVICE_LOST_CONNECTIONファイル転送サービスへのセッションが切断されました。ネットワーク環境を確認してください。または,時間を置いて,再度実行してください。
ERR_DMAEDMRC_FTPSERVICE_MAX_SESSIONファイル転送サービスに同時に接続できるセッション数の上限に達しています。時間を置いて,Connectユーザ数が減ったあと,再度実行してください。または,ファイル転送サービス環境定義ファイルのFtpSessionMaxエントリを見直してください。
ERR_DMAEDMRC_FTPSERVICE_NOT_AVAILABLEファイル転送サービスが利用できません。サーバのバージョンに対応したクライアントを利用してください。
ERR_DMAEDMRC_NO_FTPSERVICE使用できるファイル転送サービスがありません。
  • ネットワーク環境を確認してください。
  • _HIEDMS_FTPMODE=STATICを指定してファイル転送サービスを起動しているかどうかを,確認してください。
  • 時間を置いて,再度実行してください。
  • ファイル転送サービスのセットアップコマンドを実行しているかどうかを,確認してください。