FEAT: Add spatial type support (geography, geometry, hierarchyid) by dlevy-msft-sql · Pull Request #423 · microsoft/mssql-python

dlevy-msft-sql · 2026-02-07T21:39:32Z

Work Item / Issue Reference

GitHub Issue #352

Summary

Adds SQL_SS_UDT (-151) handling so geography, geometry, and hierarchyid columns are fetched as bytes instead of raising errors. These SQL Server CLR User-Defined Types all report as SQL_SS_UDT via ODBC and were previously unhandled in both the C++ binding layer and Python type maps.

Changes

File	Change
`ddbc_bindings.cpp`	Define `SQL_SS_UDT` constant; add `case SQL_SS_UDT:` fallthroughs to `SQL_BINARY` in `SQLGetData_wrap`, `SQLBindColums`, and `FetchBatchData`; separate `calculateRowSize` case with LOB-size fallback; include in LOB detection for `FetchMany_wrap` and `FetchAll_wrap`
`constants.py`	Add `SQL_SS_UDT = -151` to `ConstantsDDBC` enum and `get_valid_types()`
`cursor.py`	Add `SQL_SS_UDT -> SQL_C_BINARY` in `sql_to_c_type` map; add `SQL_SS_UDT -> bytes` in `sql_to_python_type` map
`test_017_spatial_types.py`	37 tests covering geography, geometry, and hierarchyid: fetch paths (fetchone/fetchmany/fetchall/executemany), NULL handling, mixed columns, binary round-trips, output converters, cursor.description metadata, error cases

Testing

Built ddbc_bindings.cp313-arm64.pyd with 0 errors
Existing test suite: 639 passed, 1 pre-existing failure (unrelated test_no_segfault_on_gc WinError 50), 8 skipped
Spatial tests require live SQL Server connection with geography/geometry/hierarchyid support

github-actions · 2026-02-07T22:33:39Z

📊 Code Coverage Report

🔥 Diff Coverage 100%	🎯 Overall Coverage 76%	📈 Total Lines Covered: `5513` out of `7171` 📁 Project: `mssql-python`

Diff Coverage

Diff: main...HEAD, staged and unstaged changes

mssql_python/constants.py (100%)
mssql_python/pybind/ddbc_bindings.cpp (100%)

Summary

Total: 13 lines
Missing: 0 lines
Coverage: 100%

📋 Files Needing Attention

📉 Files with overall lowest coverage (click to expand)

mssql_python.pybind.logger_bridge.hpp: 58.8%
mssql_python.pybind.logger_bridge.cpp: 59.2%
mssql_python.row.py: 66.2%
mssql_python.pybind.ddbc_bindings.cpp: 69.4%
mssql_python.pybind.ddbc_bindings.h: 69.7%
mssql_python.pybind.connection.connection.cpp: 75.3%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.pybind.connection.connection_pool.cpp: 79.6%
mssql_python.cursor.py: 84.8%
mssql_python.__init__.py: 84.9%

🔗 Quick Links

⚙️ Build Summary	📋 Coverage Details
View Azure DevOps Build	Browse Full Coverage Report

Copilot

Pull request overview

Adds handling for SQL Server CLR user-defined spatial types (reported via ODBC as SQL_SS_UDT / -151) so geography, geometry, and hierarchyid can be fetched as bytes instead of raising “unsupported type” errors.

Changes:

Add SQL_SS_UDT support in the native ODBC fetch/bind paths by treating it like binary data (including LOB/streaming detection).
Extend Python type mappings so SQL_SS_UDT maps to SQL_C_BINARY and bytes (including cursor.description type codes).
Add a comprehensive spatial-types test suite covering fetch methods, NULLs, metadata, converters, and error cases.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
`mssql_python/pybind/ddbc_bindings.cpp`	Handles `SQL_SS_UDT` in `SQLGetData`, batch binding, row-size calculation, and LOB detection to fetch spatial UDTs as binary.
`mssql_python/constants.py`	Introduces `SQL_SS_UDT = -151` in `ConstantsDDBC`.
`mssql_python/cursor.py`	Maps `SQL_SS_UDT` to `SQL_C_BINARY` for binding and to `bytes` for `cursor.description` type mapping.
`tests/test_017_spatial_types.py`	Adds test coverage for geography/geometry/hierarchyid fetch behaviors and related metadata/converter scenarios.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/test_017_spatial_types.py

