Odbc driver feature

.github/actions/prepare_vm/action.yaml

@@ -13,8 +13,11 @@ runs:
         sudo apt-get -y update
         sudo apt-get -y install git gdb ninja-build libidn11-dev ragel yasm libc-ares-dev libre2-dev \
           rapidjson-dev zlib1g-dev libxxhash-dev libzstd-dev libsnappy-dev libgtest-dev libgmock-dev \
-          libbz2-dev liblz4-dev libdouble-conversion-dev libssl-dev libstdc++-13-dev gcc-13 g++-13
+          libbz2-dev liblz4-dev libdouble-conversion-dev libssl-dev libstdc++-13-dev gcc-13 g++-13 \
+          unixodbc unixodbc-dev
 
+        # Static deps are linked into the shared ODBC driver; they must be built with -fPIC.
+        export PIC="-DCMAKE_POSITION_INDEPENDENT_CODE=ON"
         # Install ccache
         (V=4.8.1; curl -L https://github.com/ccache/ccache/releases/download/v${V}/ccache-${V}-linux-x86_64.tar.xz | \
         sudo tar -xJ -C /usr/local/bin/ --strip-components=1 --no-same-owner ccache-${V}-linux-x86_64/ccache)
@@ -38,7 +41,7 @@ runs:
         tar -xvzf abseil-cpp-20230802.0.tar.gz
         cd abseil-cpp-20230802.0
         mkdir build && cd build
-        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_BUILD_TYPE=Release -DABSL_PROPAGATE_CXX_STD=ON ..
+        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_BUILD_TYPE=Release -DABSL_PROPAGATE_CXX_STD=ON ${PIC} ..
         cmake --build . --config Release
         cmake --install . --config Release --prefix ~/ydb_deps/absl
         cd ../../
@@ -48,7 +51,7 @@ runs:
         tar -xvzf protobuf-3.21.12.tar.gz
         cd protobuf-3.21.12
         mkdir build && cd build
-        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_BUILD_TYPE=Release -Dprotobuf_BUILD_TESTS=OFF -Dprotobuf_INSTALL=ON ..
+        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_BUILD_TYPE=Release -Dprotobuf_BUILD_TESTS=OFF -Dprotobuf_INSTALL=ON ${PIC} ..
         cmake --build . --config Release
         cmake --install . --config Release --prefix ~/ydb_deps/protobuf
         cd ../../
@@ -57,7 +60,7 @@ runs:
         wget -O grpc-1.54.3.tar.gz https://github.com/grpc/grpc/archive/refs/tags/v1.54.3.tar.gz
         tar -xvzf grpc-1.54.3.tar.gz && cd grpc-1.54.3
         mkdir build && cd build
-        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_PREFIX_PATH="~/ydb_deps/absl;~/ydb_deps/protobuf" -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 \
+        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_PREFIX_PATH="${HOME}/ydb_deps/absl;${HOME}/ydb_deps/protobuf" -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 ${PIC} \
           -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -DgRPC_BUILD_CSHARP_EXT=OFF \
           -DgRPC_ZLIB_PROVIDER=package -DgRPC_CARES_PROVIDER=package -DgRPC_RE2_PROVIDER=package \
           -DgRPC_SSL_PROVIDER=package -DgRPC_PROTOBUF_PROVIDER=package -DgRPC_ABSL_PROVIDER=package \
@@ -67,17 +70,26 @@ runs:
         cmake --install . --config Release --prefix ~/ydb_deps/grpc
         cd ../../
 
+        # Install base64
+        wget -O base64-0.5.2.tar.gz https://github.com/aklomp/base64/archive/refs/tags/v0.5.2.tar.gz
+        tar -xvzf base64-0.5.2.tar.gz && cd base64-0.5.2
+        mkdir build && cd build
+        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_BUILD_TYPE=Release ${PIC} ..
+        cmake --build . --config Release
+        cmake --install . --config Release --prefix ~/ydb_deps/base64
+        cd ../../
+
         # Install brotli
         wget -O brotli-1.1.0.tar.gz https://github.com/google/brotli/archive/refs/tags/v1.1.0.tar.gz
         tar -xvzf brotli-1.1.0.tar.gz && cd brotli-1.1.0
         mkdir build && cd build
-        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_BUILD_TYPE=Release ..
+        cmake -G Ninja ${ENABLE_CCACHE} -DCMAKE_BUILD_TYPE=Release ${PIC} ..
         cmake --build . --config Release
         cmake --install . --config Release --prefix ~/ydb_deps/brotli
         cd ../../
 
         # Clean up
         ccache -s
         sudo rm -rf llvm.sh abseil-cpp-20230802.0.tar.gz protobuf-3.21.12.tar.gz grpc-1.54.3.tar.gz \
