Java Flight SQL package
InfluxDB Clustered is currently only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.
Apache Arrow Flight SQL for Java integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL.
Use InfluxDB v3 client libraries
We recommend using the
influxdb3-java Go client library for integrating InfluxDB v3 with your Java application code.
InfluxDB v3 client libraries wrap Apache Arrow Flight clients and provide convenient methods for writing, querying, and processing data stored in InfluxDB Clustered. Client libraries can query using SQL or InfluxQL.
- Get started using the Java Flight SQL client to query InfluxDB
- Troubleshoot Arrow Flight requests
Get started using the Java Flight SQL client to query InfluxDB
Write a Java class for a Flight SQL client that connects to InfluxDB Clustered, executes an SQL query, and retrieves data stored in an InfluxDB Clustered database.
The example uses the Apache Arrow Java implementation (
org.apache.arrow) for interacting with Flight database servers like InfluxDB v3.
org.apache.arrow: Provides classes and methods for integrating Java applications with Apache Arrow data and protocols.
org.apache.arrow.flight.sql: Provides classes and methods for interacting with Flight database servers using Arrow Flight RPC and Flight SQL.
- Set up InfluxDB
- Install prerequisites
- Create the FlightQuery class
- Create a query client
- Execute a query
- Retrieve and process Arrow data
To clone or download the example application that you can run with Docker, see the InfluxCommunity/ArrowFlightClient_Query_Examples repository on GitHub.
Set up InfluxDB
To configure the application for querying InfluxDB Clustered, you’ll need the following InfluxDB resources:
- InfluxDB Clustered database
- InfluxDB Clustered database token with read permission to the database
The following uses Docker and Maven to build and run the Java application and avoid platform-specific dependency problems.
Dockerfile installs compatible versions of Maven
and Java JDK in the Docker container, and then runs the Maven commands to download dependencies and compile the application.
Follow the instructions to download and install Docker for your system:
Create the FlightQuery class
<PROJECT_ROOT>/src/main/javadirectory, create the
com/influxdb/examplessubdirectories for the
examplesdirectory from the preceding step, create the
FlightQuery.javaclass file. You should have the following directory structure:
PROJECT_ROOT └──src └──main └──java └──com └──influxdb └──examples └──FlightQuery.java
Add the package name:
importstatements for the following packages. You’ll use classes and methods from these packages in the remaining steps:
Define constants for server credentials.
Dockerfiledefines environment variables for these credentials.
Create a query client
FlightQuery.main() method, do the following to create an SQL client that can connect to
Construct a gRPC+TLS channel URI with
443for communicating with a gRPC server over TLS.
FlightClientMiddlewareand define an event callback that inserts the following Flight request metadata header property:
BufferAllocatorthat sets the memory allowed for the client.
FlightClientwith the allocator and gRPC channel.
FlightSqlClientthat wraps the
Execute a query
TOKENas a bearer credential. The result is a credential object that you’ll pass in each request to the server.
Define a string that contains the SQL query to execute–for example:
String query = "SELECT * FROM home";
FlightSqlClient.executemethod with the SQL query and the
If successful, the
FlightSqlClient.executemethod responds with a
FlightInfoobject that contains metadata and an
endpoints: [...]list. Each endpoint contains the following:
- A list of addresses where you can retrieve the data.
ticketvalue that identifies the data to retrieve.
Extract the ticket from the response.
Retrieve and process Arrow data
FlightQuery.main() method, do the following to retrieve the data stream described in the
FlightSqlClient.getStreammethod with the ticket and the
CredentialCallOptionto fetch the Arrow stream.
FlightStream.getRootmethod to get the current vector data from the stream.
Process the data and handle exceptions. The example converts the vector data into tab-separated values and prints the result to
For more examples using Java to work with Arrow data, see the Apache Arrow Java Cookbook.
Finally, close the stream and client.
Run the application
Follow these steps to build and run the application using Docker:
pom.xmlto your project root directory.
Open a terminal in your project root directory.
In your terminal, run the
docker buildcommand and pass
--build-argflags for the server credentials:
DATABASE_NAME: your InfluxDB Clustered database
HOST: your [InfluxDB cluster hostname (URL without the “https://”)
TOKEN: your InfluxDB Clustered database token with read permission to the database
docker build \ --build-arg DATABASE_NAME=INFLUX_DATABASE \ --build-arg HOST=cluster-id.influxdb.io \ --build-arg TOKEN=INFLUX_TOKEN \ -t javaflight .
The command builds a Docker image named
To run the application in a new Docker container, enter the following command:
docker run javaflight
The output is the query data in TSV-format.
Troubleshoot Arrow Flight requests
For the list of Arrow Flight error response codes, see the Arrow Flight RPC documentation.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.