mssql_python/constants.py

dlevy-msft-sql · 2026-02-08T02:41:02Z

Thanks for the review — both comments were valid and have been fixed in the amended commit:

Comment 1 — Unused ConstantsDDBC import in test file: Fixed. Removed the unused import from test_017_spatial_types.py.

Comment 2 — SQL_SS_UDT missing from SQLTypes.get_valid_types(): Fixed. Added ConstantsDDBC.SQL_SS_UDT.value to the valid-types set so cursor.setinputsizes() will accept SQL_SS_UDT as a valid type code.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/test_017_spatial_types.py

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/test_017_spatial_types.py

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mssql_python/cursor.py

tests/test_017_spatial_types.py

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mssql_python/pybind/ddbc_bindings.cpp

tests/test_017_spatial_types.py

mssql_python/cursor.py

Add SQL_SS_UDT (-151) handling for SQL Server spatial types, enabling geography, geometry, and hierarchyid columns to be fetched as raw bytes. C++ changes (ddbc_bindings.cpp): - SQLGetData_wrap: SQL_SS_UDT falls through to SQL_BINARY - SQLBindColumns: SQL_SS_UDT falls through to SQL_BINARY - FetchBatchData: SQL_SS_UDT falls through to ProcessBinary - calculateRowSize: SQL_SS_UDT with LOB-size fallback for 0/SQL_NO_TOTAL - FetchMany_wrap/FetchAll_wrap: SQL_SS_UDT added to LOB detection Python changes: - constants.py: SQL_SS_UDT = -151 in ConstantsDDBC enum + get_valid_types() - cursor.py: SQL_SS_UDT -> SQL_C_BINARY in _get_c_type_for_sql_type, SQL_SS_UDT -> bytes in _map_data_type Tests: 37 tests covering all three spatial types across fetch paths (fetchone, fetchmany, fetchall, executemany), NULL handling, mixed-column queries, output converters, description metadata, spatial methods, error handling, and binary output consistency.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/test_017_spatial_types.py

dlevy-msft-sql force-pushed the spatial-type-support branch from 8bcb847 to ce07df5 Compare February 7, 2026 22:28

dlevy-msft-sql mentioned this pull request Feb 7, 2026

FEAT: Add spatial type support (geography, geometry, hierarchyid) #422

Closed

dlevy-msft-sql marked this pull request as ready for review February 8, 2026 01:21

Copilot AI review requested due to automatic review settings February 8, 2026 01:21

Copilot started reviewing on behalf of dlevy-msft-sql February 8, 2026 01:22 View session

Copilot AI reviewed Feb 8, 2026

View reviewed changes

tests/test_017_spatial_types.py Outdated Show resolved Hide resolved

mssql_python/constants.py Show resolved Hide resolved

dlevy-msft-sql force-pushed the spatial-type-support branch from ce07df5 to 7c474e8 Compare February 8, 2026 02:40

dlevy-msft-sql requested a review from Copilot February 8, 2026 02:42

Copilot started reviewing on behalf of dlevy-msft-sql February 8, 2026 02:42 View session

Copilot AI reviewed Feb 8, 2026

View reviewed changes

tests/test_017_spatial_types.py Outdated Show resolved Hide resolved

dlevy-msft-sql force-pushed the spatial-type-support branch 3 times, most recently from 8088d9c to 0927dda Compare February 8, 2026 03:04

dlevy-msft-sql requested a review from Copilot February 8, 2026 03:07

Copilot started reviewing on behalf of dlevy-msft-sql February 8, 2026 03:07 View session

Copilot AI reviewed Feb 8, 2026

View reviewed changes

