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

Commit 91c5929

Browse files
authored
Java driver VST Keep-Alive configuration (#595)
1 parent 9e81e7f commit 91c5929

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

3.4/drivers/java-reference-setup.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,3 +203,23 @@ Connection TTL can be disabled setting it to `null`:
203203
```
204204

205205
The default TTL is `null` (no automatic connection closure).
206+
207+
208+
## VST Keep-Alive
209+
210+
Since version 6.8 the driver supports setting keep-alive interval (in seconds)
211+
for VST connections. If set, every VST connection will perform a no-op request
212+
at the specified intervals, to avoid to be closed due to inactivity by the
213+
server (or by the external environment, e.g. firewall, intermediate routers,
214+
operating system, ... ).
215+
216+
This option can be set using the key `arangodb.connections.keepAlive.interval`
217+
in the properties file or programmatically from the driver builder:
218+
219+
```Java
220+
ArangoDB arangoDB = new ArangoDB.Builder()
221+
.keepAliveInterval(1800) // 30 minutes
222+
.build();
223+
```
224+
225+
If not set or set to `null` (default), no keep-alive probes will be sent.

3.7/drivers/java-reference-setup.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,3 +216,23 @@ Connection TTL can be disabled setting it to `null`:
216216
```
217217

218218
The default TTL is `null` (no automatic connection closure).
219+
220+
221+
## VST Keep-Alive
222+
223+
Since version 6.8 the driver supports setting keep-alive interval (in seconds)
224+
for VST connections. If set, every VST connection will perform a no-op request
225+
at the specified intervals, to avoid to be closed due to inactivity by the
226+
server (or by the external environment, e.g. firewall, intermediate routers,
227+
operating system, ... ).
228+
229+
This option can be set using the key `arangodb.connections.keepAlive.interval`
230+
in the properties file or programmatically from the driver builder:
231+
232+
```Java
233+
ArangoDB arangoDB = new ArangoDB.Builder()
234+
.keepAliveInterval(1800) // 30 minutes
235+
.build();
236+
```
237+
238+
If not set or set to `null` (default), no keep-alive probes will be sent.

0 commit comments

Comments
 (0)