]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
additional updates to stream results note
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 21 Mar 2022 20:29:59 +0000 (16:29 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 21 Mar 2022 20:30:45 +0000 (16:30 -0400)
Change-Id: I9d7ed9f412a2d9384f6c0b50316df79b6f8f481a

doc/build/core/connections.rst
lib/sqlalchemy/orm/query.py

index f749dbe4a35fdcb07dff47eaf1f4799e9dd48658..39ddab961c563167587cf8089d314670a711e901 100644 (file)
@@ -757,16 +757,19 @@ as the schema name is passed to these methods explicitly.
 
       session = Session(schema_engine)
 
-  When using the ORM, the schema translate feature is only supported as
-  **a single schema translate map per Session**.   It will **not work** if
-  different schema translate maps are given on a per-statement basis, as
-  the ORM :class:`_orm.Session` does not take current schema translate
-  values into account for individual objects.  In other words, all
-  objects loaded in a particular :class:`_orm.Session` must be based on the
-  **same** ``schema_translate_map``.
-
       ...
 
+  .. warning::
+
+    When using the ORM, the schema translate feature is only supported as
+    **a single schema translate map per Session**.   It will **not work** if
+    different schema translate maps are given on a per-statement basis, as
+    the ORM :class:`_orm.Session` does not take current schema translate
+    values into account for individual objects.  In other words, all
+    objects loaded in a particular :class:`_orm.Session` must be based on the
+    **same** ``schema_translate_map``.
+
+
 
 
 .. versionadded:: 1.1
index 3b4b082a4cafbccedea80b28887f63109df635b8..7eb957acc6573d2a6bef7b7d05a6f3e53a44aa1b 100644 (file)
@@ -1347,12 +1347,20 @@ class Query(
         automatically if the :meth:`~sqlalchemy.orm.query.Query.yield_per()`
         method or execution option is used.
 
+        .. versionadded:: 1.4 - added ORM options to
+           :meth:`_orm.Query.execution_options`
+
         The execution options may also be specified on a per execution basis
         when using :term:`2.0 style` queries via the
         :paramref:`_orm.Session.execution_options` parameter.
 
-        .. versionadded:: 1.4 - added ORM options to
-           :meth:`_orm.Query.execution_options`
+        .. warning:: The
+           :paramref:`_engine.Connection.execution_options.stream_results`
+           parameter should not be used at the level of individual ORM
+           statement executions, as the :class:`_orm.Session` will not track
+           objects from different schema translate maps within a single
+           session.
+
 
         .. seealso::