-          brotli-1.1.0.tar.gz abseil-cpp-20230802.0 \
-          protobuf-3.21.12 grpc-1.54.3 brotli-1.1.0
+          base64-0.5.2.tar.gz brotli-1.1.0.tar.gz abseil-cpp-20230802.0 \
+          protobuf-3.21.12 grpc-1.54.3 base64-0.5.2 brotli-1.1.0

CMakeLists.txt

@@ -12,6 +12,11 @@ option(YDB_SDK_TESTS "Build YDB C++ SDK tests" Off)
 option(YDB_SDK_EXAMPLES "Build YDB C++ SDK examples" On)
 option(YDB_SDK_ENABLE_OTEL_METRICS "Build OpenTelemetry metrics plugin" Off)
 option(YDB_SDK_ENABLE_OTEL_TRACE "Build OpenTelemetry trace plugin" Off)
+option(YDB_SDK_ODBC "Build YDB ODBC driver" Off)
+if (YDB_SDK_ODBC)
+  # ODBC driver is a shared library; static archives linked into it must be PIC.
+  set(CMAKE_POSITION_INDEPENDENT_CODE ON CACHE BOOL "" FORCE)
+endif()
 set(YDB_SDK_GOOGLE_COMMON_PROTOS_TARGET "" CACHE STRING "Name of cmake target preparing google common proto library")
 option(YDB_SDK_USE_RAPID_JSON "Search for rapid json library in system" ON)
 
@@ -64,6 +69,10 @@ add_subdirectory(plugins)
 
 #_ydb_sdk_validate_public_headers()
 
+if (YDB_SDK_ODBC)
+  add_subdirectory(odbc)
+endif()
+
 if (YDB_SDK_EXAMPLES)
   add_subdirectory(examples)
 endif()

CMakePresets.json

@@ -56,6 +56,7 @@
       "cacheVariables": {
         "YDB_SDK_TESTS": "TRUE",
         "YDB_SDK_EXAMPLES": "TRUE",
+        "YDB_SDK_ODBC": "TRUE",
         "ARCADIA_ROOT": "..",
         "ARCADIA_BUILD_ROOT": "."
       }

README.md

@@ -42,11 +42,18 @@
 
 ### Install dependencies
 
