detach-ds command

The detach-ds command detaches an attached Endeca data store.

The syntax for the detach-ds command is:
endeca-cmd detach-ds <datastore-name> [global-options]
where datastore-name is the name of an existing, attached Endeca data store that is not running.
Note the following about the detach-db command:
  • A started data store must be stopped before it can be detached.
  • The command removes any configuration settings that were used when the Endeca data store was created (for example, with the --args flag). This means that if you subsequently use the attach-ds command, you must re-specify those configuration settings or else the data store will be re-attached with the default settings.
  • The command does not remove the data store's indexes directory or any of its data. This means that you do not have to use the create-ds command to re-use the index data files, but you do have to use the attach-ds command to re-attach the data store to the Endeca Server.

detach-ds errors

If datastore-name is started, the Endeca Server returns an error message similar to this example:
DataStore 'books' cannot be detached while it is running.
If datastore-name is already detached or does not exist, the Endeca Server returns an error message similar to this example:
Could not find the Endeca data store 'books'

detach-ds example

This command detaches the books data store:
endeca-cmd detach-ds books