]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Minor docs changes
authorFederico Caselli <cfederico87@gmail.com>
Sat, 1 Jul 2023 10:07:24 +0000 (12:07 +0200)
committerFederico Caselli <cfederico87@gmail.com>
Tue, 11 Jul 2023 19:38:01 +0000 (21:38 +0200)
Change-Id: I15d8aa3d497ef1f8bb1a14f216d99e4ebc5713b1

doc/build/changelog/changelog_11.rst
doc/build/orm/dataclasses.rst
lib/sqlalchemy/engine/result.py

index c84effc3905bc7d2de41c71ace1354bbcf579f58..fe2a02477cec97dad7f6620e3158fa4bf1a10a1e 100644 (file)
         :tags: bug, sql
         :tickets: 3878
 
-        Fixed 1.1 regression where "import *" would not work for
+        Fixed 1.1 regression where ``import *`` would not work for
         sqlalchemy.sql.expression, due to mis-spelled ``any_`` and ``all_``
         functions.
 
index 0b0c49a06e22354ff812cc568116e29bedc253eb..12cb3ec3760bc61b5ec6ead4d50cfa8c4b4b6b5e 100644 (file)
@@ -528,15 +528,16 @@ variable may be generated::
 Integrating with Alternate Dataclass Providers such as Pydantic
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. warning::  The dataclass layer of Pydantic version 1.x is **not fully
-   compatible with SQLAlchemy's class instrumentation without additional
-   internal changes, and many features such as related collections may
-   not work correctly.**.
-
-   For Pydantic compatibility, please consider the
-   `SQLModel <https://sqlmodel.tiangolo.com/>` ORM which is built with
-   Pydantic on top of SQLAlchemy ORM, which includes special implementation
-   details which **explicitly resolve** these incompabilities.
+.. warning::
+
+    The dataclass layer of Pydantic version 1.x is **not fully compatible** with
+    SQLAlchemy's class instrumentation without additional internal changes,
+    and many features such as related collections may not work correctly.
+
+    For Pydantic compatibility, please consider the
+    `SQLModel <https://sqlmodel.tiangolo.com>`_ ORM which is built with
+    Pydantic on top of SQLAlchemy ORM, which includes special implementation
+    details which **explicitly resolve** these incompatibilities.
 
 SQLAlchemy's :class:`_orm.MappedAsDataclass` class
 and :meth:`_orm.registry.mapped_as_dataclass` method call directly into
index e7f9b30b9eaf3d0699f7adfaf4c9268caa13d56c..250584c45b67783c4e0e00d494f40c6b75294d8f 100644 (file)
@@ -1380,6 +1380,11 @@ class Result(_WithKeys, ResultInternal[Row[_TP]]):
 
         :return: a list of :class:`_engine.Row` objects.
 
+        .. seealso::
+
+            :ref:`engine_stream_results` - How to stream a large result set
+            without loading it completely in python.
+
         """
 
         return self._allrows()