dlevy-msft-sql force-pushed the spatial-type-support branch from 0927dda to fde7ea4 Compare February 10, 2026 00:22

dlevy-msft-sql marked this pull request as draft February 10, 2026 00:29

dlevy-msft-sql force-pushed the spatial-type-support branch from 64a671a to ce4f8c5 Compare February 11, 2026 03:29

dlevy-msft-sql requested a review from Copilot February 11, 2026 03:31

dlevy-msft-sql self-assigned this Feb 11, 2026

Copilot started reviewing on behalf of dlevy-msft-sql February 11, 2026 03:32 View session

Copilot AI reviewed Feb 11, 2026

View reviewed changes

tests/test_017_spatial_types.py Outdated Show resolved Hide resolved

dlevy-msft-sql force-pushed the spatial-type-support branch from ce4f8c5 to 0b66236 Compare February 18, 2026 16:41

dlevy-msft-sql requested a review from Copilot February 18, 2026 16:43

Copilot started reviewing on behalf of dlevy-msft-sql February 18, 2026 16:45 View session

Copilot AI reviewed Feb 18, 2026

View reviewed changes

mssql_python/cursor.py Outdated Show resolved Hide resolved

tests/test_017_spatial_types.py Outdated Show resolved Hide resolved

dlevy-msft-sql force-pushed the spatial-type-support branch from 0b66236 to 1ddc25f Compare February 18, 2026 16:58

dlevy-msft-sql requested a review from Copilot February 18, 2026 17:52

Copilot started reviewing on behalf of dlevy-msft-sql February 18, 2026 17:53 View session

Copilot AI reviewed Feb 18, 2026

View reviewed changes

dlevy-msft-sql force-pushed the spatial-type-support branch from 1ddc25f to cf2ecbf Compare February 19, 2026 04:18

dlevy-msft-sql requested a review from Copilot February 19, 2026 04:25

Copilot started reviewing on behalf of dlevy-msft-sql February 19, 2026 04:26 View session

Copilot AI reviewed Feb 19, 2026

View reviewed changes

dlevy-msft-sql force-pushed the spatial-type-support branch from cf2ecbf to 85b0ec6 Compare February 19, 2026 04:38

dlevy-msft-sql requested a review from Copilot February 19, 2026 04:40

Copilot started reviewing on behalf of dlevy-msft-sql February 19, 2026 04:41 View session

Copilot AI reviewed Feb 19, 2026

View reviewed changes

dlevy-msft-sql force-pushed the spatial-type-support branch from 85b0ec6 to 0629b3e Compare February 19, 2026 04:53

dlevy-msft-sql requested a review from Copilot February 19, 2026 04:56

Copilot started reviewing on behalf of dlevy-msft-sql February 19, 2026 04:57 View session

Copilot AI reviewed Feb 19, 2026

View reviewed changes

dlevy-msft-sql force-pushed the spatial-type-support branch from 0629b3e to af13019 Compare February 19, 2026 05:01

dlevy-msft-sql requested a review from Copilot February 19, 2026 05:09

Copilot started reviewing on behalf of dlevy-msft-sql February 19, 2026 05:09 View session

Copilot AI reviewed Feb 19, 2026

View reviewed changes

tests/test_017_spatial_types.py Show resolved Hide resolved

dlevy-msft-sql marked this pull request as ready for review February 19, 2026 05:30

sumitmsft approved these changes Feb 19, 2026

View reviewed changes

Conversation

dlevy-msft-sql commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Work Item / Issue Reference

Summary

Changes

Testing

Uh oh!

github-actions bot commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Code Coverage Report

🔥 Diff Coverage

100%

🎯 Overall Coverage

76%

Diff Coverage

Diff: main...HEAD, staged and unstaged changes

Summary

📋 Files Needing Attention

🔗 Quick Links

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

dlevy-msft-sql commented Feb 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

dlevy-msft-sql commented Feb 7, 2026 •

edited

Loading

github-actions bot commented Feb 7, 2026 •

edited

Loading