データ・ドメイン・プロファイルのパラメータ

クラスタWebサービスのputDataDomainProfile操作またはendeca-cmd put-dd-profileコマンドにより、データ・ドメイン・プロファイルとそのパラメータを構成できます。このトピックにはこれらのパラメータがリストされ、それらの説明が記載されています。

クラスタWebサービスを使用してOracle Endeca Serverで作成するデータ・ドメイン・プロファイルごとに次のパラメータがあります。

注意: パラメータに関する一覧を次の表に示します。これらは、クラスタWebサービスのWSDLに表示されます。そのため、クラスタWebサービスのリクエストを直接使用する場合、この形式を使用します。endeca-cmdユーティリティではクラスタWebサービスへのコールを利用するので、同じ特性を若干異なる形式で指定できます。たとえば、クラスタWebサービスのallowQueriesOnLeaderパラメータは、endeca-cmd put-dd-profile --query-leaderコマンドと同等です。可能な場合、必ず両方の形式が表に含まれます。

デフォルト値をパラメータで使用するには、Webサービス・リクエストの送信に使用するツールに応じて、デフォルト値を明示的に指定することが必要な場合がありますし、指定が不要の場合もあります。たとえば、指定されないと、WebサービスのWSDLで参照することで、soapUIによりデフォルトで設定されます。同様に、JRF Webサービス・インタフェースを使用する場合も、パラメータがリクエストで省略されたり、パラメータはリストされているがその値が指定されないと、Endeca Serverでデフォルト値を入力します。ただし、パラメータとその値を明示的に指定しないと、他のクライアントはデフォルトで設定しない場合があります。

パラメータ 型 説明
name 文字列 データ・ドメイン・プロファイルの名前。endeca-cmdコマンドには同等のオプションがありません。コマンドラインでendeca-cmdに名前が指定されます。
description 文字列 データ・ドメイン・プロファイルの説明。このパラメータをendeca-cmdで使用する同等コマンドを次に示します。 
endeca-cmd put-dd-profile --description

endeca-cmdを使用する際に説明に空白がある場合、二重引用符で囲む必要があります。

allowQueriesOnLeader ブール trueに設定すると、リーダー・ノードは更新問合せ処理に加えて、読取り(更新でない)問合せを処理します。デフォルトはtrueです。falseに設定すると、リーダー・ノードは更新問合せ処理専用になります。このパラメータをendeca-cmdで使用する同等コマンドを次に示します。 
endeca-cmd put-dd-profile --query-leader true
注意: 更新でない問合せは、索引に対する読取りリクエストを示します。更新問合せにより、索引や他の構成設定がDgraphプロセスで変更され、それらは索引に対する書込みリクエストを示します。
numFollowers 整数 適切な数のフォロワ・ノードを指定して、更新でない問合せの負荷を処理します。デフォルトは0です(この場合、データ・ドメイン・クラスタは1つのリーダー・ノードで構成されます)。allowQueriesOnLeaderをfalseに設定すると、numFollowersは1以上にする必要があります。
注意: データ・ドメインごとに1つのDgraphノードのみが、各Endeca Serverインスタンスでホストできます。そのため、フォロワ・ノードをデータ・ドメインに追加する前に、十分な数のEndeca Serverノードが必要です。たとえば、3つのEndeca ServerノードのみがあるEndeca Serverクラスタで、4つのノードのあるデータ・ドメインは作成できません。
このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --num-followers 2
readOnly ブール データ・ドメインのDgraphノードを読取り専用にするかどうかを示します。デフォルトは、falseです。
注意: allowQueriesOnLeaderをtrueに設定すると、readOnlyはfalseにする必要があります。
このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --read-only false
allowOversubscribe ブール trueに設定すると、このデータ・ドメインをホストするノードを他のデータ・ドメインと共有すると同時に、Endeca Serverクラスタはその容量を超過できます。デフォルトはtrueです。このフラグの設定は、numComputeThreadsと連携して機能します。

この設定がtrueの場合、Endeca Serverノードで利用可能な容量よりも少ない容量をデータ・ドメイン・クラスタ・ノードで使用する場合があります。ただし、データ・ドメイン・プロファイルで構成された処理スレッドをEndeca Serverノードが利用できない場合でも、このフラグによりDgraphノードがこれらのスレッドで競合できます。この場合においてスレッド割当ては、オペレーティング・システムで処理されます。データ・ドメイン・プロファイルを開発環境用に設定してハードウェア・リソースを節約する場合、ノードが過大サブスクライブできると便利なことがあります。

データ・ドメイン・クラスタが過大サブスクライブ可能な場合、十分な容量がないノード上でこのデータ・ドメイン用ノードをEndeca Serverクラスタがホストできます。たとえば、12個のCPUがあるEndeca Serverノードは7個のDgraphノード(7個の異なるデータ・ドメイン・クラスタ用)をホストでき、それぞれは--num-compute-threads 2と--oversubscribe trueで構成されます。このデータ・ドメインの構成におけるEndeca Serverノードは、過大サブスクライブ状態と考えられます。

