Skip to content

GH-49723: [C++][FlightRPC][ODBC] Update ODBC Documentation #49851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
justing-bq wants to merge 1 commit into
base: main
Choose a base branch
from
+96 −10
Open

GH-49723: [C++][FlightRPC][ODBC] Update ODBC Documentation #49851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 32 additions & 10 deletions cpp/src/arrow/flight/sql/odbc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,50 @@
under the License.
-->

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

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

1. Open Windows Power Shell as administrator.
On Windows, the driver binary will be located at `build\debug\Debug\arrow_flight_sql_odbc.dll` for a debug build and `build\release\Release\arrow_flight_sql_odbc.dll` for a release build.

2. Register your ODBC DLL:
On MacOS, the driver binary will be located at `build/debug/libarrow_flight_sql_odbc.dylib` for a debug build and `build/release/libarrow_flight_sql_odbc.dylib` for a release build.

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

1. `cd <path\to\repo>`
2. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC Driver
1. Open your system terminal. On Windows this should be Power Shell in administrator mode.

2. Register your ODBC binary:

These commands need `<path/to/repo>` to be replaced with the actual path to the repository.

1. `cd <path/to/repo>`
2. Run script to register your ODBC driver binary as Apache Arrow Flight SQL ODBC Driver.<br>
On Windows:
```
.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd <path\to\repo>\cpp\build\< release | debug >\< Release | Debug>\arrow_flight_sql_odbc.dll
```
Example command for reference:
```
.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd C:\path\to\arrow\cpp\build\release\Release\arrow_flight_sql_odbc.dll
```
On MacOS:
```
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/repo>/cpp/build/< release | debug >/libarrow_flight_sql_odbc.dylib
```
Example command for reference:
```
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/arrow>/cpp/build/release/libarrow_flight_sql_odbc.dylib
```
On Linux:
```
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/repo>/cpp/build/< release | debug >/libarrow_flight_sql_odbc.so
```
Example command for reference:
```
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/arrow>/cpp/build/release/libarrow_flight_sql_odbc.so
```

If the registration is successful, then Apache Arrow Flight SQL ODBC Driver
should show as an available ODBC driver in the x64 ODBC Driver Manager.
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 & Linux this should be visible in your system odbc.ini.

## Steps to Generate Windows Installer
1. Install WiX toolset v6 from [GitHub](https://github.com/wixtoolset/wix/releases/).
Expand Down Expand Up @@ -129,3 +150,4 @@ After ODBC has been registered, you can run the ODBC tests. It is recommended to

- 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.
- Conversion from strings to big int data type has a limit range of -9007199254740992 to 9007199254740992.
- On Linux, `isql` commands `tables` and `columns` don’t work due to GH-49702. Users are not blocked from fetching data tables.
64 changes: 64 additions & 0 deletions cpp/src/arrow/flight/sql/odbc/connection-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!---
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.
-->

# Connection Properties on Apache Arrow Flight SQL ODBC Driver

## Setting ODBC Connection Properties

ODBC connection parameters can be set in a connection string or defined in a DSN inside your system's odbc.ini.

The following sample connection string and sample DSN are two equivalent ways to connect to Arrow.

### Sample Connection String
```
"driver={Apache Arrow Flight SQL ODBC Driver};HOST=1234.56.789;port=12345;uid=sample_user;pwd=sample_password;useEncryption=false;useWideChar=true;"
```

### Sample DSN
```
[Apache Arrow Flight SQL]
Driver = Apache Arrow Flight SQL ODBC Driver
Host = 1234.56.789
Port = 12345
UID = sample_user
PWD = sample_password
useEncryption = false
useWideChar = true
```

### Driver Connection Options
| Option | Description | Default |
|--------|-------------|---------------|
| `driver` | Required: the driver for this ODBC driver. | Apache Arrow Flight SQL
| `dsn` | Data Source Name used for configuring the connection. | `NONE`
| `host` | The IP address or hostname for the server. | `NONE`
| `port` | The TCP port number the server uses for ODBC connections. | `NONE`
| `user` | The username for authentication to the server. | `NONE`
| `user id` | The username for authentication to the server. | `NONE`
| `uid` | The username for authentication to the server. | `NONE`
| `password` | The password for authentication to the server. | `NONE`
| `pwd` | The password for authentication to the server. | `NONE`
| `token` | The personal access token for authentication to the server. | `NONE`
| `useEncryption` | Setting to determine if an SSL-encrypted connection should be used. | `true` on Windows & Linux, `false` on MacOS
| `disableCertificateVerification` | Setting to determine if the driver should verify the host certificate against the trust store. | `false`
| `trustedCerts` | The full path of the .pem file containing certificates for the purpose of verifying the server. | `NONE`
| `useSystemTrustStore` | Setting to determine whether to use a CA certificate from the system's trust store or from a specified .pem file. | `true`
| `stringColumnLength` | Maximum length of a string column. Some apps may require a lower length. | `NONE`
| `useWideChar` | Setting to determine if wide characters should be used. Important for Unicode applications. | `true` on Windows, `false` on MacOS & Linux
| `chunkBufferCapacity` | Capacity of a chunk buffer. Larger values will improve throughput at the cost of increased memory usage. | 5
Loading