28 Apr 2022

Notes on running (java) FlightSqlExample

Here are my notes on how to run the sample java Arrow Flight SQL server and client.

Clone https://github.com/apache/arrow/:

git clone git@github.com:apache/arrow.git

Install snapshot versions of arrow:

cd java
mvn clean install -DskipTests=true

Add Application entry point:

cd flight/flight-sql
cat << EOF > ./src/test/java/org/apache/arrow/flight/sql/example/Main.java
package org.apache.arrow.flight.sql.example;

import org.apache.arrow.flight.FlightServer;
import org.apache.arrow.flight.Location;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

public class Main {

    public static void main(String args[]) throws Exception {

        BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);

        final String LOCALHOST = "localhost";

        final Location serverLocation = Location.forGrpcInsecure(LOCALHOST, 52358);
        final FlightServer server = FlightServer.builder(allocator, serverLocation, new FlightSqlExample(serverLocation))
                .build()
                .start();

        System.out.println("server is up and running at port: " + server.getPort());
        Thread.sleep(Long.MAX_VALUE);
    }
}
EOF

4. Run the server:

```bash
mvn test exec:java -Dcheckstyle.skip -DskipTests=true -Drat.skip=true -Dexec.mainClass="org.apache.arrow.flight.sql.example.Main" -Dexec.classpathScope="test"

Compile the client:

mvn compile -Dcheckstyle.skip -Drat.skip=true

Run client without arguments:

mvn exec:java -Dcheckstyle.skip -Drat.skip=true \
    -Dexec.mainClass="org.apache.arrow.flight.sql.example.FlightSqlClientDemoApp"

Output:

Missing required option: command
usage: FlightSqlClientDemoApp -host localhost -port 32010 ...
 -catalog,--catalog         Catalog
 -command,--command <arg>   Method to run
 -host,--host <arg>         Host to connect to
 -port,--port <arg>         Port to connect to
 -query,--query             Query
 -schema,--schema           Schema
 -table,--table             Table
[WARNING] 
org.apache.commons.cli.MissingOptionException: Missing required options: host, port, command

List tables in APP schema:

mvn exec:java -Dcheckstyle.skip -Drat.skip=true \
    -Dexec.mainClass="org.apache.arrow.flight.sql.example.FlightSqlClientDemoApp" \
    -Dexec.args="-host localhost -port 52358 -command GetTables -schema APP"

Output:

catalog_name    db_schema_name  table_name      table_type
null    APP     FOREIGNTABLE    TABLE
null    APP     INTTABLE        TABLE

Execute a query:

mvn exec:java -Dcheckstyle.skip -Drat.skip=true \
    -Dexec.mainClass="org.apache.arrow.flight.sql.example.FlightSqlClientDemoApp" \
    -Dexec.args='-host localhost -port 52358 -command Execute -query "select * from APP.INTTABLE"'

Output:

ID      KEYNAME VALUE   FOREIGNID
1       one     1       1
2       zero    0       1
3       negative one    -1      1

Tim Van Wassenhove

Notes on running (java) FlightSqlExample