GH-47787: [C++][FlightRPC] ODBC `msi` Windows installer #48054

alinaliBQ · 2025-11-04T23:31:22Z

Rationale for this change

Implement ODBC installer code for Windows. The primary platform for ODBC is MSVC Windows. The version is set to 1.0.0.

What changes are included in this PR?

ODBC msi installer
Added components to other parts of Arrow, so we can select ODBC component for cpack

Are these changes tested?

Tested locally on MSVC Windows

Are there any user-facing changes?

N/A

GitHub Issue: [C++][FlightSQL][ODBC] Windows Installer #47787

github-actions · 2025-11-04T23:31:48Z

⚠️ GitHub issue #47787 has been automatically assigned in GitHub to PR creator.

alinaliBQ

@lidavidm @kou This ODBC msi installer draft PR is ready for initial review. Please let me know your thoughts, thanks!

.github/workflows/cpp.yml

.gitignore

alinaliBQ · 2025-11-11T00:13:02Z

cpp/CMakeLists.txt

For installer to be able to select different components, we needed to add COMPONENT to other parts of Arrow cpp that gets build with ODBC.

alinaliBQ · 2025-11-11T00:14:14Z

cpp/src/arrow/flight/sql/odbc/install/windows/arrow-wix-banner.bmp

This is an image of Arrow banner

Minor fix for DSN Window So ODBC installed by installer works as intended Change Arrow odbc component name to `arrow_flight_sql_odbc` Add component name for `ARROW_BUILD_UTILITIES` * change component name for Flight SQL ODBC to be more consistent Use targets instead of hard-coded dll regex Add `RUNTIME ` removes `.lib` file Clean up Attempt to fix CI ODBC msi Add debug message for odbc bin install path Add ODBC Installer definitions Move path for Windows install files Extract ODBC installer Need to add `component` to other parts to be able to select the ODBC components Add product ID to Windows installer With stable product and upgrade id, Windows will be able to properly recognize ODBC installer as the same product, and prevent double-installation from happening. Update README Co-Authored-By: vic-tsang <victor.tsang@improving.com> Co-Authored-By: alinalibq <alina.li@improving.com>

kou · 2026-01-07T01:39:37Z

.github/workflows/cpp_extra.yml

+        run: |
+          # Verify WiX version
+          wix --version
+          cd "${{ github.workspace }}\build\cpp"


Can we simplify this?

Suggested change

cd "${{ github.workspace }}\build\cpp"

cd "build\cpp"

kou · 2026-01-07T01:39:51Z

.github/workflows/cpp_extra.yml

+        uses: actions/upload-artifact@v6
+        with:
+          name: flight-sql-odbc-msi-installer
+          path: ${{ github.workspace }}\build\cpp\Apache Arrow Flight SQL ODBC-1.0.0-win64.msi


Can we simplify this?

Suggested change

path: ${{ github.workspace }}\build\cpp\Apache Arrow Flight SQL ODBC-1.0.0-win64.msi

path: build\cpp\Apache Arrow Flight SQL ODBC-1.0.0-win64.msi

yup, removed ${{ github.workspace }}

kou · 2026-01-07T01:41:05Z

cpp/src/arrow/flight/sql/odbc/install/windows/arrow-flight-sql-odbc.wxs

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="windows-1252"?>


Is windows-1252 expected?
Can we use UTF-8 instead?

kou · 2026-01-07T01:42:04Z

cpp/src/arrow/flight/sql/odbc/install/windows/arrow-flight-sql-odbc.wxs

+          <RegistryKey Root="HKLM"
+                      Key="Software\ODBC\ODBCINST.INI\Apache Arrow Flight SQL ODBC Driver">
+                <!-- CM_FP_arrow_flight_sql_odbc.bin.arrow_flight_sql_odbc.dll is a generated variable value from build\_CPack_Packages\win64\WIX\files.wxs -->
+                <RegistryValue Type="string" Name="DriverODBCVer" Value="03.00"/>


Is this the version of our Flight SQL ODBC version?

Can we use the same version as Apache Arrow C++?

DriverODBCVer refers to the ODBC API version which is 3.0 for Flight SQL ODBC. The Flight SQL ODBC driver version is set by ODBC_PACKAGE_VERSION_* variables in CMake

kou · 2026-01-07T01:43:18Z

cpp/src/arrow/flight/sql/odbc/CMakeLists.txt

+set(ODBC_PACKAGE_VERSION_MAJOR "1")
+set(ODBC_PACKAGE_VERSION_MINOR "0")
+set(ODBC_PACKAGE_VERSION_PATCH "0")


Can we use the same version as Apache Arrow C++?

Yes, I have changed these values to corresponding arrow_VERSION_*.

kou · 2026-01-07T01:44:12Z

cpp/src/arrow/flight/sql/odbc/install/windows/versioninfo.rc.in

+// under the License.
+
+#define VER_FILEVERSION             @VER_FILEVERSION@
+#define VER_FILEVERSION_STR         "@VER_FILEVERSION_STR@\0"


Is \0 needed?

Yes I think so, I think it's because a null-terminated string is expected. I got it (\0) from Msft example here.

