Versions Compared

Key

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

Every time you make a dump using CleverMaps Shell, a dump directory structure is created. Every dump is uniquely identified by its dump ID - a time stamp of when the dump was created. Format of the dump ID is "yyyy-MM-dd_HH-mm-ss".

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

...

  1. the default directory you specified in the config file (recommended)
  2. working directory, e.g. the directory you run Shell fromthe directory you specify as a value of --directory parameter of the dumpProject command

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

Code Block
themeMidnight
/var/local/metadataprojects/{projectId}/{dumpId}/

So, in practice:

Code Block
themeMidnight
/var/local/metadataprojects/q1zdp9d0ao78rdv5/2017-08-28_20-17-51/

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

...

KeyTypeOptionalityDescription
dumpIdstring
Status
colourBlue
titlegenerated

ID of the dump

serverstring

Status
colourBlue
titlegenerated

server, from where the project was dumped

projectIdstring

Status
colourBlue
titlegenerated

ID of the project

projectTitlestring

Status
colourBlue
titlegenerated

human-readable title of the project

dumpTimestring
Status
colourBlue
titlegenerated
timestamp of when the project was last dumped or fetched
userstring
Status
colourBlue
titlegenerated
email of the user who performed the dump
metadataContentobject
Status
colourGreen
titleoptional
list of metadata object files contained in the dump, with their respective md5 hashes (used for local file modification detection)
dataContentobject
Status
colourGreen
titleoptional
like metadataContent, but with .csv files

...