Skip to content

Commit 56c0480

Browse files
authored
Update README
1 parent eef3b6f commit 56c0480

1 file changed

Lines changed: 33 additions & 11 deletions

File tree

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

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,50 @@
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 `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.
2625

27-
2. Register your ODBC DLL:
26+
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.
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 `build/debug/libarrow_flight_sql_odbc.so` for a debug build and `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 Power Shell in administrator mode.
31+
32+
2. Register your ODBC binary:
33+
34+
These commands need `<path/to/repo>` to be replaced with the actual path to the repository.
35+
36+
1. `cd <path/to/repo>`
37+
2. Run script to register your ODBC driver binary as Apache Arrow Flight SQL ODBC Driver.<br>
38+
On Windows:
3339
```
3440
.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd <path\to\repo>\cpp\build\< release | debug >\< Release | Debug>\arrow_flight_sql_odbc.dll
3541
```
3642
Example command for reference:
3743
```
3844
.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd C:\path\to\arrow\cpp\build\release\Release\arrow_flight_sql_odbc.dll
3945
```
46+
On MacOS:
47+
```
48+
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/repo>/cpp/build/< release | debug >/libarrow_flight_sql_odbc.dylib
49+
```
50+
Example command for reference:
51+
```
52+
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/arrow>/cpp/build/release/libarrow_flight_sql_odbc.dylib
53+
```
54+
On Linux:
55+
```
56+
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/repo>/cpp/build/< release | debug >/libarrow_flight_sql_odbc.so
57+
```
58+
Example command for reference:
59+
```
60+
./cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh <path/to/arrow>/cpp/build/release/libarrow_flight_sql_odbc.so
61+
```
4062
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.
63+
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.
4364
4465
## Steps to Generate Windows Installer
4566
1. Install WiX toolset v6 from [GitHub](https://github.com/wixtoolset/wix/releases/).
@@ -138,10 +159,11 @@ ODBC installers are uploaded to the CI artifacts.
138159
### Install `.RPM` on Ubuntu
139160
While installing via `.DEB` installer on Ubuntu is the recommended approach, users may install `.RPM` on Ubuntu using below command
140161
```
141-
alien -i --scripts ArrowFlightSqlOdbcODBC-<version>.rpm
162+
alien -i --scripts ArrowFlightSqlOdbc-<version>.rpm
142163
```
143164
144165
## Known Limitations
145166
146167
- 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.
147168
- Conversion from strings to big int data type has a limit range of -9007199254740992 to 9007199254740992.
169+
- On Linux, `isql` commands `tables` and `columns` don’t work due to GH-49702. Users are not blocked from fetching data tables.

0 commit comments

Comments
 (0)