falseに設定すると、このデータ・ドメインをホストするEndeca Serverクラスタのノードは、その容量の範囲内でのみリソースを共有できます。たとえば、Endeca Serverノードに16個のCPUがあり、2個のDgraphノードをホストしており、それぞれが8個のスレッドで構成されている場合、その処理能力を均等に2個のデータ・ドメイン・ノードで共有し、そのCPU処理能力の100%を利用しますが、過大サブスクライブしません。高いハードウェア使用率の要件でデータ・ドメインを本番環境において設定する際、過大サブスクライブが可能でないデータ・ドメイン・プロファイルを構成することは有用です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --oversubscribe true
numComputeThreads 整数 このプロファイルを使用してデータ・ドメインを処理するDgraphノードごとにリクエストを処理するために割り当てるスレッドの数。スレッドの数は4以上にする必要があります。デフォルトは4です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile ---num-compute-threads 4
computeCacheSizeMB 整数 データ・ドメインにある各Dgraphノードで結果キャッシュに割り当てるRAMの容量(MB単位)。デフォルトは0で、次のように解釈されます。
絶対値が0の場合、DgraphノードをホストするEndeca Serverノードで利用可能なRAMの容量の10%としてデフォルトのDgraphキャッシュ・サイズが算出されます。このパラメータで同等のコマンドは、Dgraphキャッシュの値として1MBを指定するこの例に類似しています。 
endeca-cmd put-dd-profile --compute-cache-size 1
startupTimeoutSeconds 整数 データ・ドメインでDgraphノードの起動に要する時間。デフォルトは600秒です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --startup-timeout <num_sec>
shutdownTimeoutSeconds 整数 Dgraphノードにおいて正常な停止に要する時間。デフォルトは30秒です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --shutdown-timeout <num_sec>
enableAncestorCounts ブール オプションです。有効に設定すると、ルート管理対象属性値と中間管理対象属性値のカウントが計算されます。このフラグが指定されていない場合、またはフラグは指定されているが値が指定されていない場合、デフォルトはfalseです。この場合、Dgraphは実際の管理対象属性値の絞込みカウントのみを計算します。ルート管理対象属性値、および中間管理対象属性値のカウントは計算されません。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --ancestor-counts false
backlogTimeout 整数 オプションです。Dgraphがタイムアウト・メッセージに応答する前に、処理問合せにおいて問合せが待機するのを許可されている最大秒数です。このフラグは指定されているが値が指定されていない場合、デフォルト値は0秒です。
minRefinementSamples 整数 オプションです。絞込み計算時にサンプリングする最小レコード数です。このフラグは指定されているが値が指定されていない場合、デフォルトは0です。多くのアプリケーションでは、値を大きくすると、動的絞込みランキング品質が向上せずパフォーマンスが低下します。極端に大規模な非階層管理対象属性を持つ一部のアプリケーションでは(回避することができない場合)、値を大きくすると、低パフォーマンス・コストで動的絞込みランキング品質を大幅に向上させることができます。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --refinement-sampling-min 0
enableExactImplicits ブール オプションです。暗黙的絞込みの概算計算を無効にします。このオプションを使用することは推奨されていません。このオプションを無効にした場合(これがデフォルトです)、現在の結果レコード・セットのすべてを対象とはしていない管理対象属性値が暗黙的絞込みとして戻されることがありますが、このような「不適切な」暗黙的絞込みが発生する可能性はほとんどありません。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --implicit-exact false
numImplicitSamples 整数 オプションです。暗黙的絞込みを計算する際にサンプリングするレコードの最大数を設定します(これは、パフォーマンス・チューニング・パラメータです)。このフラグは指定されているが値が指定されていない場合、デフォルト値は1024です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --implicit-exact 1024
netTimeoutSeconds 整数 オプションです。クライアントがネットワーク間の問合せからデータをダウンロードするのをDgraphが待機する最大秒数を指定します。このフラグは指定されているが値が指定されていない場合、デフォルトのネットワーク・タイムアウト値は30秒です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --net-timeout 30
maxSearchTerms 整数 オプションです。テキスト検索における最大語数を指定します。このフラグは指定されているが値が指定されていない場合、デフォルト値は10です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --search-max 10
searchCharLimit 整数 オプションです。レコードおよび値検索における検索語の最大長を指定します(文字数単位)。デフォルトは132文字です。この長さを超える語は索引付けされないため、レコードおよび値検索では検出されません。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --search-char-limit 132
snippetCutoff 整数 オプションです。属性内でスニペットを識別するためにDgraphが評価する語数を制限します。<num>語数内で一致するものが検出されなかった場合、後に属性値内で一致するものが検出された場合でも、Dgraphはスニペットを戻しません。このフラグは指定されているが<num>が指定されていない場合、デフォルトは500です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --snippet-cutoff 500
disableSnippets ブール オプションです。スニペット化を全体的に無効にします。デフォルトはfalseで、これはスニペット化が有効であることを示します。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --snippet-disable false
enableAllDynamicsMAs ブール オプションです。使用可能な動的属性値特性をすべて有効にします。このフラグは指定されているが値が指定されていない場合、デフォルト値はfalseです。このオプションはパフォーマンスに密接に関係するものであり、製品での使用を意図しているものではありません。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --dynamic-category-enable false
disableContraction ブール オプションです。ナビゲーション結果に絞込みを表示する際に、Dgraphが暗黙的管理対象属性を計算せずに、明示的に指定された管理対象属性のみを計算して表示するように指定します。このフラグは指定されているが値が指定されていない場合、デフォルトはfalseです。このフラグを指定しても、表示される結果のレコード・セットのサイズは減少しません。ただし、Dgraphプロセスのランタイム・パフォーマンスは向上します。
適切なナビゲーション絞込みを受け取るためにこのフラグを使用する場合は、すべてのアウトバウンド問合せに対して、トップレベルの優先順位ルールを適用する必要があることに注意してください。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --contraction-disable false
maxWildcards 整数 オプションです。ワイルドカード問合せ内でab*c.def*などの記号を含むワイルドカード語に一致する最大語数を指定します。このフラグは指定されているが値が指定されていない場合、デフォルト値は100です。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --wildcard-max 100
sessionIdType 文字列 リクエストをこのデータ・ドメインにルーティングする際、セッション・アフィニティの処理に使用する方法を指定します。デフォルトの方法はheaderです。sessionIdTypeをデータ・ドメイン・プロファイルで指定しない場合にHTTPヘッダーがセッション・アフィニティ用に使用されます。
使用可能なオプションは次のとおりです。
  • HEADER。HTTPヘッダーがセッション・アフィニティで使用されます。
  • PARAMETER。URLパラメータが使用されます。
  • COOKIE。Cookieが使用されます。