+When building with `YDB_SDK_ODBC=ON` (included in the `release-test-*` presets), the ODBC
+driver is a shared library. Static dependencies installed under `~/ydb_deps` must be built
+with position-independent code (`-DCMAKE_POSITION_INDEPENDENT_CODE=ON`).
+
 ```bash
 sudo apt-get -y update
 sudo apt-get -y install git gdb ninja-build libidn11-dev ragel yasm libc-ares-dev libre2-dev \
   rapidjson-dev zlib1g-dev libxxhash-dev libzstd-dev libsnappy-dev libgtest-dev libgmock-dev \
-  libbz2-dev liblz4-dev libdouble-conversion-dev libssl-dev libstdc++-13-dev gcc-13 g++-13
+  libbz2-dev liblz4-dev libdouble-conversion-dev libssl-dev libstdc++-13-dev gcc-13 g++-13 \
+  unixodbc unixodbc-dev
+
+PIC="-DCMAKE_POSITION_INDEPENDENT_CODE=ON"
 
 wget https://apt.llvm.org/llvm.sh
 chmod u+x llvm.sh
@@ -57,7 +64,7 @@ wget -O abseil-cpp-20230802.0.tar.gz https://github.com/abseil/abseil-cpp/archiv
 tar -xvzf abseil-cpp-20230802.0.tar.gz
 cd abseil-cpp-20230802.0
 mkdir build && cd build
-cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DABSL_PROPAGATE_CXX_STD=ON ..
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DABSL_PROPAGATE_CXX_STD=ON ${PIC} ..
 cmake --build . --config Release
 cmake --install . --config Release --prefix ~/ydb_deps/absl
 cd ../../
@@ -67,7 +74,7 @@ wget -O protobuf-3.21.12.tar.gz https://github.com/protocolbuffers/protobuf/arch
 tar -xvzf protobuf-3.21.12.tar.gz
 cd protobuf-3.21.12
 mkdir build && cd build
-cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -Dprotobuf_BUILD_TESTS=OFF -Dprotobuf_INSTALL=ON ..
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -Dprotobuf_BUILD_TESTS=OFF -Dprotobuf_INSTALL=ON ${PIC} ..
 cmake --build . --config Release
 cmake --install . --config Release --prefix ~/ydb_deps/protobuf
 cd ../../
@@ -76,7 +83,7 @@ cd ../../
 wget -O grpc-1.54.3.tar.gz https://github.com/grpc/grpc/archive/refs/tags/v1.54.3.tar.gz
 tar -xvzf grpc-1.54.3.tar.gz && cd grpc-1.54.3
 mkdir build && cd build
-cmake -G Ninja -DCMAKE_PREFIX_PATH="~/ydb_deps/absl;~/ydb_deps/protobuf" -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 \
+cmake -G Ninja -DCMAKE_PREFIX_PATH="${HOME}/ydb_deps/absl;${HOME}/ydb_deps/protobuf" -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 ${PIC} \
   -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -DgRPC_BUILD_CSHARP_EXT=OFF \
   -DgRPC_ZLIB_PROVIDER=package -DgRPC_CARES_PROVIDER=package -DgRPC_RE2_PROVIDER=package \
   -DgRPC_SSL_PROVIDER=package -DgRPC_PROTOBUF_PROVIDER=package -DgRPC_ABSL_PROVIDER=package \
@@ -90,7 +97,7 @@ cd ../../
 wget -O base64-0.5.2.tar.gz https://github.com/aklomp/base64/archive/refs/tags/v0.5.2.tar.gz
 tar -xvzf base64-0.5.2.tar.gz && cd base64-0.5.2
 mkdir build && cd build
-cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ${PIC} ..
 cmake --build . --config Release
 cmake --install . --config Release --prefix ~/ydb_deps/base64
 cd ../../
@@ -99,7 +106,7 @@ cd ../../
 wget -O brotli-1.1.0.tar.gz https://github.com/google/brotli/archive/refs/tags/v1.1.0.tar.gz
 tar -xvzf brotli-1.1.0.tar.gz && cd brotli-1.1.0
 mkdir build && cd build
-cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ${PIC} ..
 cmake --build . --config Release
 cmake --install . --config Release --prefix ~/ydb_deps/brotli
 cd ../../
@@ -108,7 +115,7 @@ cd ../../
 wget -O jwt-cpp-0.7.0.tar.gz https://github.com/Thalhammer/jwt-cpp/archive/refs/tags/v0.7.0.tar.gz
 tar -xvzf jwt-cpp-0.7.0.tar.gz && cd jwt-cpp-0.7.0
 mkdir build && cd build
-cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ${PIC} ..
 cmake --build . --config Release
 cmake --install . --config Release --prefix ~/ydb_deps/jwt-cpp
 cd ../../

cmake/common.cmake

@@ -110,7 +110,7 @@ function(generate_enum_serilization Tgt Input)
 endfunction()
 
 function(add_global_library_for TgtName MainName)
-  add_library(${TgtName} STATIC ${ARGN})
+  _ydb_sdk_add_library(${TgtName} STATIC ${ARGN})
   if(APPLE)
     target_link_options(${MainName} INTERFACE "SHELL:-Wl,-force_load,$<TARGET_FILE:$<INSTALL_INTERFACE:YDB-CPP-SDK::>${TgtName}>")
   else()
@@ -196,7 +196,7 @@ endfunction()
 
 function(_ydb_sdk_add_library Tgt)
   cmake_parse_arguments(ARG
-    "INTERFACE" "" ""
+    "INTERFACE;OBJECT;SHARED" "" ""
     ${ARGN}
   )
 
@@ -206,7 +206,12 @@ function(_ydb_sdk_add_library Tgt)
     set(libraryMode "INTERFACE")
     set(includeMode "INTERFACE")
   endif()
-
+  if (ARG_OBJECT)
+    set(libraryMode "OBJECT")
+  endif()
+  if (ARG_SHARED)
+    set(libraryMode "SHARED")
+  endif()
   add_library(${Tgt} ${libraryMode})
   target_include_directories(${Tgt} ${includeMode}
     $<BUILD_INTERFACE:${YDB_SDK_SOURCE_DIR}>
@@ -216,6 +221,7 @@ function(_ydb_sdk_add_library Tgt)
   target_compile_definitions(${Tgt} ${includeMode}
     YDB_SDK_OSS
   )
+  set_property(TARGET ${Tgt} PROPERTY POSITION_INDEPENDENT_CODE ON)
 
 endfunction()
 
@@ -462,4 +468,3 @@ function(_ydb_sdk_validate_public_headers)
   )
   target_include_directories(validate_public_interface PUBLIC ${YDB_SDK_BINARY_DIR}/__validate_headers_dir/include)
 endfunction()
-

cmake/external_libs.cmake

@@ -194,6 +194,10 @@ if (YDB_SDK_ENABLE_OTEL_METRICS OR YDB_SDK_ENABLE_OTEL_TRACE)
   set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME "${_ydb_sdk_saved_install_component}")
 endif()
 
+if (YDB_SDK_ODBC)
+  find_package(ODBC REQUIRED)
+endif()
+
 # RapidJSON
 if (YDB_SDK_USE_RAPID_JSON)
   find_package(RapidJSON REQUIRED)

cmake/testing.cmake

@@ -78,9 +78,9 @@ function(add_ydb_test)
 
   if (YDB_TEST_GTEST)
     set(env_vars "")
-    foreach(env_var ${YDB_TEST_ENV})
+    foreach(env_var IN LISTS YDB_TEST_ENV)
       list(APPEND env_vars "ENVIRONMENT")
-      list(APPEND env_vars ${env_var})
+      list(APPEND env_vars "${env_var}")
     endforeach()
 
     gtest_discover_tests(${YDB_TEST_NAME}
@@ -121,3 +121,37 @@ function(add_ydb_test)
 
   vcs_info(${YDB_TEST_NAME})
 endfunction()
+
+if (YDB_SDK_ODBC)
+  function(add_odbc_test)
+    set(opts "")
+    set(oneval_args NAME WORKING_DIRECTORY OUTPUT_DIRECTORY)
+    set(multival_args SOURCES LINK_LIBRARIES LABELS)
+    cmake_parse_arguments(ODBC_TEST
+      "${opts}"
+      "${oneval_args}"
+      "${multival_args}"
+      ${ARGN}
+    )
+
+    add_ydb_test(GTEST
+      NAME ${ODBC_TEST_NAME}
+      SOURCES ${ODBC_TEST_SOURCES}
+      LINK_LIBRARIES
+        ${ODBC_TEST_LINK_LIBRARIES}
+        ODBC::ODBC
+      LABELS
+        integration
+        ${ODBC_TEST_LABELS}
+    )
+
+    target_compile_definitions(${ODBC_TEST_NAME} 
+      PRIVATE 
+        ODBC_DRIVER_PATH="$<TARGET_FILE:ydb-odbc>"
+        ODBC_TEST_ODBCINI="${CMAKE_BINARY_DIR}/odbc/odbc.ini"
+        ODBC_TEST_ODBCSYSINI="${CMAKE_BINARY_DIR}/odbc"
+    )
+
+    add_dependencies(${ODBC_TEST_NAME} ydb-odbc)
+  endfunction()
+endif()

odbc/CMakeLists.txt

@@ -0,0 +1,77 @@
+add_library(ydb-odbc SHARED
+  src/utils/attr.cpp
+  src/utils/escape.cpp
+  src/utils/sql_type_map.cpp
+  src/utils/param_rewrite.cpp
+  src/utils/type_info_rows.cpp
+  src/utils/cursor.cpp
+  src/utils/types.cpp
+  src/utils/util.cpp
+  src/utils/status_util.cpp
+  src/utils/convert.cpp
+  src/utils/error_manager.cpp
+  src/odbc_driver.cpp
+  src/connection_attr.cpp
+  src/connection.cpp
+  src/statement_attr.cpp
+  src/statement.cpp
+  src/statement_metadata.cpp
+  src/environment.cpp
+  src/metadata.cpp
+  src/descriptor.cpp
+)
+
+target_include_directories(ydb-odbc
+  PRIVATE
+    ${CMAKE_CURRENT_SOURCE_DIR}/include
+    ${CMAKE_CURRENT_SOURCE_DIR}/src
+    ${ODBC_INCLUDE_DIRS}
+)
+
+target_link_libraries(ydb-odbc
+  PRIVATE
+    YDB-CPP-SDK::Query
+    YDB-CPP-SDK::Table
+    YDB-CPP-SDK::Scheme
+    YDB-CPP-SDK::Driver
+    ODBC::ODBC
+    odbcinst
+)
+
+set_target_properties(ydb-odbc PROPERTIES
+  POSITION_INDEPENDENT_CODE ON
+)
+
+include(GNUInstallDirs)
+
+file(GENERATE
+  OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/odbcinst.ini"
+  CONTENT "[YDB]
+Description=YDB ODBC Driver
+Driver=$<TARGET_FILE:ydb-odbc>
+Setup=$<TARGET_FILE:ydb-odbc>
+"
+)
+
+set(YDB_ODBC_DRIVER_PATH
+  "${CMAKE_INSTALL_FULL_LIBDIR}/libydb-odbc${CMAKE_SHARED_LIBRARY_SUFFIX}")
+configure_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/odbcinst.ini.in"
+  "${CMAKE_CURRENT_BINARY_DIR}/ydb-odbc-odbcinst.ini"
+  @ONLY
+)
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/ydb-odbc-odbcinst.ini"
+  DESTINATION "${CMAKE_INSTALL_SYSCONFDIR}/odbcinst.d"
+  RENAME ydb-odbc.ini
+)
+
+install(TARGETS ydb-odbc
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+)
+
+install(DIRECTORY include/
+  DESTINATION include/ydb-odbc
+)
+
+add_subdirectory(examples)
+add_subdirectory(tests)