データ・ドメイン・プロファイル操作

これらのコマンドは、Endecaデータ・ドメイン・プロファイルで動作します。

データ・ドメイン・プロファイルとは、Endecaデータ・ドメインの作成に使用するための構成設定を提供する名前付きのテンプレートです。新しいデータ・ドメインの構成設定では、次のことを設定します。
  • 必要なフォロワ・ノードの数。
  • リーダーが更新リクエスト専用であるか、または通常の問合せ負荷を共有しているか。
  • Endeca Serverがそのノードを他のデータ・ドメインと共有しながら、そのノードをオーバーサブスクライブできるかどうか。
  • Dgraphプロセスを読取り専用にするかどうか。
  • セッション・アフィニティ構成。
  • Dgraphプロセスのハードウェア特性(スレッドの数およびキャッシュ・サイズ)。
  • Dgraphプロセスの起動に使用するDgraphフラグのセット。これらのフラグは、検索およびその他の計算のパフォーマンスを微調整するのに役立ちます。
  • その他の下位レベルのDgraphフラグ。

ここで説明するコマンドでは、データ・ドメイン・プロファイルを作成および削除し、およびそれらに関する情報を返します。

重要: データ・ドメイン・プロファイルを作成した後は、その構成を変更できません。ただし、別のデータ・ドメイン・プロファイルを作成し、endeca-cmd update-ddコマンドを使用して既存のデータ・ドメインをこのプロファイルで更新できます。
データ・ドメイン・プロファイルを管理するためのコマンドは次のとおりです。

put-dd-profile

put-dd-profileコマンドは、指定した名前で新しいデータ・ドメイン・プロファイルを作成します。デフォルトのデータ・ドメイン・プロファイル( defaultという名前)はEndeca Serverに常に存在するため、このコマンドで作成する必要はありません。

このコマンドの構文は次のとおりです。 
endeca-cmd put-dd-profile <new-profile-name> [global-options] [create-options]
ここで、new-profile-nameは、新しいデータ・ドメインの名前です。
次の追加コマンド・オプションを使用して、作成するデータ・ドメイン・プロファイルの構成を変更できます(指定がなければデフォルトが使用されます)。
作成オプション 説明
--description <text> データ・ドメイン・プロファイルの詳細な説明。説明に空白が含まれている場合は、二重引用符で囲む必要があります。このオプションを指定しない場合、説明はデフォルトで空の文字列になります。
--query-leader <bool> リーダー・ノードで読取り専用問合せを受入れ可能かどうか。指定しない場合のデフォルトはtrueです。
--num-followers <int> データ・ドメインで構成する必要のあるフォロワ・ノード(Dgraphプロセス)の数。指定しない場合のデフォルトは0です。
--read-only <bool> データ・ドメインを読取り専用で作成するか、更新リクエスト(データ・ロード・リクエストを含む)を受け入れないか。指定しない場合のデフォルトはfalseです。
--oversubscribe <bool> オーバーサブスクライブされたEndeca Serverインスタンスにデータ・ドメイン(またはそのノードのいずれか)を配置できるかどうか。指定しない場合のデフォルトはtrueです。
--num-compute-threads <int> Dgraphノードのスレッド・プールの計算スレッドの数を指定します。値は正の整数(4以上)である必要があります。Dgraphプロセスの計算スレッドの推奨値は通常、ホストEndeca ServerノードのCPUコアの数と同じです。値を指定しないか、0を指定した場合のデフォルトは、4または使用可能なプロセス数の大きい方の値になります。
--compute-cache-size <int> データ・ドメインのDgraphノードごとに、Dgraphプロセス・キャッシュの絶対値(MB)を指定します。

値を指定しないか、0を指定した場合のデフォルトは、DgraphノードをホストしているEndeca Serverノードで使用可能なRAMの量の10%として計算される、Dgraphのデフォルトのキャッシュ・サイズになります。

