Documentation

Java Flight SQL package

Limited availability

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

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.
  1. Set up InfluxDB
  2. Install prerequisites
  3. Create the FlightQuery class
  4. Create a query client
  5. Execute a query
  6. 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

If you don’t already have a database token and a database, see how to set up InfluxDB. If you don’t already have data to query, see how to write data to a database.

Install prerequisites

The following uses Docker and Maven to build and run the Java application and avoid platform-specific dependency problems.

The example 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:

View the Dockerfile

View the Maven pom.xml

Create the FlightQuery class

View FlightQuery.java

  1. In your <PROJECT_ROOT>/src/main/java directory, create the com/influxdb/examples subdirectories for the com.influxdb.examples package.

  2. In the examples directory from the preceding step, create the FlightQuery.java class file. You should have the following directory structure:

    PROJECT_ROOT
    └──src
       └──main
          └──java
             └──com
                └──influxdb
                   └──examples
                      └──FlightQuery.java
    
  3. In FlightQuery.java:

    1. Add the package name:

      package com.influxdb.examples;
      
    2. Add import statements for the following packages. You’ll use classes and methods from these packages in the remaining steps:

      • org.apache.arrow.flight.auth2.BearerCredentialWriter
      • org.apache.arrow.flight.CallHeaders
      • org.apache.arrow.flight.CallStatus
      • org.apache.arrow.flight.grpc.CredentialCallOption
      • org.apache.arrow.flight.Location
      • org.apache.arrow.flight.FlightClient
      • org.apache.arrow.flight.FlightClientMiddleware
      • org.apache.arrow.flight.FlightInfo
      • org.apache.arrow.flight.FlightStream
      • org.apache.arrow.flight.sql.FlightSqlClient
      • org.apache.arrow.flight.Ticket
      • org.apache.arrow.memory.BufferAllocator
      • org.apache.arrow.memory.RootAllocator
      • org.apache.arrow.vector.VectorSchemaRoot
    3. Create a FlightQuery class.

    4. In the FlightQuery class:

      1. Define constants for server credentials.

        • DATABASE_NAME
        • HOST
        • TOKEN

        The example Dockerfile defines environment variables for these credentials.

      2. Create a main() method.

Create a query client

In the FlightQuery.main() method, do the following to create an SQL client that can connect to HOST and DATABASE_NAME:

  1. Construct a gRPC+TLS channel URI with HOST and port 443 for communicating with a gRPC server over TLS.

  2. Instantiate FlightClientMiddleware and define an event callback that inserts the following Flight request metadata header property:

    "database": "DATABASE_NAME"
    
  3. Instantiate a BufferAllocator that sets the memory allowed for the client.

  4. Create a FlightClient with the allocator and gRPC channel.

  5. Instantiate a FlightSqlClient that wraps the FlightClient instance.

Execute a query

In the FlightQuery.main method:

  1. Instantiate a CredentialCallOption with TOKEN as a bearer credential. The result is a credential object that you’ll pass in each request to the server.

  2. Define a string that contains the SQL query to execute–for example:

    String query = "SELECT * FROM home";
    
  3. Call the FlightSqlClient.execute method with the SQL query and the CredentialCallOption.

  4. If successful, the FlightSqlClient.execute method responds with a FlightInfo object that contains metadata and an endpoints: [...] list. Each endpoint contains the following:

    • A list of addresses where you can retrieve the data.
    • A ticket value that identifies the data to retrieve.
  5. Extract the ticket from the response.

Retrieve and process Arrow data

In the FlightQuery.main() method, do the following to retrieve the data stream described in the FlightInfo response:

  1. Call the FlightSqlClient.getStream method with the ticket and the CredentialCallOption to fetch the Arrow stream.

  2. Call the FlightStream.getRoot method to get the current vector data from the stream.

  3. Process the data and handle exceptions. The example converts the vector data into tab-separated values and prints the result to System.out.

    For more examples using Java to work with Arrow data, see the Apache Arrow Java Cookbook.

  4. Finally, close the stream and client.

Run the application

Follow these steps to build and run the application using Docker:

  1. Copy the Dockerfile and pom.xml to your project root directory.

  2. Open a terminal in your project root directory.

  3. In your terminal, run the docker build command and pass --build-arg flags for the server credentials:

    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 javaflight.

  4. 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!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more