GH-47876: [C++][FlightRPC] ODBC: macOS `.PKG` installer for Intel and ARM by alinaliBQ · Pull Request #49766 · apache/arrow

alinaliBQ · 2026-04-15T17:58:08Z

Rationale for this change

Generate and upload macOS .pkg installer in CI. The installer is unsigned.

What changes are included in this PR?

Adds in support for macOS .PKG Installer for Intel and ARM. It will install:

/Library/ODBC/arrow-odbc
├── doc
│   ├── Connection-Options.md
│   └── LICENSE.txt
└── lib
    ├── libarrow_flight_sql_odbc.2400.0.0.dylib
    ├── libarrow_flight_sql_odbc.2400.dylib -> libarrow_flight_sql_odbc.2400.0.0.dylib
    └── libarrow_flight_sql_odbc.dylib -> libarrow_flight_sql_odbc.2400.dylib

3 directories, 5 files

If Apache Arrow Flight SQL ODBC is already registered in the system DSN on the user machine, the installer will not overwrite the registration.

Are these changes tested?

Tested on Intel macOS. Team will test ARM installer using ARM machine later.

Are there any user-facing changes?

Developers can download the .pkg installers for usage.

GitHub Issue: [C++][FlightRPC] ODBC macOS .pkg Installer #47876

github-actions · 2026-04-15T17:58:43Z

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

alinaliBQ · 2026-04-16T17:56:16Z

@lidavidm @kou PR is ready for review, please have a look

Copilot

Pull request overview

Adds macOS .pkg packaging support for the Arrow Flight SQL ODBC driver, integrating installer generation into CI and providing post-install registration scripts/resources.

Changes:

Add macOS CPack productbuild configuration for an ODBC .pkg installer (including postinstall registration and bundled docs).
Introduce a Unix DSN registration helper (install_odbc_ini.sh) and a macOS postinstall script to register the driver + DSN.
Update CI and repo configs to build/upload the .pkg and accommodate new installer resource files.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
dev/release/rat_exclude_files.txt	Excludes new macOS installer resource text files from RAT scanning.
cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc_ini.sh	Adds a DSN registration script for system `odbc.ini`.
cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh	Adjusts macOS driver registration to write to system `/Library/ODBC/odbcinst.ini`.
cpp/src/arrow/flight/sql/odbc/install/mac/postinstall	Adds post-install script to register driver + DSN and delete temporary scripts.
cpp/src/arrow/flight/sql/odbc/install/mac/Welcome.txt	Adds installer welcome text resource.
cpp/src/arrow/flight/sql/odbc/install/mac/README.txt	Adds installer readme text resource with setup steps.
cpp/src/arrow/flight/sql/odbc/Connection-Options.md	Adds a (currently placeholder) connection options doc intended to be shipped in the installer.
cpp/src/arrow/flight/sql/odbc/CMakeLists.txt	Adds macOS CPack config, installs driver/scripts/docs, and defines Docs component for UNIX.
.pre-commit-config.yaml	Adds new scripts to ShellCheck scope.
.github/workflows/cpp_extra.yml	Enables ODBC installer build, runs `cpack`, and uploads `.pkg` artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-18T12:02:48Z

+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/Connection-Options.md"
+            DESTINATION "${DOC_INSTALL_DIR}"
+            COMPONENT Docs)


Connection-Options.md is installed into the package (Docs component) but currently only contains a TODO placeholder. Since this is user-facing documentation shipped with the installer, it should either be populated with the supported keys/options or omitted from installation until it has real content.

Suggested change

install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/Connection-Options.md"

DESTINATION "${DOC_INSTALL_DIR}"

COMPONENT Docs)

The TODO will be addressed before this is shipped.

Copilot · 2026-04-18T12:02:48Z

+To setup a connection, you can use DSN to store your data source connection information.
+1. Open 'iODBC Data Source Administrator'.
+2. To create a user DSN, go to 'User DSN' tab and click 'Add'.
+3. Select 'Apache Arrow Flight SQL ODBC Driver' and click 'Finish'.
+4. Enter DSN name and connection string values. 
+For the list of all supported options, check '/Library/ODBC/arrow-odbc/doc/Connection-Options.md'.
+5. Click 'Ok' to save the DSN.


User-facing text fixes: change "To setup a connection" to "To set up a connection" (grammar), change "Ok" to "OK", and remove the trailing whitespace at the end of line 7. Since this README is used as an installer resource, it should be polished.