kou · 2026-01-07T01:45:34Z

cpp/src/arrow/flight/sql/odbc/CMakeLists.txt

+  set(CPACK_PACKAGE_NAME ${ODBC_PACKAGE_NAME})
+  set(CPACK_PACKAGE_VENDOR ${ODBC_PACKAGE_VENDOR})
+  set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Apache Arrow Flight SQL ODBC Driver")
+  set(CPACK_PACKAGE_CONTACT "#GH-47787 TODO arrow maintainers")


Do we need an e-mail address here?
If so, could you use dev@arrow.apache.org?

Yes email addresses are needed. I have changed it to dev@arrow.apache.org, thanks!

kou · 2026-01-07T01:48:02Z

cpp/src/arrow/flight/sql/odbc/CMakeLists.txt

+                      DISPLAY_NAME "ODBC library"
+                      DESCRIPTION "ODBC library bin, required to install"


I'm not sure whether this is used but do we need to include "Apache Arrow Flight SQL" or something in them?

Yes DESCRIPTION is used, and I have included "Apache Arrow Flight SQL". I don't hold a strong opinion on the DESCRIPTION value.

This is what it looks like in the installer :

kou · 2026-01-07T01:48:42Z

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

Could you add .md extension?

kou · 2026-01-07T01:49:50Z

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

+    iii. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC Driver
+    `.\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`


Suggested change

`.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd C:\path\to\arrow\cpp\build\release\Release\arrow_flight_sql_odbc.dll`

Need to replace <path\to\repo> with actual path to repository in the commands.

1. `cd to repo.`

2. `cd <path\to\repo>`

3. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC Driver

```

.\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

```

- Simplify CI - Update installer files - Update README.md Change to `README.md`

alinaliBQ

@kou Thanks for the review. All comments have been addressed

alinaliBQ · 2026-01-07T22:26:05Z

.github/workflows/cpp_extra.yml

+        run: |
+          # Verify WiX version
+          wix --version
+          cd "${{ github.workspace }}\build\cpp"


alinaliBQ · 2026-01-07T22:31:23Z

.github/workflows/cpp_extra.yml

+        uses: actions/upload-artifact@v6
+        with:
+          name: flight-sql-odbc-msi-installer
+          path: ${{ github.workspace }}\build\cpp\Apache Arrow Flight SQL ODBC-1.0.0-win64.msi


yup, removed ${{ github.workspace }}

alinaliBQ · 2026-01-07T22:44:24Z

cpp/src/arrow/flight/sql/odbc/install/windows/arrow-flight-sql-odbc.wxs

+          <RegistryKey Root="HKLM"
+                      Key="Software\ODBC\ODBCINST.INI\Apache Arrow Flight SQL ODBC Driver">
+                <!-- CM_FP_arrow_flight_sql_odbc.bin.arrow_flight_sql_odbc.dll is a generated variable value from build\_CPack_Packages\win64\WIX\files.wxs -->
+                <RegistryValue Type="string" Name="DriverODBCVer" Value="03.00"/>


DriverODBCVer refers to the ODBC API version which is 3.0 for Flight SQL ODBC. The Flight SQL ODBC driver version is set by ODBC_PACKAGE_VERSION_* variables in CMake

alinaliBQ · 2026-01-07T22:49:03Z

cpp/src/arrow/flight/sql/odbc/CMakeLists.txt

+set(ODBC_PACKAGE_VERSION_MAJOR "1")
+set(ODBC_PACKAGE_VERSION_MINOR "0")
+set(ODBC_PACKAGE_VERSION_PATCH "0")


Yes, I have changed these values to corresponding arrow_VERSION_*.

alinaliBQ · 2026-01-07T22:49:37Z

cpp/src/arrow/flight/sql/odbc/CMakeLists.txt

+set(ODBC_PACKAGE_VERSION_MINOR "0")
+set(ODBC_PACKAGE_VERSION_PATCH "0")
+set(ODBC_PACKAGE_NAME "Apache Arrow Flight SQL ODBC")
+set(ODBC_PACKAGE_VENDOR "Apache Arrow")


alinaliBQ · 2026-01-07T23:26:01Z

cpp/src/arrow/flight/sql/odbc/install/windows/versioninfo.rc.in

+// under the License.
+
+#define VER_FILEVERSION             @VER_FILEVERSION@
+#define VER_FILEVERSION_STR         "@VER_FILEVERSION_STR@\0"


Yes I think so, I think it's because a null-terminated string is expected. I got it (\0) from Msft example here.

alinaliBQ · 2026-01-07T23:30:31Z

cpp/src/arrow/flight/sql/odbc/CMakeLists.txt

+  set(CPACK_PACKAGE_NAME ${ODBC_PACKAGE_NAME})
+  set(CPACK_PACKAGE_VENDOR ${ODBC_PACKAGE_VENDOR})
+  set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Apache Arrow Flight SQL ODBC Driver")
+  set(CPACK_PACKAGE_CONTACT "#GH-47787 TODO arrow maintainers")


Yes email addresses are needed. I have changed it to dev@arrow.apache.org, thanks!

