Mac Setup ODBC ini Script

* added setup script for mac and platform folders

updated read me windows file path

updated windows folder related file paths

added license

Fix Lint issues

Add install ODBC script

Update install_odbc_ini.sh

This script depends on the ODBC install script.

Add TODO note and update DSN

* Fix typo in README

---------

Co-authored-by: Alina (Xi) Li <[email protected]>
Co-authored-by: vic-tsang <[email protected]>

Author: vic-tsang

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

@@ -58,7 +58,7 @@ if(WIN32)
   set(VER_COMPANYNAME_STR ${ODBC_PACKAGE_VENDOR})
   set(VER_PRODUCTNAME_STR ${ODBC_PACKAGE_NAME})
 
-  configure_file("install/versioninfo.rc.in" "install/versioninfo.rc" @ONLY)
+  configure_file("install/windows/versioninfo.rc.in" "install/versioninfo.rc" @ONLY)
 
   list(APPEND ARROW_FLIGHT_SQL_ODBC_SRCS odbc.def install/versioninfo.rc)
 endif()
@@ -136,11 +136,12 @@ if(ARROW_FLIGHT_SQL_ODBC_INSTALLER)
             PATTERN "zlib1.dll")
 
     set(CPACK_WIX_EXTRA_SOURCES
-        "${CMAKE_CURRENT_SOURCE_DIR}/install/arrow-flight-sql-odbc.wxs")
+        "${CMAKE_CURRENT_SOURCE_DIR}/install/windows/arrow-flight-sql-odbc.wxs")
     set(CPACK_WIX_PATCH_FILE
-        "${CMAKE_CURRENT_SOURCE_DIR}/install/arrow-flight-sql-odbc-patch.xml")
+        "${CMAKE_CURRENT_SOURCE_DIR}/install/windows/arrow-flight-sql-odbc-patch.xml")
 
-    set(CPACK_WIX_UI_BANNER "${CMAKE_CURRENT_SOURCE_DIR}/install/arrow-wix-banner.bmp")
+    set(CPACK_WIX_UI_BANNER
+        "${CMAKE_CURRENT_SOURCE_DIR}/install/windows/arrow-wix-banner.bmp")
   endif()
 
   get_cmake_property(CPACK_COMPONENTS_ALL COMPONENTS)

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

@@ -30,9 +30,9 @@ After the build succeeds, the ODBC DLL will be located in
     i. `cd to repo.`
     ii. `cd <path\to\repo>`
     iii. Run script to register your ODBC DLL as Apache Arrow Flight SQL ODBC Driver
-    `.\cpp\src\arrow\flight\sql\odbc\install\install_amd64.cmd <path\to\repo>\cpp\build\< release | debug >\< Release | Debug>\arrow_flight_sql_odbc.dll`
+    `.\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\install\install_amd64.cmd C:\path\to\arrow\cpp\build\release\Release\arrow_flight_sql_odbc.dll`
+    `.\cpp\src\arrow\flight\sql\odbc\tests\install_odbc.cmd C:\path\to\arrow\cpp\build\release\Release\arrow_flight_sql_odbc.dll`
 
 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.
@@ -44,6 +44,27 @@ should show as an available ODBC driver in the x64 ODBC Driver Manager.
 
 If the generation is successful, you will find `Apache Arrow Flight SQL ODBC-<version>-win64.msi` generated under the `build` folder.
 
+## Steps to Register the 64-bit Apache Arrow ODBC driver on macOS
+
+After the build succeeds, the ODBC DYLIB will be located in 
+`build\debug` for a debug build and `build\release` for a release build.
+
+1. Open terminal shell.
+
+2. Register your ODBC DYLIB:
+    Need to replace <path\to\repo> with actual path to repository in the commands.
+
+    i. `cd to repo.`
+    ii. `cd <path\to\repo>`
+    iii. Give script permission to execute
+    `chmod +x cpp/src/arrow/flight/sql/odbc/install/mac/install_odbc.sh`
+    iv. Run script with `sudo` to register your ODBC DYLIB as Apache Arrow Flight SQL ODBC Driver
+    `sudo cpp/src/arrow/flight/sql/odbc/install/mac/install_odbc.sh <path\to\repo>/cpp/build/< release | debug >/libarrow_flight_sql_odbc.dylib`
+    Example command for reference:
+    `sudo cpp/src/arrow/flight/sql/odbc/install/mac/install_odbc.sh /path/to/arrow/cpp/build/release/libarrow_flight_sql_odbc.dylib`
+
+If the registration is successful, then Apache Arrow Flight SQL ODBC Driver 
+should be shown at `~/Library/ODBC/odbcinst.ini`
 
 ## Steps to Enable Logging
 Arrow Flight SQL ODBC driver uses Arrow's internal logging framework. By default, the log messages are printed to the terminal.

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

