Skip to content

[DE-794] Java Driver: connection TTL #502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 22, 2024
Merged

[DE-794] Java Driver: connection TTL #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2af55f5
Java Driver: connection TTL
rashtao Mar 21, 2024
4dac9be
Partially apply to later versions, style
Simran-B Mar 22, 2024
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
14 changes: 8 additions & 6 deletions site/content/3.11/develop/drivers/java/reference-version-7/driver-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Here are examples to integrate configuration properties from different sources:
- `verifyHost(Boolean)`: enable hostname verification, (HTTP only, default: `true`)
- `chunkSize(Integer)`: VST chunk size in bytes, (default: `30000`)
- `maxConnections(Integer)`: max number of connections per host, (default: 1 VST, 1 HTTP/2, 20 HTTP/1.1)
- `connectionTtl(Long)`: max lifetime of a connection (ms), (default: no ttl)
- `connectionTtl(Long)`: time to live of an inactive connection (ms), (default: `30_000` for HTTP, no TTL for VST)
- `keepAliveInterval(Integer)`: VST keep-alive interval (s), (default: no keep-alive probes will be sent)
- `acquireHostList(Boolean)`: acquire the list of available hosts, (default: `false`)
- `acquireHostListInterval(Integer)`: acquireHostList interval (ms), (default: `3_600_000`, 1 hour)
Expand Down Expand Up @@ -132,7 +132,7 @@ ArangoDB arangoDB = new ArangoDB.Builder()
The driver keeps a pool of connections for each host, the max amount of
connections is configurable.

Connections are released after the configured connection time-to-live
Inactive connections are released after the configured connection time-to-live
(`ArangoDB.Builder.connectionTtl(Long)`) or when the driver is shut down:

```java
Expand Down Expand Up @@ -221,22 +221,24 @@ ArangoDB arangoDB = new ArangoDB.Builder()

## Connection time to live

The driver supports setting a TTL (time to life) for connections:
The driver supports setting a TTL (time to live) for connections:

```java
ArangoDB arango = new ArangoDB.Builder()
.connectionTtl(5 * 60 * 1000) // ms
.build();
```

In this example all connections will be closed/reopened after 5 minutes.
In this example, inactive connections are closed after 5 minutes.

If not set or set to `null` (default), no automatic connection closure will be performed.
The default TTL for HTTP connections is 30 seconds, while it is `null` for VST connections.

If set to `null`, no automatic connection closure is performed.

## VST Keep-Alive

The driver supports setting keep-alive interval (in seconds)
for VST connections. If set, every VST connection will perform a no-op request
for VST connections. If set, every VST connection performs a no-op request
at the specified intervals, to avoid to be closed due to inactivity by the
server (or by the external environment, e.g. firewall, intermediate routers,
operating system, ... ).
Expand Down
14 changes: 8 additions & 6 deletions site/content/3.12/develop/drivers/java/reference-version-7/driver-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Here are examples to integrate configuration properties from different sources:
- `verifyHost(Boolean)`: enable hostname verification, (HTTP only, default: `true`)
- `chunkSize(Integer)`: VST chunk size in bytes, (default: `30000`)
- `maxConnections(Integer)`: max number of connections per host, (default: 1 VST, 1 HTTP/2, 20 HTTP/1.1)
- `connectionTtl(Long)`: max lifetime of a connection (ms), (default: no ttl)
- `connectionTtl(Long)`: time to live of an inactive connection (ms), (default: `30_000` for HTTP, no TTL for VST)
- `keepAliveInterval(Integer)`: VST keep-alive interval (s), (default: no keep-alive probes will be sent)
- `acquireHostList(Boolean)`: acquire the list of available hosts, (default: `false`)
- `acquireHostListInterval(Integer)`: acquireHostList interval (ms), (default: `3_600_000`, 1 hour)
Expand Down Expand Up @@ -138,7 +138,7 @@ ArangoDB arangoDB = new ArangoDB.Builder()
The driver keeps a pool of connections for each host, the max amount of
connections is configurable.

Connections are released after the configured connection time-to-live
Inactive connections are released after the configured connection time-to-live
(`ArangoDB.Builder.connectionTtl(Long)`) or when the driver is shut down:

```java
Expand Down Expand Up @@ -213,23 +213,25 @@ ArangoDB arangoDB = new ArangoDB.Builder()

## Connection time to live

The driver supports setting a TTL (time to life) for connections:
The driver supports setting a TTL (time to live) for connections:

```java
ArangoDB arango = new ArangoDB.Builder()
.connectionTtl(5 * 60 * 1000) // ms
.build();
```

