FEAT: PDB File generation to make Private symbols for DDBC Bindings (#71)

### Summary  
This pull request introduces changes to improve debugging support for
the `ddbc_bindings` project by enabling PDB (Program Database) file
generation and ensuring proper handling of these files during the build
process. The changes primarily focus on updating the CMake configuration
and build script.

### Debugging Support Improvements:

* **Enabled PDB generation for MSVC builds in Release mode**: Added
compile and link options in `CMakeLists.txt` to ensure PDB files are
generated when building with MSVC in Release mode.
(`mssql_python/pybind/CMakeLists.txt`,
[mssql_python/pybind/CMakeLists.txtR8-R13](diffhunk://#diff-dbb5892fbbb28149d1639664797cf3adb48ced28ec11aba95f2e2b338ca46badR8-R13))

* **Configured PDB properties for `ddbc_bindings` target**: Set
properties in `CMakeLists.txt` to specify the PDB file name and output
directory for the `ddbc_bindings` target.
(`mssql_python/pybind/CMakeLists.txt`,
[mssql_python/pybind/CMakeLists.txtR113-R119](diffhunk://#diff-dbb5892fbbb28149d1639664797cf3adb48ced28ec11aba95f2e2b338ca46badR113-R119))

* **Handled PDB file copying in build script**: Updated `build.bat` to
check for the existence of the PDB file after the build, copy it to the
appropriate directory if found, and log diagnostic messages for success
or warnings if the file is missing. (`mssql_python/pybind/build.bat`,
[mssql_python/pybind/build.batR147-R155](diffhunk://#diff-a08055320153458138a68ccff086b540cb080819b76f921664caa782603a4c2eR147-R155))

### Issue Reference  
Fixes
[AB#37472](https://sqlclientdrivers.visualstudio.com/c6d89619-62de-46a0-8b46-70b92a84d85e/_workitems/edit/37472)

### Solution Implemented  
<!-- Explain the fix implemented -->
- [x] Updated `CMakeLists` and `build.bat` to generate a PDB file for
release

### Checklist  
- [x] **Tests Passed** (if applicable)  
- [x] **Code is formatted**   
- [x] **Docs Updated** (if necessary) 

### Testing Performed  
<!-- How was this fix tested? -->
- [x] Unit Tests
- [x] Manual Testing  
  - [x] Python Version: `3.13.3`
  - [x] OS: `Windows`

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: bewithgaurav

.gitignore

@@ -1,11 +1,6 @@
 # Ignore all files in the pybind/build directory
 mssql_python/pybind/build/
 
-mssql_python/pybind/pymsbuild/build/
-
-# Ignore pyd file
-mssql_python/ddbc_bindings.pyd
-
 # Ignore pycache files and folders
 __pycache__/
 **/__pycache__/
@@ -43,6 +38,7 @@ build/
 # C extensions
 *.so
 *.pyd
+*.pdb
 
 # IDE files
 .vscode/

eng/pipelines/build-whl-pipeline.yml

@@ -126,6 +126,14 @@ jobs:
         TargetFolder: '$(Build.ArtifactStagingDirectory)\all-pyds'
       displayName: 'Place PYD file into artifacts directory'
 
+    # Copy the built .pdb files to staging folder for artifacts
+    - task: CopyFiles@2
+      inputs:
+        SourceFolder: '$(Build.SourcesDirectory)\mssql_python\pybind\build\$(targetArch)\py$(shortPyVer)\Release'
+        Contents: 'ddbc_bindings.cp$(shortPyVer)-*.pdbs'
+        TargetFolder: '$(Build.ArtifactStagingDirectory)\all-pdbs'
+      displayName: 'Place PDB file into artifacts directory'
+
     # Build wheel package for the current architecture
     - script: |
         python -m pip install --upgrade pip

eng/pipelines/pr-validation-pipeline.yml

@@ -62,6 +62,13 @@ jobs:
       publishLocation: 'Container'
     displayName: 'Publish pyd file as artifact'
 
+  - task: PublishBuildArtifacts@1
+    inputs:
+      PathtoPublish: 'mssql_python/ddbc_bindings.cp313-amd64.pdb'
+      ArtifactName: 'ddbc_bindings'
+      publishLocation: 'Container'
+    displayName: 'Publish pdb file as artifact'
+
   - task: PublishTestResults@2
     condition: succeededOrFailed()
     inputs:

mssql_python/pybind/CMakeLists.txt

@@ -5,6 +5,12 @@ project(ddbc_bindings)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+if (MSVC)
+    # Enable PDB generation for all target types
+    add_compile_options("$<$<CONFIG:Release>:/Zi>")
+    add_link_options("$<$<CONFIG:Release>:/DEBUG /OPT:REF /OPT:ICF>")
+endif()
+
 # Detect platform
 if(WIN32)
     set(PLATFORM_NAME "windows")
@@ -19,6 +25,7 @@ endif()
 # Set default architecture if not provided
 if(NOT DEFINED ARCHITECTURE)
     if(WIN32)
+        # Default to x64 for Windows
         set(ARCHITECTURE "win64")
     elseif(APPLE)
         # Check if we're on Apple Silicon or Intel
@@ -207,6 +214,13 @@ set_target_properties(ddbc_bindings PROPERTIES
     OUTPUT_NAME "ddbc_bindings.cp${PYTHON_VERSION}-${WHEEL_ARCH}"
     SUFFIX "${MODULE_EXTENSION}"
 )
+# Ensure PDB is generated in Release
+set_target_properties(ddbc_bindings PROPERTIES
+    COMPILE_PDB_NAME "ddbc_bindings.cp${PYTHON_VERSION}-${WHEEL_ARCH}"
+    COMPILE_PDB_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
+    PDB_NAME "ddbc_bindings.cp${PYTHON_VERSION}-${WHEEL_ARCH}"
+    PDB_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
+)
 
 # Include directories for all architectures
 if(NOT DEFINED ODBC_INCLUDE_DIR)

mssql_python/pybind/build.bat

@@ -142,7 +142,20 @@ set OUTPUT_DIR=%BUILD_DIR%\Release
 
 if exist "%OUTPUT_DIR%\%PYD_NAME%" (
     copy /Y "%OUTPUT_DIR%\%PYD_NAME%" "%SOURCE_DIR%\.."
-    echo [SUCCESS] Copied %PYD_NAME% to %SOURCE_DIR%..
+    echo [SUCCESS] Copied %PYD_NAME% to %SOURCE_DIR%\..
+
+    echo [DIAGNOSTIC] Copying PDB file if it exists...
+    set PDB_NAME=ddbc_bindings.cp%PYTAG%-%WHEEL_ARCH%.pdb
+    echo [DEBUG] Computed PDB_NAME: !PDB_NAME!
+
+    if exist "%OUTPUT_DIR%\!PDB_NAME!" (
+        echo [DIAGNOSTIC] Found PDB file: "!PDB_NAME!"
+        echo [DIAGNOSTIC] Copying PDB file to source directory...
+        copy /Y "%OUTPUT_DIR%\!PDB_NAME!" "%SOURCE_DIR%\.."
+        echo [SUCCESS] Copied !PDB_NAME! to %SOURCE_DIR%..
+    ) else (
+        echo [WARNING] PDB file !PDB_NAME! not found in output directory.
+    )
 
     setlocal enabledelayedexpansion
     for %%I in ("%SOURCE_DIR%..") do (