mirror of https://gitee.com/bigwinds/arangodb
54 lines
2.5 KiB
Plaintext
54 lines
2.5 KiB
Plaintext
COMMAND SECTION "DATE" "" "ArangoDB"
|
|
NAME
|
|
COMMAND - the ArangoDB benchmark and test tool
|
|
SYNOPSIS
|
|
COMMAND [options]
|
|
DESCRIPTION
|
|
The arangob binary can be used to issue test requests to the
|
|
ArangoDB database. It can be used for benchmarks or server function
|
|
testing. It supports parallel querying and batch requests.
|
|
arangob currently only supports a few common test cases out of the box.
|
|
More test cases might be added later.
|
|
OPTIONS
|
|
For a complete list of options, please refer to the ArangoDB
|
|
online manual, available at http://www.arangodb.org/
|
|
|
|
The most important startup options are:
|
|
|
|
OPTION "--configuration <string>"
|
|
read configuration from file <string> ENDOPTION
|
|
OPTION "--batch-size <int32>"
|
|
number of operations to send per batch (use 0 to disable batching)
|
|
OPTION "--collection <string>"
|
|
name of collection to use in test (only relevant for tests that invoke collections)
|
|
OPTION "--concurrency <int32>"
|
|
number of parallel threads that will issue requests (default is 1 thread)
|
|
OPTION "--requests <int32>"
|
|
total number of requests to perform
|
|
OPTION "--test-case <string>"
|
|
name of test case to perform (possible values: "version" and "document")
|
|
OPTION "--complexity <int32>"
|
|
complexity value for test case (meaning depends on test case)
|
|
OPTION "--server.endpoint <string>"
|
|
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
|
|
OPTION "--server.database <string>"
|
|
database name to use when connection (default: "_system") ENDOPTION
|
|
OPTION "--server.username <string>"
|
|
username to use when connecting (default "root") ENDOPTION
|
|
OPTION "--server.password <string>"
|
|
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
|
|
OPTION "--server.disable-authentication <boolean>"
|
|
disable the password prompt and authentication when connecting to the server ENDOPTION
|
|
EXAMPLES
|
|
EXAMPLE COMMAND
|
|
starts COMMAND with the default user and server endpoint ENDEXAMPLE
|
|
EXAMPLE COMMAND --test-case version --requests 1000 --concurrency 1
|
|
runs the 'version' test case with 1000 requests, without concurrency ENDEXAMPLE
|
|
EXAMPLE COMMAND --test-case document --requests 1000 --concurrency 2
|
|
runs the 'document' test case with 2000 requests, with concurrency 2 ENDEXAMPLE
|
|
EXAMPLE COMMAND --test-case document --requests 1000 --concurrency 2 --async true
|
|
runs the 'document' test case with 2000 requests, with concurrency 2, with async requests ENDEXAMPLE
|
|
EXAMPLE COMMAND --test-case document --requests 1000 --concurrency 2 --batch-size 10
|
|
runs the 'document' test case with 2000 requests, with concurrency 2, using batch requests ENDEXAMPLE
|
|
AUTHOR
|