In this example all connections will be closed/reopened after 5 minutes.
In this example, inactive connections are closed after 5 minutes.

If not set or set to `null` (default), no automatic connection closure will be performed.
The default TTL for HTTP connections is 30 seconds, while it is `null` for VST connections.

If set to `null`, no automatic connection closure is performed.

## VST Keep-Alive

The driver supports setting keep-alive interval (in seconds)
for VST connections (but VST is not supported from ArangoDB v3.12.0 onward).
If set, every VST connection will perform a no-op request
If set, every VST connection performs a no-op request
at the specified intervals, to avoid to be closed due to inactivity by the
server (or by the external environment, e.g. firewall, intermediate routers,
operating system, ... ).
Expand Down
22 changes: 15 additions & 7 deletions site/content/4.0/develop/drivers/java/reference-version-7/driver-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,16 @@ Here are examples to integrate configuration properties from different sources:
- `verifyHost(Boolean)`: enable hostname verification, (HTTP only, default: `true`)
- `chunkSize(Integer)`: VST chunk size in bytes, (default: `30000`)
- `maxConnections(Integer)`: max number of connections per host, (default: 1 VST, 1 HTTP/2, 20 HTTP/1.1)
- `connectionTtl(Long)`: max lifetime of a connection (ms), (default: no ttl)
- `connectionTtl(Long)`: time to live of an inactive connection (ms), (default: `30_000` for HTTP, no TTL for VST)
- `keepAliveInterval(Integer)`: VST keep-alive interval (s), (default: no keep-alive probes will be sent)
- `acquireHostList(Boolean)`: acquire the list of available hosts, (default: `false`)
- `acquireHostListInterval(Integer)`: acquireHostList interval (ms), (default: `3_600_000`, 1 hour)
- `loadBalancingStrategy(LoadBalancingStrategy)`: load balancing strategy, possible values are: `NONE`, `ROUND_ROBIN`, `ONE_RANDOM`, (default: `NONE`)
- `responseQueueTimeSamples(Integer)`: amount of samples kept for queue time metrics, (default: `10`)
- `serde(ArangoSerde)`: serde to serialize and deserialize user-data
- `compression(Compression)`: the `content-encoding` and `accept-encoding` to use for HTTP requests, possible values are: `NONE`, `DEFLATE`, `GZIP`, (default: `NONE`)
- `compressionThreshold(Integer)`: the minimum HTTP request body size (in bytes) to trigger compression, (default: `1024`)
- `compressionLevel`: compression level between 0 and 9, (default: `6`)
- `serde(ArangoSerde)`: serde to serialize and deserialize user-data

### Config File Properties

Expand All @@ -114,6 +117,9 @@ The properties read are:
- `acquireHostListInterval`
- `loadBalancingStrategy`: `NONE`, `ROUND_ROBIN` or `ONE_RANDOM`
- `responseQueueTimeSamples`
- `compression`: `NONE`, `DEFLATE` or `GZIP`
- `compressionThreshold`
- `compressionLevel`

## SSL

Expand All @@ -132,7 +138,7 @@ ArangoDB arangoDB = new ArangoDB.Builder()
The driver keeps a pool of connections for each host, the max amount of
connections is configurable.

Connections are released after the configured connection time-to-live
Inactive connections are released after the configured connection time-to-live
(`ArangoDB.Builder.connectionTtl(Long)`) or when the driver is shut down:

```java
Expand Down Expand Up @@ -207,23 +213,25 @@ ArangoDB arangoDB = new ArangoDB.Builder()

## Connection time to live

The driver supports setting a TTL (time to life) for connections:
The driver supports setting a TTL (time to live) for connections:

```java
ArangoDB arango = new ArangoDB.Builder()
.connectionTtl(5 * 60 * 1000) // ms
.build();
```

In this example all connections will be closed/reopened after 5 minutes.
In this example, inactive connections are closed after 5 minutes.

If not set or set to `null` (default), no automatic connection closure will be performed.
The default TTL for HTTP connections is 30 seconds, while it is `null` for VST connections.

If set to `null`, no automatic connection closure is performed.

## VST Keep-Alive

The driver supports setting keep-alive interval (in seconds)
for VST connections (but VST is not supported from ArangoDB v3.12.0 onward).
If set, every VST connection will perform a no-op request
If set, every VST connection performs a no-op request
at the specified intervals, to avoid to be closed due to inactivity by the
server (or by the external environment, e.g. firewall, intermediate routers,
operating system, ... ).
Expand Down