influxdb-java

influxdb-java

This is the official (and community-maintained) Java client library for InfluxDB (1.x), the open source time series database that is part of the TICK (Telegraf, InfluxDB, Chronograf, Kapacitor) stack.

For InfluxDB 3.0 users, this library is succeeded by the lightweight v3 client library.

Note: This library is for use with InfluxDB 1.x and 2.x compatibility API. For full supports of InfluxDB 2.x features, please use the influxdb-client-java client.

Adding the library to your project

The library artifact is published in Maven central, available at https://search.maven.org/artifact/org.influxdb/influxdb-java.

Release versions

Maven dependency:

  org.influxdb
  influxdb-java
  ${influxdbClient.version}

Gradle dependency:

compile group: 'org.influxdb', name: 'influxdb-java', version: "${influxdbClientVersion}"

Features

• Querying data using:
  • Influx Query Language (InfluxQL), with support for bind parameters (similar to JDBC PreparedStatement parameters);
  • it's own QueryBuilder, as you would do with e.g. EclipseLink or Hibernate;
  • Message Pack (requires InfluxDB 1.4+);
• Writing data using:
  • Data Point (an object provided by this library that represents a ... data point);
  • Your own POJO (you need to add a few Java Annotations);
  • InfluxDB line protocol (for the braves only);
  • UDP, as supported by InfluxDB;
• Support synchronous and asynchronous writes;
• Batch support configurable with jitter interval, buffer size and flush interval.

Quick start

…

Contribute

For version change history have a look at ChangeLog.

Build Requirements

• Java 1.8+
• Maven 3.5+
• Docker (for Unit testing)

Then you can build influxdb-java with all tests with:

$> export INFLUXDB_IP=127.0.0.1

$> mvn clean install

There is a shell script running InfluxDB and Maven from inside a Docker container and you can execute it by running:

$> ./compile-and-test.sh

Useful links

• Manual (main documentation);
• InfluxDB Object Mapper;
• Query Builder;
• FAQ;
• Changelog.

License

…