これらのオプションの値では大文字と小文字は区別されません。このパラメータで同等のendeca-cmdコマンドを次に示します。 
endeca-cmd put-dd-profile --session-id-type header
この例ではheaderをセッションIDキーとして指定しています。
sessionIdKey 文字列 sessionIdTypeで指定された方法のいずれかによりセッション・アフィニティを確立するために、チェック対象オブジェクトの名前を指定します。sessionIdKeyの値は、HTTPヘッダー、URLパラメータまたはCookie名として使用可能な文字列にできます。デフォルトはX-Endeca-Session-IDです。sessionIdKeyの値を指定しないと、ヘッダー、URLパラメータまたはCookieとして使用されます。このパラメータで同等のendeca-cmdコマンドを次に示します。 
endeca-cmd put-dd-profile --session-id-key X-Endeca-Session-ID
autoIdle ブール タイムアウト期間中このデータ・ドメインに対して問合せが発行されなかった場合、タイムアウト後にデータ・ドメインをアイドル状態にするかどうかを示します。デフォルトは、falseです。falseに設定すると、データ・ドメインはアイドル状態にはなりません。trueに設定すると、データ・ドメイン・プロファイルのidleTimeoutMinutes設定で指定したタイムアウト後にデータ・ドメインがアイドル状態になります。データ・ドメインがアイドル状態になると、Endeca ServerはDgraphプロセスを停止し、そのプロセスへのリソース割当ても停止します。ただし、エンドユーザーがこの状態のデータ・ドメインに対して問合せを発行した場合、データ・ドメインはアクティブ化され、Endeca ServerによってDgraphプロセスが再起動されます。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --auto-idle false
idleTimeoutMinutes 文字列 (オプション)。アイドリングに使用するタイムアウトを示します(分単位)。デフォルトは10分です。データ・ドメインで自動アイドル化が有効に設定されており、指定したタイムアウト期間このデータ・ドメインに対して問合せが発行されなかった場合、Endeca ServerはDgraphプロセスを正常に停止させることにより、このデータ・ドメインをアイドル状態にします。このデータ・ドメインに対して問合せが発行されると、アクティブ化されます。自動アイドル化を有効に設定してデータ・ドメインを作成し、有効にするとすぐにタイムアウトが開始します。データ・ドメインをアイドル状態にすると、問合せを受け取るたびにタイマーがリセットされます(また、Dgraphプロセスが再起動されます)。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --auto-idle true --idle-timeout 30
args 文字列 このプロファイルを使用してデータ・ドメインを処理するDgraphプロセスを指定するフラグのリスト。指定しないと、Dgraphフラグは使用されません。このパラメータで同等のコマンドを次に示します。 
endeca-cmd put-dd-profile --args <list_of_args>

フラグのリストを取得するには、endeca-cmd put-dd-profile --args --usageを使用します。Dgraphフラグのリストについては、『Oracle Endeca Server管理者ガイド』を参照してください。