データ・ドメイン操作

これらのコマンドは、Endecaデータ・ドメインで動作します。たとえば、データ・ドメインを作成して、そのステータスに関する情報を返すことができます。

データ・ドメイン操作は、endeca-cmdを使用してEndeca Serverのノード・プロファイルおよびデータ・ドメイン・プロファイルを構成した場合にのみ使用できます。

データ・ドメインを管理するためのコマンドは次のとおりです。

create-dd

create-ddコマンドは、デフォルトのデータ・ドメイン・プロファイルまたは指定したデータ・ドメイン・プロファイルのいずれかの構成設定を使用して、指定した名前で新しいデータ・ドメインを作成、登録および開始します。

このコマンドの構文は次のとおりです。 
endeca-cmd create-dd <new-data-domain> [global-options] [create-options]
ここで、new-data-domainは必須であり、新しいEndecaデータ・ドメインの名前です。名前は次の規則に従っています。
  • 名前は、このEndeca Serverインスタンス(またはEndeca Serverクラスタ)のその他のEndecaデータ・ドメイン全体で一意である必要があります。
  • 名前には、& (アンパサンド)、| (パイプ)、; (セミコロン)、\ (バックスラッシュ)および/ (スラッシュ)を使用できません。
  • 名前の先頭を"." (ピリオド)にすることはできません。
  • 名前に空白を含める場合は、名前を二重引用符で囲む必要があります。作成後、後続のコマンドで、二重引用符で囲んだその名前を参照する必要があります。

データ・ドメインの索引は、デフォルトで$DOMAIN_HOME/EndecaServer/dataディレクトリに作成されます。この場所を変更するには、Endeca Server構成ファイルEndecaServer.properties内でendeca-data-dirパラメータに別のディレクトリを指定します。

注意: create-ddコマンドを使用して、以前に作成されたデータ・ドメインをその索引に基づいて復元することはできません。この場合、import-ddおよびexport-ddを使用します。
次の追加コマンド・オプションを使用して、作成するデータ・ドメインの構成を変更できます(指定がなければデフォルトが使用されます)。
作成オプション 説明
--dd-profile-name name 使用するデータ・ドメイン・プロファイルの名前を指定します。指定しない場合は、デフォルトのデータ・ドメイン・プロファイルがデフォルトで使用されます。
--is-enabled boolean trueに設定すると、新しいデータ・ドメインが有効になります。このオプションを指定しない場合、データ・ドメインが有効になります。

データ・ドメインを作成および登録するが、開始しない場合は、--is-enabled falseを指定します。

例1: 
endeca-cmd create-dd MyDD
デフォルトのデータ・ドメイン・プロファイルを使用して、MyDDの名前のEndecaデータ・ドメインを作成します。データ・ドメインが有効になります。
例2: 
endeca-cmd create-dd MyDD2 --dd-profile-name MyProfile --is-enabled false
MyProfileの名前のデータ・ドメイン・プロファイルを使用して、MyDD2データ・ドメインを作成します。データ・ドメインは作成および登録されますが、開始されません。

clone-dd

clone-ddコマンドは、既存のデータ・ドメインに基づいて、データ・ドメインを作成します。このコマンドの構文は次のとおりです。 
endeca-cmd clone-dd <cloned-domain> --source-name <source-domain> [global-options] [clone-option]

ここで、cloned-domainは新しいEndecaデータ・ドメインの一意の名前であり、source-domainからコピーされます。ソース・データ・ドメインは、このコマンドを実行する前に有効にする必要があります。新しいデータ・ドメイン名は、create-ddコマンドと同じネーミング・ルールに従います。

--is-enabledオプションをtrueに設定すると、新しいデータ・ドメインが有効になります。このオプションを指定しない場合、データ・ドメインが有効になります。データ・ドメインをクローニングするが、開始しない場合は、--is-enabled falseを指定します。

次のコマンド例があるとします。 
endeca-cmd clone-dd MyDD3 --source-name MyDDMaster --is-enabled false
MyDDMasterデータ・ドメインをクローニングして、MyDD3データ・ドメインを作成します。データ・ドメインは作成および登録されますが、開始されません。

delete-dd

delete-ddコマンドは、指定した名前のデータ・ドメインを削除します。これは、Endeca Serverクラスタからデータ・ドメインを登録解除し、このデータ・ドメインにサービスを提供するDgraphノードを停止して、このデータ・ドメインの索引ファイルを削除します。

このコマンドの構文は次のとおりです。 
endeca-cmd delete-dd <data-domain> [global-options]

disable-dd

disable-ddコマンドは、指定した有効なデータ・ドメインを停止しますが、Dgraphノードへのリソースの割当ては続行します。