Suggested change

To setup a connection, you can use DSN to store your data source connection information.

1. Open 'iODBC Data Source Administrator'.

2. To create a user DSN, go to 'User DSN' tab and click 'Add'.

3. Select 'Apache Arrow Flight SQL ODBC Driver' and click 'Finish'.

4. Enter DSN name and connection string values.

For the list of all supported options, check '/Library/ODBC/arrow-odbc/doc/Connection-Options.md'.

5. Click 'Ok' to save the DSN.

To set up a connection, you can use DSN to store your data source connection information.

1. Open 'iODBC Data Source Administrator'.

2. To create a user DSN, go to 'User DSN' tab and click 'Add'.

3. Select 'Apache Arrow Flight SQL ODBC Driver' and click 'Finish'.

4. Enter DSN name and connection string values.

For the list of all supported options, check '/Library/ODBC/arrow-odbc/doc/Connection-Options.md'.

5. Click 'OK' to save the DSN.

Copilot · 2026-04-18T12:02:49Z

    # macOS
-    USER_ODBCINST_FILE="$HOME/Library/ODBC/odbcinst.ini"
-    mkdir -p "$HOME"/Library/ODBC
+    USER_ODBCINST_FILE="/Library/ODBC/odbcinst.ini"
+    mkdir -p /Library/ODBC


On macOS this script now writes to the system-level /Library/ODBC/odbcinst.ini, but the variable is still named USER_ODBCINST_FILE. Renaming it to reflect that it's a system-wide file would reduce confusion for future maintenance (especially since the script requires sudo).

Changed to ODBCINST_FILE.

Copilot · 2026-04-18T12:02:49Z

+# Use temporary driver registration script to register ODBC driver in system DSN
+odbc_install_script="/Library/ODBC/arrow-odbc/lib/install_odbc.sh"
+"$odbc_install_script" /Library/ODBC/arrow-odbc/lib/libarrow_flight_sql_odbc.dylib
+
+# Use temporary DSN registration script to register sample system DSN
+dsn_install_script="/Library/ODBC/arrow-odbc/lib/install_odbc_ini.sh"
+"$dsn_install_script" /Library/ODBC/odbc.ini
+
+# clean temporary script
+rm -f "$odbc_install_script"
+rm -f "$dsn_install_script"


The postinstall script doesn't enable strict error handling (e.g., set -euo pipefail). As written, if either registration script fails, the postinstall can still exit successfully because the final rm -f commands will return 0, leaving the driver/DSN unregistered while the installer reports success. Please fail fast on any error and consider emitting a clear error message if registration fails.

Copilot · 2026-04-18T12:02:49Z

+SYSTEM_ODBC_FILE="$1"
+
+if [[ -z "$SYSTEM_ODBC_FILE" ]]; then
+  echo "error: path to system ODBC DSN is not specified. Call format: install_odbc_ini abs_path_to_odbc_dsn_ini"
+  exit 1
+fi
+
+DRIVER_NAME="Apache Arrow Flight SQL ODBC Driver"
+DSN_NAME="Apache Arrow Flight SQL ODBC DSN"
+
+touch "$SYSTEM_ODBC_FILE"
+


This script doesn't use strict mode (set -euo pipefail) like install_odbc.sh does. Without it, failures from commands like touch, awk, or mv may go unnoticed depending on where they occur, which is risky for an installer-time system configuration update. Please add strict mode and ensure any failures propagate as a non-zero exit code.

Copilot · 2026-04-18T12:02:49Z

+# Check if [ODBC Data Sources] section exists
+if grep -q '^\[ODBC Data Sources\]' "$SYSTEM_ODBC_FILE"; then
+  # Section exists: check if DSN entry exists
+  if ! grep -q "^${DSN_NAME}=" "$SYSTEM_ODBC_FILE"; then
+    # Add DSN entry under [ODBC Data Sources] section
+
+    # Use awk to insert the line immediately after [ODBC Data Sources]
+    awk -v dsn="$DSN_NAME" -v driver="$DRIVER_NAME" '
+      $0 ~ /^\[ODBC Data Sources\]/ && !inserted {
+        print
+        print dsn "=" driver
+        inserted=1
+        next
+      }
+      { print }
+    ' "$SYSTEM_ODBC_FILE" > "${SYSTEM_ODBC_FILE}.tmp" && mv "${SYSTEM_ODBC_FILE}.tmp" "$SYSTEM_ODBC_FILE"
+  fi


