FIX: Implementing RecordBatchReader.Close() functionality for Arrow

[subrata-ms]

Work Item / Issue Reference

AB#45978

GitHub Issue: #643

---

Summary

This pull request introduces a new _ArrowReader wrapper to enhance the behavior of the arrow_reader method in the Cursor class. The new wrapper ensures that server-side resources are properly released when the reader is closed, supporting robust cleanup and allowing the parent cursor to remain usable. The tests are updated and extended to verify the improved semantics, including close behavior and context manager support.

Enhancements to Arrow batch reading and resource management:

• Added the _ArrowReader class to cursor.py, which wraps a pyarrow.RecordBatchReader and implements an 8-step close sequence to properly release server-side resources, reset cursor state, and support idempotent and context-manager-based cleanup. The parent Cursor remains usable after closing the reader.
• Modified the Cursor.arrow_reader method to return an instance of _ArrowReader instead of a raw pyarrow.RecordBatchReader, ensuring that closing the reader stops fetching, releases the server-side cursor, and resets cursor state. [1] [2]

Test improvements for Arrow reader behavior:

• Updated the test_arrow_reader test to check for duck-typed compatibility with pyarrow.RecordBatchReader, reflecting the new wrapper class.
• Added new tests: test_arrow_reader_close_semantics to verify that .close() stops fetching, marks the reader as closed, is idempotent, and leaves the parent cursor usable; and test_arrow_reader_context_manager to verify that the reader is closed on context manager exit and the cursor remains usable.

[github-actions]

📊 Code Coverage Report

🔥 Diff Coverage 86%

🎯 Overall Coverage 80%

📈 Total Lines Covered: 6846 out of 8473 📁 Project: mssql-python

---

Diff Coverage

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

• mssql_python/cursor.py (87.2%): Missing lines 128,146,164,170-171,209,2936,2942,2950,2960,2969
• mssql_python/pybind/ddbc_bindings.cpp (84.2%): Missing lines 1449,1624-1625

Summary

• Total: 105 lines
• Missing: 14 lines
• Coverage: 86%

mssql_python/cursor.py

Lines 124-132

  124     @property
  125     def schema(self):
  126         """Schema of the record batches produced by this reader."""
  127         if self._closed:
! 128             raise self._arrow_invalid("Reader is closed")
  129         return self._inner.schema
  130 
  131     def read_next_batch(self):
  132         if self._closed:

---

Lines 142-150

  142         return self._inner.read_next_batch()
  143 
  144     def __enter__(self):
  145         if self._closed:
! 146             raise self._arrow_invalid("Reader is closed")
  147         return self
  148 
  149     def __exit__(self, exc_type, exc_val, exc_tb):
  150         self.close()

---

Lines 160-168

  160         try:
  161             import sys as _sys
  162 
  163             if _sys.is_finalizing():
! 164                 return
  165             # Retry whenever the generator is still referenced — covers both
  166             # "user never called close()" and "earlier close() raised before
  167             # the generator was released".
  168             if getattr(self, "_generator", None) is not None:

---

Lines 166-175

  166             # "user never called close()" and "earlier close() raised before
  167             # the generator was released".
  168             if getattr(self, "_generator", None) is not None:
  169                 self.close()
! 170         except Exception:  # pylint: disable=broad-exception-caught
! 171             pass
  172 
  173     # ── Close implementation ──────────────────────────────────────────────
  174 
  175     def close(self) -> None:

---

Lines 205-213

  205         cursor = self._cursor
  206         if cursor is not None and not cursor.closed and cursor.hstmt is not None:
  207             try:
  208                 cursor.hstmt._cancel()  # pylint: disable=protected-access
! 209             except Exception as e:  # pylint: disable=broad-exception-caught
  210                 logger.debug("arrow_reader.close: SQLCancel raised: %s", e)
  211 
  212         # Close the generator — this raises GeneratorExit inside it, which
  213         # runs the try/finally cleanup block (SQLFreeStmt + diag drain +

---

Lines 2932-2940

  2932                 # body.  This is the single canonical cleanup site.
  2933                 cur = cursor_ref[0]
  2934                 cursor_ref[0] = None
  2935                 if cur is None or cur.closed or cur.hstmt is None:
! 2936                     return
  2937 
  2938                 # 1) Drain diagnostics produced by the (possibly cancelled)
  2939                 #    fetch *before* SQL_CLOSE so we don't lose them.
  2940                 try:

---

Lines 2938-2946

  2938                 # 1) Drain diagnostics produced by the (possibly cancelled)
  2939                 #    fetch *before* SQL_CLOSE so we don't lose them.
  2940                 try:
  2941                     cur.messages.extend(ddbc_bindings.DDBCSQLGetAllDiagRecords(cur.hstmt))
! 2942                 except Exception as e:  # pylint: disable=broad-exception-caught
  2943                     logger.debug("arrow_reader cleanup: pre-close diag drain failed: %s", e)
  2944 
  2945                 # 2) Release the server-side cursor & locks while keeping the
  2946                 #    HSTMT and prepared plan intact, so the parent Cursor can

---

Lines 2946-2954

  2946                 #    HSTMT and prepared plan intact, so the parent Cursor can
  2947                 #    be re-executed.
  2948                 try:
  2949                     cur.hstmt._close_cursor()  # pylint: disable=protected-access
! 2950                 except Exception as e:  # pylint: disable=broad-exception-caught
  2951                     logger.debug("arrow_reader cleanup: _close_cursor failed: %s", e)
  2952 
  2953                 # 3) Drain diagnostics produced by SQL_CLOSE itself.  This
  2954                 #    runs unconditionally because SQL_CLOSE can return

---

Lines 2956-2964

  2956                 #    warning records on the HSTMT diag stack; the previous
  2957                 #    "only on failure" path would silently drop those.
  2958                 try:
  2959                     cur.messages.extend(ddbc_bindings.DDBCSQLGetAllDiagRecords(cur.hstmt))
! 2960                 except Exception as e:  # pylint: disable=broad-exception-caught
  2961                     logger.debug("arrow_reader cleanup: post-close diag drain failed: %s", e)
  2962 
  2963                 # 4) Reset cursor bookkeeping to a clean "no result set"
  2964                 #    state.  rowcount becomes -1 to signal that the prior

---

Lines 2965-2973

  2965                 #    result is no longer meaningful.
  2966                 try:
  2967                     cur._clear_rownumber()  # pylint: disable=protected-access
  2968                     cur.rowcount = -1
! 2969                 except Exception as e:  # pylint: disable=broad-exception-caught
  2970                     logger.debug("arrow_reader cleanup: bookkeeping reset failed: %s", e)
  2971 
  2972         gen = batch_generator()
  2973         inner = pyarrow.RecordBatchReader.from_batches(schema, gen)

---

mssql_python/pybind/ddbc_bindings.cpp

Lines 1445-1453

  1445     SQLEndTran_ptr = GetFunctionPointer<SQLEndTranFunc>(handle, "SQLEndTran");
  1446     SQLDisconnect_ptr = GetFunctionPointer<SQLDisconnectFunc>(handle, "SQLDisconnect");
  1447     SQLFreeHandle_ptr = GetFunctionPointer<SQLFreeHandleFunc>(handle, "SQLFreeHandle");
  1448     SQLFreeStmt_ptr = GetFunctionPointer<SQLFreeStmtFunc>(handle, "SQLFreeStmt");
! 1449     SQLCancel_ptr = GetFunctionPointer<SQLCancelFunc>(handle, "SQLCancel");
  1450 
  1451     SQLGetDiagRec_ptr = GetFunctionPointer<SQLGetDiagRecFunc>(handle, "SQLGetDiagRecW");
  1452 
  1453     SQLParamData_ptr = GetFunctionPointer<SQLParamDataFunc>(handle, "SQLParamData");

---

Lines 1620-1629

  1620     if (!SQLCancel_ptr) {
  1621         return;
  1622     }
  1623     SQLHANDLE h = _handle;
! 1624     SQLRETURN ret;
! 1625     {
  1626         py::gil_scoped_release release;
  1627         ret = SQLCancel_ptr(h);
  1628     }
  1629     // SQLCancel may return SQL_SUCCESS_WITH_INFO when there was nothing to

---

---

📋 Files Needing Attention

📉 Files with overall lowest coverage (click to expand)

mssql_python.pybind.logger_bridge.cpp: 59.2%
mssql_python.pybind.ddbc_bindings.h: 59.9%
mssql_python.pybind.logger_bridge.hpp: 70.8%
mssql_python.pybind.ddbc_bindings.cpp: 76.1%
mssql_python.pybind.connection.connection.cpp: 76.2%
mssql_python.__init__.py: 77.3%
mssql_python.row.py: 77.6%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.connection.py: 83.6%
mssql_python.logging.py: 85.5%

---

🔗 Quick Links

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

[Copilot]

Pull request overview

This PR improves Arrow streaming ergonomics by making Cursor.arrow_reader() return a RecordBatchReader-compatible wrapper whose .close() actually cancels in-flight fetches and releases server-side ODBC cursor resources, keeping the parent Cursor reusable.

Changes:

• Introduces _ArrowReader in cursor.py and updates Cursor.arrow_reader() to return it instead of a raw pyarrow.RecordBatchReader.
• Adds an ODBC SQLCancel binding and exposes it via SqlHandle._cancel() to support cross-thread cancellation during .close().
• Extends Arrow reader tests to validate close semantics, context-manager behavior, GC cleanup, and cross-thread cancellation.

Reviewed changes

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

File	Description
mssql_python/cursor.py	Adds _ArrowReader and reworks arrow_reader() to drive robust cleanup/cancellation and cursor state reset.
mssql_python/pybind/ddbc_bindings.h	Declares the SQLCancel function pointer type and adds SqlHandle::cancel() API surface.
mssql_python/pybind/ddbc_bindings.cpp	Loads SQLCancel, implements SqlHandle::cancel() (releasing the GIL), and exposes _cancel to Python.
tests/test_004_cursor_arrow.py	Updates/expands tests to cover new reader wrapper behavior and resource release semantics.

---

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

[ffelixg]

Huh, I didn't know that arrow readers supported a close method! I think that _ArrowReader should be subclassing pyarrow.RecordBatchReader. That way, we won't have to worry about duck typing. It also might save on some implementation overhead. @subrata-ms