このコマンドの構文は次のとおりです。 
endeca-cmd disable-dd <data-domain> [global-options]
ここで、data-domainは、停止される無効なデータ・ドメインの名前です。

データ・ドメインは、問合せに答える前に有効にする必要があります。

enable-dd

enable-ddコマンドは、指定した無効なデータ・ドメインを開始します。このコマンドの構文は次のとおりです。 
endeca-cmd enable-dd <data-domain> [global-options]
ここで、data-domainは、開始される無効なデータ・ドメインの名前です。

export-dd

export-ddコマンドは、索引ファイルのスナップショットを取得して、別の名前でオフライン・ディレクトリにコピーすることで、指定したデータ・ドメインの索引をエクスポートします。スナップショットは、索引ファイルのコピーのみを表し、データ・ドメインのその他の特性は取得しません。

このコマンドの構文は次のとおりです。 
endeca-cmd export-dd <data-domain> [--offline-name <exported-domain>] [global-options]
ここで、data-domainは、エクスポートする既存のEndecaデータ・ドメインの名前です。
--offline-nameオプションは、エクスポートされるデータ・ドメインに付与する名前を指定します。この名前は、一意である必要があります。このオプションを指定しない場合、次の書式を使用して、元のデータ・ドメイン名に日付を追加して、エクスポートされる名前が自動的に割り当てられます。 
name_MMMMM-dd-yyyy-hh-mm

このコマンドは、エクスポートされる索引に使用される結果名を返します。

重要: --export-nameの値は、後でこの索引をインポートする際に必要になるため、記録を残してください。

オフライン・ディレクトリの場所は、Endeca Server構成ファイルのendeca-offline-dirパラメータによって指定されます。デフォルトは$DOMAIN_HOME/EndecaServer/offlineディレクトリです。

次のコマンド例があるとします。 
endeca-cmd export-dd MyDD --offline-name MyDD_offline
MyDDデータ・ドメインをMyDD_offlineの名前でオフライン・ディレクトリにエクスポートします。

import-dd

import-ddコマンドは、エクスポートした索引ファイルを使用して、指定したnameで新しいデータ・ドメインを作成します。このコマンドの構文は次のとおりです。 
endeca-cmd import-dd <new-data-domain> --offline-name <exported-domain> [global-options] [import-options]
ここで、new-data-domainは、--offline-nameフラグで指定されたエクスポート済データ・ドメインから作成される新しいデータ・ドメインの名前です。

この操作を使用する場合は、索引が現在エクスポートされているデータ・ドメインを作成済であることを前提とします。また、使用した--export-nameをexport-ddコマンドで追跡するか、自動的に割り当てられた名前を把握していることも前提とします。

このコマンドには、次のオプションがあります。
インポート・オプション 説明
--dd-profile-name 使用するデータ・ドメイン・プロファイルの名前(指定しない場合のデフォルトは、デフォルトのデータ・ドメイン・プロファイルです)。
--is-enabled trueに設定すると、新しいデータ・ドメインがインポート後に有効になります。このオプションを指定しない場合、インポートされたデータ・ドメインが有効になります(これがデフォルトです)。データ・ドメインをインポートするが、開始しない場合は、--is-enabled falseを指定します。
次のコマンド例があるとします。 
endeca-cmd import-dd NewDD --offline-name MyDD --dd-profile-name MyDDProfile --is-enabled false
索引MyDDを、オフライン・ディレクトリから新しいデータ・ドメインNewDDにインポートします。これはMyDDProfileデータ・ドメイン・プロファイルで作成され、有効になりません。

get-dd

get-ddコマンドは、指定したデータ・ドメインの特性を返します。

このコマンドの構文は次のとおりです。 
endeca-cmd get-dd <data-domain> [global-options]
ここで、data-domainは、情報を返すデータ・ドメインの名前です。

返される情報には、データ・ドメインが有効かどうか、フォロワ・ノードの数、問合せ処理スレッドの数、およびこのデータ・ドメインのDgraphプロセスに送信される引数のリストが含まれます。

get-dd-health

get-dd-healthコマンドは、指定した名前で、Endeca Serverクラスタのデータ・ドメインの状態に関する情報を返します。

このコマンドの構文は次のとおりです。 
endeca-cmd get-dd-health <data-domain> [global-options]
ここで、data-domainは、状態の情報を返すデータ・ドメインの名前です。データ・ドメインは有効または無効にできます。

返される情報には、リーダー・ノードおよびフォロワ・ノードを含む、Dgraphノードのステータスがリストされます。

get-dd-status

get-dd-statusコマンドは、指定したデータ・ドメインに関するランタイム統計を返します。

