Db2 Text Search 用の構成ツール
構成ツールは、Db2 インスタンスのための初期のテキスト検索構成またはテキスト検索構成のポストインストール・カスタマイズに使用できる、コマンド行ツールです。
パラメーター記述に別の記載がなければ、パラメーターを構成するために、 テキスト検索のインスタンス・サービスを停止する必要があります。 インスタンス・サービスを停止する必要のある構成設定の場合、 構成ツールは関連付けられた状態を検出して、インスタンス・サービスが実行中なので停止する必要があることを示すメッセージを戻します。
Db2 データベース製品をインストールするときには、テキスト検索を構成する必要があります。インストーラーでは 2 つの設定のみを構成する必要があり、それ以外の場合はデフォルトを使用するためです。 ただし、構成設定やその後の変更をさらに制御するには、構成ツールを使用する必要があります。 例えば、以下の設定を変更することができます。
- 構成パス、ログ・パス、インストール・パス、一時ディレクトリー・パスなどの、さまざまなパス
- ログ・レベル
- 使用されるヒープ・サイズ
- リソース構成オプション
詳しくは、キャパシティー・プランニングに関する考慮事項について、Text Search の計画のトピックを参照してください。
Windows オペレーティング・システムの場合、-configPath パラメーターが必要です。
ツールの構文
パラメーター
Db2 Text Search では、以下にリストするパラメーターのみをサポートします。
必須のコマンド・オプション
- list -system [-details] [-showAdvanced] [-parameter_name] -configPath-configdir
- システム・レベルのパラメーターとそれぞれの現行値を表示します。 各パラメーターの説明を参照してください。
- -details
- 各パラメーターに関する詳細情報 (説明、デフォルト値、タイプ、変更可能かどうかなど) を表示します。
- -showAdvanced
- 拡張構成パラメーターについての情報を表示します。
- -パラメーター名
- 指定されたパラメーターについての詳細情報を表示します。
- list -collectionName -collection [-details] [-parameter_name] -configPath-configdir
- 指定されたコレクションの構成パラメーターとそれぞれの現行値を表示します。
- -details
- 各パラメーターについて詳細情報を表示します。詳細情報には、説明、デフォルト値、タイプ、およびそのパラメーターが変更可能かどうかの情報が含まれます。
- -パラメーター名
- 指定されたパラメーターについての詳細情報を表示します。
- set -system -parameter_name -value -configPath-configdir
- システム・レベル・パラメーターの値を指定します。
- set -collectionName -parameter_name -value -configPath-configdir
- システム・レベル・パラメーターの値を指定します。
- configureHTTPListener
- TCP/IP を使用してテキスト検索プロセス間の通信を可能にするための管理 HTTP ポートを構成するために使用します。 以下の引数を指定してください。
- -adminHTTPPort値
- Db2 Text Searchで使用するポートを指定します。 このパラメーターは非推奨です。 代わりに set -system -port コマンドを使用してください。
- upgradeInstance
- upgradeInstance コマンドを発行して、インスタンスの Db2 Text Search サーバーを更新できます。 以下の引数を指定してください。
- configureParams
- Db2 Text Searchのさまざまな構成可能パラメーターを構成するために使用します。
このパラメーターは非推奨です。 代わりに set コマンドを使用してください。
以下の引数の 1 つを指定します。- -configPath absolute-path-to-config-folder
- /opt/ibm/search/config など、テキスト検索の構成フォルダーへの絶対パスを指定します。 configureParams を使用するとき、
configPath は構成ディレクトリーを指すために、および指定の構成パスを使用するように構成を変更するために使用されます。デフォルトの config ディレクトリーを名前変更したり、削除したりしないでください。 ユーザーによって config ディレクトリーが異なるパスに再構成されていても、Text Search サーバーにはデフォルトの config ディレクトリーがなければなりません。 config ディレクトリーをデフォルトのパスからユーザー定義のパスに変更するには、以下の要件が満たされていることを確認してください。
- 新規 config ディレクトリーに適切な config の詳細がある。
- config.xml ファイル内で、新規 config ディレクトリー・パスが正しく更新されている。
- -documentBatchSize 値
- 各呼び出しでキューから取得されるデフォルトの文書の数を指定します。
- -tempDirPath パス
- テキスト検索サーバーで使用する一時ディレクトリーのパスを指定します。
- -locale ロケール
- ツールの使用中に戻されるエラー・メッセージを記述するための 5 文字のロケール (en_US、de_DE、fr_FR など) を指定します。 デフォルトは en_USです。 詳しくは、サポートされているロケールを参照してください。
- -logPath パス
- Db2 Text Searchによって使用されるログ・パスを指定します。
- -logLevel値
- テキスト検索サーバー用に、ログ・ファイル内のメッセージのロギング・レベルを指定します。 設定値は、重大度の順に以下のとおりです。
- FINEST
- FINER
- FINE
- 警告
- SEVERE
- OFF
- generateToken
- 認証トークンを生成します。 次の引数だけを使用できます。
- -seed 値
- 認証トークンを生成するための任意のストリングとして機能します。 同じシード値を指定すると、構成ツールは毎回固有のトークンを生成します。
- printToken
- 認証トークンを印刷します。 このオプションでは、インスタンス・サービスを停止する必要はありません。
- sysinfo
- ビルドのバージョン番号、オペレーティング・システム、JAR バージョンなどの、システム情報を表示します。
- help
- 構成ツールのコマンド使用法を印刷します。 使用法情報は、必要な引数を指定しないで構成ツールを実行するときにも印刷されます。
- printAll
- 構成可能なすべてのプロパティーの値を標準出力に印刷します。 このオプションでは、インスタンス・サービスを停止する必要はありません。
- printAdminHTTPPort
- 管理 HTTP ポートの現行値を印刷します。 このコマンドは動的であり、インスタンス・サービスを停止する必要はありません。
- upgradeConfigFolder -sourceConfigFolder パス -targetConfigFolder パス
- サーバー構成をアップグレードします。
- -sourceConfigFolder
- 新しいソース構成ディレクトリーの完全修飾パス。
- -targetConfigFolder
- アップグレードする宛先構成ディレクトリーの完全修飾パス。
サーバー・パラメーター
- -acceptorThreads
- クライアント要求を処理するサーバー・スレッドの数を指定します。 20 から 2000 までの整数を指定します。 この値を小さくすると、サーバー要求の処理に遅延が生じる可能性があります。 この値を大きくすると、使用するシステム・リソースが多くなりすぎ、メモリー不足エラーが発生する可能性があります。 このパラメーターのデフォルト値は 300 です。
- -concatenateSmallFiles
- サイズの小さなテキスト・ファイルの処理を最適化するかどうかを示します。 この拡張パラメーターはデフォルトで有効になります。
- -configPath
- 構成ディレクトリーの絶対パスを指定します。 このディレクトリーには、構成ファイルと \collections サブディレクトリーが含まれています。 このパラメーターは変更できません。
- -defaultDataDirectoryパス
- すべてのコレクションに対して、コレクション構成ファイルのロケーションを指定します。 コレクション・データ (索引) ファイルは、<defaultDataDirectory>\collection_name\data\text コレクション構成ディレクトリーの下のサブディレクトリーにあります。 コレクションの定義時に、索引ファイルに対して別のディレクトリーを指定できます。 デフォルト・データ・ディレクトリー が指定されていないかブランクの場合、デフォルトは configPath\collectionsです。
- -docQueueDrainTimeInMillisパス
- 文書キューが空になるまで待機する時間 (ミリ秒) を指定します。この時間が経過すると、サーバーはシャットダウンされます。
- -documentBatchMemorySizeパス
- 前処理スレッドおよび索引作成スレッドによるそれぞれの呼び出しにおいてキューから取得する一連の文書の最大サイズを指定します。
- -documentDeleteBatchSizeパス
- それぞれの呼び出しにおいてキューから削除する対象として索引作成スレッドによって取得される文書のデフォルトの数を指定します。
- -documentQueueSizeパス
- 拡張機能: 索引付けサーバー上の入力キューおよび出力キューの文書数を指定します。 このパラメーターはデフォルトで無効になっています (値 = -1)。 inputQueueMemorySize パラメーターによって、キュー・サイズ (MB 単位) も定義されます。 documentQueueSize パラメーターが指定されている場合は、2 つのパラメーターのうちの低い値により、キュー・サイズが定義されます。 このパラメーターは、サーバーが稼働していないときにのみ変更できます。
- -documentRetryNumber 値
- 文書の前処理を再試行する回数を指定します。 前処理で documentTimeout の制限を超えるたびに、索引付けサーバー上の入力キューに文書が返され、documentRetryNumber を超えるまでさらに再試行が行われます。 指定された試行回数 (documentRetryNumber + 1) 以内で文書の前処理が完了しない場合、文書に対してエラーが生成されます。
- -documentTimeout 値
- 文書の前処理に許可される最大時間 (秒) を指定します。 この値を超えた場合、documentRetryNumber パラメーターにより、前処理を再試行する回数が決まります。
- -inputQueueMemorySize 値
- 索引付けサーバー上の入力キューのメモリー・サイズを指定します。 入力キューは、前処理のために待機している文書を格納します。 メモリー・サイズが大きいほど高速になりますが、リソース消費も大きくなります。 デフォルトのサイズは 50 MB です。
- -installPath パス
- テキスト検索のインストール・ディレクトリーの完全修飾パスを指定します。 config.xml にあるデフォルトのインストール・パス $DB2DIR/db2tss を新規パスに構成できます。 例えば、UNIX オペレーティング・システムでは、このパスを $HOME/sqllib/db2tssに再構成できます。
- -logFolder
- Db2 Text Search で使用するログ・パスを指定します。 このパラメーターは、テキスト・サーバーが稼働していないときにのみ変更できます。
- -maxConcurrentIndexingCollections
- 同時に索引付けのために開くことができるコレクションの最大数を指定します。 この値は、使用可能なメモリーに応じて設定してください。 デフォルト値は 16 です。 パーティション環境の場合は、この値は最小でもパーティションの数と同じにする必要があります。
- -maxHeapSize
- サーバーの最大ヒープ・サイズを指定します。 この値は、JVM ヒープ・サイズ仕様に従って設定する必要があります。注: コマンド configTool printAll -configPath を実行すると、 maxHeapSize パラメーターが startupHeapSizeとしてリストされます。
- -numberOfIndexerThreads 値
- サーバー上で実行する索引付けスレッドの数を指定します。
- -numberOfPreprocessingThreads 値
- Text Search サーバー上で実行する前処理スレッドの数を指定します。 各前処理スレッドには、文書コンストラクター、テキスト抽出、言語識別、トークン化、および言語解析のステップを含めることができます。
- -numberOfSearchables値
- 検索用に同時に開くことができるコレクションの最大数を指定します。
- -numberOfTokenizers 値
- 入力を解析してトークンを作成するために使用する言語プロセッサーの数を指定します。 通常、これを前処理スレッドの数に設定する必要があります。
- -outputQueueMemorySize 値
- 索引付けサーバー上の出力キューのメモリー・サイズを指定します。 出力キューは、前処理後に索引付けのために待機している文書を格納します。 メモリー・サイズを大きくすると高速になりますが、消費するリソースも大きくなります。 デフォルトのサイズは 50 MB です。
- -outsideInMaxProcessableDocuments値
- テキスト抽出プログラムを再始動する頻度を文書数で指定します。
- -port 値
- サーバーが非セキュア要求を listen するポートの番号を指定します。 値 0 を指定すると、ポートを無効にすることができます。
- -queryExpansionLimit 値
- ワイルドカード照会を展開できる用語の最大数を指定します。 照会がこの制限を超えると、例外がスローされます。
- -rangeQueryExpansionLimit 値
- 範囲照会が拡張できる値の最大数を指定します。例えば、[aTO z] のように指定します。 範囲照会がこの制限を超えると、例外がスローされます。
- -stellentEnabled 値
- Outside In フィルターを使用可能にするかどうかを指定します。
- -stellentVersion 値
- テキスト検索で使用している Outside In のバージョンを指定します。 このパラメーターは変更できません。