docs(sql): a parameterized query's status follows its result stream

describe() reports running until the reader has received every row of a parameterized query, so callers should open the reader directly instead of waiting for finished.
This commit is contained in:
Jack Ye
2026-10-07 23:03:39 -07:00
parent 951619df87
commit ddc6df31b8
3 changed files with 16 additions and 2 deletions
+3 -1
View File
@@ -1219,7 +1219,9 @@ class DBConnection(EnforceOverrides):
Parameters are supported in queries, not in DDL or DML. A
parameterized query runs on the call that returns its rows:
cancelling it, or dropping its handle before reading, stops it on the
server.
server. Its status follows that stream as well: ``describe()``
reports ``running`` until the reader has received every row, so open
``reader()`` directly rather than waiting for ``finished``.
Local connections do not support SQL.
"""