Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 4.4 KB

influxdb.md

File metadata and controls

109 lines (77 loc) · 4.4 KB
Raw

InfluxDB Module

Testcontainers module for InfluxData InfluxDB.

Important note

There are breaking changes in InfluxDB 2.x. For more information refer to the main documentation. You can find more information about the official InfluxDB image on Docker Hub.

InfluxDB 2.x usage example

Running a InfluxDBContainer as a stand-in for InfluxDB in a test:

Create an InfluxDB container inside_block:constructorWithDefaultVariables

The InfluxDB instance will be setup with the following data:

Property Default Value
username test-user
password test-password
organization test-org
bucket test-bucket
retention 0 (infinite)
adminToken -

For more details about the InfluxDB setup, please visit the official InfluxDB documentation.

It is possible to overwrite the default property values. Create a container with InfluxDB admin token:

Create an InfluxDB container with admin token inside_block:constructorWithAdminToken

Or create a container with custom username, password, bucket, organization, and retention time:

Create an InfluxDB container with custom settings inside_block:constructorWithCustomVariables

The following code snippet shows how you can create an InfluxDB Java client:

Create an InfluxDB Java client inside_block:createInfluxDBClient

!!! hint You can find the latest documentation about the InfluxDB 2.x Java client here.

InfluxDB 1.x usage example

Running a InfluxDBContainer as a stand-in for InfluxDB in a test with default env variables:

Create an InfluxDB container inside_block:constructorWithDefaultVariables

The InfluxDB instance will be setup with the following data:

Property Default Value
username test-user
password test-password
authEnabled true
admin admin
adminPassword password
database -

It is possible to overwrite the default values. For instance, creating an InfluxDB container with a custom username, password, and database name:

Create an InfluxDB container with custom settings inside_block:constructorWithUserPassword

In the following example you will find a snippet to create an InfluxDB client using the official Java client:

Create an InfluxDB Java client inside_block:createInfluxDBClient

!!! hint You can find the latest documentation about the InfluxDB 1.x Java client here.

Adding this module to your project dependencies

Add the following dependency to your pom.xml/build.gradle file:

=== "Gradle"

testImplementation "org.testcontainers:influxdb:{{latest_version}}"

=== "Maven"

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>influxdb</artifactId>
    <version>{{latest_version}}</version>
    <scope>test</scope>
</dependency>

!!! hint Adding this Testcontainers library JAR will not automatically add a database driver JAR to your project. You should ensure that your project also has a suitable database driver as a dependency.