InfluxDB 3的Java客户端库
InfluxDB 3 influxdb3-java Java 客户端库 集成了 Java 应用程序代码,以便写入和查询存储在 InfluxDB Cloud Serverless 中的数据。
InfluxDB 客户端库提供可配置的批量写入数据到 InfluxDB Cloud Serverless。 使用客户端库构造行协议数据,将其他格式的数据转换为行协议,并将行协议数据批量写入 InfluxDB HTTP APIs。
InfluxDB 3 客户端库可以使用 SQL 或 InfluxQL 查询 InfluxDB Cloud Serverless。
influxdb3-java Java 客户端库将 Apache Arrow org.apache.arrow.flight.FlightClient
封装成一个方便的 InfluxDB 3 接口,用于执行 SQL 和 InfluxQL 查询,请求
服务器元数据,并使用 gRPC 的 Flight 协议从 InfluxDB Cloud Serverless 检索数据。
示例:写入和查询数据
以下示例展示了如何使用 influxdb3-java 来写入和查询存储在 InfluxDB Cloud Serverless 中的数据。
package com.influxdata.demo;
import com.influxdb.v3.client.InfluxDBClient;
import com.influxdb.v3.client.Point;
import com.influxdb.v3.client.query.QueryOptions;
import com.influxdb.v3.client.query.QueryType;
import java.time.Instant;
import java.util.stream.Stream;
public class HelloInfluxDB {
private static final String HOST_URL = "https://cloud2.influxdata.com"; // your Cloud Serverless region URL
private static final String DATABASE = "DATABASE_NAME"; // your InfluxDB bucket
private static final char[] TOKEN = System.getenv("API_TOKEN"); // a local environment variable that stores your API token
// Create a client instance that writes and queries data in your bucket.
public static void main(String[] args) {
// Instantiate the client with your InfluxDB credentials
try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, TOKEN, DATABASE)) {
writeData(client);
queryData(client);
}
catch (Exception e) {
System.err.println("An error occurred while connecting to InfluxDB!");
e.printStackTrace();
}
}
// Use the Point class to construct time series data.
private static void writeData(InfluxDBClient client) {
Point point = Point.measurement("temperature")
.setTag("location", "London")
.setField("value", 30.01)
.setTimestamp(Instant.now().minusSeconds(10));
try {
client.writePoint(point);
System.out.println("Data is written to the bucket.");
}
catch (Exception e) {
System.err.println("Failed to write data to the bucket.");
e.printStackTrace();
}
}
// Use SQL to query the most recent 10 measurements
private static void queryData(InfluxDBClient client) {
System.out.printf("--------------------------------------------------------%n");
System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time");
System.out.printf("--------------------------------------------------------%n");
String sql = "select time,location,value from temperature order by time desc limit 10";
try (Stream<Object[]> stream = client.query(sql)) {
stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0]));
}
catch (Exception e) {
System.err.println("Failed to query data from the bucket.");
e.printStackTrace();
}
}
}
来源: suyashcjoshi/SimpleJavaInfluxDB 在 GitHub
替换以下内容:
DATABASE_NAME: 您的 InfluxDB Cloud Serverless 的 bucket 名称,用于读取和写入数据API_TOKEN: 一个本地环境变量,用于存储您的 token——该 token 必须具有在指定存储区的读取和写入权限。
运行示例以写入和查询数据
为项目构建一个可执行的 JAR - 例如,使用 Maven:
mvn package在你的终端中,运行
java命令以写入和查询你的存储桶中的数据:java \ --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED \ -jar target/PROJECT_NAME.jar在你的命令中包含以下内容:
--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED: 在Java 9或更高版本以及Apache Arrow 16或更高版本中,暴露JDK内部实现以供Arrow使用。 有关更多选项,请参阅Apache Arrow Java安装文档。-jar target/PROJECT_NAME.jar: 您要运行的.jar文件。
输出是来自您 InfluxDB Cloud Serverless 存储桶的新写入数据。
安装
在您的项目依赖中包含 com.influxdb.influxdb3-java。
<dependency>
<groupId>com.influxdb</groupId>
<artifactId>influxdb3-java</artifactId>
<version>RELEASE</version>
</dependency>
dependencies {
implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release'
}
导入客户端
influxdb3-java 客户端库提供了 com.influxdb.v3.client 类,用于构建、写入和查询存储在 InfluxDB Cloud Serverless 中的数据。
API 参考
InfluxDBClient 接口
InfluxDBClient 提供了一个与 InfluxDB API 进行交互的接口,用于写入和查询数据。
InfluxDBClient.getInstance 构造函数初始化并返回一个客户端实例,具有以下内容:
- 一个配置为写入存储桶的 写客户端。
- 一个配置用于查询桶的 Flight client。
要初始化客户端,请调用 getInstance 并将您的凭据作为以下类型之一传递:
使用凭证参数初始化
static InfluxDBClient getInstance(@Nonnull final String host,
@Nullable final char[] token,
@Nullable final String database)
示例:使用凭证参数初始化
package com.influxdata.demo;
import com.influxdb.v3.client.InfluxDBClient;
import com.influxdb.v3.client.Point;
import com.influxdb.v3.client.query.QueryOptions;
import com.influxdb.v3.client.query.QueryType;
import java.time.Instant;
import java.util.stream.Stream;
public class HelloInfluxDB {
private static final String HOST_URL = "https://cloud2.influxdata.com";
private static final String DATABASE = "DATABASE_NAME";
private static final char[] API_TOKEN = System.getenv("API_TOKEN");
// Create a client instance, and then write and query data in InfluxDB.
public static void main(String[] args) {
try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) {
writeData(client);
queryData(client);
}
catch (Exception e) {
System.err.println("An error occurred while connecting with the serverless InfluxDB!");
e.printStackTrace();
}
}
}
替换以下内容:
DATABASE_NAME: 你的 InfluxDB Cloud Serverless bucketAPI_TOKEN: 一个本地环境变量,用于存储您的 token——该token必须在指定的bucket上具有必要的权限。
默认标签
要在所有书写的数据中包含默认 tags,请传递一个 Map 的标签键和值。
InfluxDBClient getInstance(@Nonnull final String host,
@Nullable final char[] token,
@Nullable final String database,
@Nullable Map<String, String> defaultTags)
使用数据库连接字符串初始化
"https://cloud2.influxdata.com"
+ "?token=API_TOKEN&database=DATABASE_NAME"
替换以下内容:
InfluxDBClient 实例方法
InfluxDBClient.writePoint
将点以线协议写入存储桶:
- 初始化
client- 您的令牌必须在指定的存储桶上具有写入权限。 - 使用
com.influxdb.v3.client.Point类来创建时间序列数据。 - 调用
client.writePoint()方法将数据点以行协议的形式写入您的存储桶。
// Use the Point class to construct time series data.
// Call client.writePoint to write the point in your bucket.
private static void writeData(InfluxDBClient client) {
Point point = Point.measurement("temperature")
.setTag("location", "London")
.setField("value", 30.01)
.setTimestamp(Instant.now().minusSeconds(10));
try {
client.writePoint(point);
System.out.println("Data written to the bucket.");
}
catch (Exception e) {
System.err.println("Failed to write data to the bucket.");
e.printStackTrace();
}
}
InfluxDBClient.query
要查询数据并处理结果:
- 初始化
client–您的令牌必须对要查询的桶具有读取权限。 - 调用
client.query()并将您的 SQL 查询作为字符串提供。 - 使用结果流的内置迭代器处理行数据。
// Query the latest 10 measurements using SQL
private static void queryData(InfluxDBClient client) {
System.out.printf("--------------------------------------------------------%n");
System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time");
System.out.printf("--------------------------------------------------------%n");
String sql = "select time,location,value from temperature order by time desc limit 10";
try (Stream<Object[]> stream = client.query(sql)) {
stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0]));
}
catch (Exception e) {
System.err.println("Failed to query data from the bucket.");
e.printStackTrace();
}
}