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

クラスタ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 --description

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

allowQueriesOnLeader ブール trueに設定すると、リーダー・ノードは更新問合せ処理に加えて、読取り(更新でない)問合せを処理します。デフォルトはtrueです。falseに設定すると、リーダー・ノードは更新問合せ処理専用になります。このパラメータをendeca-cmdで使用する同等コマンドを次に示します。
endeca-cmd 
put-dd-profile --query-leader true
注意: 更新でない問合せは、索引に対する読取りリクエストを示します。更新問合せにより、索引や他の構成設定がDgraphプロセスで変更され、それらは索引に対する書込みリクエストを示します。
numFollowers 整数 適切な数のフォロワ・ノードを指定して、更新でない問合せの負荷を処理します。デフォルトは0です(この場合、データ・ドメイン・クラスタは1つのリーダー・ノードで構成されます)。allowQueriesOnLeaderfalseに設定すると、numFollowersは1以上にする必要があります。
注意: データ・ドメインごとに1つのDgraphノードのみが、各Endeca Serverインスタンスでホストできます。そのため、フォロワ・ノードをデータ・ドメインに追加する前に、十分な数のEndeca Serverノードが必要です。たとえば、3つのEndeca ServerノードのみがあるEndeca Serverクラスタで、4つのノードのあるデータ・ドメインは作成できません。
このパラメータで同等のコマンドを次に示します。
endeca-cmd put-dd-profile --num-followers 2
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ノードごとにリクエストを処理するために割り当てるスレッドの数。スレッドの数は2以上にする必要があります。デフォルトは2です。このパラメータで同等のコマンドを次に示します。
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>
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
readOnly ブール データ・ドメインのDgraphノードを読取り専用にするかどうかを示します。デフォルトは、falseです。
注意: allowQueriesOnLeadertrueに設定すると、readOnlyfalseにする必要があります。
このパラメータで同等のコマンドを次に示します。
endeca-cmd put-dd-profile --read-only false
args 文字列 このプロファイルを使用してデータ・ドメインを処理するDgraphプロセスを指定するフラグのリスト。指定しないと、Dgraphフラグは使用されません。このパラメータで同等のコマンドを次に示します。
endeca-cmd put-dd-profile --args <list_of_args>
フラグのリストを取得するには、endeca-cmd put-dd-profile --args --usageを使用します。Dgraphフラグのリストについては、『Oracle Endeca Server管理者ガイド』を参照してください。