GH-46522: [C++][FlightRPC] Add Arrow Flight SQL ODBC driver

.github/workflows/cpp.yml

@@ -382,6 +382,7 @@ jobs:
       ARROW_DATASET: ON
       ARROW_FLIGHT: ON
       ARROW_FLIGHT_SQL: ON
+      ARROW_FLIGHT_SQL_ODBC: ON
       ARROW_GANDIVA: ON
       ARROW_GCS: ON
       ARROW_HDFS: OFF

LICENSE.txt

@@ -2290,3 +2290,46 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+--------------------------------------------------------------------------------
+The files cpp/src/arrow/vendored/whereami/whereami.h, 
+cpp/src/arrow/vendored/whereami/whereami.cc are adapted from
+Grégory Pakosz's whereami library (https://github.com/gpakosz/whereami)
+It is dual licensed under both the WTFPLv2 and MIT licenses.
+
+The WTFPLv2 License
+        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <[email protected]>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.
+  1. Bla bla bla
+  2. Montesqieu et camembert, vive la France, zut alors!
+
+The MIT License (MIT)
+Copyright Gregory Pakosz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

cpp/CMakePresets.json

@@ -178,6 +178,7 @@
       "cacheVariables": {
         "ARROW_BUILD_EXAMPLES": "ON",
         "ARROW_BUILD_UTILITIES": "ON",
+        "ARROW_FLIGHT_SQL_ODBC": "ON",
         "ARROW_SKYHOOK": "ON",
         "ARROW_TENSORFLOW": "ON",
         "PARQUET_BUILD_EXAMPLES": "ON",

cpp/build-support/lint_cpp_cli.py

@@ -77,6 +77,9 @@ def lint_file(path):
 
 EXCLUSIONS = _paths('''\
     arrow/arrow-config.cmake
+    arrow/flight/sql/odbc/flight_sql/get_info_cache.h
+    arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/blocking_queue.h
+    arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/odbc_impl/odbc_handle.h
     arrow/python/iterators.h
     arrow/util/hashing.h
     arrow/util/macros.h

cpp/cmake_modules/DefineOptions.cmake

@@ -338,6 +338,13 @@ takes precedence over ccache if a storage backend is configured" ON)
                 DEPENDS
                 ARROW_FLIGHT)
 
+  define_option(ARROW_FLIGHT_SQL_ODBC
+                "Build the Arrow Flight SQL ODBC extension"
+                OFF
+                DEPENDS
+                ARROW_FLIGHT_SQL
+                ARROW_COMPUTE)
+
   define_option(ARROW_GANDIVA
                 "Build the Gandiva libraries"
                 OFF

cpp/cmake_modules/ThirdpartyToolchain.cmake

@@ -410,7 +410,7 @@ if(ARROW_AZURE)
   set(ARROW_WITH_AZURE_SDK ON)
 endif()
 
-if(ARROW_JSON)
+if(ARROW_JSON OR ARROW_FLIGHT_SQL_ODBC)
   set(ARROW_WITH_RAPIDJSON ON)
 endif()
 
@@ -1261,6 +1261,7 @@ endif()
 if(ARROW_BUILD_INTEGRATION
    OR ARROW_BUILD_TESTS
    OR (ARROW_FLIGHT AND (ARROW_TESTING OR ARROW_BUILD_BENCHMARKS))
+   OR ARROW_FLIGHT_SQL_ODBC
    OR (ARROW_S3 AND ARROW_BUILD_BENCHMARKS)
    OR (ARROW_TESTING AND ARROW_BUILD_SHARED))
   set(ARROW_USE_BOOST TRUE)
@@ -1287,6 +1288,9 @@ if(ARROW_USE_BOOST)
   endif()
   if(ARROW_BOOST_REQUIRE_LIBRARY)
     set(ARROW_BOOST_COMPONENTS filesystem system)
+    if(ARROW_FLIGHT_SQL_ODBC AND MSVC)
+      list(APPEND ARROW_BOOST_COMPONENTS locale)
+    endif()
     set(ARROW_BOOST_OPTIONAL_COMPONENTS process)
   else()
     set(ARROW_BOOST_COMPONENTS)
@@ -5561,4 +5565,11 @@ if(ARROW_WITH_AZURE_SDK)
                                Azure::azure-storage-blobs Azure::azure-identity)
 endif()
 
+# ----------------------------------------------------------------------
+# Apache Flight SQL ODBC
+
+if(ARROW_FLIGHT_SQL_ODBC)
+  find_package(ODBC REQUIRED)
+endif()
+
 message(STATUS "All bundled static libraries: ${ARROW_BUNDLED_STATIC_LIBS}")

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

@@ -168,3 +168,7 @@ if(ARROW_BUILD_TESTS OR ARROW_BUILD_EXAMPLES)
     endforeach()
   endif()
 endif()
+
+if(ARROW_FLIGHT_SQL_ODBC)
+  add_subdirectory(odbc)
+endif()

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

@@ -0,0 +1,21 @@
+# 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.
+
+add_custom_target(arrow_flight_sql_odbc)
+
+add_subdirectory(flight_sql)
+add_subdirectory(odbcabstraction)

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

@@ -0,0 +1,140 @@
+# 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.
+
+add_library(arrow_odbc_spi_impl
+            include/flight_sql/flight_sql_driver.h
+            accessors/binary_array_accessor.cc
+            accessors/binary_array_accessor.h
+            accessors/boolean_array_accessor.cc
+            accessors/boolean_array_accessor.h
+            accessors/common.h
+            accessors/date_array_accessor.cc
+            accessors/date_array_accessor.h
+            accessors/decimal_array_accessor.cc
+            accessors/decimal_array_accessor.h
+            accessors/main.h
+            accessors/primitive_array_accessor.cc
+            accessors/primitive_array_accessor.h
+            accessors/string_array_accessor.cc
+            accessors/string_array_accessor.h
+            accessors/time_array_accessor.cc
+            accessors/time_array_accessor.h
+            accessors/timestamp_array_accessor.cc
+            accessors/timestamp_array_accessor.h
+            address_info.cc
+            address_info.h
+            flight_sql_auth_method.cc
+            flight_sql_auth_method.h
+            flight_sql_connection.cc
+            flight_sql_connection.h
+            flight_sql_driver.cc
+            flight_sql_get_tables_reader.cc
+            flight_sql_get_tables_reader.h
+            flight_sql_get_type_info_reader.cc
+            flight_sql_get_type_info_reader.h
+            flight_sql_result_set.cc
+            flight_sql_result_set.h
+            flight_sql_result_set_accessors.cc
+            flight_sql_result_set_accessors.h
+            flight_sql_result_set_column.cc
+            flight_sql_result_set_column.h
+            flight_sql_result_set_metadata.cc
+            flight_sql_result_set_metadata.h
+            flight_sql_ssl_config.cc
+            flight_sql_ssl_config.h
+            flight_sql_statement.cc
+            flight_sql_statement.h
+            flight_sql_statement_get_columns.cc
+            flight_sql_statement_get_columns.h
+            flight_sql_statement_get_tables.cc
+            flight_sql_statement_get_tables.h
+            flight_sql_statement_get_type_info.cc
+            flight_sql_statement_get_type_info.h
+            flight_sql_stream_chunk_buffer.cc
+            flight_sql_stream_chunk_buffer.h
+            get_info_cache.cc
+            get_info_cache.h
+            json_converter.cc
+            json_converter.h
+            record_batch_transformer.cc
+            record_batch_transformer.h
+            scalar_function_reporter.cc
+            scalar_function_reporter.h
+            system_trust_store.cc
+            system_trust_store.h
+            utils.cc)
+target_include_directories(arrow_odbc_spi_impl
+                           PUBLIC include include/flight_sql
+                                  ${CMAKE_SOURCE_DIR}/odbcabstraction/include)
+target_include_directories(arrow_odbc_spi_impl PUBLIC ${CMAKE_CURRENT_LIST_DIR})
+
+if(WIN32)
+  target_sources(arrow_odbc_spi_impl
+                 PRIVATE include/flight_sql/config/configuration.h
+                         include/flight_sql/config/connection_string_parser.h
+                         include/flight_sql/ui/add_property_window.h
+                         include/flight_sql/ui/custom_window.h
+                         include/flight_sql/ui/dsn_configuration_window.h
+                         include/flight_sql/ui/window.h
+                         config/configuration.cc
+                         config/connection_string_parser.cc
+                         ui/custom_window.cc
+                         ui/window.cc
+                         ui/dsn_configuration_window.cc
+                         ui/add_property_window.cc
+                         system_dsn.cc)
+endif()
+
+target_link_libraries(arrow_odbc_spi_impl PUBLIC odbcabstraction arrow_flight_sql_shared)
+
+if(MSVC)
+  target_link_libraries(arrow_odbc_spi_impl PUBLIC Boost::locale)
+endif()
+
+set_target_properties(arrow_odbc_spi_impl
+                      PROPERTIES ARCHIVE_OUTPUT_DIRECTORY
+                                 ${CMAKE_BINARY_DIR}/$<CONFIG>/lib
+                                 LIBRARY_OUTPUT_DIRECTORY
+                                 ${CMAKE_BINARY_DIR}/$<CONFIG>/lib
+                                 RUNTIME_OUTPUT_DIRECTORY
+                                 ${CMAKE_BINARY_DIR}/$<CONFIG>/lib)
+
+# CLI
+add_executable(arrow_odbc_spi_impl_cli main.cc)
+set_target_properties(arrow_odbc_spi_impl_cli
+                      PROPERTIES RUNTIME_OUTPUT_DIRECTORY
+                                 ${CMAKE_BINARY_DIR}/$<CONFIG>/bin)
+target_link_libraries(arrow_odbc_spi_impl_cli arrow_odbc_spi_impl)
+
+# Unit tests
+add_arrow_test(arrow_odbc_spi_impl_test
+               SOURCES
+               accessors/boolean_array_accessor_test.cc
+               accessors/binary_array_accessor_test.cc
+               accessors/date_array_accessor_test.cc
+               accessors/decimal_array_accessor_test.cc
+               accessors/primitive_array_accessor_test.cc
+               accessors/string_array_accessor_test.cc
+               accessors/time_array_accessor_test.cc
+               accessors/timestamp_array_accessor_test.cc
+               flight_sql_connection_test.cc
+               parse_table_types_test.cc
+               json_converter_test.cc
+               record_batch_transformer_test.cc
+               utils_test.cc
+               EXTRA_LINK_LIBS
+               arrow_odbc_spi_impl)

cpp/src/arrow/flight/sql/odbc/flight_sql/accessors/binary_array_accessor.cc

@@ -0,0 +1,91 @@
+// 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.
+
+#include "arrow/flight/sql/odbc/flight_sql/accessors/binary_array_accessor.h"
+
+#include <algorithm>
+#include <cstdint>
+#include "arrow/array.h"
+
+namespace driver {
+namespace flight_sql {
+
+using arrow::BinaryArray;
+using odbcabstraction::RowStatus;
+
+namespace {
+
+inline RowStatus MoveSingleCellToBinaryBuffer(ColumnBinding* binding, BinaryArray* array,
+                                              int64_t arrow_row, int64_t i,
+                                              int64_t& value_offset,
+                                              bool update_value_offset,
+                                              odbcabstraction::Diagnostics& diagnostics) {
+  RowStatus result = odbcabstraction::RowStatus_SUCCESS;
+
+  const char* value = array->Value(arrow_row).data();
+  size_t size_in_bytes = array->value_length(arrow_row);
+
+  size_t remaining_length = static_cast<size_t>(size_in_bytes - value_offset);
+  size_t value_length = std::min(remaining_length, binding->buffer_length);
+
+  auto* byte_buffer =
+      static_cast<unsigned char*>(binding->buffer) + i * binding->buffer_length;
+  memcpy(byte_buffer, ((char*)value) + value_offset, value_length);
+
+  if (remaining_length > binding->buffer_length) {
+    result = odbcabstraction::RowStatus_SUCCESS_WITH_INFO;
+    diagnostics.AddTruncationWarning();
+    if (update_value_offset) {
+      value_offset += value_length;
+    }
+  } else if (update_value_offset) {
+    value_offset = -1;
+  }
+
+  if (binding->strlen_buffer) {
+    binding->strlen_buffer[i] = static_cast<ssize_t>(remaining_length);
+  }
+
+  return result;
+}
+
+}  // namespace
+
+template <CDataType TARGET_TYPE>
+BinaryArrayFlightSqlAccessor<TARGET_TYPE>::BinaryArrayFlightSqlAccessor(Array* array)
+    : FlightSqlAccessor<BinaryArray, TARGET_TYPE,
+                        BinaryArrayFlightSqlAccessor<TARGET_TYPE>>(array) {}
+
+template <>
+RowStatus
+BinaryArrayFlightSqlAccessor<odbcabstraction::CDataType_BINARY>::MoveSingleCell_impl(
+    ColumnBinding* binding, int64_t arrow_row, int64_t i, int64_t& value_offset,
+    bool update_value_offset, odbcabstraction::Diagnostics& diagnostics) {
+  return MoveSingleCellToBinaryBuffer(binding, this->GetArray(), arrow_row, i,
+                                      value_offset, update_value_offset, diagnostics);
+}
+
+template <CDataType TARGET_TYPE>
+size_t BinaryArrayFlightSqlAccessor<TARGET_TYPE>::GetCellLength_impl(
+    ColumnBinding* binding) const {
+  return binding->buffer_length;
+}
+
+template class BinaryArrayFlightSqlAccessor<odbcabstraction::CDataType_BINARY>;
+
+}  // namespace flight_sql
+}  // namespace driver