InfluxDB 3 的 Java 客户端库
InfluxDB 3 的 influxdb3-java Java 客户端库 与 Java 应用程序代码集成，用于写入和查询存储在 InfluxDB 集群版中的数据。
InfluxDB 客户端库提供可配置的批量写入数据到 InfluxDB 集群版的功能。使用客户端库可以构建 Line Protocol 数据，将其他格式的数据转换为 Line Protocol，并将 Line Protocol 数据批量写入 InfluxDB HTTP API。
InfluxDB 3 客户端库可以使用 SQL 或 InfluxQL 查询 InfluxDB 集群版。influxdb3-java Java 客户端库将 Apache Arrow 的 org.apache.arrow.flight.FlightClient 封装在一个方便的 InfluxDB 3 接口中，用于执行 SQL 和 InfluxQL 查询、请求服务器元数据，以及使用基于 gRPC 的 Flight 协议从 InfluxDB 集群版检索数据。
示例：写入和查询数据
以下示例展示了如何使用 influxdb3-java 写入和查询存储在 InfluxDB 集群版中的数据。
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://cluster-host.com"; // your cluster URL
private static final String DATABASE = "DATABASE_NAME"; // your InfluxDB database name
private static final char[] TOKEN = System.getenv("DATABASE_TOKEN"); // a local environment variable that stores your database token
// Create a client instance that writes and queries data in your database.
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 database.");
}
catch (Exception e) {
System.err.println("Failed to write data to the database.");
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 database.");
e.printStackTrace();
}
}
}
源代码：GitHub 上的 suyashcjoshi/SimpleJavaInfluxDB
替换以下内容
DATABASE_NAME：您的 InfluxDB 集群版 数据库 的名称，用于读取和写入数据DATABASE_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 或更高版本，此选项会为 Arrow 公开 JDK 内部组件。有关更多选项，请参阅 Apache Arrow Java 安装文档。-jar target/PROJECT_NAME.jar：您要运行的.jar文件。
输出是来自您的 InfluxDB 集群版数据库的新写入数据。
安装
在您的项目依赖项中包含 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 集群版中的数据。
API 参考
InfluxDBClient 接口
InfluxDBClient 提供了一个接口，用于与 InfluxDB API 交互，以进行数据的写入和查询。
InfluxDBClient.getInstance 构造函数初始化并返回一个客户端实例，其中包含以下内容
- 一个配置为写入数据库的*写入客户端*。
- 一个配置为查询数据库的 Arrow *Flight 客户端*。
要初始化客户端，请调用 getInstance 并将您的凭据作为以下类型之一传递
- 参数
- 一个
ClientConfig - 一个 数据库连接字符串
使用凭据参数初始化
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://cluster-host.com";
private static final String DATABASE = "DATABASE_NAME";
private static final char[] TOKEN = System.getenv("DATABASE_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, DATABASE_TOKEN, DATABASE)) {
writeData(client);
queryData(client);
}
catch (Exception e) {
System.err.println("An error occurred while connecting to InfluxDB!");
e.printStackTrace();
}
}
}
替换以下内容
默认标签
要在所有写入的数据中包含默认 标签，请传递一个包含标签键和值的 Map。
InfluxDBClient getInstance(@Nonnull final String host,
@Nullable final char[] token,
@Nullable final String database,
@Nullable Map<String, String> defaultTags)
使用数据库连接字符串初始化
"https://cluster-host.com"
+ "?token=DATABASE_TOKEN&database=DATABASE_NAME"
替换以下内容
InfluxDBClient 实例方法
InfluxDBClient.writePoint
要将点以 Line Protocol 格式写入数据库
- 初始化
client——您的令牌必须对指定的数据库具有写入权限。 - 使用
com.influxdb.v3.client.Point类创建时间序列数据。 - 调用
client.writePoint()方法以 Line Protocol 格式将点写入您的数据库。
// Use the Point class to construct time series data.
// Call client.writePoint to write the point in your database.
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 database.");
}
catch (Exception e) {
System.err.println("Failed to write data to the database.");
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 database.");
e.printStackTrace();
}
}
此页是否对您有帮助？
感谢您的反馈！
支持和反馈
感谢您成为我们社区的一份子！我们欢迎并鼓励您提供关于 InfluxDB 集群版和本文档的反馈和错误报告。要获得支持，请使用以下资源
拥有年度合同或支持合同的客户 可以联系 InfluxData 支持。