Command Line Interface Cheatsheet
This is a quick introductory section on the CLI. As you add more slices, you will use these primitives to manage your Datacoral deployment.
<slice-category>
refers to one of collect
, organize
, and harness
. However, in this version, we only support collect
and organize
.
<slice-type>
refers to the type of slice, for example Google Analytics or MySQL.<slice-name>
Is a user definable name of the instance of the slice you have deployed. For example if you have 3 MySQL slices for the 3 databases you want to connect, you would name the slices accordingly.
List all the available slices
datacoral <slice-category> list-slice-types
Describe slice types
Describe the input and output parameters needed for a given slice-type
datacoral <slice-category> describe --slice-type <slice-type>
There are several arguments relating to the describe command including to see those arguments and their definition type. The other arguments are:
--input-parameters list input parameters
--output-parameters list output parameters
--docs print slice documentation
--help output usage information
Add a slice
datacoral <slice-category> add --slice-type <slice-type> --slice-name <slice-name> [--parameters-file <params-file>]
Describe a deployed slice
List the input and output parameters for a deployed slice
datacoral describe --slice-name <slice-name>
List installed slices
datacoral <slice-category> list
Update a slice
A. Update only the slice software
datacoral <slice-category> update --slice-name <slice-name>
B. Update only the configuration
datacoral <slice-category> update --slice-name <slice-name> --configuration-only [--parameters-file <params-file>]
C. Update slice software and the configuration
datacoral <slice-category> update --slice-name <slice-name> --parameters-file <params-file>
Remove a slice
datacoral remove --slice-name <slice-name>