Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
addMetadataAnchor
addMetadataAnchor

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.

...

Anchor
createMetadataAnchor
createMetadataAnchor

createMetadata

Create a new metadata object.

(info) At this moment, only dataset type is supported. Datasets are generated from a provided CSV file.

Parameter nameTypeOptionalityDescriptionConstraints
typeenum
Status
colourRed
titleREQUIRED
type of the object to create

[dataset]

objectNamestring
Status
colourRed
titleREQUIRED
current name of the object (with or without .json extension)to create
subtypeenum
Status
colourYellow
titleVARIES

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

required only for dataset type

[basic, geometryPoint, geometryPolygon]
filestring
Status
colourYellow
titleVARIES

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

required only for dataset type


primaryKeystring
Status
colourGreenYellow
titleOPTIONALVARIES

name of the CSV column that will be marked as primary keyif not specified, first CSV column is selected

required only for dataset type


geometrystring
Status
colourYellow
titleVARIES

name of the geometry key

required only for geometryPolygon subtype


csvSeparatorchar
Status
colourGreen
titleOPTIONAL

specifies custom the CSV column separator character

default = ,


csvQuotechar
Status
colourGreen
titleOPTIONAL

specifies custom the CSV column quote character

default = "


csvEscapechar
Status
colourGreen
titleOPTIONAL

specifies custom CSV column escape character

default = \


...

Parameter nameTypeOptionalityDescriptionConstraints
objectNamestring
Status
colourYellow
titleVARIES

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

(info) one of objectName, objectId or orphanObjects parameters must be specified


objectIdstring
Status
colourYellow
titleVARIES
id ID of the object
orphanObjectsboolean
Status
colourYellow
titleVARIES

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


Anchor
renameMetadataAnchor
renameMetadataAnchor

renameMetadata

Rename an a metadata 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.

...

Parameter nameTypeOptionalityDescriptionConstraints
skipMetadataboolean
Status
colourGreen
titleOPTIONAL

skip metadata push

default = false


skipDataboolean
Status
colourGreen
titleOPTIONAL

skip data push

default = false


skipValidateboolean
Status
colourGreen
titleOPTIONAL

skip the run of validate after push

default = false


forceboolean
Status
colourGreen
titleOPTIONAL

force metadata push when there's a share breaking change

default = false


verbose


boolean
Status
colourGreen
titleOPTIONAL

enables more verbose output

default = false


multipartboolean
Status
colourGreen
titleOPTIONAL

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

default = truefalse


gzipboolean
Status
colourGreen
titleOPTIONAL

enables gzip compression

default = true


...

This command detects files which have been locally or remotely changed, and also detects files which have a syntax error or constraint violations.

When --remote is used command only displays metadata content on the server.

Parameter nameTypeOptionalityDescriptionConstraints
remote-boolean
Status
colourGreen
titleOPTIONAL

list metadata

contents

content on the server

default = false


Anchor
applyDiffAnchor
applyDiffAnchor

...

Parameter nameTypeOptionalityDescriptionConstraints
sourceProjectstring
Status
colourRed
titlerequired
id Project ID of the source project
objectTypesstringarray
Status
colourGreen
titleOPTIONAL

list of object types to be compared

example = "views,indicators,metrics"


...