From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Sat, 14 Aug 2021 16:04:42 +0000 (-0400)
Subject: clarify with_polymorphic re: rows loaded
X-Git-Tag: rel_1_4_23~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=66144dbdc75dd67422e8b6def5b30694a25069e7;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

clarify with_polymorphic re: rows loaded

Change-Id: Iaec90932b5cb49e16ec95756f8c6129ba305c88d
References: #6878
---

diff --git a/doc/build/orm/inheritance_loading.rst b/doc/build/orm/inheritance_loading.rst
index 3ddff01cfb..daf60b7f83 100644
--- a/doc/build/orm/inheritance_loading.rst
+++ b/doc/build/orm/inheritance_loading.rst
@@ -74,18 +74,18 @@ statement for the above would be:
 
     query.all()
     {opensql}
-    SELECT employee.id AS employee_id,
+    SELECT
+        employee.id AS employee_id,
         engineer.id AS engineer_id,
         manager.id AS manager_id,
         employee.name AS employee_name,
         employee.type AS employee_type,
         engineer.engineer_info AS engineer_engineer_info,
         manager.manager_data AS manager_manager_data
-    FROM employee
-        LEFT OUTER JOIN engineer
-        ON employee.id = engineer.id
-        LEFT OUTER JOIN manager
-        ON employee.id = manager.id
+    FROM
+        employee
+        LEFT OUTER JOIN engineer ON employee.id = engineer.id
+        LEFT OUTER JOIN manager ON employee.id = manager.id
     []
 
 Where above, the additional tables / columns for "engineer" and "manager" are
@@ -106,6 +106,21 @@ subclasses:
     # include columns for all mapped subclasses
     entity = with_polymorphic(Employee, '*')
 
+.. tip::
+
+    It's important to note that :func:`_orm.with_polymorphic` only affects the
+    **columns that are included in fetched rows**, and not the **types of
+    objects returned**. A call to ``with_polymorphic(Employee, [Manager])``
+    will refer to rows that contain all types of ``Employee`` objects,
+    including not only ``Manager`` objects, but also ``Engineer`` objects as
+    these are subclasses of ``Employee``, as well as ``Employee`` instances if
+    these are present in the database. The effect of using
+    ``with_polymorphic(Employee, [Manager])`` would only provide the behavior
+    that additional columns specific to ``Manager`` will be eagerly loaded in
+    result rows, and as described below in
+    :ref:`with_polymorphic_subclass_attributes` also be available for use
+    within the WHERE clause of the SELECT statement.
+
 Using aliasing with with_polymorphic
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -229,6 +244,8 @@ modern database versions now support this syntax.
     of :paramref:`.with_polymorphic` with **joined table inheritance** and when
     the :paramref:`.with_polymorphic.selectable` argument is **not** used.
 
+.. _with_polymorphic_subclass_attributes:
+
 Referring to Specific Subclass Attributes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -249,6 +266,31 @@ specific to ``Engineer`` as well as ``Manager`` in terms of ``eng_plus_manager``
                     )
                 )
 
+A query as above would generate SQL resembling the following:
+
+.. sourcecode:: python+sql
+
+    query.all()
+    {opensql}
+    SELECT
+        employee.id AS employee_id,
+        engineer.id AS engineer_id,
+        manager.id AS manager_id,
+        employee.name AS employee_name,
+        employee.type AS employee_type,
+        engineer.engineer_info AS engineer_engineer_info,
+        manager.manager_data AS manager_manager_data
+    FROM
+        employee
+        LEFT OUTER JOIN engineer ON employee.id = engineer.id
+        LEFT OUTER JOIN manager ON employee.id = manager.id
+    WHERE
+      engineer.engineer_info=? OR
+      manager.manager_data=?
+    ['x', 'y']
+
+
+
 .. _with_polymorphic_mapper_config:
 
 Setting with_polymorphic at mapper configuration time