Arrow Flight SQL JDBC 驱动程序#

Flight SQL JDBC 驱动程序是 JDBC 驱动程序实现,它在底层使用 Flight SQL 协议。此驱动程序可以与任何实现 Flight SQL 的数据库一起使用。

安装和要求#

该驱动程序与 JDK 11+ 兼容。请注意,需要以下 JVM 参数

java --add-opens=java.base/java.nio=ALL-UNNAMED ...

要通过 Maven 添加依赖项,请使用如下所示的 pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.example</groupId>
  <artifactId>demo</artifactId>
  <version>1.0-SNAPSHOT</version>
  <properties>
    <arrow.version>18.1.0</arrow.version>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.apache.arrow</groupId>
      <artifactId>flight-sql-jdbc-driver</artifactId>
      <version>${arrow.version}</version>
    </dependency>
  </dependencies>
</project>

连接到数据库#

URI 格式如下

jdbc:arrow-flight-sql://HOSTNAME:PORT[/?param1=val1&param2=val2&...]

例如,采用以下 URI

jdbc:arrow-flight-sql://localhost:12345/?username=admin&password=pass&useEncryption=1

这将连接到在端口 12345 上的 localhost 上运行的 Flight SQL 服务。它将创建一个安全、加密的连接,并使用用户名 admin 和密码 pass 进行身份验证。

URI 的组成部分如下。

  • URI 方案必须是 jdbc:arrow-flight-sql://

  • HOSTNAME 是 Flight SQL 服务的主机名。

  • PORT 是 Flight SQL 服务的端口。

其他选项可以作为查询参数传递。参数名称区分大小写。支持的参数有

参数

默认值

描述

disableCertificateVerification

false

启用 TLS 时,是否验证服务器证书

password

null

用于用户/密码身份验证的密码

threadPoolSize

1

内部线程池的大小

token

null

用于令牌身份验证的令牌

trustStore

null

启用 TLS 时,证书存储的路径

trustStorePassword

null

启用 TLS 时,证书存储的密码

tlsRootCerts

null

用于 TLS 的 PEM 编码的根证书的路径 - 将其用作 trustStore 的替代方案

clientCertificate

null

当 Flight SQL 服务器需要客户端验证时,指向 PEM 编码的客户端 mTLS 证书的路径。

clientKey

null

当 Flight SQL 服务器需要客户端验证时,指向 PEM 编码的客户端 mTLS 密钥的路径。

useEncryption

true

是否使用 TLS(默认值为加密连接)

user

null

用于用户/密码身份验证的用户名

useSystemTrustStore

true

启用 TLS 时,是否使用系统证书存储

retainCookies

true

从初始连接中使用 cookie 是否在从单独的端点检索流时用于后续内部连接。

retainAuth

true

从初始连接中获得的持有者令牌是否用于从单独的端点检索流时使用的后续内部连接。

请注意,如果 URI 值包含 !, @, $ 等字符,则必须进行 URI 编码。

驱动程序未处理的任何 URI 参数都将作为 gRPC 标头传递到 Flight SQL 服务。例如,以下 URI

jdbc:arrow-flight-sql://localhost:12345/?useEncryption=0&database=mydb

这将连接到在端口 12345 上的 localhost 上运行的 Flight SQL 服务,而无需身份验证或加密。每个请求还将包含一个 database=mydb gRPC 标头。

使用 JDBC Driver Manager 连接时,也可以使用 Properties 对象提供连接参数。使用 Properties 对象提供时,值应进行 URI 编码。

URI 指定的参数优先于 Properties 对象提供的参数。当调用 DriverManager#getConnection() 的 user/password 重载时,URI 上提供的用户名和密码优先于函数调用的用户名和密码参数。