...
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
verbose | boolean |
| specifies if the output should be more detailedverbose | |||||||
share | enum |
| list projects by share type | [demo, dimension, template] | ||||||
organization | string |
| list projects by organization (organization ID) |
...
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
server | string |
| Hostname of the server from which the project will be imported default = | |||||||
project | string |
| Project ID of the project from which files will be imported
| |||||||
dump | string |
| ID of a project dump to be imported
| |||||||
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 | |||||||
| boolean |
| import datasets 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 |
either Usage examples:
| Code Block | ||||
|---|---|---|---|---|
| ||||
// import all objects referenced from catchment_area_view including datasets & data importProject --project djrt22megphul1a5 --server --cascadeFrom catchment_area_view // import all objects referenced from catchment_area_view except including datasets & data importProject --project djrt22megphul1a5 --server --cascadeFrom catchment_area_view --dashboards --exports --indicatorDrills --indicators --markerSelectors --markers --metrics --views // import all objects referenced from catchment_area_dashboard importProject --project djrt22megphul1a5 --server --cascadeFrom catchment_area_dashboard // import all objects (datasets) referenced from baskets dataset - data model subset importProject --project djrt22megphul1a5 --server --force --cascadeFrom baskets |
...
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
engine | enum |
| name of the database engine | [postgresql] | ||||||
host | string |
| database server hostname for local databases, use | |||||||
port | integer |
| database server port | |||||||
schema | string |
| name of the database schema leave out if your engine does not support schemas, or the schema is | |||||||
database | string |
| name of the database | |||||||
user | string |
| user name for login to the database | |||||||
password | string |
| user's password | |||||||
tables | array |
| list of tables to import leave out if you want to import all tables from the database example = | |||||||
skipData | boolean |
| skip data import default = false | |||||||
skipMetadata | boolean |
| skip metadata import default = false |
Usage examples:
| Code Block | ||
|---|---|---|
| ||
importDatabase --engine postgresql --host localhost --port 5432 --database my_db --user postgres --password test importDatabase --engine postgresql --host 172.16.254.1 --port 6543 --schema my_schema --database my_db --user postgres --password test --tables orders,clients,stores |
...
| Parameter name | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
file | string |
| path to the CSV file
| |||||||||
s3Uri | string |
| URI of an object on AWS S3 to upload (see examples below)
| |||||||||
url | string |
| HTTPS URL which contains a CSV file to be loaded into the dataset
| |||||||||
dataset | string |
| name of dataset into which the data should be loaded | |||||||||
mode | enum |
| data load mode
| [incremental, full] | ||||||||
| boolean |
| specifies if the CSV file to upload has a header default =
| |||||||||
csvSeparator | char |
| specifies the CSV column separator character default = | |||||||||
csvQuote | char |
| specifies the CSV quote character default = | |||||||||
csvEscape | char |
| specifies the CSV escape character default = | |||||||||
csvNull | string |
| specifies the replacement of custom CSV null values | |||||||||
csvForceNull | enum |
| specifies which CSV columns should enforce the null replacement | |||||||||
verbose | boolean |
| enables more verbose output default = | [true, false] | ||||||||
multipart | boolean |
| enables multipart file upload (recommended for files larger than 2 GB) default = true | [true, false | ]||||||||
gzip | boolean |
| enables gzip compression default = true | [true | , false]
Usage examples:
Please note that your AWS S3 Access Key ID and Secret Access Key must be set using setup command first.
...
Dump data from a specified dataset into a CSV file. Creates new dump with dumped data.
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
filedirectory | string |
| path to the CSV filea directory where project's dump will be created | stored in config file | ||||||
dataset | string |
| dataset whose data will be dumpedname of the dataset do dump |
Anchor dumpProjectAnchor dumpProjectAnchor
| Anchor | ||||
|---|---|---|---|---|
|
dumpProject
Dump project data & and metadata to a directory. If the dump if 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 = false | |||||||
nativeDatasetsOnly | boolean |
| import only native datasets (without origin attribute) default = false |
Anchor listDumpsAnchor listDumpsAnchor
| Anchor | ||||
|---|---|---|---|---|
|
listDumps
List all local project dumps in a local directory.
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
directory | string |
| path to a parent directory of a specific project's dumps | stored in config file |
...
| 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 specific dumpspecified dump (eg. 2019-01-01_12-00-00) if not specified, latest dump is opened |
...
Validate the project's data model and data integrity.
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
project | string |
| validate any other project than the currently opened one project ID of other project which will be validated | |||||||
skipModel | string |
| skip validations of the data model default = false | |||||||
skipData | string |
| skip validations of the data itself default = false |
Opened dump
Anchor addMetadataAnchor addMetadataAnchor
| Anchor | ||||
|---|---|---|---|---|
|
...
| Parameter name | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
skipMetadata | boolean |
| skip metadata push | |||||||||
skipData | boolean |
| skip data push | |||||||||
skipValidate | boolean |
| skip the run of validate after push | |||||||||
force | boolean |
| force metadata push when there's a share breaking change | |||||||||
verbose | boolean |
| enables more verbose output default = | [true,
| ]||||||||
multipart | boolean |
| enables multipart file upload (recommended for files larger than 2 GB) default = true | |||||||||
gzip | boolean |
| enables gzip compression default = true [true , false] |
Anchor statusAnchor statusAnchor
| Anchor | ||||
|---|---|---|---|---|
|
...