...
_
_
Started state
login
Log in as a user with correct credentials.
| 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 | ||||||
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 |
setup
...
| 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 | ||||||
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
...
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 |
...
Opened dump
addMetadata
Add a new metadata object and upload it to the project. The file must be located in a currently opened dump, and in the correct directory.
...
| Parameter name | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
objectName | string |
| name of the object (with or without .json extension) |
| Info | ||
|---|---|---|
| ||
When modifying already added (uploaded) metadata objects use |
createMetadata
Create a new metadata object.
...