]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
narrow formatting in table, turn format off
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 14 Oct 2022 13:17:09 +0000 (09:17 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 14 Oct 2022 13:28:57 +0000 (09:28 -0400)
Change-Id: I0824495e0582657ffb63eaa2466021f56005c81c
References: https://github.com/sqlalchemy/sqlalchemy/discussions/8157#discussioncomment-3878806

doc/build/changelog/migration_20.rst

index 799c5421ba8e06932691e3fe3b82c582fa31e69c..757bf39160d1ff0fe1a15346a505429b5ef97b37 100644 (file)
@@ -1224,6 +1224,7 @@ calling form with links to documentation for each technique
 presented.  The individual migration notes are in the embedded sections
 following the table, and may include additional notes not summarized here.
 
+.. format: off
 
 .. container:: sliding-table
 
@@ -1250,9 +1251,15 @@ following the table, and may include additional notes not summarized here.
 
       - ::
 
-          session.execute(select(User)).scalars().all()
+          session.execute(
+            select(User)
+          ).scalars().all()
+
           # or
-          session.scalars(select(User)).all()
+
+          session.scalars(
+            select(User)
+          ).all()
 
       - :ref:`migration_20_unify_select`
 
@@ -1261,11 +1268,16 @@ following the table, and may include additional notes not summarized here.
 
     * - ::
 
-          session.query(User).filter_by(name="some user").one()
+          session.query(User).\
+            filter_by(name="some user").\
+            one()
 
       - ::
 
-          session.execute(select(User).filter_by(name="some user")).scalar_one()
+          session.execute(
+            select(User).
+            filter_by(name="some user")
+          ).scalar_one()
 
       - :ref:`migration_20_unify_select`
 
@@ -1273,11 +1285,17 @@ following the table, and may include additional notes not summarized here.
 
     * - ::
 
-          session.query(User).filter_by(name="some user").first()
+          session.query(User).\
+            filter_by(name="some user").\
+            first()
 
       - ::
 
-          session.scalars(select(User).filter_by(name="some user").limit(1)).first()
+          session.scalars(
+            select(User).
+            filter_by(name="some user").
+            limit(1)
+          ).first()
 
       - :ref:`migration_20_unify_select`
 
@@ -1285,22 +1303,38 @@ following the table, and may include additional notes not summarized here.
 
     * - ::
 
-            session.query(User).options(joinedload(User.addresses)).all()
+            session.query(User).options(
+              joinedload(User.addresses)
+            ).all()
 
       - ::
 
-            session.scalars(select(User).options(joinedload(User.addresses))).unique().all()
+            session.scalars(
+              select(User).
+              options(
+                joinedload(User.addresses)
+              )
+            ).unique().all()
 
       - :ref:`joinedload_not_uniqued`
 
     * - ::
 
-          session.query(User).join(Address).filter(Address.email == "e@sa.us").all()
+          session.query(User).\
+            join(Address).\
+            filter(
+              Address.email == "e@sa.us"
+            ).\
+            all()
 
       - ::
 
           session.execute(
-              select(User).join(Address).where(Address.email == "e@sa.us")
+            select(User).
+            join(Address).
+            where(
+              Address.email == "e@sa.us"
+            )
           ).scalars().all()
 
       - :ref:`migration_20_unify_select`
@@ -1309,27 +1343,43 @@ following the table, and may include additional notes not summarized here.
 
     * - ::
 
-          session.query(User).from_statement(text("select * from users")).all()
+          session.query(User).\
+            from_statement(
+              text("select * from users")
+            ).\
+            all()
 
       - ::
 
-          session.scalars(select(User).from_statement(text("select * from users"))).all()
+          session.scalars(
+            select(User).
+            from_statement(
+              text("select * from users")
+            )
+          ).all()
 
       - :ref:`orm_queryguide_selecting_text`
 
     * - ::
 
-          session.query(User).join(User.addresses).options(
+          session.query(User).\
+            join(User.addresses).\
+            options(
               contains_eager(User.addresses)
-          ).populate_existing().all()
+            ).\
+            populate_existing().all()
 
       - ::
 
           session.execute(
-              select(User)
-              .join(User.addresses)
-              .options(contains_eager(User.addresses))
-              .execution_options(populate_existing=True)
+            select(User)
+            .join(User.addresses)
+            .options(
+              contains_eager(User.addresses)
+            )
+            .execution_options(
+                populate_existing=True
+            )
           ).scalars().all()
 
       -
@@ -1341,17 +1391,22 @@ following the table, and may include additional notes not summarized here.
     *
       - ::
 
-          session.query(User).filter(User.name == "foo").update(
-              {"fullname": "Foo Bar"}, synchronize_session="evaluate"
-          )
+          session.query(User).\
+            filter(User.name == "foo").\
+            update(
+              {"fullname": "Foo Bar"},
+              synchronize_session="evaluate"
+            )
 
       - ::
 
           session.execute(
-              update(User)
-              .where(User.name == "foo")
-              .values(fullname="Foo Bar")
-              .execution_options(synchronize_session="evaluate")
+            update(User)
+            .where(User.name == "foo")
+            .values(fullname="Foo Bar")
+            .execution_options(
+              synchronize_session="evaluate"
+            )
           )
 
       - :ref:`orm_expression_update_delete`
@@ -1363,11 +1418,18 @@ following the table, and may include additional notes not summarized here.
 
       - ::
 
-          session.scalar(select(func.count()).select_from(User))
-          session.scalar(select(func.count(User.id)))
+          session.scalar(
+            select(func.count()).
+            select_from(User)
+          )
+          session.scalar(
+            select(func.count(User.id))
+          )
 
       - :meth:`_orm.Session.scalar`
 
+.. format: on
+
 .. _migration_20_unify_select:
 
 ORM Query Unified with Core Select