The DSN existence check under [ODBC Data Sources] only matches entries formatted exactly as Apache Arrow Flight SQL ODBC DSN=.... In many odbc.ini files the = is surrounded by whitespace (e.g., DSN_NAME = Driver), so this can fail to detect an existing entry and insert a duplicate. Consider matching optional whitespace around = (and/or parsing the section more robustly) before inserting.

We now check for possible whitespace.

kou · 2026-04-18T12:09:46Z

+      # GH-49595: TODO implement DEB installer
+      # GH-47977: TODO implement RPM installer
+      message(STATUS "ODBC_PACKAGE_FORMAT DEB not implemented, see GH-49595")
+      message(STATUS "ODBC_PACKAGE_FORMAT RPM not implemented, see GH-47977")


Do you want to use CPack for deb and RPM?
I want to use https://github.com/apache/arrow/tree/main/dev/tasks/linux-packages for them.

@kou Yes we would like to use CPack for the deb and RPM Linux ODBC installers. The goal is to have deb and rpm installers on Linux that are comparable to the Windows and macOS ODBC installers. By using CPack, we will be able make the installer run ODBC registration scripts and install the docs etc.

I have raised GitHub issues for using linux-packages to create deb and rpm installers:

DEB [C++][FlightRPC][ODBC] linux-packages DEB installer #49829

RPM [C++][FlightRPC][ODBC] linux-packages RPM installer #49830

These are currently unassigned

cc @lidavidm

cc @raulcd, as mentioned in the Arrow community meeting, this is the PR thread discussion regarding linux-packages

By using CPack, we will be able make the installer run ODBC registration scripts and install the docs etc.

We can do it with dev/tasks/linux-packages/.

If we use CPack, we can't share libarrow.so with the ODBC package and other packages such as libarrow-flight2400. Do you want to manage ODBC packages separately from other existing packages?

@kou Sorry I missed this comment from earlier. Yes for now we can manage ODBC packages separately from other packages, as currently I don't have capacity for implementing installers with dev/tasks/linux-packages/.
cc @lidavidm

OK. I'll work on deb/RPM in dev/tasks/linux-packages/.

kou · 2026-04-18T12:15:38Z

+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../LICENSE.txt"
+            DESTINATION "${DOC_INSTALL_DIR}"
+            COMPONENT Docs)


LICENSE.txt (and NOTICE.txt) are already installed to ARROW_DOC_DIR. Do we need to install them separately for ODBC?

Yes, a separate install command is needed for ODBC here. During Windows ODBC implementation, we noticed Unspecified components that are not ODBC-related (such as file system stream executables), so we excluded all Unspecified components from the ODBC installer.

I assume we are talking about:

arrow/cpp/CMakeLists.txt

Lines 697 to 699 in acd8e44

install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/../LICENSE.txt

${CMAKE_CURRENT_SOURCE_DIR}/../NOTICE.txt

${CMAKE_CURRENT_SOURCE_DIR}/README.md DESTINATION "${ARROW_DOC_DIR}")

Cmake marks install(... ${ARROW_DOC_DIR}) command as Unspecified since it doesn't set a COMPONENT. Therefore it isn't picked up by the ODBC installer.

If we specify COMPONENT Docs to

arrow/cpp/CMakeLists.txt

Lines 697 to 699 in acd8e44

install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/../LICENSE.txt

${CMAKE_CURRENT_SOURCE_DIR}/../NOTICE.txt

${CMAKE_CURRENT_SOURCE_DIR}/README.md DESTINATION "${ARROW_DOC_DIR}")

, can we remove this?

We need to install not only LICENSE.txt but also NOTICE.txt.

Theoretically it can work for ODBC installer, but adding COMPONENT Docs in arrow/cpp/CMakeLists.txt will change the Arrow installer behavior. When the COMPONENT is the default Unspecified, these files are installed by default (unless we actively exclude Unspecified components like we do with ODBC installer). Once assigned to a COMPONENT, these files will only be installed when Docs is explicitly included in the Arrow installer. I don't have enough context with Arrow installer to make this change, and I will leave this to folks with more context.

cc @justing-bq For ODBC, I suggest we can do these 2 things in cpp/src/arrow/flight/sql/odbc/CMakeLists.txt:

