Merge "mention adapt on names" into main

zzzeek · Gerrit Code Review · commit b7a8ea19f47b · 2025-12-18T15:04:08.000Z
diff --git a/doc/build/orm/queryguide/select.rst b/doc/build/orm/queryguide/select.rst
@@ -365,7 +365,7 @@ Selecting Entities from Subqueries
 The :func:`_orm.aliased` construct discussed in the previous section
 can be used with any :class:`_sql.Subquery` construct that comes from a
 method such as :meth:`_sql.Select.subquery` to link ORM entities to the
-columns returned by that subquery; there must be a **column correspondence**
+columns returned by that subquery; by default, there must be a **column correspondence**
 relationship between the columns delivered by the subquery and the columns
 to which the entity is mapped, meaning, the subquery needs to be ultimately
 derived from those entities, such as in the example below::
@@ -387,6 +387,25 @@ derived from those entities, such as in the example below::
     User(id=4, name='squidward', fullname='Squidward Tentacles')
     User(id=5, name='ehkrabs', fullname='Eugene H. Krabs')
 
+Alternatively, an aliased subquery can be matched to the entity based on name
+by applying the :paramref:`_orm.aliased.adapt_on_names` parameter::
+
+    >>> from sqlalchemy import literal
+    >>> inner_stmt = select(
+    ...     literal(14).label("id"),
+    ...     literal("made up name").label("name"),
+    ...     literal("made up fullname").label("fullname"),
+    ... )
+    >>> subq = inner_stmt.subquery()
+    >>> aliased_user = aliased(User, subq, adapt_on_names=True)
+    >>> stmt = select(aliased_user)
+    >>> for user_obj in session.execute(stmt).scalars():
+    ...     print(user_obj)
+    {execsql}SELECT anon_1.id, anon_1.name, anon_1.fullname
+    FROM (SELECT ? AS id, ? AS name, ? AS fullname) AS anon_1
+    [generated in ...] (14, 'made up name', 'made up fullname')
+    {stop}User(id=14, name='made up name', fullname='made up fullname')
+
 .. seealso::
 
     :ref:`tutorial_subqueries_orm_aliased` - in the :ref:`unified_tutorial`
