1
0
Fork 0
arangodb/Documentation/Examples/arangobench.json

843 lines
22 KiB
JSON

{
"async" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "send asynchronous requests",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"batch-size" : {
"category" : "option",
"default" : 0,
"deprecatedIn" : null,
"description" : "number of operations in one batch (0 disables batching)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "uint64"
},
"check-configuration" : {
"category" : "command",
"default" : false,
"deprecatedIn" : null,
"description" : "check the configuration and exit",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"collection" : {
"category" : "option",
"default" : "ArangoBenchmark",
"deprecatedIn" : null,
"description" : "collection name to use in tests (if they involve collections)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "string"
},
"complexity" : {
"category" : "option",
"default" : 1,
"deprecatedIn" : null,
"description" : "complexity parameter for the test (meaning depends on test case)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "uint64"
},
"concurrency" : {
"category" : "option",
"default" : 1,
"deprecatedIn" : null,
"description" : "number of parallel threads and connections",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "uint64"
},
"config" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "the configuration file or 'none'",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "string"
},
"configuration" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "the configuration file or 'none'",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "string"
},
"define" : {
"category" : "option",
"default" : [
],
"deprecatedIn" : null,
"description" : "define key=value for a @key@ entry in config file",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "string..."
},
"delay" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "use a startup delay (necessary only when run in series)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"dump-dependencies" : {
"category" : "command",
"default" : false,
"deprecatedIn" : null,
"description" : "dump dependency graph",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"dump-options" : {
"category" : "command",
"default" : true,
"deprecatedIn" : null,
"description" : "dump configuration options in JSON format",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"junit-report-file" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "filename to write junit style report to",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "string"
},
"keep-alive" : {
"category" : "option",
"default" : true,
"deprecatedIn" : null,
"description" : "use HTTP keep-alive",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"log" : {
"category" : "option",
"default" : [
"info"
],
"deprecatedIn" : [
"v3.5.0"
],
"description" : "the global or topic-specific log level",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "string..."
},
"log.color" : {
"category" : "option",
"default" : true,
"deprecatedIn" : null,
"description" : "use colors for TTY logging",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.escape" : {
"category" : "option",
"default" : true,
"deprecatedIn" : null,
"description" : "escape characters when logging",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.file" : {
"category" : "option",
"default" : "-",
"deprecatedIn" : null,
"description" : "shortcut for '--log.output file://<filename>'",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "log",
"type" : "string"
},
"log.file-group" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "group to use for new log file, user must be a member of this group",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : [
"v3.4.5",
"v3.5.0"
],
"obsolete" : false,
"requiresValue" : true,
"section" : "log",
"type" : "string"
},
"log.file-mode" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "mode to use for new log file, umask will be applied as well",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : [
"v3.4.5",
"v3.5.0"
],
"obsolete" : false,
"requiresValue" : true,
"section" : "log",
"type" : "string"
},
"log.force-direct" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "do not start a seperate thread for logging",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.foreground-tty" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "also log to tty if backgrounded",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.ids" : {
"category" : "option",
"default" : true,
"deprecatedIn" : null,
"description" : "log unique message ids",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : [
"v3.5.0"
],
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.keep-logrotate" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "keep the old log file after receiving a sighup",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.level" : {
"category" : "option",
"default" : [
"info"
],
"deprecatedIn" : null,
"description" : "the global or topic-specific log level",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "log",
"type" : "string..."
},
"log.line-number" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "append line number and file name",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.output" : {
"category" : "option",
"default" : [
],
"deprecatedIn" : null,
"description" : "log destination(s)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "log",
"type" : "string..."
},
"log.performance" : {
"category" : "option",
"default" : false,
"deprecatedIn" : [
"v3.5.0"
],
"description" : "shortcut for '--log.level performance=trace'",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.prefix" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "prefix log message with this string",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "log",
"type" : "string"
},
"log.request-parameters" : {
"category" : "option",
"default" : true,
"deprecatedIn" : null,
"description" : "include full URLs and HTTP request parameters in trace logs",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.role" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "log server role",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.shorten-filenames" : {
"category" : "option",
"default" : true,
"deprecatedIn" : null,
"description" : "shorten filenames in log output (use with --log.line-number)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.thread" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "show thread identifier in log message",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.thread-name" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "show thread name in log message",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.time-format" : {
"category" : "option",
"default" : "utc-datestring",
"deprecatedIn" : null,
"description" : "time format to use in logs",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : [
"v3.5.0"
],
"obsolete" : false,
"requiresValue" : true,
"section" : "log",
"type" : "string",
"values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-millis\""
},
"log.use-local-time" : {
"category" : "option",
"default" : false,
"deprecatedIn" : [
"v3.5.0"
],
"description" : "use local timezone instead of UTC",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"log.use-microtime" : {
"category" : "option",
"default" : false,
"deprecatedIn" : [
"v3.5.0"
],
"description" : "use microtime instead",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "log",
"type" : "boolean"
},
"number-of-shards" : {
"category" : "option",
"default" : 1,
"deprecatedIn" : null,
"description" : "number of shards of created collections (cluster only)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "uint64"
},
"progress" : {
"category" : "option",
"default" : true,
"deprecatedIn" : null,
"description" : "log intermediate progress",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"quiet" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "suppress status messages",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"random.generator" : {
"category" : "option",
"default" : 1,
"deprecatedIn" : null,
"description" : "random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "random",
"type" : "uint32",
"values" : "Possible values: 1, 2, 3, 4"
},
"replication-factor" : {
"category" : "option",
"default" : 1,
"deprecatedIn" : null,
"description" : "replication factor of created collections (cluster only)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "uint64"
},
"requests" : {
"category" : "option",
"default" : 1000,
"deprecatedIn" : null,
"description" : "total number of operations",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "uint64"
},
"runs" : {
"category" : "option",
"default" : 1,
"deprecatedIn" : null,
"description" : "run test n times (and calculate statistics based on median)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "uint64"
},
"server.authentication" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "require authentication credentials when connecting (does not affect the server-side authentication settings)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "server",
"type" : "boolean"
},
"server.connection-timeout" : {
"category" : "option",
"default" : 5,
"deprecatedIn" : null,
"description" : "connection timeout in seconds",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "server",
"type" : "double"
},
"server.database" : {
"category" : "option",
"default" : "_system",
"deprecatedIn" : null,
"description" : "database name to use when connecting",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "server",
"type" : "string"
},
"server.endpoint" : {
"category" : "option",
"default" : "http+tcp://127.0.0.1:8529",
"deprecatedIn" : null,
"description" : "endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// or vst+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp://, vst+tcp:// or unix://",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "server",
"type" : "string"
},
"server.max-packet-size" : {
"category" : "option",
"default" : 1073741824,
"deprecatedIn" : null,
"description" : "maximum packet size (in bytes) for client/server communication",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : true,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "server",
"type" : "uint64"
},
"server.password" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "password to use when connecting. If not specified and authentication is required, the user will be prompted for a password",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "server",
"type" : "string"
},
"server.request-timeout" : {
"category" : "option",
"default" : 1200,
"deprecatedIn" : null,
"description" : "request timeout in seconds",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "server",
"type" : "double"
},
"server.username" : {
"category" : "option",
"default" : "root",
"deprecatedIn" : null,
"description" : "username to use when connecting",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "server",
"type" : "string"
},
"ssl.protocol" : {
"category" : "option",
"default" : 5,
"deprecatedIn" : null,
"description" : "ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3)",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "ssl",
"type" : "uint64",
"values" : "Possible values: 1, 2, 3, 4, 5, 6"
},
"temp.path" : {
"category" : "option",
"default" : "",
"deprecatedIn" : null,
"description" : "path for temporary files",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "temp",
"type" : "string"
},
"test-case" : {
"category" : "option",
"default" : "version",
"deprecatedIn" : null,
"description" : "test case to use",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : true,
"section" : "",
"type" : "string",
"values" : "Possible values: \"aqlinsert\", \"aqltrx\", \"aqlv8\", \"collection\", \"counttrx\", \"crud\", \"crud-append\", \"crud-write-read\", \"document\", \"edge\", \"hash\", \"import-document\", \"multi-collection\", \"multitrx\", \"random-shapes\", \"shapes\", \"shapes-append\", \"skiplist\", \"stream-cursor\", \"version\""
},
"verbose" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "print out replies if the HTTP header indicates DB errors",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"version" : {
"category" : "command",
"default" : false,
"deprecatedIn" : null,
"description" : "reports the version and exits",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
},
"wait-for-sync" : {
"category" : "option",
"default" : false,
"deprecatedIn" : null,
"description" : "use waitForSync for created collections",
"dynamic" : false,
"enterpriseOnly" : false,
"hidden" : false,
"introducedIn" : null,
"obsolete" : false,
"requiresValue" : false,
"section" : "",
"type" : "boolean"
}
}