GH-47876: [C++][FlightRPC] ODBC: macOS .PKG installer for Intel and ARM

.github/workflows/cpp_extra.yml

@@ -428,6 +428,7 @@ jobs:
       ARROW_DEPENDENCY_SOURCE: BUNDLED
       ARROW_DEPENDENCY_USE_SHARED: OFF
       ARROW_FLIGHT_SQL_ODBC: ON
+      ARROW_FLIGHT_SQL_ODBC_INSTALLER: ON
       ARROW_HOME: /tmp/local
       ARROW_MIMALLOC: OFF
     steps:
@@ -503,6 +504,19 @@ jobs:
             --allow libresolv \
             --allow libz \
             "$(pwd)/build/cpp/${{ matrix.build-type }}/libarrow_flight_sql_odbc.dylib"
+      - name: Generate macOS Installer
+        if: matrix.build-type == 'release'
+        shell: bash
+        run: |
+            cd $(pwd)/build/cpp
+            cpack
+      - name: Upload ODBC PKG to the job
+        if: matrix.build-type == 'release'
+        uses: actions/upload-artifact@v7
+        with:
+          name: flight-sql-odbc-pkg-installer-${{ matrix.architecture }}
+          path: build/cpp/ArrowFlightSqlOdbc-*.pkg
+          if-no-files-found: error
       - name: Register Flight SQL ODBC Driver
         run: |
           sudo cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh $(pwd)/build/cpp/${{ matrix.build-type }}/libarrow_flight_sql_odbc.dylib

.pre-commit-config.yaml

@@ -347,7 +347,9 @@ repos:
           ?^cpp/build-support/update-thrift\.sh$|
           ?^cpp/examples/minimal_build/run\.sh$|
           ?^cpp/examples/tutorial_examples/run\.sh$|
+          ?^cpp/src/arrow/flight/sql/odbc/install/mac/postinstall$|
           ?^cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc\.sh$|
+          ?^cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc_ini\.sh$|
           ?^dev/release/05-binary-upload\.sh$|
           ?^dev/release/07-flightsqlodbc-upload\.sh$|
           ?^dev/release/09-binary-verify\.sh$|

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

@@ -132,7 +132,6 @@ if(ARROW_FLIGHT_SQL_ODBC_INSTALLER)
   set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Apache Arrow Flight SQL ODBC Driver")
   set(CPACK_PACKAGE_CONTACT "dev@arrow.apache.org")
 
-  # GH-47876 TODO: set up `arrow_flight_sql_odbc` component for macOS Installer
   # GH-47877 TODO: set up `arrow_flight_sql_odbc` component for Linux Installer
   if(WIN32)
     # Install ODBC and its Arrow dependencies
@@ -159,6 +158,66 @@ if(ARROW_FLIGHT_SQL_ODBC_INSTALLER)
 
     set(CPACK_WIX_UI_BANNER
         "${CMAKE_CURRENT_SOURCE_DIR}/install/windows/arrow-wix-banner.bmp")
+  else()
+    if(APPLE)
+      set(CPACK_PACKAGE_FILE_NAME
+          "ArrowFlightSqlOdbc-${CPACK_PACKAGE_VERSION_MAJOR}.${ODBC_PACKAGE_VERSION_MINOR}.${ODBC_PACKAGE_VERSION_PATCH}"
+      )
+      set(CPACK_PACKAGE_INSTALL_DIRECTORY "${CPACK_PACKAGE_NAME}")
+
+      set(CPACK_SET_DESTDIR ON)
+      set(CPACK_INSTALL_PREFIX "/Library/ODBC")
+      # Register ODBC after install
+      set(CPACK_POSTFLIGHT_ARROW_FLIGHT_SQL_ODBC_SCRIPT
+          "${CMAKE_CURRENT_SOURCE_DIR}/install/mac/postinstall")
+      set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/install/mac/README.txt")
+      set(CPACK_RESOURCE_FILE_WELCOME
+          "${CMAKE_CURRENT_SOURCE_DIR}/install/mac/welcome.txt")
+
+      set(ODBC_INSTALL_DIR "arrow-odbc/lib")
+      set(ODBC_DOC_INSTALL_DIR "arrow-odbc/doc")
+    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 arrow_flight_sql_odbc)
+
+    # Install temporary driver registration scripts, they will be removed after driver registration is complete
+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/install/unix/install_odbc.sh"
+            DESTINATION "${ODBC_INSTALL_DIR}"
+            COMPONENT arrow_flight_sql_odbc
+            PERMISSIONS OWNER_EXECUTE
+                        OWNER_WRITE
+                        OWNER_READ
+                        GROUP_EXECUTE
+                        GROUP_READ
+                        WORLD_EXECUTE
+                        WORLD_READ)
+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/install/unix/install_odbc_ini.sh"
+            DESTINATION "${ODBC_INSTALL_DIR}"
+            COMPONENT arrow_flight_sql_odbc
+            PERMISSIONS OWNER_EXECUTE
+                        OWNER_WRITE
+                        OWNER_READ
+                        GROUP_EXECUTE
+                        GROUP_READ
+                        WORLD_EXECUTE
+                        WORLD_READ)
+
+    # Install documentation files
+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../LICENSE.txt"
+            DESTINATION "${ODBC_DOC_INSTALL_DIR}"
+            COMPONENT Docs)
+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/connection-options.md"
+            DESTINATION "${ODBC_DOC_INSTALL_DIR}"
+            COMPONENT Docs)
   endif()
 
   get_cmake_property(CPACK_COMPONENTS_ALL COMPONENTS)
