...
- Started - you have started the tool
- Connected to server - you have successfully logged in to your account on a specific server
- Opened project - you have opened a project you have access to
- Opened dump - you have created a new dump, or opened an existing one
...
...
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| string |
| your email account | stored in credentials file | ||||||
password | string |
| your password | stored in credentials file|||||||
accessToken | string |
| generated CleverMaps access token (see how to get one) | stored in config file | ||||||
bearerToken | string |
| JWT token generated after signing with limited 1h validity | |||||||
dumpDirectory | string |
| directory where your dumps will be stored | stored in config file | ||||||
server | string |
| server to connect to default = | stored in config file | ||||||
proxyHost | string |
| proxy server hostname | stored in config file | ||||||
proxyPort | integer |
| proxy server port | stored in config file | ||||||
s3AccessKeyId | string |
| AWS S3 Access Key ID required for S3 upload ( | stored in config file | ||||||
s3SecretAccessKey | string |
| AWS S3 Secret Access Key required for S3 upload ( | stored in config file |
| Anchor | ||||
|---|---|---|---|---|
|
...
| Parameter name | Type | Optionality | Description | Constraints | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accessToken | string |
| your email accountgenerated CleverMaps access token (see how to get one) | stored in credentials file config file | |||||||||
passwordserver | string |
| your password server to connect to | stored in credentials config file | |||||||||
accessTokendumpDirectory | string |
| generated CleverMaps access token (see how to get one) | stored in config file | |||||||||
server | string |
| server to connect to | stored in config file | |||||||||
dumpDirectory | string |
| directory where your dumps will be stored | stored in config file | |||||||||
proxyHost | string |
| proxy server hostname | stored in config file | |||||||||
proxyPort | integer |
| proxy server port | stored in config file | |||||||||
s3AccessKeyId | string |
| AWS S3 Access Key ID required for S3 upload ( | stored in config file | |||||||||
s3SecretAccessKey | string |
| AWS S3 Secret Access Key required for S3 upload ( | stored in config file |
Connected to server
...
Open a project and set as current. Opens dump if it exists.
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| string |
| Project ID of project to be opened |
...
importProject
Allows you to import either:
- project from a server (e.g. a data dimension)
- a local dump of a project (See the tutorial)
- perform import on server
You can also import a part of a project with one of the parameters (dashboards, datasets, indicators, indicatorDrills, markers, markerSelectors, metrics, views). If you specify none of these parameters, the whole project will be imported. Everytime you specify a datasets parameter, corresponding data will be imported.
...
| Parameter name | Type | Optionality | Description | Constraints | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
project | string |
| Project ID of the project from which files will be imported | ||||||||
dump must be specifieddump | boolean | string |
| ID of a import project from local dump to be imported
| |||||||
serverSide | boolean |
| performs import of specified project on server
| ||||||||
cascadeFrom | string |
| cascade import object and all objects it references see usage examples below | ||||||||
| string |
| specify a prefix for the metadata objects and data files | ||||||||
dashboards | boolean |
| import dashboards only | ||||||||
dataPermissions | boolean |
| import data permission only | ||||||||
| boolean |
| import datasets only | ||||||||
| boolean |
| import exports only | ||||||||
indicators | boolean |
| import indicators only | ||||||||
| boolean |
| import indicator drills only | ||||||||
markers | boolean |
| import markers only | ||||||||
markerSelectors | boolean |
| import marker selectors only | ||||||||
metrics | boolean |
| import metrics only | ||||||||
projectSettings | boolean |
| import project settings only | ||||||||
shares | boolean |
| import shares only | ||||||||
views | boolean |
| import views only | ||||||||
force | boolean |
| ignore source project skip failed dataset dumps (for projects with incomplete data) default = false | ||||||||
skipData | boolean |
| skip data import default = false |
...
Please note that your AWS S3 Access Key ID and Secret Access Key must be set using setup command first.
| Code Block | ||||
|---|---|---|---|---|
| ||||
loadCsv --dataset orders --mode full --s3Uri s3://my-company/data/orders.csv --verbose |
...
Dump data from a specified dataset into a CSV file. Creates new dump with dumped data.
| Parameter name | Type | Optionality | Description | Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
directorydataset | string |
| path to a directory where project's dump will be created | stored in config file | dataset | string
| name of the dataset do dump | |||||||||
force | boolean |
| REQUIRED | name of the dataset do dump
|
Anchor dumpProjectAnchor dumpProjectAnchor
| Anchor | ||||
|---|---|---|---|---|
|
...
Dump project data and metadata to a directory. If the dump if is successfull, the current dump is opened.
| Parameter name | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
directory | string |
| path to a directory to which the dump will be saved | stored in config file | ||||||||
skip | boolean |
| skip metadata dump default = false | |||||||||
skipData | boolean |
| skip data dump default = false | |||||||||
force | boolean |
skip failed dataset dumps (for projects with incomplete data) default | overwrites current dump default = false | |||||||||
nativeDatasetsOnly | boolean |
| import only native datasets (without origin attribute) default = false |
...
...
listDumps
List all project dumps in a local directory.
| Parameter name | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
directory | string | ignoreFailedDatasets | boolean |
| path to a parent directory of a specific project's dumps | stored in config file |
...
openDump
Open a specific dump.
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
directory | string |
| path to a parent directory of a specific project's dumps | stored in config file | ||||||
dump | string |
| open a specified dump (eg. 2019-01-01_12-00-00) if not specified, latest dump is openedskip failed dataset dumps (for projects with incomplete data) default = false |
Anchor openDumpAnchor openDumpAnchor
| Anchor | ||||
|---|---|---|---|---|
|
openDump
Open dump of project.
This command has no parameters.
Anchor truncateProjectAnchor truncateProjectAnchor
| Anchor | ||||
|---|---|---|---|---|
|
...
| Info | ||
|---|---|---|
| ||
When modifying already added (uploaded) metadata objects use |
...
| Parameter name | Type | Optionality | Description | Constraints | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
skipMetadata | boolean |
| skip metadata push default = false | |||||||||||||||||
skipData | boolean |
| skip data push default = false | |||||||||||||||||
skipValidate | boolean |
| skip the run of default = false | force | boolean |
| force metadata push when there's a share breaking change default = false | |||||||||||||
verbose | boolean |
| enables more verbose output default = false | |||||||||||||||||
multipart | boolean |
| enables multipart file upload (recommended for files larger than 2 GB) default = false | |||||||||||||||||
gzip | boolean |
| enables gzip compression default = true |
...
This command detects files which have been locally or remotely changed, are missing in dump, and also detects files which have a syntax error or constraint violations.
...