...
_create
_
Started state
| Anchor |
|---|
| myloginAnchor |
|---|
| myloginAnchor |
|---|
|
...
| Parameter name | Type | Optionality | Description | Constraints |
|---|
email
| 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 = https://secure.clevermaps.io | 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 (loadCsv --s3Uri) | stored in config file |
s3SecretAccessKey | string | | AWS S3 Secret Access Key required for S3 upload (loadCsv --s3Uri) | stored in config file |
...
Connected to server
...
Please note that your AWS S3 Access Key ID and Secret Access Key must be set using setup command first.
| Code Block |
|---|
| theme | Midnight |
|---|
| title | Load CSV from AWS S3 |
|---|
|
loadCsv --dataset orders --mode full --s3Uri s3://my-company/data/orders.csv --verbose |
...
Validate the project's data model and data integrity. An update of dataset definition (metadata) should be followed by data update. Typically, it helps to make a full load of data for updated dataset (see loadCsv command). During the full load an original DWH table is dropped and data is loaded into a new table which is created regards the updated dataset definition.
...
| Info |
|---|
| title | Updating existing metadata objects |
|---|
|
When modifying already added (uploaded) metadata objects use pushProject command for uploading modified objects to the project. |
...
| Parameter name | Type | Optionality | Description | Constraints |
|---|
remote | boolean | | list metadata content on the server default = false |
|
fetch
Fetch objects that have changed on server and update local objects.
Server objects are compared with local objects and following action can happen:
- object changed on server and not locally modified is dumped
- object changed on server and locally modified creates conflict (see conflict)
- object deleted on server and not locally modified is deleted
- object deleted on server and locally modified is unwrapped and can be added again with
addMetadata
| Parameter name | Type | Optionality | Description | Constraints |
|---|
objectName | string | | name of the object to fetch (with or without .json extension) |
|
force | boolean | | overwrite local changes |
|
Conflict
When object is modified on server and also locally conflict occurs. Conflicts are written to metadata objects and have to be resolved.
Conflict example:
| Code Block |
|---|
|
...
"visualizations": {
<<<<<<< local
"grid": false
=============
"grid": true
>>>>>>> server
},
... |
| Anchor |
|---|
| applyDiffAnchor |
|---|
| applyDiffAnchor |
|---|
|
applyDiff
Create and apply metadata diff between two live projects.
...