add NOTICE.txt to the ODBC Doc component.

add Doc component to Windows platform by changing the set(CPACK_COMPONENTS_ALL line to

set(CPACK_COMPONENTS_ALL "ArrowFlightSQLODBC" "Docs")

and remove

list(APPEND CPACK_COMPONENTS_ALL Docs)

and also remove the if(UNIX) wrapper for cpack_add_component(Docs

alinaliBQ · 2026-04-21T17:25:55Z

@justing-bq Could you help with addressing the comments here, thank you

justing-bq · 2026-04-24T00:12:22Z

@lidavidm @kou
Please take a look when you have time.

Co-authored-by: vic-tsang <victor.tsang@improving.com> cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc_ini.sh is originally authored by vic-tsang <victor.tsang@improving.com> --------------------------------------- * Initial draft for macOS .pkg installer * in-progress for `install_odbc` * Remove `$HOME` from registration script * Generate .pkg installer and attempts to fix installer * Attempt to fix doc not seen * Attempt to fix ODBC registration script * Fix installer script and doc * Rename `install_odbc_ini.sh` to `postinstall` * Reuse `install_odbc.sh` script inside `postinstall` * Fix to generate macOS installer - Check $(pwd)/build/cpp * Clean up PR and todos * Update format to re-use code * Use `install_odbc_ini.sh` script to install DSN Keep a lightweight `postinstall` file for macOS * Update install_odbc_ini.sh execution access * Address Justin's comment

alinaliBQ

@kou Thanks for reviewing, I think @justing-bq has addressed your comments

alinaliBQ · 2026-05-07T17:27:55Z

+      # GH-49595: TODO implement DEB installer
+      # GH-47977: TODO implement RPM installer
+      message(STATUS "ODBC_PACKAGE_FORMAT DEB not implemented, see GH-49595")
+      message(STATUS "ODBC_PACKAGE_FORMAT RPM not implemented, see GH-47977")


@kou Sorry I missed this comment from earlier. Yes for now we can manage ODBC packages separately from other packages, as currently I don't have capacity for implementing installers with dev/tasks/linux-packages/.
cc @lidavidm

kou

Could you rebase on main to fix known CI failures?

kou · 2026-05-08T01:01:17Z

+      # GH-49595: TODO implement DEB installer
+      # GH-47977: TODO implement RPM installer
+      message(STATUS "ODBC_PACKAGE_FORMAT DEB not implemented, see GH-49595")
+      message(STATUS "ODBC_PACKAGE_FORMAT RPM not implemented, see GH-47977")


OK. I'll work on deb/RPM in dev/tasks/linux-packages/.

kou · 2026-05-08T01:02:55Z

+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../LICENSE.txt"
+            DESTINATION "${DOC_INSTALL_DIR}"
+            COMPONENT Docs)


If we specify COMPONENT Docs to

arrow/cpp/CMakeLists.txt

Lines 697 to 699 in acd8e44

install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/../LICENSE.txt

${CMAKE_CURRENT_SOURCE_DIR}/../NOTICE.txt

${CMAKE_CURRENT_SOURCE_DIR}/README.md DESTINATION "${ARROW_DOC_DIR}")

, can we remove this?

We need to install not only LICENSE.txt but also NOTICE.txt.

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

+if grep -q '^\[ODBC Drivers\]' "$ODBCINST_FILE"; then
  # Section exists: check if driver entry exists
-  if ! grep -q "^${DRIVER_NAME}=" "$USER_ODBCINST_FILE"; then
+  if ! grep -q "^${DRIVER_NAME}=" "$ODBCINST_FILE"; then
    # Driver entry does not exist, add under [ODBC Drivers]
    sed -i '' "/^\[ODBC Drivers\]/a\\
 ${DRIVER_NAME}=Installed
-" "$USER_ODBCINST_FILE"
+" "$ODBCINST_FILE"


+    else()
+      # Linux
+      # GH-49595: TODO implement DEB installer
+      # GH-47977: TODO implement RPM installer
+      message(STATUS "ODBC_PACKAGE_FORMAT DEB not implemented, see GH-49595")
+      message(STATUS "ODBC_PACKAGE_FORMAT RPM not implemented, see GH-47977")
+    endif()
+
+    # Install ODBC
+    install(TARGETS arrow_flight_sql_odbc_shared
+            DESTINATION "${ODBC_INSTALL_DIR}"
+            COMPONENT ArrowFlightSQLODBC)


