Skip to content

Commit 603eeec

Browse files
justing-bqjusting-bq
authored
GH-49723: [C++][FlightRPC][ODBC] Update ODBC Documentation (#49851)
### Rationale for this change Update ODBC Documentation in preparation for public release. Resolves #49723 ### What changes are included in this PR? Miscellaneous doc changes. ### Are these changes tested? N/A ### Are there any user-facing changes? No * GitHub Issue: #49723 Authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
1 parent 95b514f commit 603eeec

2 files changed

Lines changed: 95 additions & 11 deletions

File tree

‎cpp/src/arrow/flight/sql/odbc/README.md‎

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,48 @@
1717
under the License.
1818
-->
1919

20-
## Steps to Register the 64-bit Apache Arrow ODBC driver on Windows
20+
## Steps to Register the Apache Arrow Flight SQL ODBC driver
2121

22-
After the build succeeds, the ODBC DLL will be located in
23-
`build\debug\Debug` for a debug build and `build\release\Release` for a release build.
22+
After building the repository you will find the built ODBC binaries in the build artifacts.
2423

25-
1. Open Windows Power Shell as administrator.
24+
On Windows, the driver binary will be located at `C:\path\to\arrow\cpp\build\debug\Debug\arrow_flight_sql_odbc.dll` for a debug build and `C:\path\to\arrow\cpp\build\release\Release\arrow_flight_sql_odbc.dll` for a release build.
2625

27-
2. Register your ODBC DLL:
26+
On macOS, the driver binary will be located at `/path/to/arrow/cpp/build/debug/libarrow_flight_sql_odbc.dylib` for a debug build and `/path/to/arrow/cpp/build/release/libarrow_flight_sql_odbc.dylib` for a release build.
2827

29-
Need to replace `<path\to\repo>` with actual path to repository in the commands.
28+
On Linux, the driver binary will be located at `/path/to/arrow/cpp/build/debug/libarrow_flight_sql_odbc.so` for a debug build and `/path/to/arrow/cpp/build/release/libarrow_flight_sql_odbc.so` for a release build.
3029

31-
1. `cd <path\to\repo>`
32-
2. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC Driver
30+
1. Open your system terminal. On Windows this should be PowerShell in administrator mode.
31+
32+
2. Register your ODBC binary:
33+
34+
1. Navigate to the root of the Arrow repo.
35+
2. Run script to register your ODBC driver binary as Apache Arrow Flight SQL ODBC Driver.<br>
36+
On Windows:
3337
```
34-
.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd <path\to\repo>\cpp\build\< release | debug >\< Release | Debug>\arrow_flight_sql_odbc.dll
38+
.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd C:\path\to\arrow\cpp\build\< release | debug >\< Release | Debug>\arrow_flight_sql_odbc.dll
3539
```
3640
Example command for reference:
3741
```
3842
.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd C:\path\to\arrow\cpp\build\release\Release\arrow_flight_sql_odbc.dll
3943
```
44+
On macOS:
45+
```
46+
sudo ./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh /path/to/arrow/cpp/build/< release | debug >/libarrow_flight_sql_odbc.dylib
47+
```
48+
Example command for reference:
49+
```
50+
sudo ./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh /path/to/arrow/cpp/build/release/libarrow_flight_sql_odbc.dylib
51+
```
52+
On Linux:
53+
```
54+
sudo ./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh /path/to/arrow/cpp/build/< release | debug >/libarrow_flight_sql_odbc.so
55+
```
56+
Example command for reference:
57+
```
58+
sudo ./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh /path/to/arrow/cpp/build/release/libarrow_flight_sql_odbc.so
59+
```
4060
41-
If the registration is successful, then Apache Arrow Flight SQL ODBC Driver
42-
should show as an available ODBC driver in the x64 ODBC Driver Manager.
61+
If the registration is successful, then Apache Arrow Flight SQL ODBC Driver should show as an available ODBC driver. On Windows this should be visible in the x64 ODBC Driver Manager. On macOS this should be visible in `$HOME/Library/ODBC/odbcinst.ini`. On Linux this should be visible in `/etc/odbcinst.ini`.
4362
4463
## Steps to Generate Windows Installer
4564
1. Install WiX toolset v6 from [GitHub](https://github.com/wixtoolset/wix/releases/).
@@ -129,3 +148,4 @@ After ODBC has been registered, you can run the ODBC tests. It is recommended to
129148
130149
- Conversion from timestamp data type with specified time zone value to strings is not supported at the moment. This doesn't impact driver's usage of retrieving timestamp data from Power BI on Windows, and Excel on macOS and Windows. See GH-47504 for more context.
131150
- Conversion from strings to big int data type has a limit range of -9007199254740992 to 9007199254740992.
151+
- On Linux, `isql` commands `tables` and `columns` don't work due to GH-49702. Users are not blocked from fetching data tables.

‎cpp/src/arrow/flight/sql/odbc/connection-options.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!---
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Connection Properties on Apache Arrow Flight SQL ODBC Driver
21+
22+
## Setting ODBC Connection Properties
23+
24+
ODBC connection parameters can be set in a connection string or defined in a DSN. On macOS and Linux, DSNs are typically defined in your system's `odbc.ini`. On Windows they are typically configured with the ODBC Data Source Administrator.
25+
26+
The following sample connection string and sample DSN are two equivalent ways to connect to Arrow.
27+
28+
### Sample Connection String
29+
```
30+
driver={Apache Arrow Flight SQL ODBC Driver};host=127.0.0.1;port=12345;uid=sample_user;pwd=sample_password;useEncryption=false;useWideChar=true;
31+
```
32+
33+
### Sample DSN
34+
```
35+
[Apache Arrow Flight SQL]
36+
driver = Apache Arrow Flight SQL ODBC Driver
37+
host = 127.0.0.1
38+
port = 12345
39+
uid = sample_user
40+
pwd = sample_password
41+
useEncryption = false
42+
useWideChar = true
43+
```
44+
45+
### Driver Connection Options
46+
| Option | Description | Default |
47+
|--------|-------------|---------------|
48+
| `driver` | Required: the driver for this ODBC driver. | `Apache Arrow Flight SQL ODBC Driver` |
49+
| `dsn` | Data Source Name used for configuring the connection. | `Apache Arrow Flight SQL` |
50+
| `host` | The IP address or hostname for the server. | `NONE` |
51+
| `port` | The TCP port number the server uses for ODBC connections. | `NONE` |
52+
| `user` | The username for authentication to the server. | `NONE` |
53+
| `user id` | The username for authentication to the server. | `NONE` |
54+
| `uid` | The username for authentication to the server. | `NONE` |
55+
| `password` | The password for authentication to the server. | `NONE` |
56+
| `pwd` | The password for authentication to the server. | `NONE` |
57+
| `token` | The personal access token for authentication to the server. | `NONE` |
58+
| `useEncryption` | Setting to determine if an SSL-encrypted connection should be used. | `true` |
59+
| `disableCertificateVerification` | Setting to determine if the driver should verify the host certificate against the trust store. | `false` |
60+
| `trustedCerts` | The full path of the .pem file containing certificates for the purpose of verifying the server. | `NONE` |
61+
| `useSystemTrustStore` | Setting to determine whether to use a CA certificate from the system's trust store or from a specified .pem file. | `true` on Windows, `false` on macOS & Linux |
62+
| `stringColumnLength` | Maximum length of a string column. Some apps may require a lower length. | `NONE` |
63+
| `useWideChar` | Setting to determine if wide characters should be used. Important for Unicode applications. | `true` on Windows, `false` on macOS & Linux |
64+
| `chunkBufferCapacity` | Capacity of a chunk buffer. Larger values will improve throughput at the cost of increased memory usage. | 5 |

0 commit comments

Comments
 (0)