Add Arrow Flight SQL ODBC driver

Co-authored-by: rscales <[email protected]>

 Add initial framework for odbc dll

- Add ARROW_FLIGHT_SQL_ODBC option. If we set `ARROW_FLIGHT_SQL_ODBC=ON`, the flightsql odbc folder will be built
- Add odbc api layer for entry_point.cc
- builds odbc dll file, with ODBC APIs exported in odbc.def

Address James' comments

Fix `odbcabstraction` build errors and partially fix `flightsql_odbc` errors

Fix boost-variant not found error
- Adding dependencies from odbc/vcpkg.json to cpp/vcpkg.json

- Fix whereami.cc and .h dependency; ported lates code

Update whereami.cc

- use `long` instead of `int64`. Fixed namespace issues.

- PR CI fix: Add `parquet-testing` back

Partial build fix for `flight_sql` folder

- Replaced `namespace arrow` and `namespace odbcabstraction` with `using namespace ...`

- fix flight_sql_connection.cc

Fix `util::nullopt` to use `std::nullopt`

- fix std::optional

- fix BufferReader

- Fix GetSchema

- fix json_converter.cc

- partial fix configuration.h

-  partial fix get_info_cache.cc

- Fix winsock build error

- Comment out `flight_sql` files that cannot build
   - Comment out configuration and unit tests
   - Comment out get info cache and system trust store

Create initial odbc tests folder

Implement SQLAllocEnv

Fix cmake build

Implement SQLFreeEnv

Fix rest of build errors from `flightsql-odbc`

- Fix get info errors

- Fix for configuration window

  - added odbcinst library

- Fix system trust store

- unit test fixes

   - Add dependency of ARROW_COMPUTE. `arrow/compute/api.h` is used in
     `flight_sql`. Adding `ARROW_COMPUTE=ON` during build fixed run time unit
     tests failures.

Implement SQLAllocConnect and SQLFreeConnect

Fix build issue from static flight sql driver

Lint and code style fixes

Re-add deleted submodule parquet-testing

clang-format lint fix

cpplint lint fix

Exclude whereami in rat exclude list

C++/CLI lint fix

Update parquet-testing to match commit from `main`

Address Kou's comments

ODBC directory lint fixes

Catching the lint fixes outside of `flightsql-odbc` code

Fix build warnings that get treated as error

Implement SQLSetEnvAttr and SQLGetEnvAttr

Implement use of ExecuteWithDiagnostics

Doxygen Error Fixes and Address comments from Kou and James

Address comments from Kou

- Updates License.txt
- Update cmake toolchain
- Move whereami to `vendored`
- Use string_view instead of NOLINT std::string

Remove `whereami.cc` from arrow util build

We are building whereami.cc as part of odbc

Fix include headers to replace <> with ""

Address comments from James

Implement SQLGetDiagField

Author: alinaliBQ

cpp/src/arrow/flight/sql/odbc/ArrowFlightSqlOdbcConfig.cmake.in

@@ -0,0 +1,38 @@
+# 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.
+#
+# This config sets the following variables in your project::
+#
+#   ArrowFlightSqlOdbc_FOUND - true if Arrow Flight SQL ODBC found on the system
+#
+# This config sets the following targets in your project::
+#
+#   ArrowFlightSqlOdbc::arrow_flight_sql_odbc_shared - for linked as shared library if shared library is built
+#   ArrowFlightSqlOdbc::arrow_flight_sql_odbc_static - for linked as static library if static library is built
+
+@PACKAGE_INIT@
+
+include(CMakeFindDependencyMacro)
+find_dependency(ArrowFlightSql)
+
+include("${CMAKE_CURRENT_LIST_DIR}/ArrowFlightSqlOdbcTargets.cmake")
+
+arrow_keep_backward_compatibility(ArrowFlightSqlOdbc arrow_flight_sql_odbc)
+
+check_required_components(ArrowFlightSqlOdbc)
+
+arrow_show_details(ArrowFlightSqlOdbc ARROW_FLIGHT_SQL_ODBC)

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

@@ -19,3 +19,53 @@ add_custom_target(arrow_flight_sql_odbc)
 
 add_subdirectory(flight_sql)
 add_subdirectory(odbcabstraction)
