]> 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:51:30 +0000 (09:51 -0400)
this docstring wasn't really saying what this method was for.

Change-Id: I2d83ed2690c93d215faadaf7c6edcb02c6c57a6f
(cherry picked from commit 75d716c7799e28ba5c86c72db08025dd6fc8c6e0)

lib/sqlalchemy/engine/base.py

index 084ca8d7565fc746a49e9fd1ae436e9b52551dfd..53916cc1233e39526949cef695d1cd38c24e3d3e 100644 (file)
@@ -1712,8 +1712,11 @@ class Connection(Connectable):
     def exec_driver_sql(
         self, statement, parameters=None, execution_options=None
     ):
-        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",
@@ -1724,6 +1727,8 @@ class Connection(Connectable):
          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::