Page Comparison

...

_

Tool state	Command
Started	`login`
Started	`setup`
Connected to server	`openProject`
	`listProjects`
	`createProject`
	`editProject`
	`deleteProject`
Opened project	`importProject`
	`importDatabase`
	`loadCsv`
	`dumpCsv`
	`dumpProject`
	`listDumps`
	`openDump`
	`truncateProject`
	`validate`
Opened dump	`addMetadata`
	`createMetadata`
	`removeMetadata`
	`renameMetadata`
	`copyMetadata`
	`pushProject`
	`status`
	`applyDiff`
	`diff`

...

Parameter name Type Optionality Description Constraints

server

string

Status

colour	Green
title	OPTIONAL

specifies if the output should be more verbose

default = https://secure.clevermaps.io

project

string

Status

colour	Yellow
title	VARIES

id of the project to import

either either project or dump must be specified

dump

string

Status

colour	Yellow
title	VARIES

id of the dump to import

either either project or dump must be specified

prefix

string

Status

colour	Green
title	OPTIONAL

specify a prefix for the metadata objects and data files

execution

enum

string

Status

colour	Green
title	OPTIONAL

load and dump request execution type

default = async

[sync, async]

specify a prefix for the metadata objects and data files

force

-

Status

colour	Green
title	OPTIONAL

force the import even if there are model violations in the source project

dashboards

-

Status

colour	Green
title	OPTIONAL

import dashboards only

datasets

-

Status

colour	Green
title	OPTIONAL

import datasets only

indicators

-

Status

colour	Green
title	OPTIONAL

import indicators only

indicatorDrills

-

Status

colour	Green
title	OPTIONAL

import indicator drills only

markers

-

Status

colour	Green
title	OPTIONAL

import markers only

markerSelectors

-

Status

colour	Green
title	OPTIONAL

import marker selectors only

metrics

-

Status

colour	Green
title	OPTIONAL

import metrics only

projectSettings

-

Status

colour	Green
title	OPTIONAL

import project settings only

shares

-

Status

colour	Green
title	OPTIONAL

import shares only

views

-

Status

colour	Green
title	OPTIONAL

import views only

force

-

Status

colour	Green
title	OPTIONAL

ignore source project validate errors and proceed with import anyway

skip failed dataset dumps (for projects with incomplete data)

skipData

boolean

Status

colour	Green
title	OPTIONAL

skip data import

`importDatabase`

Allows you to create datasets and import data from an external database.

This command reads the database metadata from which datasets are created, then imports the data and saves them as CSV files. You can choose to import either of which with --skipMetadata and --skipData parameters. Please note that this command does not create any other metadata objects than datasets. It's also possible to import only specific tables using the --tables parameter.

Usage examples:

Code Block

theme	Midnight
title	Cascade import examples

// 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

`importDatabase`

Allows you to create datasets and import data from an external database.

This command reads the database metadata from which datasets are created, then imports the data and saves them as CSV files. You can choose to import either of which with --skipMetadata and --skipData parameters. Please note that this command does not create any other metadata objects than datasets. It's also possible to import only specific tables using the --tables parameter.

The database must be located on a running database server which is accessible under an URL. This can be on localhost, or anywhere on the internet. Valid credentials to the database are of course necessary.

...

Parameter name Type Optionality Description Constraints

engine

enum

Status

colour	Red
title	REQUIRED

name of the database engine

[postgresql]

host

string

Status

colour	Red
title	REQUIRED

database server hostname

for local databases, use localhost

port

integer

Status

colour	Red
title	REQUIRED

database server port

schema

string

Status

colour	Green
title	OPTIONAL

name of the database schema

leave out if your engine does not support schemas, or the schema is public

database

string

Status

colour	Red
title	REQUIRED

name of the database

user

string

Status

colour	Red
title	REQUIRED

user name for login to the database

password

string

Status

colour	Red
title	REQUIRED

user's password

tables

array

Status

colour	Green
title	OPTIONAL

list of tables to import

leave out if you want to import all tables from the database

example = "orders,clients,stores"

skipData

boolean

Status

colour	Green
title	OPTIONAL

skip data import

skipMetadata

boolean

Status

colour	Green
title	OPTIONAL

skip metadata import

Usage examples

...

theme	Midnight

...

:

Code Block

theme	Midnight

