Dump structure reference

Every time you make a dump using CleverMaps Shell, a dump directory structure is created.

All dumped metadata objects are saved to the file system in a wrapper containing detailed metadata about the object itself.

In addition, a dump metadata (or "metadata about the metadata") file is created. It stores useful information, like dump time, or the original project ID. It is also used to store the dump content and to track local file changes.

These directory structures and files are generated by Shell and should not be modified.

Dump structure

The dump directory structure is created either in:

the default directory you specified in the config file (recommended)
working directory, e.g. the directory you run Shell from

Let's assume that, in this case, /var/local/projects is our default directory. The dump structure is as follows:

CODE

/var/local/projects/{projectId}/

So, in practice:

CODE

/var/local/projects/q1zdp9d0ao78rdv5/

If we list the contents of this dump directory, we see data and metadata directories, and the dumpMetadata.json file (described below).

CODE

./
../
data/
dumpMetadata.json
metadata/
metadata/dashboards/
metadata/dataPermissions/
metadata/datasets/
metadata/exports/
metadata/indicatorDrills/
metadata/indicators/
metadata/markers/
metadata/markerSelectors/
metadata/metrics/
metadata/projectSettings/
metadata/views/

The data folder contains .csv files. The metadata folder contains subdirectories of the metadata object types. Each dumped file is wrapped in a dump object wrapper.

Dump object wrapper

Simple wrapper, which contains metadata about the dumped object.

Key	Type	Optionality	Description
`url`	string	GENERATED	URL link uniquely identifying the object
`dumpTime`	string	GENERATED	timestamp of when the object was dumped
`version`	string	GENERATED	version of the object starts at 1, is incremented everytime the object is pushed to the project
`content`	object	GENERATED	the object itself may contain valid content of one of metadata object types

Dump metadata file

The dumpMetadata.json file is located in the dump directory, one level above the data and metadata directories. It contains metadata about the dump itself, and a list of its contents.

Key	Type	Optionality	Description
`server`	string	GENERATED	server, from where the project was dumped
`projectId`	string	GENERATED	ID of the project
`projectTitle`	string	GENERATED	human-readable title of the project
`dumpTime`	string	GENERATED	timestamp of when the project was last dumped or fetched
`user`	string	GENERATED	email of the user who performed the dump
`metadataContent`	object	OPTIONAL	list of metadata object files contained in the dump, with their respective md5 hashes (used for local file modification detection)
`dataContent`	object	OPTIONAL	like `metadataContent`, but with .csv files