Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Added documentation for APM-173 #777

Merged
merged 9 commits into from
Oct 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion 3.9/programs-arangobench.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,17 @@ The most important general _arangobench_ options are:

- `--server.endpoint`: the server endpoint to connect to. This can be a remote
server or a server running on the same host. The endpoint also specifies
whether encryption at transit (TLS) should be used.
whether encryption at transit (TLS) should be used. Multiple endpoints can be
provided. Example:

```
arangobench \
--server.endpoint tcp://[::1]::8529 \
--server.endpoint tcp://[::1]::8530 \
--server.endpoint tcp://[::1]::8531 \
...
```

- `--server.username` and `--server.password`: these can be used to authenticate
with an existing ArangoDB installation.
- `--test-case`: selects the test case to be executed by _arangobench_. A list
Expand Down
27 changes: 25 additions & 2 deletions 3.9/programs-arangodump-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,41 @@ Note that the specified user must have access to the databases.
Here's an example of dumping data from a non-standard endpoint, using a dedicated
[database name](appendix-glossary.html#database-name):

arangodump --server.endpoint tcp://192.168.173.13:8531 --server.username backup --server.database mydb --output-directory "dump"
```
arangodump \
--server.endpoint tcp://192.168.173.13:8531 \
--server.username backup \
--server.database mydb \
--output-directory "dump"
```

In contrast to the above call `--server.database` must not be specified when dumping
all databases using `--all-databases true`:

arangodump --server.endpoint tcp://192.168.173.13:8531 --server.username backup --all-databases true --output-directory "dump-multiple"
```
arangodump \
--server.endpoint tcp://192.168.173.13:8531 \
--server.username backup \
--all-databases true \
--output-directory "dump-multiple"
```

When finished, _arangodump_ will print out a summary line with some aggregate
statistics about what it did, e.g.:

Processed 43 collection(s), wrote 408173500 byte(s) into datafiles, sent 88 batch(es)

Also, more than one endpoint can be provided, such as:

```
arangodump \
--server.endpoint tcp://192.168.173.13:8531 \
--server.endpoint tcp://192.168.173.13:8532 \
--server.username backup \
--all-databases true \
--output-directory "dump-multiple"
```

By default, _arangodump_ will dump both structural information and documents from all
non-system collections. To adjust this, there are the following command-line
arguments:
Expand Down
19 changes: 18 additions & 1 deletion 3.9/programs-arangorestore-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,24 @@ The `--force-same-database` option is set to `false` by default to ensure backwa
Here's an example of reloading data to a non-standard endpoint, using a dedicated
[database name](appendix-glossary.html#database-name):

arangorestore --server.endpoint tcp://192.168.173.13:8531 --server.username backup --server.database mydb --input-directory "dump"
```
arangorestore \
--server.endpoint tcp://192.168.173.13:8531 \
--server.username backup \
--server.database mydb \
--input-directory "dump" \
```

Also, more than one endpoint can be provided, such as:

```
arangorestore \
--server.endpoint tcp://192.168.173.13:8531 \
--server.endpoint tcp://192.168.173.13:8532 \
--server.username backup \
--server.database mydb \
--input-directory "dump"
```

To create the target database when restoring, use a command like this:

Expand Down
52 changes: 52 additions & 0 deletions 3.9/release-notes-new-features39.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,58 @@ target real world use cases but were rather writing for some internal testing.
The deprecated test cases will be removed in a future version to clear up
the list of test cases.

_arangobench_ now supports multiple Coordinators. The flag `--server.endpoint`
can be specified multiple times, as in the example below:

```
arangobench \
--server.endpoint tcp://[::1]::8529 \
--server.endpoint tcp://[::1]::8530 \
--server.endpoint tcp://[::1]::8531 \
...
```

This does not compromise the use of the other client tools, that preserve
the behavior of having one Coordinator and one endpoint.

Also see [_arangobench_ Options](programs-arangobench.html#general-configuration)

### arangodump

_arangodump_ now supports multiple Coordinators. The flag `--server.endpoint`
can be used multiple times, as in the example below:

```
arangodump \
--server.endpoint tcp://[::1]::8529 \
--server.endpoint tcp://[::1]::8530 \
--server.endpoint tcp://[::1]::8531 \
...
```

This does not compromise the use of the other client tools that preserve
the behavior of having one Coordinator and one endpoint.

Also see [_arangodump_ examples](programs-arangodump-examples.html)

### arangorestore

_arangorestore_ now supports multiple Coordinators. The flag `--server.endpoint`
can be used multiple times, as in the example below:

```
arangorestore \
--server.endpoint tcp://[::1]::8529 \
--server.endpoint tcp://[::1]::8530 \
--server.endpoint tcp://[::1]::8531 \
...
```

This does not compromise the use of the other client tools that preserve
the behavior of having one Coordinator and one endpoint.

Also see [_arangorestore_ examples](programs-arangorestore-examples.html)

### arangovpack

The _arangovpack_ utility supports more input and output formats (JSON and
Expand Down