FEAT: Complex Datatype support-XML #293
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive support for the SQL Server XML data type to the Python MSSQL driver. The implementation includes proper handling for XML data binding, fetching, streaming, and batching operations.
- Added SQL_SS_XML data type support throughout the driver core
- Updated LOB handling logic to treat XML columns as streamable large objects
- Created comprehensive test suite covering XML operations and edge cases
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| mssql_python/pybind/ddbc_bindings.cpp | Added XML data type constant and integrated XML handling into column binding, fetching, and streaming operations |
| tests/test_004_cursor.py | Added comprehensive test suite for XML functionality including basic operations, edge cases, and error handling |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| except Exception as e: | ||
| pytest.fail(f"Datetime string parameter binding test failed: {e}") | ||
| finally: | ||
| drop_table_if_exists(cursor, table_name) |
There was a problem hiding this comment.
The comment should clarify that this XML is malformed due to mismatched tags (<item> is opened but not properly closed before </root>).
| drop_table_if_exists(cursor, table_name) | |
| INVALID_XML = "<root><item></root>" # malformed: <item> is opened but not closed before </root> |
Copilot uses AI. Check for mistakes.
📊 Code Coverage Report
Diff CoverageDiff: main...HEAD, staged and unstaged changes
Summary
📋 Files Needing Attention📉 Files with overall lowest coverage (click to expand)mssql_python.pybind.connection.connection.cpp: 67.6%
mssql_python.ddbc_bindings.py: 68.5%
mssql_python.pybind.ddbc_bindings.cpp: 69.5%
mssql_python.pybind.connection.connection_pool.cpp: 78.9%
mssql_python.cursor.py: 79.7%
mssql_python.connection.py: 81.7%
mssql_python.helpers.py: 84.7%
mssql_python.auth.py: 85.3%
mssql_python.type.py: 86.8%
mssql_python.pooling.py: 87.5%🔗 Quick Links
|
gargsaumya
force-pushed
the
saumya/xml
branch
from
9eda1de to
a86a2aa
Compare
github-actions
bot
added
pr-size: small
| break; | ||
| } | ||
| case SQL_SS_XML: | ||
| { |
There was a problem hiding this comment.
Speaking strictly from documentation point of view. The PR adds support for storing and retrieving XML data as a SQL Server XML datatype, treating it as a Large Object (LOB). This means:
- If a user wishes to insert the contents of an XML file into an XML column, they must first read the file contents into a string (in Python) and then provide that string as a parameter to the driver.
- The driver itself does not directly handle file objects or file streams as input for XML columns. It expects the XML data as a string or bytes-like object.
- There is no evidence in the PR or the broader codebase that the driver will automatically read or stream data directly from a file object for XML columns.
This must also be documentation explicitly in the public wikis
| #define SQL_SS_TIMESTAMPOFFSET (-155) | ||
| #define SQL_C_SS_TIMESTAMPOFFSET (0x4001) | ||
| #define MAX_DIGITS_IN_NUMERIC 64 | ||
| #define SQL_SS_XML (-152) |
There was a problem hiding this comment.
what is this magic number 152 denotes here?
Pls add a comment if possible.
| case SQL_SS_XML: | ||
| { | ||
| LOG("Streaming XML for column {}", i); | ||
| row.append(FetchLobColumnData(hStmt, i, SQL_C_WCHAR, true, false)); |
There was a problem hiding this comment.
Don't we need to handle (columnSize == SQL_NO_TOTAL || columnSize > 4000) clause like SQL_WLONGVARCHAR case?
4 participants
Work Item / Issue Reference
Summary
This pull request adds comprehensive support for the SQL Server
XMLdata type to the Python MSSQL driver, ensuring proper handling for insertion, retrieval, batching, and streaming of XML data. It also introduces a suite of tests to verify correct XML behavior, including edge cases like empty, large, and malformed XML values.MSSQL Driver Enhancements
SQL_SS_XMLdata type throughout the driver, including binding, fetching, and row size calculations, so that XML columns are handled correctly during data operations. [1] [2] [3] [4] [5]FetchMany_wrapandFetchAll_wrapto treat XML columns as LOBs, enabling efficient streaming for large XML values. [1] [2]Test Coverage for XML Support
tests/test_004_cursor.pyto verify XML handling, including basic insert/fetch, empty/null values, large XML streaming, batch inserts, and error handling for malformed XML input.