Endeca Server operational model

The Endeca Server has a command-line interface that lets you control Endeca data stores.

With the Endeca Server commands, you can perform the following tasks:
Endeca Server command Purpose
create-ds Creates a named Endeca data store. The command also attaches and starts the data store.
attach-ds Attaches an existing but detached Endeca data store. This operation in effect registers the Endeca data store with the Endeca Server. The command also starts the data store.
detach-ds Detaches an attached Endeca data store. The data store must be stopped before it can be detached. Although the Endeca data store's index files are not deleted from the file system, the data store is de-registered from the Endeca Server, so that subsequent commands (except for attach-ds) will have no effect on the data store.
start-ds Starts an attached but stopped Endeca data store.
stop-ds Stops a started (running) Endeca data store.
status-ds Shows the status of an attached Endeca data store. The status information includes its assigned ports, as well as the Dgraph arguments (if any) that were specified when the data store was created or attached.
list-ds Lists all the Endeca data stores that are attached to this Endeca Server.
list-jobs Lists the running or queued jobs on a specific Endeca data store.
version Lists the version of the Oracle Endeca Server and the versions of the Dgraph processes powering each of the data stores (if the Dgraph processes for these data stores are currently running).

You do not need to specify the name of the data stores when using this command.

All of the operations that control data stores are also programmatically available in the Endeca Server's Control Web Service. The list-jobs and the version operations are available as listJobsOperation and GetVersionOperation in the Administration Web Service.

endeca-cmd directory

The endeca-cmd directory contains the endeca-cmd script for running the Endeca Server commands. To run the commands, you use a command-line window (for example, open a Command Prompt in Windows) and navigate to the endeca-cmd directory, or run /<path>/endeca-cmd.