importDatabase --engine postgresql --host 172.16.254.1localhost --port 6543 --schema my_schema 5432 --database my_db --user postgres --password test
importDatabase --tables orders,clients,stores

`loadCsv`

Load data from a CSV file into a specified dataset.

...

engine postgresql --host 172.16.254.1 --port 6543 --schema my_schema --database my_db --user postgres --password test --tables orders,clients,stores

`loadCsv`

Load data from a CSV file into a specified dataset.

loadCsv also offers various CSV input settings. Your CSV file may contain specific features, like custom quote or separator characters. The parameters with the csv prefix allow you to configure the data load to fit these features, instead of transforming the CSV file to one specific format. Special cases include the csvNull and csvForceNull parameters.

...

path to the CSV file

Parameter name Type Optionality Description Constraints

file

string

Status

colour	Yellow
title	VARIES

path to the CSV file

one of file, s3Uri or url parameters must be specified

s3Uri

string

Status

colour	Yellow
title	VARIES

URI of an object on AWS S3 to upload (see examples below)

one of file, s3Uri or url parameters must be specified

url

string

Status

colour

Red

title
Yellow

REQUIRED

VARIES

HTTPS URL which contains a CSV file to be loaded into the dataset

one of file, s3Uri or url parameters must be specified

datasetstring

Status

colour	Red
title	REQUIRED

dataset to into which the data should be loaded
modeenum

Status


colour	Red
title	required

incremental mode appends the data to the end of the table

full mode truncates the table and loads the table anew

[incremental, full]executionenum

Status

colour	Green
title	OPTIONAL

load request execution type

default = async