--startup-timeout <int> データ・ドメインのDgraphプロセスの起動処理に許可する最大時間(秒)を指定します。デフォルトは600秒です。
--shutdown-timeout <int> データ・ドメインのDgraphプロセスの停止処理に許可する最大時間(秒)を指定します。デフォルトは30秒です。
--ancestor-counts <bool> オプション。有効にすると、ルート管理属性値および任意の中間管理属性値の選択の数を計算します。デフォルトはfalseです。このオプションを無効にすると、Dgraphは実際の管理属性値の絞込み数のみを計算します。ルート管理属性値または任意の中間管理属性値の選択の数は計算されません。
--backlog-timeout <int> オプション。Dgraphがタイムアウト・メッセージを返す前に、処理中のキューで問合せが待機できる最大秒数です。デフォルト値は0秒です。
--refinement-sampling-min <int> オプション。絞込みの計算中にサンプリングするレコードの最小数です。デフォルトは0です。ほとんどのアプリケーションでは、値を大きくすると、動的絞込みランキング品質を改善することなくパフォーマンスが低下します。非常に大規模な非階層型の管理属性を保持する一部のアプリケーションでは(それらが不可避の場合)、値を大きくすると、パフォーマンスの低下は少ないままで、動的絞込みランキング品質を確実に改善できます。
--implicit-exact <bool> オプション。暗黙的絞込みの近似計算を無効にします。このオプションを使用することはお薦めしません。このオプションを無効にする(デフォルト)と、現在の結果レコード・セット全体に対応しない管理属性値が暗黙的絞込みとして返されることがありますが、このような間違った暗黙的絞込みが発生する可能性はごくわずかです。
--implicit-sample <int> オプション。パフォーマンス・チューニング・パラメータである暗黙的絞込みを計算する場合にサンプリングするレコードの最大数を設定します。デフォルト値は1024です。
--net-timeout <int> オプション。クライアントがネットワーク全体にわたる問合せからデータをダウンロードするまでDgraphが待機する最大秒数を指定します。デフォルトのネットワーク・タイムアウト値は、30秒です。
--search-max <int> オプション。テキスト検索する用語の最大数を設定します。デフォルト値は10です。
--search-char-limit <int> オプション。レコードおよび値の検索の検索用語の最大長(文字数)を設定します。デフォルトは132文字です。この長さを超える用語は索引付けされないため、レコードおよび値の検索では見つかりません。
--snippet-cutoff <int> オプション。Dgraphがスニペットを識別するために評価する属性内の単語の数を制限します。<num>個の単語内に一致が見つからない場合、それ以降に属性値で一致があっても、Dgraphはスニペットを返しません。フラグを指定しない場合、または<num>を指定しない場合のデフォルトは500です。
--snippet-disable <bool> オプション。スニペットをグローバルに無効にします。デフォルトはfalseで、スニペットが有効であることを示します。
--dynamic-category-enable <bool> オプション。すべての使用可能な動的属性値の特性を有効にします。 The default is false.このオプションはパフォーマンスに影響を与えるため、本番使用は意図されていないことに注意してください。
--contraction-disable <bool> オプション。ナビゲーション結果に絞込みを表示する場合に、暗黙的管理属性を計算せず、明示的に指定した管理属性のみを計算して表示するようにDgraphに指定します。デフォルトはfalseです。このフラグを指定しても、表示される結果のレコード・セットのサイズは削減されませんが、Dgraphプロセスの実行時パフォーマンスが向上します。

有益なナビゲーション絞込みを取得する目的でこのフラグを使用する場合、最高レベルの優先ルールがすべての送信問合せで機能するように設定する必要があります。

--wildcard-max <int> オプション。記号を含むワイルドカード問合せのワイルドカード用語(ab*c.def*など)に一致できる用語の最大数を指定します。デフォルトは100です。
--auto-idle <bool> 指定された--idle-timeoutの間にデータ・ドメインが問合せを受信しなかった場合、Endeca Serverがこのデータ・ドメインをアイドル状態にする必要があるかどうかを指定します。auto-idleがfalseに設定されている場合、データ・ドメインがアイドル状態になることはありません。trueに設定されている場合、タイムアウト期間中に問合せを受信しないと、idle-timeoutの終了後にデータ・ドメインはアイドル状態になります。Endeca ServerがDgraphプロセスを停止した場合、データ・ドメイン・プロファイルでauto-idleに設定されているデータ・ドメインはアイドル状態とみなされます。問合せを受信すると、アイドル状態のデータ・ドメインは自動的にアクティブ化されます。アイドル状態のデータ・ドメインがアクティブ化されると、タイムアウトのタイマーはリセットされます。
--idle-timeout <int> オプション。タイムアウト期間(分)を指定します。タイムアウト期間中にデータ・ドメインが問合せを受信しなかった場合、このタイムアウト期間の終了後に、Endeca Serverは自動アイドルになるように構成されているデータ・ドメインをアイドル状態にします。デフォルトは10分であり、タイムアウトが指定されていない場合に使用されます。

