-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ARROW-17332: [Docs][Java] Add minimal JDBC driver docs
- Loading branch information
Showing
3 changed files
with
154 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
.. 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¶m2=val2&...] | ||
|
||
where | ||
|
||
* **HOSTNAME** is the hostname of the Flight SQL service. | ||
* **PORT** is the port of the Flight SQL service. | ||
|
||
By default, this will create an insecure (plaintext) connection. | ||
|
||
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 | ||
|
||
* - username | ||
- null | ||
- The username for user/password authentication | ||
|
||
* - useSystemTrustStore | ||
- true | ||
- When TLS is enabled, whether to use the system certificate store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters