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

mssql_python/constants.py

@@ -114,6 +114,7 @@ class ConstantsDDBC(Enum):
     SQL_FETCH_ABSOLUTE = 5
     SQL_FETCH_RELATIVE = 6
     SQL_FETCH_BOOKMARK = 8
+    SQL_SS_UDT = -151
     SQL_DATETIMEOFFSET = -155
     SQL_C_SS_TIMESTAMPOFFSET = 0x4001
     SQL_SCOPE_CURROW = 0
@@ -363,6 +364,7 @@ def get_valid_types(cls) -> set:
             ConstantsDDBC.SQL_TIME.value,
             ConstantsDDBC.SQL_TIMESTAMP.value,
             ConstantsDDBC.SQL_GUID.value,
+            ConstantsDDBC.SQL_SS_UDT.value,
         }
 
     # Could also add category methods for convenience

mssql_python/cursor.py

@@ -865,6 +865,7 @@ def _get_c_type_for_sql_type(self, sql_type: int) -> int:
             ddbc_sql_const.SQL_BINARY.value: ddbc_sql_const.SQL_C_BINARY.value,
             ddbc_sql_const.SQL_VARBINARY.value: ddbc_sql_const.SQL_C_BINARY.value,
             ddbc_sql_const.SQL_LONGVARBINARY.value: ddbc_sql_const.SQL_C_BINARY.value,
+            ddbc_sql_const.SQL_SS_UDT.value: ddbc_sql_const.SQL_C_BINARY.value,
             ddbc_sql_const.SQL_DATE.value: ddbc_sql_const.SQL_C_TYPE_DATE.value,
             ddbc_sql_const.SQL_TIME.value: ddbc_sql_const.SQL_C_TYPE_TIME.value,
             ddbc_sql_const.SQL_TIMESTAMP.value: ddbc_sql_const.SQL_C_TYPE_TIMESTAMP.value,
@@ -942,9 +943,11 @@ def _initialize_description(self, column_metadata: Optional[Any] = None) -> None
         """Initialize the description attribute from column metadata."""
         if not column_metadata:
             self.description = None
+            self._column_sql_types = None
             return
 
         description = []
+        sql_types = []
         for _, col in enumerate(column_metadata):
             # Get column name - lowercase it if the lowercase flag is set
             column_name = col["ColumnName"]
@@ -953,6 +956,8 @@ def _initialize_description(self, column_metadata: Optional[Any] = None) -> None
             if get_settings().lowercase:
                 column_name = column_name.lower()
 
+            sql_types.append(col["DataType"])
+
             # Add to description tuple (7 elements as per PEP-249)
             description.append(
                 (
@@ -966,6 +971,7 @@ def _initialize_description(self, column_metadata: Optional[Any] = None) -> None
                 )
             )
         self.description = description
+        self._column_sql_types = sql_types
 
     def _build_converter_map(self):
         """
@@ -981,14 +987,24 @@ def _build_converter_map(self):
             return None
 
         converter_map = []
+        raw_types = getattr(self, "_column_sql_types", None)
 
-        for desc in self.description:
+        for i, desc in enumerate(self.description):
             if desc is None:
                 converter_map.append(None)
                 continue
-            sql_type = desc[1]
-            converter = self.connection.get_output_converter(sql_type)
-            # If no converter found for the SQL type, try the WVARCHAR converter as a fallback
+
+            converter = None
+
+            # First try lookup by raw SQL type code (e.g. -151 for SQL_SS_UDT)
+            if raw_types and i < len(raw_types):
+                converter = self.connection.get_output_converter(raw_types[i])
+
+            # Fall back to lookup by Python type from description
+            if converter is None:
+                converter = self.connection.get_output_converter(desc[1])
+
+            # Last resort: try the WVARCHAR converter as a catch-all fallback
             if converter is None:
                 from mssql_python.constants import ConstantsDDBC
 
@@ -1052,6 +1068,7 @@ def _map_data_type(self, sql_type):
             ddbc_sql_const.SQL_BINARY.value: bytes,
             ddbc_sql_const.SQL_VARBINARY.value: bytes,
             ddbc_sql_const.SQL_LONGVARBINARY.value: bytes,
+            ddbc_sql_const.SQL_SS_UDT.value: bytes,
             ddbc_sql_const.SQL_GUID.value: uuid.UUID,
             # Add more mappings as needed
         }

mssql_python/pybind/ddbc_bindings.cpp

@@ -27,6 +27,7 @@
 #define MAX_DIGITS_IN_NUMERIC 64
 #define SQL_MAX_NUMERIC_LEN 16
 #define SQL_SS_XML (-152)
+#define SQL_SS_UDT (-151)
 
 #define STRINGIFY_FOR_CASE(x)                                                                      \
     case x:                                                                                        \
@@ -3285,6 +3286,7 @@ SQLRETURN SQLGetData_wrap(SqlHandlePtr StatementHandle, SQLUSMALLINT colCount, p
                 }
                 break;
             }
+            case SQL_SS_UDT:
             case SQL_BINARY:
             case SQL_VARBINARY:
             case SQL_LONGVARBINARY: {
@@ -3555,6 +3557,7 @@ SQLRETURN SQLBindColums(SQLHSTMT hStmt, ColumnBuffers& buffers, py::list& column
                 ret = SQLBindCol_ptr(hStmt, col, SQL_C_GUID, buffers.guidBuffers[col - 1].data(),
                                      sizeof(SQLGUID), buffers.indicators[col - 1].data());
                 break;
+            case SQL_SS_UDT:
             case SQL_BINARY:
             case SQL_VARBINARY:
             case SQL_LONGVARBINARY:
@@ -3683,6 +3686,7 @@ SQLRETURN FetchBatchData(SQLHSTMT hStmt, ColumnBuffers& buffers, py::list& colum
             case SQL_WLONGVARCHAR:
                 columnProcessors[col] = ColumnProcessors::ProcessWChar;
                 break;
+            case SQL_SS_UDT:
             case SQL_BINARY:
             case SQL_VARBINARY:
             case SQL_LONGVARBINARY:
@@ -3981,6 +3985,10 @@ size_t calculateRowSize(py::list& columnNames, SQLUSMALLINT numCols) {
             case SQL_BIT:
                 rowSize += sizeof(SQLCHAR);
                 break;
+            case SQL_SS_UDT:
+                rowSize += (columnSize == SQL_NO_TOTAL || columnSize == 0)
+                               ? SQL_MAX_LOB_SIZE : columnSize;
+                break;
             case SQL_BINARY:
             case SQL_VARBINARY:
             case SQL_LONGVARBINARY:
@@ -4043,7 +4051,8 @@ SQLRETURN FetchMany_wrap(SqlHandlePtr StatementHandle, py::list& rows, int fetch
 
         if ((dataType == SQL_WVARCHAR || dataType == SQL_WLONGVARCHAR || dataType == SQL_VARCHAR ||
              dataType == SQL_LONGVARCHAR || dataType == SQL_VARBINARY ||
-             dataType == SQL_LONGVARBINARY || dataType == SQL_SS_XML) &&
+             dataType == SQL_LONGVARBINARY || dataType == SQL_SS_XML ||
+             dataType == SQL_SS_UDT) &&
             (columnSize == 0 || columnSize == SQL_NO_TOTAL || columnSize > SQL_MAX_LOB_SIZE)) {
             lobColumns.push_back(i + 1);  // 1-based
         }
@@ -4177,7 +4186,8 @@ SQLRETURN FetchAll_wrap(SqlHandlePtr StatementHandle, py::list& rows,
 
         if ((dataType == SQL_WVARCHAR || dataType == SQL_WLONGVARCHAR || dataType == SQL_VARCHAR ||
              dataType == SQL_LONGVARCHAR || dataType == SQL_VARBINARY ||
-             dataType == SQL_LONGVARBINARY || dataType == SQL_SS_XML) &&
+             dataType == SQL_LONGVARBINARY || dataType == SQL_SS_XML ||
+             dataType == SQL_SS_UDT) &&
             (columnSize == 0 || columnSize == SQL_NO_TOTAL || columnSize > SQL_MAX_LOB_SIZE)) {
             lobColumns.push_back(i + 1);  // 1-based
         }