[sync, async

[incremental, full]

csvHeader

boolean

Status

colour	Green
title	OPTIONAL

specifies if the CSV file to upload has a header

default = true

[true, false]

csvSeparatorchar

Status

colour	Green
title	OPTIONAL

specifies the CSV column separator character

default = ,

csvQuotechar

Status

colour	Green
title	OPTIONAL

specifies the CSV quote character

default = "

csvEscapechar

Status

colour	Green
title	OPTIONAL

specifies the CSV escape character

default = \

csvNullstring

Status

colour	Green
title	OPTIONAL

specifies the replacement of custom CSV null values
csvForceNullenum

Status

colour	Green
title	OPTIONAL

specifies which CSV columns should enforce the null replacement
verboseboolean

Status

colour	Green
title	OPTIONAL

enables more verbose outputoutput

default = false

[true, false]multipartboolean

Status

colour	Green
title	OPTIONAL

enables multipart file upload (recommended for files larger than 2 GB)

default = true

[true, false]gzipboolean

Status

colour	Green
title	OPTIONAL

enables gzip compression

default = falsetrue

[true, false]multipartboolean

Status

colour	Green
title	OPTIONAL

enables multipart file upload (recommended for files larger than 2 GB)

default = true

[true, false]gzipboolean

Status

colour	Green
title	OPTIONAL

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.

Code Block

theme	Midnight
title	Load CSV from AWS S3

loadCsv --dataset orders --mode full --s3Uri s3://my-company/data/orders.csv --verbose

Code Block

theme	Midnight
title	Load CSV from HTTPS URL

loadCsv --dataset orders --mode full --url http://www.example.com/download/orders.csv --verbose

`dumpCsv`

Dump data from a specified dataset into a CSV file.

This command also offers the synchronous/asynchronous execution type, analogously to the loadCsv command, as described above.

[sync, async]

Parameter name Type Optionality Description Constraints

file

string

Status

colour	Green
title	OPTIONAL

path to the CSV file

stored in config file

dataset

string

Status

colour	Red
title	REQUIRED

dataset whose data will be dumped

execution

enum

Status

colour	Green
title	OPTIONAL

dump request execution type

default = async


title	REQUIRED

dataset whose data will be dumped

`dumpProject`

Dump project data & metadata to a directory. If the dump if successfull, the current dump is opened.

colour

Parameter name Type Optionality Description Constraints

directory

string

Status

colour	Green
title	OPTIONAL

directory to which the dump will be saved

stored in config file

skipMetadata

-

Status

colour	Green
title	OPTIONAL

skip metadata dump

skipData

-

Status

colour	Green
title	OPTIONAL

skip data dump

execution

enum

Status

Green

title OPTIONAL

dump request execution type

default = async

[sync, async]

force

-

Status

colour	Green
title	OPTIONAL

skip failed dataset dumps (for projects with incomplete data)

...

[sync, async]

Parameter name Type Optionality Description Constraints

project

string

Status

colour	Green
title	OPTIONAL

validate any other project than the currently opened one

skipModel

string

Status

colour	Green
title	OPTIONAL

skip validations of the data model

skipData

string

Status

colour	Green
title	OPTIONAL

skip validations of the data itself

execution

enum

Status

colour	Green
title	OPTIONAL

validation request execution type

default = async

skip validations of the data itself

Opened dump

`addMetadata`

Add a metadata object to the project. The file must be located in a currently opened dump, and in the correct directory.

...

Parameter name Type Optionality Description Constraints

type

enum

Status

colour	Red
title	REQUIRED

type of the object

[dataset]

objectName

string

Status

colour	Red
title	REQUIRED

current name of the object (with or without .json extension)

subtype

enum

Status

colour	Yellow
title	VARIES

name of the object copy (with or without .json extension)

required only for dataset type

[basic, geometryPoint, geometryPolygon]

file

string

Status

colour	Yellow
title	VARIES

path to the CSV file (located either in dump, or anywhere in the file system)

required only for dataset type

primaryKey

string

Status

colour	Green
title	OPTIONAL

name of the CSV column that will be marked as primary key

if not specified, first CSV column is selected

geometry

string

Status

colour	Yellow
title	VARIES

name of the geometry key

required only for geometryPolygon subtype

csvSeparator

char

Status

colour	Green
title	OPTIONAL

specifies custom CSV column separator character

default = ,

csvQuote

char

Status

colour	Green
title	OPTIONAL

specifies custom CSV column quote character

default = "

csvEscape

char

Status

colour	Green
title	OPTIONAL

specifies custom CSV column escape character

default = \

Usage examples:

Code Block

theme	Midnight

createMetadata --type dataset --subtype basic --objectName "baskets" --file "baskets.csv" --primaryKey "basket_id"
createMetadata --type dataset --subtype geometryPoint --objectName "shops" --file "shops.csv" --primaryKey "shop_id"
createMetadata --type dataset --subtype geometryPolygon --objectName "district" --geometry "districtgeojson" --file "district.csv" --primaryKey "district_code"

...

Remove a metadata object from the project and from the dump. The file must be located in a currently opened dump, and must not be new.

...

Status

colour	Red
title	REQUIRED

...

from the dump. The file must be located in a currently opened dump, and must not be new.

Parameter name Type Optionality Description Constraints

objectName

string

Status

colour	Yellow
title	VARIES

name of the object (with or without .json extension)

one of objectName, objectId or orphanObjects parameters must be specified

objectId

string

Status

colour	Yellow
title	VARIES

id of the object

orphanObjects

boolean

Status

colour	Yellow
title	VARIES

prints a list of removeMetadata commands to delete orphan metadata objects

orphan object is an object not referenced from any of the project's views, or visible anywhere else in the app

`renameMetadata`

Rename an object in a local dump and on the server. If the object is referenced in some other objects by URI (/rest/projects/$projectId/md/{objectType}?name=), the references will be renamed as well.

...

This command basically wraps the functionality of loadCsv. It collects all modified metadata to upload, and performs asynchronous full load of CSV files.

[sync, async]

Parameter name Type Optionality Description Constraints

skipMetadata

-

Status

colour	Green
title	OPTIONAL

skip metadata push

skipData

-

Status

colour	Green
title	OPTIONAL

skip data push

skipValidate

-

Status

colour	Green
title	OPTIONAL

skip the run of validate after push

execution

enum

Status

colour	Green
title	OPTIONAL

load request execution type

default = async

force

boolean

Status

colour	Green
title	OPTIONAL

force metadata push when there's a share breaking change

verbose

boolean

Status

colour	Green
title	OPTIONAL

enables more verbose output

default = false

[true, false]

multipart

boolean

Status

colour	Green
title	OPTIONAL

enables multipart file upload (recommended for files larger than 2 GB)

default = true

[true, false]

gzip

boolean

Status

colour	Green
title	OPTIONAL

enables gzip compression

default = true

[true, false]

...

Versions Compared

Old Version 75

New Version 76

Key

`importDatabase`

Usage examples:

`importDatabase`

Usage examples

:

`loadCsv`

`loadCsv`

Usage examples:

`dumpCsv`

`dumpProject`

Opened dump

`addMetadata`

Usage examples:

`renameMetadata`