Operations in the Control Web Service

This topic lists the operations of the Control Web Service.

A request to the Control Web Service will contain one of the following operations:
Operation Description Equivalent endeca-cmd command
attachDataStore Attach an Endeca data store to existing data files on disk. The data store will be started. attach-ds
createDataStore Create the data files for a new Endeca data store on disk and attach it. The data store will be started. create-ds
dataStoreStatus Get the status of a started or stopped Endeca data store. status-ds
detachDataStore Detach a stopped Endeca data store. detach-ds
listDataStores List the names of all attached Endeca data stores. list-ds
startDataStore Start a stopped Endeca data store. start-ds
stopDataStore Stop a started Endeca data store. stop-ds
usage List the available Dgraph start-up flags. usage
version List the version of the Oracle Endeca Server and the versions of any started Dgraph processes powering each of the data stores. version
Note: The endeca-cmd list-jobs command is not listed in the table, as it uses the listJobsOperation of the Administration Web Service. For details on this operation, see the Oracle Endeca Server Administrator's Guide.

dataStoreConfig complex type

When you are creating or attaching a data store, you do so using the dataStoreConfig complex type. It represents an Endeca data store and all its configuration attributes. The dataStoreConfig type has the following characteristics:
Element Data Type Description
name string Required. The name of the new Endeca data store. The name must be unique among any other Endeca data stores on this node.
dataFiles string Required for attachDataStore; optional for createDataStore. The absolute path of the Endeca data store's data files directory to be created or attached to. For a createDataStore, the default is to create the data files directory in the location configured in the Endeca Server.
wsPort int Optional. Web service port number to be used for the Endeca data store's Dgraph process. The port number cannot be in use by any other process on the machine (including another Endeca data store). Defaults to a port number in the default range specified on the Endeca Server.
bulkLoadPort int Optional. The port number for bulk load ingest operations for the Endeca data store's Dgraph process. Defaults to a port number in the default range specified on the Endeca Server.
startupTimeoutSeconds int Optional. The maximum length of time (in seconds) that is allowed for the Endeca data store's Dgraph process to start up. Default is 60 seconds.
shutdownTimeoutSeconds int Optional. The maximum length of time (in seconds) that is allowed for the Endeca data store's Dgraph process to shut down. Default is 60 seconds.
arg string Optional. Specifies one Dgraph flag that will be used for the Endeca data store's Dgraph process. For multiple flags, use an arg element per flag.
The arg cannot parse spaces. Therefore, for flags that take parameters, use one arg for the flag itself and a second arg for the parameter. For example, the "--threads 6" flag would be specified as:
<arg>--threads</arg>
<arg>6</arg>