alinaliBQ · 2026-05-08T22:39:19Z

Thank you kou! Our team will resume addressing comments the week of May 19th, as Justin is out of office.

github-actions Bot added the awaiting review Awaiting review label Apr 15, 2026

github-actions Bot added Component: C++ Component: FlightRPC Component: Documentation CI: Extra: C++ Run extra C++ CI labels Apr 15, 2026

alinaliBQ force-pushed the gh-47876-mac-pkg branch 2 times, most recently from fcb4971 to 1b8f118 Compare April 15, 2026 21:01

alinaliBQ marked this pull request as ready for review April 16, 2026 17:55

alinaliBQ requested review from assignUser, jonkeane, kou, lidavidm and raulcd as code owners April 16, 2026 17:55

alinaliBQ mentioned this pull request Apr 17, 2026

GH-47877: [C++][FlightRPC] ODBC Linux rpm installer support with Cpack #49787

Draft

kou requested a review from Copilot April 18, 2026 11:58

Copilot started reviewing on behalf of kou April 18, 2026 11:58 View session

Copilot AI reviewed Apr 18, 2026

View reviewed changes

kou reviewed Apr 18, 2026

View reviewed changes

github-actions Bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Apr 18, 2026

github-actions Bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Apr 21, 2026

justing-bq force-pushed the gh-47876-mac-pkg branch from 28a2a8c to eaf55a8 Compare April 21, 2026 21:43

alinaliBQ requested a review from kou April 22, 2026 17:16

alinaliBQ mentioned this pull request Apr 22, 2026

[C++][FlightRPC] ODBC macOS .pkg Installer #47876

Open

justing-bq force-pushed the gh-47876-mac-pkg branch from eaf55a8 to 9c3784e Compare April 22, 2026 19:58

alinaliBQ force-pushed the gh-47876-mac-pkg branch from 9c3784e to 4e55c78 Compare April 23, 2026 20:54

github-actions Bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Apr 27, 2026

kou reviewed Apr 27, 2026

View reviewed changes

justing-bq force-pushed the gh-47876-mac-pkg branch from 4e55c78 to b28e41f Compare April 27, 2026 21:11

github-actions Bot added awaiting change review Awaiting change review awaiting changes Awaiting changes and removed awaiting changes Awaiting changes awaiting change review Awaiting change review labels Apr 27, 2026

justing-bq force-pushed the gh-47876-mac-pkg branch from b28e41f to c34f4db Compare April 30, 2026 22:02

github-actions Bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Apr 30, 2026

alinaliBQ requested a review from kou May 4, 2026 18:02

justing-bq force-pushed the gh-47876-mac-pkg branch from c34f4db to e0ed80b Compare May 4, 2026 21:00

alinaliBQ and others added 3 commits May 5, 2026 14:26

Address feedback

2d3bc48

More feedback

7d4b1a8

justing-bq force-pushed the gh-47876-mac-pkg branch from e0ed80b to 7d4b1a8 Compare May 5, 2026 21:26

alinaliBQ commented May 7, 2026

View reviewed changes

kou reviewed May 8, 2026

View reviewed changes

kou requested a review from Copilot May 8, 2026 01:04

github-actions Bot removed the awaiting change review Awaiting change review label May 8, 2026

Copilot started reviewing on behalf of kou May 8, 2026 01:05 View session

github-actions Bot added the awaiting changes Awaiting changes label May 8, 2026

Copilot AI reviewed May 8, 2026

View reviewed changes

	install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/Connection-Options.md"
	DESTINATION "${DOC_INSTALL_DIR}"
	COMPONENT Docs)

	install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/../LICENSE.txt
	${CMAKE_CURRENT_SOURCE_DIR}/../NOTICE.txt
	${CMAKE_CURRENT_SOURCE_DIR}/README.md DESTINATION "${ARROW_DOC_DIR}")

Conversation

alinaliBQ commented Apr 15, 2026 • edited by kou 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 Apr 15, 2026

Uh oh!

alinaliBQ commented Apr 16, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

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 May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alinaliBQ commented Apr 21, 2026

Uh oh!

justing-bq commented Apr 24, 2026

Uh oh!

Uh oh!

Uh oh!

alinaliBQ commented Apr 15, 2026 •

edited by kou

Loading

alinaliBQ May 8, 2026 •

edited

Loading