Data domain operations

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 commands for managing data domains are:

create-dd

The create-dd command creates, registers, and starts a data domain with the specified name, using the configuration settings from either the default data domain profile or the specified data domain profile.

The syntax for this command is: 
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 name must be unique among any other Endeca data domains in this Endeca Server instance (or Endeca Server cluster).
  • The name cannot contain these characters: & (ampersand), | (pipe), ; (semicolon), \ (back slash), / (forward slash).
  • The name cannot start with "." (a period).
  • The name must be enclosed in double quotes if it contains spaces. Note that after being created, the name must be referenced within double quotes in subsequent commands.

The data files for the data domain are put 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.

The following additional command options can be used to change the created data domain's configuration (defaults are used otherwise):
Create Option Meaning
--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.

Example 1: 
endeca-cmd create-dd MyDD
creates an Endeca data domain named MyDD using the default data domain profile. The data domain will be enabled.
Example 2: 
endeca-cmd create-dd MyDD2 --dd-profile-name MyProfile --is-enabled false
creates a MyDD2 data domain using the data domain profile named MyProfile. The data domain is created and registered, but not started.

clone-dd

The clone-dd command creates a data domain based on the existing data domain. The syntax for this command is: 
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.

This example: 
endeca-cmd clone-dd MyDD3 --source-name MyDDMaster --is-enabled false
creates a MyDD3 data domain by cloning the MyDDMaster data domain. The data domain is created and registered, but not started.

delete-dd

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.

The syntax for this command is: 
endeca-cmd delete-dd <data-domain> [global-options]

disable-dd

The disable-dd command stops the specified enabled data domain but continues to allocate resources to the Dgraph nodes.

The syntax for this command is: 
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.

enable-dd

The enable-dd command starts the specified disabled data domain. The syntax for this command is: 
endeca-cmd enable-dd <data-domain> [global-options]
where data-domain is the name of the disabled data domain that will be started.

export-dd

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.

The running state of the data domain to be exported depends on your operating system:
  • Linux: Both disabled data domains and enabled data domains can be exported.
  • Windows: Disabled data domains can be exported, but enabled data domains cannot be exported.
The syntax for this command is: 
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.
The --offline-name option specifies the name to give to the exported data domain. This name must be unique. If this option is not specified, the exported name is assigned automatically, by appending the date to the original data domain name, using this format: 
name_MMMMM-dd-yyyy-hh-mm

The command returns the resulting name used for the exported index.

Important: Keep track of the value of --export-name, because you will need it later for importing this 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.

This example: 
endeca-cmd export-dd MyDD --offline-name MyDD_offline
exports the MyDD data domain to the offline directory under the name MyDD_offline.

import-dd

The import-dd command creates a new data domain with the specified name using previously exported index files. The syntax for this command is: 
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.

The command has these options:
Import Option Meaning
--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.

This example: 
endeca-cmd import-dd MyDD --offline-name MyDD_offline --dd-profile-name MyDDProfile --is-enabled false
imports the index MyDD_offline from the offline directory into the new data domain MyDD_offline, which is created with the MyDDProfile data domain profile and is not enabled.

get-dd

The get-dd command returns the characteristics of the specified data domain.

The syntax for this command is: 
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.

get-dd-health

The get-dd-health command returns information about a data domain's health in the Endeca Server cluster, with the specified name.

The syntax for this command is: 
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.

get-dd-status

The get-dd-status command returns runtime statistics about the specified data domain.

The syntax for this command is: 
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 response includes the following information:
  • The size of the index records (in MB)
  • The number of source records in the data domain (this number excludes non-data, or system records).
  • The Dgraph node statistics for each running Dgraph node in the data domain, including the Dgraph startup time, last index creation time, and path.

rescale-dd

The rescale-dd command adds a specified number of follower Dgraph nodes to the data domain and starts these nodes.

The syntax for this command is: 
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.

This example: 
endeca-cmd rescale-dd MyDD --num-followers 4
adds four follower Dgraph notes to the MyDD data domain and starts them.

allocate-bulk-load-port

The allocate-bulk-load-port command returns a host name for the leader node and the port used for Bulk Load Interface, for a specified data domain. The syntax for this command is: 
endeca-cmd allocate-bulk-load-port [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.

Note that when you create a data domain profile, you can specify a port for Bulk Load, using one of the following two options. Use the putDataDomainProfile operation of the Cluster Web Service, which lets you specify args, one of which is the port for Bulk Load. Alternatively, use endeca-cmd put-dd-profile --args --bulk_load_port. Because this port must be unique on this machine, it is not guaranteed that the Endeca Server cluster will actually use the port you assign — it may assign its own port. You can always use endeca-cmd allocate-bulk-load-port name to find out which port is used for Bulk Load.

list-dd

The list-dd command lists all existing data domains and shows their status (enabled or disabled).

The syntax for this command is: 
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.

update-spelling-dictionaries

The update-spelling-dictionaries command updates the spelling dictionaries in the index for the specified data domain.

The syntax for this command is: 
endeca-cmd update-spelling-dictionaries <data-domain> [global-options]

This operation enables spelling correction and allows you to rebuild the dictionaries for spelling correction from the data corpus while continuing to issue queries and updates to the data domain and without stopping and restarting its Dgraph nodes.

version

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).

The syntax for this command is: 
endeca-cmd version [global-options]