このコマンドの構文は次のとおりです。 
endeca-cmd get-dd-status <data-domain> [global-options]
ここで、data-domainは、統計を返すデータ・ドメインの名前です。統計を返すには、データ・ドメインを有効にする必要があります。
レスポンスには、次の情報が含まれます。
  • 索引レコードのサイズ(MB)
  • データ・ドメインのソース・レコードの数(非データ(システム・レコード)は除く)。
  • データ・ドメインで実行中の各DgraphノードのDgraphノード統計(Dgraphの起動時間、索引の最終作成時間、パスを含む)(この情報は、Oracle Endecaサポートでの使用のみを対象にしています)。

rescale-dd

rescale-ddコマンドは、指定した数のフォロワDgraphノードをデータ・ドメインに追加して、これらのノードを起動します。

このコマンドの構文は次のとおりです。 
endeca-cmd rescale-dd <data-domain> [--num-followers <integer>] [global-options]
ここで、data-domainは、エクスポートする既存のEndecaデータ・ドメインの名前です。

--num-followersオプションは、追加するノードの数を指定します。この名前は、一意である必要があります。このオプションを指定しない場合、デフォルトの数は1になります。指定した数は、オーバーサブスクライブされたノードの構成済の最大許容数を超えることができないことに注意してください。

次のコマンド例があるとします。 
endeca-cmd rescale-dd MyDD --num-followers 4
4つのフォロワDgraphノードをMyDDデータ・ドメインに追加して、起動します。

allocate-bulk-load-port

allocate-bulk-load-portコマンドは、指定したデータ・ドメインで、バルク・ロード・インタフェースに使用されるリーダー・ノードのホスト名とポートを返します。このコマンドの構文は次のとおりです。 
endeca-cmd allocate-bulk-load-port <data-domain> [global-options]

これは読取り/書込み操作です。現在のリーダー・ノードが使用可能な場合は、現在のDgraphリーダー・ノードを確認して、バルク・ロードに使用されるポートとともにレポートします。現在のリーダー・ノードが使用できない場合は、新しいリーダー・ノードおよび新しいバルク・ポートを指定し、それらをレポートします。

注意: データ・ドメインがアイドル状態の場合、このコマンドを発行すると(Dgraphプロセスの再起動によって)データ・ドメインがアクティブになります。

list-dd

list-ddコマンドは、既存のすべてのデータ・ドメインをリストし、それらのステータス(有効または無効)を表示します。

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

--verboseオプションでは、各データ・ドメインの追加のステータス情報(名前、説明、ノードの数、問合せ処理スレッドの数、およびこのデータ・ドメインのDgraphプロセスに送信される引数のリスト)を表示します。

update-dd

update-ddコマンドは、指定されたデータ・ドメインを新しいデータ・ドメイン・プロファイルで更新します。このコマンドは、無効なデータ・ドメインでのみ実行できます。このコマンドの実行後もデータ・ドメインは無効のままであるため、有効にする必要があります。

このコマンドの構文は次のとおりです。 
endeca-cmd update-dd <data-domain> --dd-profile-name <profile-name> [global-options]

--dd-profile-nameオプションは必須です。このデータ・ドメインに使用するデータ・ドメイン・プロファイルの名前を指定します。したがって、このコマンドを使用する前に、使用するデータ・ドメイン・プロファイルがすでに作成されていることを確認します。

このコマンドは、データ・ドメイン・プロファイルに指定されているデータ・ドメインのパラメータをすべて変更し、Endeca Serverクラスタ内のノードにデータ・ドメインを自動的に再割当します。

warm-cache-dd

warm-cache-ddコマンドは、指定されたデータ・ドメインで基礎となるDgraphプロセス・キャッシュをウォームします。

このコマンドの構文は次のとおりです。 
endeca-cmd warm-cache-dd <data-domain> [--time-limit-sec <sec>] [global-options]

--time-limit-secパラメータはオプションです。ウォーミング・スクリプトを実行する時間制限を指定します。タイムアウトを指定しない場合、デフォルト値の1800秒(30分)が使用されます。

このコマンドを使用すると、カスタム・ウォームアップ・スクリプトを作成しなくても、Dgraphプロセスによりそのキャッシュがウォームアップされます。このコマンドでは、指定された期間に再生する問合せのセットを選択するために、現在のDgraphプロセスの使用パターンが考慮されます。これにより、Dgraphは問合せ全体で計算結果を再利用できるようになり、問合せ処理でユーザーが認識可能な遅延を軽減するのに役立ち、パフォーマンスが向上します。

version

versionコマンドは、Oracle Endeca Serverのバージョンおよびデータ・ドメインを支援するDgraphプロセスのバージョン(Dgraphプロセスが現在実行中の場合)をリストします。

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