]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
clarify exec_driver_sql
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 19 May 2023 13:50:09 +0000 (09:50 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 19 May 2023 13:50:09 +0000 (09:50 -0400)
this docstring wasn't really saying what this method was for.

Change-Id: I2d83ed2690c93d215faadaf7c6edcb02c6c57a6f

lib/sqlalchemy/engine/base.py

index dac7c94735b1589174bf6e23e8c4415acd5e57ed..0ef057471dd9767b51c498791e28f98d174a808b 100644 (file)
@@ -1713,8 +1713,11 @@ class Connection(ConnectionEventsTarget, inspection.Inspectable["Inspector"]):
         parameters: Optional[_DBAPIAnyExecuteParams] = None,
         execution_options: Optional[CoreExecuteOptionsParameter] = None,
     ) -> CursorResult[Any]:
-        r"""Executes a SQL statement construct and returns a
-        :class:`_engine.CursorResult`.
+        r"""Executes a string SQL statement on the DBAPI cursor directly,
+        without any SQL compilation steps.
+
+        This can be used to pass any string directly to the
+        ``cursor.execute()`` method of the DBAPI in use.
 
         :param statement: The statement str to be executed.   Bound parameters
          must use the underlying DBAPI's paramstyle, such as "qmark",
@@ -1725,6 +1728,8 @@ class Connection(ConnectionEventsTarget, inspection.Inspectable["Inspector"]):
          a tuple of positional parameters, or a list containing either
          dictionaries or tuples for multiple-execute support.
 
+        :return: a :class:`_engine.CursorResult`.
+
          E.g. multiple dictionaries::