...
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 dump, or opened an existing one
_create
Tool state | Command |
---|---|
_
Started state
Anchor | ||||
---|---|---|---|---|
|
...
Parameter name | Type | Optionality | Description | Constraints | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| string |
| Code Block | Project ID of projectto be opened |
Anchor | ||||
---|---|---|---|---|
|
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| Project ID of the project from which new project will be cloned | |||||||
| string |
| ID of the organization which will become the owner of the project | |||||||
| string |
| description of the project. A description can be formatted by markdown syntax. | |||||||
| string |
| title of the project, if none provided defaults to = "Clone of [projectName]" |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| Project ID of the project from which files will be imported | |||||||
| boolean |
| import project from local dump | |||||||
| boolean |
| performs import of specified project on server | |||||||
| string |
| cascade import object and all objects it references see usage examples below | |||||||
| string |
| specify a prefix for the metadata objects and data files | |||||||
| boolean |
| import dashboards only | |||||||
| boolean |
| import data permission only | |||||||
| boolean |
| import datasets only | |||||||
| boolean |
| import exports only | |||||||
| boolean |
| import indicators only code | |||||||
| boolean |
| import indicator drills only | |||||||
| boolean |
| import markers only | |||||||
| boolean |
| import marker selectors only | |||||||
| boolean |
| import metrics only | |||||||
| boolean |
| import project settings only | |||||||
| boolean |
| import shares only | |||||||
| boolean |
| import views only | |||||||
| boolean |
| ignore source project skip failed dataset dumps (for projects with incomplete data) default = false | |||||||
| boolean |
| skip data import default = false |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| path to the CSV file one of | |||||||
| string |
| URI of an object on AWS S3 to upload (see examples below) one of | |||||||
| string |
| HTTPS URL which contains a CSV file to be loaded into the dataset one of | |||||||
| string |
| name of dataset into which the data should be loaded | |||||||
| enum |
| data load mode
|
| ||||||
| boolean |
| specifies if the CSV file to upload has a header default = | |||||||
| char |
| specifies the CSV column separator character default = | |||||||
| char |
| specifies the CSV quote character default = | |||||||
| char |
| specifies the CSV escape character default = | |||||||
| string |
| specifies the replacement of custom CSV null values | |||||||
| enum |
| specifies which CSV columns should enforce the null replacement | |||||||
| boolean |
| enables more verbose output default = | |||||||
| boolean |
| enables multipart file upload (recommended for files larger than 2 GB) default = false | |||||||
| boolean |
| enables gzip compression default = true |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| name of the dataset do dump | |||||||
| boolean |
| overwrites dumped data |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| path to a directory to which the dump will be saved | stored in config file | ||||||
| boolean |
| skip metadata dump default = false | |||||||
| boolean |
| skip data dump default = false | |||||||
| boolean |
| overwrites current dump default = false | |||||||
| boolean |
| import only native datasets (without origin attribute) default = false | |||||||
| boolean |
| skip failed dataset dumps (for projects with incomplete data) default = false |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| name of the object (with or without .json extension) |
Info |
---|
Updating existing metadata objectsWhen modifying already added (uploaded) metadata objects use pushProject command for uploading modified objects to the project. |
Anchor | ||||
---|---|---|---|---|
|
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| name of the object (with or without .json extension) one of | |||||||
| string |
| ID of the object | |||||||
| boolean |
| prints a sequence of orphan object is an object not referenced from any of the project's views, or visible anywhere else in the app |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| boolean |
| skip metadata push default = false | |||||||
| boolean |
| skip data push default = false | |||||||
| boolean |
| skip the run of default = false | |||||||
| boolean |
| enables more verbose output default = false | |||||||
| boolean |
| enables multipart file upload (recommended for files larger than 2 GB) default = false | |||||||
| boolean |
| enables gzip compression default = true |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| name of the object to fetch (with or without .json extension) | |||||||
| boolean |
| overwrite local changes |
...
Parameter name | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| Project ID of the source project | |||||||
| array |
| list of object types to be compared example = |
...