@@ -0,0 +1,74 @@
+#!/bin/sh
+#
+# 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.
+
+# Used by macOS ODBC installer script and macOS ODBC testing
+
+ODBC_64BIT="$1"
+
+if [[ -z "$ODBC_64BIT" ]]; then
+  echo "error: 64-bit driver is not specified. Call format: install_odbc abs_path_to_64_bit_driver"
+  exit 1
+fi
+
+if [ ! -f $ODBC_64BIT ]; then
+    echo "64-bit driver can not be found: $ODBC_64BIT"
+	  echo "Call format: install_odbc abs_path_to_64_bit_driver"
+    exit 1
+fi
+
+USER_ODBCINST_FILE="$HOME/Library/ODBC/odbcinst.ini"
+DRIVER_NAME="Apache Arrow Flight SQL ODBC Driver"
+DSN_NAME="Apache Arrow Flight SQL ODBC DSN"
+
+touch "$USER_ODBCINST_FILE"
+
+# Admin privilege is needed to add ODBC driver registration
+if [ $EUID -ne 0 ]; then 
+    echo "Please run this script with sudo"
+    exit 1
+fi
+
+if grep -q "^\[$DRIVER_NAME\]" "$USER_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"
+fi
+
+# Check if [ODBC Drivers] section exists
+if grep -q '^\[ODBC Drivers\]' "$USER_ODBCINST_FILE"; then
+  # Section exists: check if driver entry exists
+  if ! grep -q "^${DRIVER_NAME}=" "$USER_ODBCINST_FILE"; then
+    # Driver entry does not exist, add under [ODBC Drivers]
+    sed -i '' "/^\[ODBC Drivers\]/a\\
+${DRIVER_NAME}=Installed
+" "$USER_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"
+fi

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

@@ -0,0 +1,82 @@
+#!/bin/sh
+#
+# 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-47876 TODO: create macOS ODBC Installer.
+# Script for installing macOS ODBC driver, to be used for macOS installer.
+
+source_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+odbc_install_script="${source_dir}/install_odbc.sh"
+
+chmod +x "$odbc_install_script"
+. "$odbc_install_script" /Library/Apache/ArrowFlightSQLODBC/lib/libarrow_flight_sql_odbc.dylib
+
+USER_ODBC_FILE="$HOME/Library/ODBC/odbc.ini"
+DRIVER_NAME="Apache Arrow Flight SQL ODBC Driver"
+DSN_NAME="Apache Arrow Flight SQL ODBC DSN"
+
+touch "$USER_ODBC_FILE"
+
+if [ $EUID -ne 0 ]; then 
+    echo "Please run this script with sudo"
+    exit 1
+fi
+
+if grep -q "^\[$DSN_NAME\]" "$USER_ODBC_FILE"; then
+  echo "DSN [$DSN_NAME] already exists in $USER_ODBC_FILE"
+else
+  echo "Adding [$DSN_NAME] to $USER_ODBC_FILE..."
+  cat >> "$USER_ODBC_FILE" <<EOF
+
+[$DSN_NAME]
+Description = An ODBC Driver DSN for Apache Arrow Flight SQL
+Driver      = Apache Arrow Flight SQL ODBC Driver
+Host        =
+Port        =
+UID         =
+PWD         =
+EOF
+fi
+
+# Check if [ODBC Data Sources] section exists
+if grep -q '^\[ODBC Data Sources\]' "$USER_ODBC_FILE"; then
+  # Section exists: check if DSN entry exists
+  if ! grep -q "^${DSN_NAME}=" "$USER_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 }
+    ' "$USER_ODBC_FILE" > "${USER_ODBC_FILE}.tmp" && mv "${USER_ODBC_FILE}.tmp" "$USER_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}"
+  } >> "$USER_ODBC_FILE"
+fi
+