These commands operate on Endeca data domains. For example, they allow you to create data domains and return information about their status.
You can use the data domain operations only after you have used endeca-cmd to configure Endeca Server node profile and data domain profiles.
The create-dd command creates, registers, and starts a new data domain with the specified name, using the configuration settings from either the default data domain profile or the specified data domain profile.
endeca-cmd create-dd <new-data-domain> [global-options] [create-options]where new-data-domain is mandatory and is the name of the new Endeca data domain. The name follows these rules:
The index for the data domain is created in the $DOMAIN_HOME/EndecaServer/data directory by default. You can change this location by specifying a different directory for the endeca-data-dir parameter in the Endeca Server configuration file EndecaServer.properties.
Create Option | Description |
---|---|
--dd-profile-name name | Specifies the name of the data domain profile name to be used. If not specified, defaults to using the default data domain profile. |
--is-enabled boolean | If set to
true, indicates that the new data domain is
enabled. If this option is not specified, the data domain is enabled.
If you want to create and register but not start the data domain, specify --is-enabled false. |
endeca-cmd create-dd MyDDcreates an Endeca data domain named MyDD using the default data domain profile. The data domain will be enabled.
endeca-cmd create-dd MyDD2 --dd-profile-name MyProfile --is-enabled falsecreates a MyDD2 data domain using the data domain profile named MyProfile. The data domain is created and registered, but not started.
endeca-cmd clone-dd <cloned-domain> --source-name <source-domain> [global-options] [clone-option]
where cloned-domain is the unique name of the new Endeca data domain, as copied from source-domain. The source data domain must be enabled before you run this command. The new data domain name follows the same naming rules as the create-dd command.
The --is-enabled option, if set to true, indicates that the new data domain is enabled. If this option is not specified, the data domain is enabled. If you want to clone but not start the data domain, specify --is-enabled false.
endeca-cmd clone-dd MyDD3 --source-name MyDDMaster --is-enabled falsecreates a MyDD3 data domain by cloning the MyDDMaster data domain. The data domain is created and registered, but not started.
The delete-dd command deletes a data domain with the specified name. This de-registers the data domain from the Endeca Server cluster, shuts down the Dgraph nodes serving this data domain, and deletes the index files for this data domain.
endeca-cmd delete-dd <data-domain> [global-options]
The disable-dd command stops the specified enabled data domain but continues to allocate resources to the Dgraph nodes.
endeca-cmd disable-dd <data-domain> [global-options]where data-domain is the name of the disabled data domain that will be stopped.
The data domain must be enabled before it can answer queries.
endeca-cmd enable-dd <data-domain> [global-options]where data-domain is the name of the disabled data domain that will be started.
The export-dd command exports the index of the specified data domain by taking a snapshot of the index files and copying them into the offline directory under another name. A snapshot represents a copy of the index files only, and does not capture any other characteristics of the data domain.
endeca-cmd export-dd <data-domain> [--offline-name <exported-domain>] [global-options]where data-domain is the name of the existing Endeca data domain to be exported.
name_MMMMM-dd-yyyy-hh-mm
The command returns the resulting name used for the exported index.
The location of the offline directory is specified by the endeca-offline-dir parameter in the Endeca Server configuration file. By default, this is the $DOMAIN_HOME/EndecaServer/offline directory.
endeca-cmd export-dd MyDD --offline-name MyDD_offlineexports the MyDD data domain to the offline directory under the name MyDD_offline.
endeca-cmd import-dd <new-data-domain> --offline-name <exported-domain> [global-options] [import-options]where new-data-domain is the name of the new data domain that will be created from the exported data domain specified by the --offline-name flag.
Using this operation assumes that you have previously created a data domain whose index is currently exported. It also assumes that you kept track of the --export-name you used in the export-dd command, or know the name that was automatically assigned.
Import Option | Description |
---|---|
--dd-profile-name | The name of the data domain profile to use (if not specified, defaults to the default data domain profile). |
--is-enabled | If set to true, indicates that the new data domain is enabled after it is imported. If this option is not specified, the imported data domain is enabled (this is the default). If you want to import but not start the data domain, specify --is-enabled false. |
endeca-cmd import-dd NewDD --offline-name MyDD --dd-profile-name MyDDProfile --is-enabled falseimports the index MyDD from the offline directory into the new data domain NewDD, which is created with the MyDDProfile data domain profile and is not enabled.
The get-dd command returns the characteristics of the specified data domain.
endeca-cmd get-dd <data-domain> [global-options]where data-domain is the name of the data domain for which to return information.
The returned information includes whether the data domain is enabled, the number of follower nodes, the number of query processing threads, and the list of arguments sent to the Dgraph processes for this data domain.
The get-dd-health command returns information about a data domain's health in the Endeca Server cluster, with the specified name.
endeca-cmd get-dd-health <data-domain> [global-options]where data-domain is the name of the data domain for which to return health information. The data domain can be enabled or disabled.
The returned information lists the status of the Dgraph nodes, including the leader node and follower nodes.
The get-dd-status command returns runtime statistics about the specified data domain.
endeca-cmd get-dd-status <data-domain> [global-options]where data-domain is the name of the data domain for which to return statistics. The data domain must be enabled for statistics to be returned.
The rescale-dd command adds a specified number of follower Dgraph nodes to the data domain and starts these nodes.
endeca-cmd rescale-dd <data-domain> [--num-followers <integer>] [global-options]where data-domain is the name of the existing Endeca data domain to export.
The --num-followers option specifies the number of nodes to add. This name must be unique. If this option is not specified, the number defaults to 1. Note that the specified number cannot exceed the configured maximum allowable number of over-subscribed nodes.
endeca-cmd rescale-dd MyDD --num-followers 4adds four follower Dgraph notes to the MyDD data domain and starts them.
endeca-cmd allocate-bulk-load-port <data-domain> [global-options]
This is a read-write operation — if the current leader node is available, it verifies the current Dgraph leader node and reports it along with the port used for Bulk Load. If the current leader node is not available, it appoints a new leader node and a new bulk load port and reports them.
The list-dd command lists all existing data domains and shows their status (enabled or disabled).
endeca-cmd list-dd [--verbose] [global-options]
The --verbose option displays additional status information for each data domain: the name, description, the number of nodes, the number of query processing threads, and the list of arguments sent to the Dgraph processes for this data domain.
The update-dd command updates the specified data domain with a new data domain profile. You can run this command only on a disabled data domain. The data domain remains disabled after running this command, and you must enable it.
endeca-cmd update-dd <data-domain> --dd-profile-name <profile-name> [global-options]
The --dd-profile-name option is required. It specifies the name of the data domain profile you want to use for this data domain. Thus before using this command, ensure that the data domain profile you want to use is already created.
This command changes all parameters of the data domain that are specified in the data domain profile, and automatically reallocates the data domain on the nodes in the Endeca Server cluster.
The warm-cache-dd command warms the underlying Dgraph process cache for the specified data domain.
endeca-cmd warm-cache-dd <data-domain> [--time-limit-sec <sec>] [global-options]
The --time-limit-sec parameter is optional. It specifies the time limit during which you would like the warming script to run. If you do not specify the timeout, the default value of 1800 seconds (30 minutes) is used.
This command causes the Dgraph process to warm up its cache without the need to create a custom warm-up script. The command takes into account current Dgraph process usage pattern for selecting the set of queries for replay for a specified period of time. It allows the Dgraph to reuse its computation results across queries, and thus helps reduce the user-observable latencies in query processing and improves performance.
The version command lists the version of the Oracle Endeca Server and the version of the Dgraph process powering the data domains (if the Dgraph processes are currently running).
endeca-cmd version [global-options]