arangodb/Documentation/Examples/arangodump.json

{
  "batch-size" : {
    "default" : 67108864,
    "description" : "maximum size for individual data batches (in bytes)",
    "hidden" : false,
    "section" : "",
    "type" : "uint64"
  },
  "check-configuration" : {
    "default" : false,
    "description" : "check the configuration and exit",
    "hidden" : true,
    "section" : "",
    "type" : "boolean"
  },
  "collection" : {
    "default" : [
    ],
    "description" : "restrict to collection name (can be specified multiple times)",
    "hidden" : false,
    "section" : "",
    "type" : "string..."
  },
  "config" : {
    "default" : "",
    "description" : "the configuration file or 'none'",
    "hidden" : true,
    "section" : "",
    "type" : "string"
  },
  "configuration" : {
    "default" : "",
    "description" : "the configuration file or 'none'",
    "hidden" : false,
    "section" : "",
    "type" : "string"
  },
  "define" : {
    "default" : [
    ],
    "description" : "define key=value for a @key@ entry in config file",
    "hidden" : true,
    "section" : "",
    "type" : "string..."
  },
  "dump-data" : {
    "default" : true,
    "description" : "dump collection data",
    "hidden" : false,
    "section" : "",
    "type" : "boolean"
  },
  "dump-dependencies" : {
    "default" : false,
    "description" : "dump dependency graph",
    "hidden" : true,
    "section" : "",
    "type" : "boolean"
  },
  "dump-options" : {
    "default" : true,
    "description" : "dump configuration options in JSON format",
    "hidden" : true,
    "section" : "",
    "type" : "boolean"
  },
  "force" : {
    "default" : false,
    "description" : "continue dumping even in the face of some server-side errors",
    "hidden" : false,
    "section" : "",
    "type" : "boolean"
  },
  "ignore-distribute-shards-like-errors" : {
    "default" : false,
    "description" : "continue dump even if sharding prototype collection is not backed up along",
    "hidden" : false,
    "section" : "",
    "type" : "boolean"
  },
  "include-system-collections" : {
    "default" : false,
    "description" : "include system collections",
    "hidden" : false,
    "section" : "",
    "type" : "boolean"
  },
  "initial-batch-size" : {
    "default" : 8388608,
    "description" : "initial size for individual data batches (in bytes)",
    "hidden" : false,
    "section" : "",
    "type" : "uint64"
  },
  "log" : {
    "default" : [
      "info"
    ],
    "description" : "the global or topic-specific log level",
    "hidden" : true,
    "section" : "",
    "type" : "string..."
  },
  "log.color" : {
    "default" : true,
    "description" : "use colors for TTY logging",
    "hidden" : false,
    "section" : "log",
    "type" : "boolean"
  },
  "log.escape" : {
    "default" : true,
    "description" : "escape characters when logging",
    "hidden" : false,
    "section" : "log",
    "type" : "boolean"
  },
  "log.file" : {
    "default" : "-",
    "description" : "shortcut for '--log.output file://<filename>'",
    "hidden" : true,
    "section" : "log",
    "type" : "string"
  },
  "log.force-direct" : {
    "default" : false,
    "description" : "do not start a seperate thread for logging",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.foreground-tty" : {
    "default" : false,
    "description" : "also log to tty if backgrounded",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.keep-logrotate" : {
    "default" : false,
    "description" : "keep the old log file after receiving a sighup",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.level" : {
    "default" : [
      "info"
    ],
    "description" : "the global or topic-specific log level",
    "hidden" : false,
    "section" : "log",
    "type" : "string..."
  },
  "log.line-number" : {
    "default" : false,
    "description" : "append line number and file name",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.output" : {
    "default" : [
    ],
    "description" : "log destination(s)",
    "hidden" : false,
    "section" : "log",
    "type" : "string..."
  },
  "log.performance" : {
    "default" : false,
    "description" : "shortcut for '--log.level performance=trace'",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.prefix" : {
    "default" : "",
    "description" : "prefix log message with this string",
    "hidden" : true,
    "section" : "log",
    "type" : "string"
  },
  "log.role" : {
    "default" : false,
    "description" : "log server role",
    "hidden" : false,
    "section" : "log",
    "type" : "boolean"
  },
  "log.shorten-filenames" : {
    "default" : true,
    "description" : "shorten filenames in log output (use with --log.line-number)",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.thread" : {
    "default" : false,
    "description" : "show thread identifier in log message",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.thread-name" : {
    "default" : false,
    "description" : "show thread name in log message",
    "hidden" : true,
    "section" : "log",
    "type" : "boolean"
  },
  "log.use-local-time" : {
    "default" : false,
    "description" : "use local timezone instead of UTC",
    "hidden" : false,
    "section" : "log",
    "type" : "boolean"
  },
  "log.use-microtime" : {
    "default" : false,
    "description" : "use microtime instead",
    "hidden" : false,
    "section" : "log",
    "type" : "boolean"
  },
  "output-directory" : {
    "default" : "/home/willi/src/devel3/dump",
    "description" : "output directory",
    "hidden" : false,
    "section" : "",
    "type" : "string"
  },
  "overwrite" : {
    "default" : true,
    "description" : "overwrite data in output directory",
    "hidden" : false,
    "section" : "",
    "type" : "boolean"
  },
  "progress" : {
    "default" : true,
    "description" : "show progress",
    "hidden" : false,
    "section" : "",
    "type" : "boolean"
  },
  "random.generator" : {
    "default" : 1,
    "description" : "random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only)",
    "hidden" : true,
    "section" : "random",
    "type" : "uint32",
    "values" : "Possible values: 1, 2, 3, 4"
  },
  "server.authentication" : {
    "default" : true,
    "description" : "require authentication credentials when connecting (does not affect the server-side authentication settings)",
    "hidden" : false,
    "section" : "server",
    "type" : "boolean"
  },
  "server.connection-timeout" : {
    "default" : 5,
    "description" : "connection timeout in seconds",
    "hidden" : false,
    "section" : "server",
    "type" : "double"
  },
  "server.database" : {
    "default" : "_system",
    "description" : "database name to use when connecting",
    "hidden" : false,
    "section" : "server",
    "type" : "string"
  },
  "server.endpoint" : {
    "default" : "tcp://127.0.0.1:8529",
    "description" : "endpoint to connect to, use 'none' to start without a server",
    "hidden" : false,
    "section" : "server",
    "type" : "string"
  },
  "server.max-packet-size" : {
    "default" : 134217728,
    "description" : "maximum packet size (in bytes) for client/server communication",
    "hidden" : true,
    "section" : "server",
    "type" : "uint64"
  },
  "server.password" : {
    "default" : "",
    "description" : "password to use when connecting. If not specified and authentication is required, the user will be prompted for a password",
    "hidden" : false,
    "section" : "server",
    "type" : "string"
  },
  "server.request-timeout" : {
    "default" : 1200,
    "description" : "request timeout in seconds",
    "hidden" : false,
    "section" : "server",
    "type" : "double"
  },
  "server.username" : {
    "default" : "root",
    "description" : "username to use when connecting",
    "hidden" : false,
    "section" : "server",
    "type" : "string"
  },
  "ssl.protocol" : {
    "default" : 5,
    "description" : "ssl protocol (1 = SSLv2, 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSV1.2)",
    "hidden" : false,
    "section" : "ssl",
    "type" : "uint64",
    "values" : "Possible values: 1, 2, 3, 4, 5"
  },
  "threads" : {
    "default" : 2,
    "description" : "maximum number of collections to process in parallel",
    "hidden" : false,
    "section" : "",
    "type" : "uint32"
  },
  "tick-end" : {
    "default" : 0,
    "description" : "last tick to be included in data dump",
    "hidden" : false,
    "section" : "",
    "type" : "uint64"
  },
  "tick-start" : {
    "default" : 0,
    "description" : "only include data after this tick",
    "hidden" : false,
    "section" : "",
    "type" : "uint64"
  },
  "version" : {
    "default" : false,
    "description" : "reports the version and exits",
    "hidden" : false,
    "section" : "",
    "type" : "boolean"
  }
}