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, which contains detailed metadata about the object itself.
In addition, dump metadata (or "metadata about the metadata") file is created. It is used to store 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.
| Note |
|---|
These directory structures and files are generated by Shell and should not be modified. |
Dump structure
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 |
|---|
/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 |
|---|
./
../
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
...
| Status | ||||
|---|---|---|---|---|
|
...
URL link uniquely identifying the object
...
dumpTime
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
timestamp of when the object was dumped
...
version
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
version of the object
starts at 1, is incremented everytime the object is pushed to the project
...
content
...
object
...
| Status | ||||
|---|---|---|---|---|
|
...
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
...
server
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
server, from where the project was dumped
...
projectId
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
ID of the project
...
projectTitle
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
human-readable title of the project
...
dumpTime
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
timestamp of when the project was last dumped or fetched
...
user
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
email of the user who performed the dump
...
metadataContent
...
object
...
| Status | ||||
|---|---|---|---|---|
|
...
list of metadata object files contained in the dump, with their respective md5 hashes (used for local file modification detection)
...
dataContent
...
object
...
| Status | ||||
|---|---|---|---|---|
|
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
The content you are trying to reach has been moved here: https://docs.clevermaps.io/docs/dump-structureWe are proud to announce that we have launched a new documentation. Please update your saved links and bookmarks to follow a new address docs.clevermaps.io. |