Page Comparison

Started

login

setup

Connected to server

openProject

listProjects

createProject

cloneProject

editProject

deleteProject

Opened project

importProject

importDatabase

loadCsv

dumpCsv

dumpProject

openDump

truncateProject

validate

Opened dump

addMetadata

createMetadata

removeMetadata

renameMetadata

copyMetadata

restoreMetadata

pushProject

status

fetch

applyDiff

diff

project

string

project

string

Project ID of the project from which new project will be cloned

organization

string

ID of the organization which will become the owner of the project

description

string

description of the project. A description can be formatted by markdown syntax.

title

string

title of the project, if none provided defaults to = "Clone of [projectName]"

project

string

Project ID of the project from which files will be imported

dump

boolean

import project from local dump

 project must be specified

serverSide

boolean

performs import of specified project on server

 project must be specified

cascadeFrom

string

cascade import object and all objects it references

see usage examples below

prefix

string

specify a prefix for the metadata objects and data files

dashboards

boolean

import dashboards only

dataPermissions

boolean

import data permission only

datasets

boolean

import datasets only

exports

boolean

import exports only

indicators

boolean

import indicators only

indicatorDrills

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 validate errors and proceed with import anyway

skip failed dataset dumps (for projects with incomplete data)

default = false

skipData

boolean

skip data import

default = false

file

string

path to the CSV file

 one of file, s3Uri or url parameters must be specified

s3Uri

string

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

 one of file, s3Uri or url parameters must be specified

url

string

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

 one of file, s3Uri or url parameters must be specified

dataset

string

name of dataset into which the data should be loaded

mode

enum

data load mode

incremental mode appends the data to the end of the table

full mode truncates the table and loads the table anew

[incremental, full]

csvHeader

boolean

specifies if the CSV file to upload has a header

default = true

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 = false

multipart

boolean

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

default = false

gzip

boolean

enables gzip compression

default = true

dataset

string

name of the dataset do dump

force

boolean

overwrites dumped data

directory

string

path to a directory to which the dump will be saved

stored in config file

skipMetadata

boolean

skip metadata dump

default = false

skipData

boolean

skip data dump

default = false

force

boolean

overwrites current dump

default = false

nativeDatasetsOnly

boolean

import only native datasets (without origin attribute)

default = false

ignoreFailedDatasets

boolean

skip failed dataset dumps (for projects with incomplete data)

default = false

objectName

string

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

 one of objectName, objectId or orphanObjects parameters must be specified

objectId

string

ID of the object

orphanObjects

boolean

prints a sequence 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

skipMetadata

boolean

skip metadata push

default = false

skipData

boolean

skip data push

default = false

skipValidate

boolean

skip the run of validate after push

default = false

verbose

boolean

enables more verbose output

default = false

multipart

boolean

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

default = false

gzip

boolean

enables gzip compression

default = true

objectName

string

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

force

boolean

overwrite local changes

sourceProject

string

Project ID of the source project

objectTypes

array

list of object types to be compared

example = "views,indicators,metrics"