InfluxDB 3 Connection Properties

scheme (string, enum)

Protocol to use for connecting to the InfluxDB 3 server. Choose 'http' for unencrypted or 'https' for encrypted connections.

This element must be one of the following enum values:

• http

• https

Default: "http"

Example: "https"

host (string, required)

Hostname or IP address of the InfluxDB 3 server.

Example: "influxdb3"

port (integer)

Network port on which the InfluxDB 3 server is listening.

Default: 8181

Example: 8181

token (string)

Authentication token used to access the InfluxDB 3 server.

Default: ""

Example: "an-influx-auth-token"

authScheme (string)

Token authentication scheme. Leave unset for InfluxDB Cloud access. Set to 'Bearer' for InfluxDB 3 Core/Enterprise.

Example: "Bearer"

database (string)

Name of the InfluxDB 3 database (the equivalent of a bucket in InfluxDB 2.x) used for reads and writes.

Default: "measurement_data"

precision (string, enum)

Time precision for timestamps written to InfluxDB. Options: only milliseconds (ms) is supported at the moment

This element must be one of the following enum values:

• ms

Default: "ms"

queryType (string, enum)

Default query language used for read endpoints when the endpoint does not specify one. InfluxDB 3 uses SQL natively; InfluxQL is offered for compatibility.

This element must be one of the following enum values:

• sql

• influxql

Default: "sql"

noSync (boolean)

When true the server responds before waiting for write-ahead-log persistence (faster, but without persistence confirmation)

Default: false

acceptPartial (boolean)

When true the server accepts a batch where some lines are valid and some are not.

Default: true

gzipThreshold (integer)

Write request bodies larger than this size (in bytes) are gzip-compressed before being sent.

Default: 1000

Example: 1000

writeTimeout (integer)

Maximum time (in milliseconds) to wait for a write request before timing out.

Default: 10000

Additional restrictions:

• Minimum: 1000

queryTimeout (integer)

Maximum time (in milliseconds) to wait for a query before timing out.

Default: 60000

Additional restrictions:

• Minimum: 1000

probeInterval (integer)

Interval (in milliseconds) at which the connection to InfluxDB 3 is checked for availability via the server '/ping' endpoint.

Default: 2000

Additional restrictions:

• Minimum: 1000

transportOptions (object)

Additional HTTP or HTTPS request options passed directly to the underlying Node.js client. When 'scheme' is 'http' the options are forwarded to http.request; when 'https' they are forwarded to https.request. Allows advanced configuration such as custom headers, agents, proxies, or TLS settings.

Default:

{}

batchSize (integer)

Maximum number of data points to accumulate before flushing them to InfluxDB in a single request. The buffer is also flushed when 'flushInterval' elapses, whichever comes first.

Default: 1000

Example: 1000

Additional restrictions:

• Minimum: 1

• Maximum: 10000

flushInterval (integer)

Maximum time (in milliseconds) to hold data points in the write buffer before sending them to InfluxDB. The buffer is also flushed when 'batchSize' is reached, whichever comes first.

Default: 3000

Example: 3000

Additional restrictions:

• Minimum: 1

connectionStrategy (object)

Configuration for retrying failed connection attempts using an exponential backoff strategy.

Properties of the connectionStrategy object:

initialDelay (integer)

Delay (in milliseconds) before the first retry attempt after a failed connection.

Default: 1000

Additional restrictions:

• Minimum: 1000

maxDelay (integer)

Maximum delay (in milliseconds) between retry attempts.

Default: 30000

incrementFactor (integer)

Multiplier applied to the previous delay to calculate the next retry delay, up to 'maxDelay'.

Default: 2

Additional restrictions:

• Minimum: 2