...
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 following:
| Code Block | ||
|---|---|---|
| ||
/var/local/projects/{projectId}/ |
So, in practice:
| Code Block | theme | Midnight
|---|
/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 Block | theme | Midnight
|---|
./ ../ 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/ |
...
Simple wrapper, which contains metadata about the dumped object.
Key | Type | Optionality | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| string |
| URL link uniquely identifying the object | ||||||
| string |
| timestamp of when the object was dumped | ||||||
| string |
| version of the object starts at 1, is incremented everytime the object is pushed to the project | ||||||
| object |
| the object itself may contain valid content of one of metadata object types |
Dump metadata file
The dumpMetadata.json file is located the dump directory, one level above the data and metadata directories. It contains metadata about the dump itself, and list of its contents.
Key | Type | Optionality | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| string |
| server, from where the project was dumped | ||||||
| string |
| ID of the project | ||||||
| string |
| human-readable title of the project | ||||||
| string |
| timestamp of when the project was last dumped or fetched | ||||||
| string |
| email of the user who performed the dump | ||||||
| object |
| list of metadata object files contained in the dump, with their respective md5 hashes (used for local file modification detection) | ||||||
| object |
| like |