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

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

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

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

重要: データ・ドメイン・プロファイルを作成した後は、その構成を変更できません。
データ・ドメイン・プロファイルを管理するためのコマンドは次のとおりです。

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です。

--oversubscribe <bool> オーバーサブスクライブされたEndeca Serverインスタンスにデータ・ドメイン(またはそのノードのいずれか)を配置できるかどうか。

指定しない場合のデフォルトはtrueです。

--num-compute-threads <int> Dgraphノードのスレッド・プールの計算スレッドの数を指定します。

値は正の整数(2以上)である必要があります。

Dgraphプロセスの計算スレッドの推奨値は、通常、ホストEndeca ServerノードのCPUコアの数と同じです。

値を指定しないか、0を指定した場合のデフォルトは、2または使用可能なプロセス数の大きい方の値になります。

--compute-cache-size <int> データ・ドメインのDgraphノードごとに、Dgraphプロセス・キャッシュの絶対値(MB)を指定します。

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

--startup-timeout <int> データ・ドメインのDgraphプロセスの起動処理に許可する最大時間(秒)を指定します。

デフォルトは600秒です。

--shutdown-timeout <int> データ・ドメインのDgraphプロセスの停止処理に許可する最大時間(秒)を指定します。

デフォルトは30秒です。

--read-only <bool> データ・ドメインを読取り専用で作成するか、更新リクエスト(データ・ロード・リクエストを含む)を受け入れないか。

指定しない場合のデフォルトは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プロセス・フラグのリストを提供します。
次のコマンド例があるとします。
endeca-cmd put-dd-profile MyProfile --description "group profile" --oversubscribe false --args --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: 2
ComputeCacheSizeMB: 0
StartupTimeoutSeconds: 600
ShutdownTimeoutSeconds: 30
SessionIdType: HEADER
SessionIdKey: X-Endeca-Session-ID
Args: [--net-timeout, 60]

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.

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