+add_subdirectory(tests)
+
+arrow_install_all_headers("arrow/flight/sql/odbc")
+
+set(ARROW_FLIGHT_SQL_ODBC_SRCS entry_points.cc odbc_api.cc)
+
+if(WIN32)
+  list(APPEND ARROW_FLIGHT_SQL_ODBC_SRCS odbc.def)
+endif()
+
+if(WIN32)
+  if(MSVC_VERSION GREATER_EQUAL 1900)
+    set(ODBCINST legacy_stdio_definitions odbccp32 shlwapi)
+  endif()
+elseif(APPLE)
+  set(ODBCINST iodbcinst)
+else()
+  set(ODBCINST odbcinst)
+endif()
+
+add_arrow_lib(arrow_flight_sql_odbc
+              CMAKE_PACKAGE_NAME
+              ArrowFlightSqlOdbc
+              PKG_CONFIG_NAME
+              arrow-flight-sql-odbc
+              OUTPUTS
+              ARROW_FLIGHT_SQL_ODBC_LIBRARIES
+              SOURCES
+              ${ARROW_FLIGHT_SQL_ODBC_SRCS}
+              DEPENDENCIES
+              arrow_flight_sql
+              SHARED_LINK_FLAGS
+              ${ARROW_VERSION_SCRIPT_FLAGS} # Defined in cpp/arrow/CMakeLists.txt
+              SHARED_LINK_LIBS
+              arrow_flight_sql_shared
+              SHARED_INSTALL_INTERFACE_LIBS
+              ArrowFlight::arrow_flight_sql_shared
+              STATIC_LINK_LIBS
+              arrow_flight_sql_static
+              STATIC_INSTALL_INTERFACE_LIBS
+              ArrowFlight::arrow_flight_sql_static
+              SHARED_PRIVATE_LINK_LIBS
+              ${ODBC_LIBRARIES}
+              ${ODBCINST}
+              odbcabstraction
+              arrow_odbc_spi_impl)
+
+foreach(LIB_TARGET ${ARROW_FLIGHT_SQL_ODBC_LIBRARIES})
+  target_compile_definitions(${LIB_TARGET} PRIVATE ARROW_FLIGHT_SQL_ODBC_EXPORTING)
+endforeach()

cpp/src/arrow/flight/sql/odbc/arrow-flight-sql-odbc.pc.in

@@ -0,0 +1,27 @@
+# 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.
+
+prefix=@CMAKE_INSTALL_PREFIX@
+includedir=@ARROW_PKG_CONFIG_INCLUDEDIR@
+libdir=@ARROW_PKG_CONFIG_LIBDIR@
+
+Name: Apache Arrow Flight SQL ODBC
+Description: Apache Arrow Flight SQL ODBC extension
+Version: @ARROW_VERSION@
+Requires: arrow-flight-sql
+Libs: -L${libdir} -larrow_flight_sql_odbc
+Cflags.private: -DARROW_FLIGHT_SQL_ODBC_STATIC

cpp/src/arrow/flight/sql/odbc/entry_points.cc

@@ -0,0 +1,82 @@
+// 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.
+
+#ifdef _WIN32
+#  include <windows.h>
+#endif
+
+#include <sql.h>
+#include <sqlext.h>
+#include <sqltypes.h>
+#include <sqlucode.h>
+
+#include "arrow/flight/sql/odbc/odbc_api.h"
+#include "arrow/flight/sql/odbc/visibility.h"
+
+SQLRETURN SQL_API SQLAllocHandle(SQLSMALLINT type, SQLHANDLE parent, SQLHANDLE* result) {
+  return arrow::SQLAllocHandle(type, parent, result);
+}
+
+SQLRETURN SQL_API SQLAllocEnv(SQLHENV* env) {
+  return arrow::SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, env);
+}
+
+SQLRETURN SQL_API SQLAllocConnect(SQLHENV env, SQLHDBC* conn) {
+  return arrow::SQLAllocHandle(SQL_HANDLE_DBC, env, conn);
+}
+
+SQLRETURN SQL_API SQLFreeHandle(SQLSMALLINT type, SQLHANDLE handle) {
+  return arrow::SQLFreeHandle(type, handle);
+}
+
+SQLRETURN SQL_API SQLFreeEnv(SQLHENV env) {
+  return arrow::SQLFreeHandle(SQL_HANDLE_ENV, env);
+}
+
+SQLRETURN SQL_API SQLFreeConnect(SQLHDBC conn) {
+  return arrow::SQLFreeHandle(SQL_HANDLE_DBC, conn);
+}
+
+SQLRETURN SQL_API SQLGetDiagFieldW(SQLSMALLINT handleType, SQLHANDLE handle,
+                                   SQLSMALLINT recNumber, SQLSMALLINT diagIdentifier,
+                                   SQLPOINTER diagInfoPtr, SQLSMALLINT bufferLength,
+                                   SQLSMALLINT* stringLengthPtr) {
+  return arrow::SQLGetDiagFieldW(handleType, handle, recNumber, diagIdentifier,
+                                 diagInfoPtr, bufferLength, stringLengthPtr);
+}
+
+SQLRETURN SQL_API SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER valuePtr,
+                                SQLINTEGER bufferLen, SQLINTEGER* strLenPtr) {
+  return arrow::SQLGetEnvAttr(env, attr, valuePtr, bufferLen, strLenPtr);
+}
+
+SQLRETURN SQL_API SQLSetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER valuePtr,
+                                SQLINTEGER strLen) {
+  return arrow::SQLSetEnvAttr(env, attr, valuePtr, strLen);
+}
+
+SQLRETURN SQL_API SQLDriverConnect(SQLHDBC conn, SQLHWND windowHandle,
+                                   SQLWCHAR* inConnectionString,
+                                   SQLSMALLINT inConnectionStringLen,
+                                   SQLWCHAR* outConnectionString,
+                                   SQLSMALLINT outConnectionStringBufferLen,
+                                   SQLSMALLINT* outConnectionStringLen,
+                                   SQLUSMALLINT driverCompletion) {
+  // TODO: implement SQLDriverConnect by linking to `odbc_impl` //-AL- TODO: create GitHub
+  // issue for SQLDriverConnect implementation
+  return SQL_INVALID_HANDLE;
+}

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

