FEAT: Adding primary key API #196
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sumitmsft
approved these changes
Sep 11, 2025
github-actions
bot
added
pr-size: medium
sumitmsft
approved these changes
Sep 12, 2025
bewithgaurav
approved these changes
Sep 15, 2025
### Work Item / Issue Reference <!-- IMPORTANT: Please follow the PR template guidelines below. For mssql-python maintainers: Insert your ADO Work Item ID below (e.g. AB#37452) For external contributors: Insert Github Issue number below (e.g. #149) Only one reference is required - either GitHub issue OR ADO Work Item. --> <!-- mssql-python maintainers: ADO Work Item --> > [AB#34929](https://sqlclientdrivers.visualstudio.com/c6d89619-62de-46a0-8b46-70b92a84d85e/_workitems/edit/34929) > [AB#34930](https://sqlclientdrivers.visualstudio.com/c6d89619-62de-46a0-8b46-70b92a84d85e/_workitems/edit/34930) ------------------------------------------------------------------- ### Summary This pull request adds support for retrieving special columns from a database table using the ODBC `SQLSpecialColumns` function. The main changes include new methods in the Python cursor for accessing row identifier and version columns, as well as the necessary C++ and Python bindings to expose this ODBC functionality. Additionally, relevant constants have been added to support these features. **New Python cursor methods:** * Added `rowIdColumns` and `rowVerColumns` methods to the `Cursor` class in `mssql_python/cursor.py`, allowing users to retrieve columns that uniquely identify a row (`SQL_BEST_ROWID`) and columns that are automatically updated when any value in the row is updated (`SQL_ROWVER`). These methods handle ODBC parameter preparation, call the new binding, and return results as row objects. **ODBC and pybind11 binding support:** * Defined the `SQLSpecialColumnsFunc` function pointer type and added the corresponding global pointer in `mssql_python/pybind/ddbc_bindings.h` and `mssql_python/pybind/ddbc_bindings.cpp`. * Loaded the `SQLSpecialColumnsW` symbol from the ODBC driver in the driver loader, and included it in the function pointer validation check. * Implemented the `SQLSpecialColumns_wrap` function to call the ODBC API, handling both Unix and Windows string conversions, and exposed it to Python as `DDBCSQLSpecialColumns` in the module definition. **Constants:** * Added new constants for `SQL_SCOPE_CURROW`, `SQL_BEST_ROWID`, `SQL_ROWVER`, `SQL_NO_NULLS`, and `SQL_NULLABLE_UNKNOWN` to the `ConstantsDDBC` enum in `mssql_python/constants.py` to support the new functionality. --------- Co-authored-by: Jahnvi Thakkar <[email protected]>
github-actions
bot
added
pr-size: large
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Work Item / Issue Reference
Summary
This pull request adds support for retrieving primary key information from database tables using a new
primaryKeysmethod on thecursorobject. It introduces the necessary C++/ODBC bindings, Python method, and a comprehensive set of tests to validate the new functionality.Primary Key Metadata Support
primaryKeysmethod to thecursorclass incursor.pyto allow users to retrieve primary key columns for a specified table, including support for catalog and schema filtering. The method handles ODBC API requirements and result formatting.ODBC/C++ Binding Enhancements
SQLPrimaryKeysFuncfunction pointer and associated logic in the C++ ODBC bindings (ddbc_bindings.cppandddbc_bindings.h), including function pointer loading, wrapper implementation, and Python module export, enabling Python to call the ODBCSQLPrimaryKeysAPI.Testing Improvements
test_004_cursor.pyto verify the behavior of the newprimaryKeysmethod, including setup and cleanup of test tables, validation for single and composite primary keys, column metadata correctness, handling of non-existent tables, and catalog filtering.