Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/source/java/flight_sql.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements. See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership. The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License. You may obtain a copy of the License at

.. http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing,
.. software distributed under the License is distributed on an
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
.. KIND, either express or implied. See the License for the
.. specific language governing permissions and limitations
.. under the License.

================
Arrow Flight SQL
================

Arrow Flight SQL is an RPC framework for efficient transfer of Arrow data
over the network.

.. seealso::

:doc:`Flight SQL protocol documentation <../format/FlightSql>`
Documentation of the Flight SQL protocol.

For usage information, see the `API documentation`_.

.. _API documentation: https://arrow.apache.org/docs/java/reference/org/apache/arrow/flight/sql/package-summary.html
128 changes: 128 additions & 0 deletions docs/source/java/flight_sql_jdbc_driver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements. See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership. The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License. You may obtain a copy of the License at

.. http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing,
.. software distributed under the License is distributed on an
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
.. KIND, either express or implied. See the License for the
.. specific language governing permissions and limitations
.. under the License.

============================
Arrow Flight SQL JDBC Driver
============================

The Flight SQL JDBC driver is a JDBC driver implementation that uses
the :doc:`Flight SQL protocol <../format/FlightSql>` under the hood.
This driver can be used with any database that implements Flight SQL.

.. contents::

Installation and Requirements
=============================

The driver is compatible with JDK 8+. On JDK 9+, the following JVM
parameter is required:

.. code-block:: shell

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

To add a dependency via Maven, use a ``pom.xml`` like the following:

.. code-block:: 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>10.0.0</arrow.version>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>flight-sql-jdbc-driver</artifactId>
<version>${arrow.version}</version>
</dependency>
</dependencies>
</project>

Connecting to a Database
========================

The URI format is as follows::

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably just me but I find these URI format definitions to be a little cryptic. Maybe include an example string with a couple of parameters so people have something concrete to refer to?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, good idea. I added an example with some prose to explain the parameters.


For example, take this URI::

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

This will connect to a Flight SQL service running on ``localhost`` on
port 12345. It will create a secure, encrypted connection, and
authenticate using the username ``admin`` and the password ``pass``.

The components of the URI are as follows.

* The URI scheme must be ``jdbc:arrow-flight-sql://``.
* **HOSTNAME** is the hostname of the Flight SQL service.
* **PORT** is the port of the Flight SQL service.

Additional options can be passed as query parameters. The supported
parameters are:

.. list-table::
:header-rows: 1

* - Parameter
- Default
- Description

* - disableCertificateVerification
- false
- When TLS is enabled, whether to verify the server certificate

* - password
- null
- The password for user/password authentication

* - threadPoolSize
- 1
- The size of an internal thread pool

* - token
- null
- The token used for token authentication

* - trustStore
- null
- When TLS is enabled, the path to the certificate store

* - trustStorePassword
- null
- When TLS is enabled, the password for the certificate store

* - useEncryption
- false
- Whether to use TLS (the default is an insecure, plaintext
connection)

* - username
- null
- The username for user/password authentication

* - useSystemTrustStore
- true
- When TLS is enabled, whether to use the system certificate store
2 changes: 2 additions & 0 deletions docs/source/java/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ on the Arrow format and other language bindings see the :doc:`parent documentati
ipc
algorithm
flight
flight_sql
flight_sql_jdbc_driver
dataset
cdata
jdbc
Expand Down