alinaliBQ · 2026-01-07T23:39:52Z

cpp/src/arrow/flight/sql/odbc/CMakeLists.txt

+                      DISPLAY_NAME "ODBC library"
+                      DESCRIPTION "ODBC library bin, required to install"


Yes DESCRIPTION is used, and I have included "Apache Arrow Flight SQL". I don't hold a strong opinion on the DESCRIPTION value.

This is what it looks like in the installer :

alinaliBQ · 2026-01-07T23:41:32Z

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

alinaliBQ · 2026-01-07T23:45:55Z

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

+    iii. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC Driver
+    `.\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`


kou

+1

conbench-apache-arrow · 2026-01-08T09:34:13Z

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 45cf928.

There weren't enough matching historic benchmark results to make a call on whether there were regressions.

The full Conbench report has more details.

github-actions bot added Component: C++ Component: FlightRPC awaiting review Awaiting review labels Nov 4, 2025

alinaliBQ force-pushed the gh-47787-odbc-msi-installer branch from ce5c956 to 34ebe24 Compare November 11, 2025 00:24

alinaliBQ commented Nov 11, 2025

View reviewed changes

alinaliBQ changed the title ~~GH-47787: [C++][FlightRPC] WIP: ODBC msi Windows installer~~ GH-47787: [C++][FlightRPC] ODBC msi Windows installer Nov 11, 2025

github-actions bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Nov 11, 2025

alinaliBQ mentioned this pull request Nov 11, 2025

GH-46734: [C++] Arrow Flight SQL ODBC layer #46099

Open

alinaliBQ force-pushed the gh-47787-odbc-msi-installer branch from 8487389 to 20ad8c6 Compare November 13, 2025 20:20

alinaliBQ changed the title ~~GH-47787: [C++][FlightRPC] ODBC msi Windows installer~~ GH-47787: [C++][FlightRPC] WIP ODBC msi Windows installer Nov 25, 2025

alinaliBQ force-pushed the gh-47787-odbc-msi-installer branch from 2728022 to 9199d85 Compare November 28, 2025 23:24

alinaliBQ mentioned this pull request Dec 3, 2025

GH-48312: [C++][FlightRPC] Standalone ODBC MSVC CI #48313

Merged

alinaliBQ changed the title ~~GH-47787: [C++][FlightRPC] WIP ODBC msi Windows installer~~ GH-47787: [C++][FlightRPC] ODBC msi Windows installer Dec 12, 2025

alinaliBQ force-pushed the gh-47787-odbc-msi-installer branch from 9199d85 to 6c8c099 Compare December 17, 2025 21:06

alinaliBQ marked this pull request as ready for review December 22, 2025 23:01

alinaliBQ requested review from assignUser, jonkeane, kou, lidavidm and raulcd as code owners December 22, 2025 23:01

github-actions bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Dec 26, 2025

alinaliBQ and others added 2 commits January 6, 2026 14:10

Apply David's suggestion

6731c9c

alinaliBQ force-pushed the gh-47787-odbc-msi-installer branch from 9c24910 to 6731c9c Compare January 6, 2026 22:11

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 6, 2026

Remove unneeded component code

19a72c2

kou reviewed Jan 7, 2026

View reviewed changes

github-actions bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 7, 2026

Work on Kou's comments

4a2c660

- Simplify CI - Update installer files - Update README.md Change to `README.md`

alinaliBQ commented Jan 7, 2026

View reviewed changes

github-actions bot added Component: Documentation awaiting change review Awaiting change review awaiting changes Awaiting changes and removed awaiting changes Awaiting changes awaiting change review Awaiting change review labels Jan 7, 2026

kou approved these changes Jan 8, 2026

View reviewed changes

kou merged commit 45cf928 into apache:main Jan 8, 2026
48 of 53 checks passed

kou removed the awaiting changes Awaiting changes label Jan 8, 2026

kou mentioned this pull request Jan 8, 2026

[C++][FlightSQL][ODBC] Windows Installer #47787

Closed

github-actions bot added the awaiting merge Awaiting merge label Jan 8, 2026

	path: ${{ github.workspace }}\build\cpp\Apache Arrow Flight SQL ODBC-1.0.0-win64.msi
	path: build\cpp\Apache Arrow Flight SQL ODBC-1.0.0-win64.msi

		@@ -0,0 +1,37 @@
		<?xml version="1.0" encoding="windows-1252"?>

		DISPLAY_NAME "ODBC library"
		DESCRIPTION "ODBC library bin, required to install"

GH-47787: [C++][FlightRPC] ODBC msi Windows installer #48054

GH-47787: [C++][FlightRPC] ODBC msi Windows installer #48054

Uh oh!

Conversation

alinaliBQ commented Nov 4, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

Uh oh!

github-actions bot commented Nov 4, 2025

Uh oh!

alinaliBQ left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alinaliBQ left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

GH-47787: [C++][FlightRPC] ODBC `msi` Windows installer #48054

GH-47787: [C++][FlightRPC] ODBC `msi` Windows installer #48054

alinaliBQ commented Nov 4, 2025 •

edited by github-actions bot

Loading