From: Federico Caselli Date: Sat, 1 Jul 2023 10:07:24 +0000 (+0200) Subject: Minor docs changes X-Git-Tag: rel_2_0_19~5^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=41637a3600a8d5de9bc3d1a10b2131d46513aa6b;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Minor docs changes Change-Id: I15d8aa3d497ef1f8bb1a14f216d99e4ebc5713b1 --- diff --git a/doc/build/changelog/changelog_11.rst b/doc/build/changelog/changelog_11.rst index c84effc390..fe2a02477c 100644 --- a/doc/build/changelog/changelog_11.rst +++ b/doc/build/changelog/changelog_11.rst @@ -949,7 +949,7 @@ :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. diff --git a/doc/build/orm/dataclasses.rst b/doc/build/orm/dataclasses.rst index 0b0c49a06e..12cb3ec376 100644 --- a/doc/build/orm/dataclasses.rst +++ b/doc/build/orm/dataclasses.rst @@ -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 ` 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 `_ 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 diff --git a/lib/sqlalchemy/engine/result.py b/lib/sqlalchemy/engine/result.py index e7f9b30b9e..250584c45b 100644 --- a/lib/sqlalchemy/engine/result.py +++ b/lib/sqlalchemy/engine/result.py @@ -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()