この設定は、auto-idleがfalseに設定されているデータ・ドメインには使用されません。

--session-id-type <type> セッション・アフィニティを確立するために使用するメソッド。

使用可能なオプションは、header (HTTPヘッダー)、parameter (URLパラメータ)またはcookieです。デフォルトのメソッドはheaderです。

--session-id-key <name> アフィニティの保持に使用するキーの名前。

デフォルト名は、X-Endeca-Session-IDです。

--args <dgraph-flags> データ・ドメインのDgraphプロセスで使用する追加のDgraphフラグのリストを指定します。引数はすべてDgraphプロセスに渡されるため、--argsフラグは、コマンドラインの最後のフラグである必要があります。
--args --usage 使用可能なDgraphプロセス・フラグのリストを提供します。See Dgraphフラグを参照してください。
次のコマンド例があるとします。 
endeca-cmd put-dd-profile MyProfile --description "group profile" --oversubscribe false --net-timeout 60
は、MyProfileという名前のデータ・ドメイン・プロファイルを作成しますが、オーバーサブスクライブされたEndeca Serverインスタンスには配置できず、60秒のネットワーク・タイムアウト値でDgraphを起動します。MyProfileは、他の構成設定のデフォルト値を使用します。

get-dd-profile

get-dd-profileコマンドは、指定した名前のデータ・ドメイン・プロファイルの特性をリストします。

このコマンドの構文は次のとおりです。 
endeca-cmd get-dd-profile <profile-name> [global-options]
ここで、profile-nameは、既存のデータ・ドメイン・プロファイルの名前です。このコマンドにはオプションはありません。
次のコマンド例があるとします。 
endeca-cmd get-dd-profile MyProfile
は、MyProfileという名前のデータ・ドメイン・プロファイルの次の詳細を返します。 
MyProfile
Description: group profile
AllowQueriesOnLeader: true
AllowOverSubscribe: false
NumFollowers: 0
ReadOnly: false
NumComputeThreads: 4
ComputeCacheSizeMB: 0
StartupTimeoutSeconds: 600
ShutdownTimeoutSeconds: 30
AutoIdle: false
SessionIdType: HEADER
SessionIdKey: X-Endeca-Session-ID
Args: []

list-dd-profiles

list-dd-profilesコマンドは、Endeca Serverクラスタで構成されるデータ・ドメイン・プロファイルの特性をリストします。このコマンドは、データ・ドメイン・プロファイルごとに、その名前、説明、およびその他の特性(ノードの数、問合せ処理スレッドの数、このプロファイルのDgraphプロセスに送信される引数のリスト(存在する場合)など)を返します。

このコマンドの構文は次のとおりです。 
endeca-cmd list-dd-profiles [--verbose] [global-options]

--verboseオプションは、各データ・ドメインの追加のステータス情報を含めます。

delete-dd-profile

delete-dd-profileコマンドは、指定した名前のデータ・ドメイン・プロファイルを削除します。このコマンドは、このプロファイルを使用している可能性のあるデータ・ドメインには影響しません。

このコマンドの構文は次のとおりです。 
endeca-cmd delete-dd-profile <profile-name> [global-options]
ここで、profile-nameは、既存のデータ・ドメイン・プロファイルの名前です。このコマンドにはオプションはありません。
次のコマンド例があるとします。 
endeca-cmd delete-dd-profile MyProfile
は、MyProfileという名前のデータ・ドメイン・プロファイルを削除します。
デフォルトのデータ・ドメイン・プロファイル(default)を削除することはできません。そうしようとすると、コマンドは次のエラーで失敗します。 
OES-000107: Cannot delete the default data domain profile.

既存のデータ・ドメインの作成に使用したデータ・ドメイン・プロファイルを削除できます(データ・ドメインが作成されると、プロファイルからの構成情報はデータ・ドメインの状態にコピーされます)。したがって、データ・ドメインは作成後にプロファイルを使用しません。