@@ -16,7 +16,7 @@
 // under the License.
 
 #include "arrow/flight/sql/odbc/flight_sql/accessors/primitive_array_accessor.h"
-#include <arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/diagnostics.h>
+#include "arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/diagnostics.h"
 #include "arrow/testing/builder.h"
 #include "gtest/gtest.h"
 

cpp/src/arrow/flight/sql/odbc/flight_sql/config/configuration.cc

@@ -38,17 +38,15 @@ std::string ReadDsnString(const std::string& dsn, const std::string_view& key,
                           const std::string& dflt = "") {
 #define BUFFER_SIZE (1024)
   std::vector<char> buf(BUFFER_SIZE);
-
-  std::string key_str = std::string(key);
   int ret =
-      SQLGetPrivateProfileString(dsn.c_str(), key_str.c_str(), dflt.c_str(), buf.data(),
+      SQLGetPrivateProfileString(dsn.c_str(), key.data(), dflt.c_str(), buf.data(),
                                  static_cast<int>(buf.size()), "ODBC.INI");
 
   if (ret > BUFFER_SIZE) {
     // If there wasn't enough space, try again with the right size buffer.
     buf.resize(ret + 1);
     ret =
-        SQLGetPrivateProfileString(dsn.c_str(), key_str.c_str(), dflt.c_str(), buf.data(),
+        SQLGetPrivateProfileString(dsn.c_str(), key.data(), dflt.c_str(), buf.data(),
                                    static_cast<int>(buf.size()), "ODBC.INI");
   }
 

cpp/src/arrow/flight/sql/odbc/flight_sql/flight_sql_result_set_accessors.h

@@ -17,9 +17,9 @@
 
 #pragma once
 
-#include <arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/types.h>
-#include <arrow/type_fwd.h>
 #include <memory>
+#include "arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/types.h"
+#include "arrow/type_fwd.h"
 
 namespace driver {
 namespace flight_sql {

cpp/src/arrow/flight/sql/odbc/flight_sql/flight_sql_result_set_metadata.cc

@@ -16,10 +16,10 @@
 // under the License.
 
 #include "arrow/flight/sql/odbc/flight_sql/flight_sql_result_set_metadata.h"
-#include <arrow/flight/sql/column_metadata.h>
-#include <arrow/util/key_value_metadata.h>
+#include "arrow/flight/sql/column_metadata.h"
 #include "arrow/flight/sql/odbc/flight_sql/utils.h"
 #include "arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/platform.h"
+#include "arrow/util/key_value_metadata.h"
 
 #include <utility>
 #include "arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/exceptions.h"

cpp/src/arrow/flight/sql/odbc/flight_sql/flight_sql_ssl_config.h

@@ -17,9 +17,9 @@
 
 #pragma once
 
-#include <arrow/flight/types.h>
-#include <arrow/status.h>
 #include <string>
+#include "arrow/flight/types.h"
+#include "arrow/status.h"
 
 namespace driver {
 namespace flight_sql {

cpp/src/arrow/flight/sql/odbc/flight_sql/flight_sql_stream_chunk_buffer.h

@@ -17,9 +17,9 @@
 
 #pragma once
 
-#include <arrow/flight/client.h>
-#include <arrow/flight/sql/client.h>
-#include <arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/blocking_queue.h>
+#include "arrow/flight/client.h"
+#include "arrow/flight/sql/client.h"
+#include "arrow/flight/sql/odbc/odbcabstraction/include/odbcabstraction/blocking_queue.h"
 
 namespace driver {
 namespace flight_sql {