Subcommand | Description |
---|---|
add | Add a new Data Source to a given system. |
create | Creates a Data Source. |
create-template-file | Creates a template file that can be used to create a Data Source. |
get | Get details of a Data Source for a given ID. |
list | Provides a list of available Data Sources. |
delete | Delete a Data Source with a given ID. |
--api-key
: Provide your USER_SECRET_KEY. It is mandatory if you don’t use the --info-only
flag.--from-bag
: The path to the bag file you want to extract the signals from.--from-file
: The path to the json file you want to extarct info about Data Sources and signals.--system-id
: System id on which the Data Source will be created. It is mandatory if you don’t use the --info-only
flag.--datasource-name
: Data Source name.--description
: Data Source description. This is optional.--info-only
: If set, it will only list the signals that would be created into your terminal, without generating them on the cloud.--cannot-contain
: This option creates a ‘cannot contain’ filter on the topic names we shall extract. Any topic name containing one of these keywords shall not be extracted. Multiple can be given: --cannot-contain key1 --cannot-contain key2
--must-contain
: This option creates a ‘must contain’ filter on the topic names we shall extract. Any topic name NOT containing one of these keywords shall not be extracted. Multiple can be given: --must-contain key1 --must-contain key2
📝 Note: Custom Topics If your bag contains custom packages/messages that are specific to your own environment, please make sure that you have sourced all the message types you mean to extract in the terminal you call the command from.The third way to create a new Data Source is by providing a json file. First you need to create the json file, by following the format below:
name
is mandatory for data sources and for signals. If not provided, the data source or signal will be skipped.
If a system Id is provided, the data source will be bound to that system, otherwise the data source will be created but not bound to any system.
Example of how to create a new data source from a json file:
Usage:
create_datasource_template.json
in the specified directory or current working directory if no path was specified.
This file contains a basic template for creating a new data source. You can edit this file to add or modify the data source properties.
If there is a field that is not required, you can leave it empty or with the default value. You can add as many data sources and signals as you want to the file.
add
. Available flags are:
--datasource-id
: The ID of the Data Source you want to add. Multiple can be specified: --datasource-id ID1 --datasource-id ID2
.--system-id
: The ID of the System you want to add the Data Source to.update
. Available flags are:
--datasource-id
: The ID of the Data Source you want to update.--datasource-name
: Data Source name to update.--description
: Data Source description to update.datasource-id
, see example below:
Usage:
--api-key
: mandatory USER_SECRET_KEY.--datasource-id
: The ID of the Data Source you want to retrieve. Multiple can be specified: --datasource-id ID1 --datasource-id ID2
. It is exclusive with option name.--name
: The name of the Data Source to retrieve. It is exclusive with datasource-id option.--output-file
: If set, it’ll provide the result in a json format in a file generated at given path. Make sure you provide the ‘.json’ extension.datasource-id
. If the data source is linked to any system, it is not possible to delete: you need to unlink it from the system(s) first and then try again.
Usage: