create-ds command

The create-ds command creates an Endeca data store, attaches it, and starts it.

This command performs three actions:
  1. Creates an Endeca data store with the specified name.
  2. Attaches the Endeca data store (i.e., executes the attach-ds command).
  3. Starts the Endeca data store (i.e., executes the start-ds command).

If the create operation fails at any point, the newly-created data files are deleted.

The syntax for this command is: 
endeca-cmd create-ds <datastore-name> [global-options] [create-options]
where datastore-name is mandatory and is the name of the new Endeca data store. The name must be unique among any other Endeca data stores on this node.
The following additional command options can be used to change the created data store's configuration (defaults will be used otherwise):
Create Option Meaning
--ws-port <num> Specifies the 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.
--bulk-load-port <num> Specifies the port number for bulk load ingest operations for the Endeca data store's Dgraph process. This port number must be different from the port specified by the --ws-port flag and cannot be in use by any other process on the machine. If the --bulk-load-port flag is not used, then the bulk load port number defaults to a port number in the default range specified on the Endeca Server.
--data-files <path> Specifies the absolute path of the Endeca data store's indexes directory to be created. The default is to create the indexes directory in the location configured in the Endeca Server.
--startup-timeout <seconds> Specifies 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.
--shutdown-timeout <seconds> Specifies 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.
--args --usage Provides a list of the Dgraph process flags.
--args <dgraph-flags> Specifies a list of the Dgraph flags that will be used for the Endeca data store's Dgraph process. The --args flag must be the last flag on the command line as all of its arguments are passed on to the Dgraph process.

create-ds examples

Example 1: 
endeca-cmd create-ds adventureworks
creates an Endeca data store named adventureworks in the default location. The port and bulk load ports for the Endeca data store's Dgraph process are assigned by the Endeca Server, and both the startup and shutdown timeout settings are 60 seconds. This is the simplest use of the command as it uses no configuration flags.
Example 2: 
endeca-cmd create-ds warranty --ws-port 6060 --bulk-load-port 6061 --shutdown-timeout 90
creates a warranty data store in the default location. The database port is 6060 and the bulk load port is 6061. The startup timeout is the default 60 seconds while shutdown timeout setting is 90 seconds.
Example 3: 
endeca-cmd create-ds wine --data-files c:\endeca\apps\wine
creates a data store named wine in the C:\Endeca\Apps directory (the name of the indexes directory is C:\Endeca\Apps\wine_indexes). The Endeca data store's Dgraph process uses the configuration defaults.
Example 4: 
endeca-cmd create-ds books --args --threads 6 --net-timeout 60
creates a data store named books in the default location. The Dgraph's port and bulk load port numbers are assigned by the Endeca Server, and both the startup and shutdown timeout settings are 60 seconds. The --args flag specifies that the Dgraph process be started with 6 threads and a network timeout value of 60 seconds.