@@ -173,8 +232,13 @@ if(ARROW_FLIGHT_SQL_ODBC_INSTALLER)
     # Upgrade GUID is required to be unchanged for ODBC installer to upgrade
     set(CPACK_WIX_UPGRADE_GUID "DBF27A18-F8BF-423F-9E3A-957414D52C4B")
     set(CPACK_WIX_PRODUCT_GUID "279D087B-93B5-4DC3-BA69-BCF485022A26")
+  else()
+    # macOS and Linux
+    list(APPEND CPACK_COMPONENTS_ALL Docs)
+    if(APPLE)
+      set(CPACK_GENERATOR "productbuild")
+    endif()
   endif()
-  # GH-47876 TODO: create macOS Installer using cpack
   # GH-47877 TODO: create Linux Installer using cpack
 
   # Load CPack after all CPACK* variables are set
@@ -183,4 +247,11 @@ if(ARROW_FLIGHT_SQL_ODBC_INSTALLER)
                       DISPLAY_NAME "ODBC library"
                       DESCRIPTION "Apache Arrow Flight SQL ODBC library bin, required to install"
                       REQUIRED)
+  if(UNIX)
+    # On macOS and Linux, provide connection string documentation since users need to manually enter DSN keys.
+    cpack_add_component(Docs
+                        DISPLAY_NAME "Documentation"
+                        DESCRIPTION "Documentation for Apache Arrow Flight SQL ODBC Driver"
+    )
+  endif()
 endif()

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

@@ -0,0 +1,20 @@
+<!---
+  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.
+-->
+
+GH-49723 TODO: enter ODBC connection options for unix DSN

cpp/src/arrow/flight/sql/odbc/install/mac/README.txt

@@ -0,0 +1,9 @@
+Files are available in '/Library/ODBC/arrow-odbc' after installation.
+
+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.

cpp/src/arrow/flight/sql/odbc/install/mac/postinstall

@@ -0,0 +1,48 @@
+#!/bin/bash
+#
+# 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.
+
+set -euo pipefail
+
+odbc_install_script="/Library/ODBC/arrow-odbc/lib/install_odbc.sh"
+dsn_install_script="/Library/ODBC/arrow-odbc/lib/install_odbc_ini.sh"
+driver_lib="/Library/ODBC/arrow-odbc/lib/libarrow_flight_sql_odbc.dylib"
+dsn_file="/Library/ODBC/odbc.ini"
+
+if [[ ! -x "$odbc_install_script" ]]; then
+  echo "ERROR: ODBC install script $odbc_install_script not found" >&2
+  exit 1
+fi
+
+"$odbc_install_script" "$driver_lib" || {
+  echo "ERROR: Failed to register ODBC driver ($driver_lib)" >&2
+  exit 1
+}
+
+if [[ ! -x "$dsn_install_script" ]]; then
+  echo "ERROR: DSN install script $dsn_install_script not found" >&2
+  exit 1
+fi
+
+"$dsn_install_script" "$dsn_file" || {
+  echo "ERROR: Failed to register DSN to ($dsn_file)" >&2
+  exit 1
+}
+
+# clean temporary script
+rm -f "$odbc_install_script" "$dsn_install_script"

cpp/src/arrow/flight/sql/odbc/install/mac/welcome.txt

@@ -0,0 +1 @@
+Apache Arrow Flight SQL ODBC Driver is a read-only ODBC driver for connecting to data sources that support Arrow Flight SQL.

cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc.sh

@@ -17,7 +17,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-# Used by macOS ODBC installer script `install_odbc_ini.sh` and macOS ODBC testing
+# Used by arrow/cpp/src/arrow/flight/sql/odbc/install/mac/postinstall
 
 set -euo pipefail
 
@@ -42,44 +42,44 @@ fi
 
 case "$(uname)" in
   Linux)
-    USER_ODBCINST_FILE="/etc/odbcinst.ini"
+    ODBCINST_FILE="/etc/odbcinst.ini"
     ;;
   *)
     # macOS
-    USER_ODBCINST_FILE="$HOME/Library/ODBC/odbcinst.ini"
-    mkdir -p "$HOME"/Library/ODBC
+    ODBCINST_FILE="/Library/ODBC/odbcinst.ini"
+    mkdir -p /Library/ODBC
     ;;
 esac
 
 DRIVER_NAME="Apache Arrow Flight SQL ODBC Driver"
 
-touch "$USER_ODBCINST_FILE"
+touch "$ODBCINST_FILE"
 
-if grep -q "^\[$DRIVER_NAME\]" "$USER_ODBCINST_FILE"; then
+if grep -q "^\[$DRIVER_NAME\]" "$ODBCINST_FILE"; then
   echo "Driver [$DRIVER_NAME] already exists in odbcinst.ini"
 else
   echo "Adding [$DRIVER_NAME] to odbcinst.ini..."
   echo "
 [$DRIVER_NAME]
 Description=An ODBC Driver for Apache Arrow Flight SQL
 Driver=$ODBC_64BIT
-" >>"$USER_ODBCINST_FILE"
+" >>"$ODBCINST_FILE"
 fi
 
 # Check if [ODBC Drivers] section exists
-if grep -q '^\[ODBC Drivers\]' "$USER_ODBCINST_FILE"; then
+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"
   fi
 else
   # Section doesn't exist, append both section and driver entry at end
   {
     echo ""
     echo "[ODBC Drivers]"
     echo "${DRIVER_NAME}=Installed"
-  } >>"$USER_ODBCINST_FILE"
+  } >>"$ODBCINST_FILE"
 fi

cpp/src/arrow/flight/sql/odbc/install/unix/install_odbc_ini.sh

@@ -0,0 +1,81 @@
+#!/bin/bash
+#
+# 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.
+
+set -euo pipefail
+
+SYSTEM_ODBC_FILE="${1:-}"
+
+if [[ -z "$SYSTEM_ODBC_FILE" ]]; then
+  echo "ERROR: path to system ODBC DSN is not specified." >&2
+  echo "Usage: install_odbc_ini.sh <abs_path_to_odbc_dsn_ini>" >&2
+  exit 1
+fi
+
+DRIVER_NAME="Apache Arrow Flight SQL ODBC Driver"
+DSN_NAME="Apache Arrow Flight SQL ODBC DSN"
+
+if ! touch "$SYSTEM_ODBC_FILE"; then
+  echo "ERROR: Cannot access or create $SYSTEM_ODBC_FILE" >&2
+  exit 1
+fi
+
+if grep -q "^\[$DSN_NAME\]" "$SYSTEM_ODBC_FILE"; then
+  echo "DSN [$DSN_NAME] already exists in $SYSTEM_ODBC_FILE"
+else
+  echo "Adding [$DSN_NAME] to $SYSTEM_ODBC_FILE..."
+  cat >> "$SYSTEM_ODBC_FILE" <<EOF
+
+[$DSN_NAME]
+Description = An ODBC Driver DSN for Apache Arrow Flight SQL
+Driver      = $DRIVER_NAME
+Host        =
+Port        =
+UID         =
+PWD         =
+EOF
+fi
+
+# 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 -Eq "^${DSN_NAME}[[:space:]]*=" "$SYSTEM_ODBC_FILE"; then
+    # Add DSN entry under [ODBC Data Sources] section
+    tmp_file="$(mktemp "${SYSTEM_ODBC_FILE}.XXXX")"
+
+    # 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" > "$tmp_file"
+
+    mv "$tmp_file" "$SYSTEM_ODBC_FILE"
+  fi
+else
+  # Section doesn't exist, append section and DSN entry at end
+  {
+    echo ""
+    echo "[ODBC Data Sources]"
+    echo "${DSN_NAME}=${DRIVER_NAME}"
+  } >> "$SYSTEM_ODBC_FILE"
+fi

dev/release/rat_exclude_files.txt

@@ -13,6 +13,8 @@ ci/vcpkg/*.patch
 CHANGELOG.md
 cpp/CHANGELOG_PARQUET.md
 cpp/src/arrow/c/dlpack_abi.h
+cpp/src/arrow/flight/sql/odbc/install/mac/README.txt
+cpp/src/arrow/flight/sql/odbc/install/mac/welcome.txt
 cpp/src/arrow/io/mman.h
 cpp/src/arrow/util/random.h
 cpp/src/arrow/status.cc