summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine
diff options
context:
space:
mode:
authormike bayer <mike_mp@zzzcomputing.com>2020-08-06 03:33:37 +0000
committerGerrit Code Review <gerrit@bbpush.zzzcomputing.com>2020-08-06 03:33:37 +0000
commit1d11001d8fef65ead8aad607f2aa0dff07b853e4 (patch)
treec314b02e35721cea8ae08d1edb7831a63366aa32 /lib/sqlalchemy/engine
parentc7c2bfd1363374fc48a6958e940377129a62de95 (diff)
parent30885744142d89740d459f4dae670ba4775d1d8c (diff)
downloadsqlalchemy-1d11001d8fef65ead8aad607f2aa0dff07b853e4.tar.gz
Merge "Documentation updates for 1.4"
Diffstat (limited to 'lib/sqlalchemy/engine')
-rw-r--r--lib/sqlalchemy/engine/interfaces.py2
-rw-r--r--lib/sqlalchemy/engine/result.py25
2 files changed, 24 insertions, 3 deletions
diff --git a/lib/sqlalchemy/engine/interfaces.py b/lib/sqlalchemy/engine/interfaces.py
index f925df6c5..1baef29af 100644
--- a/lib/sqlalchemy/engine/interfaces.py
+++ b/lib/sqlalchemy/engine/interfaces.py
@@ -953,7 +953,7 @@ class CreateEnginePlugin(object):
engine = create_engine(
"mysql+pymysql://scott:tiger@localhost/test?plugin=myplugin")
- Alternatively, the :paramref:`.create_engine.plugins" argument may be
+ Alternatively, the :paramref:`_sa.create_engine.plugins" argument may be
passed as a list to :func:`_sa.create_engine`::
engine = create_engine(
diff --git a/lib/sqlalchemy/engine/result.py b/lib/sqlalchemy/engine/result.py
index db546380e..621cba674 100644
--- a/lib/sqlalchemy/engine/result.py
+++ b/lib/sqlalchemy/engine/result.py
@@ -649,6 +649,11 @@ class Result(InPlaceGenerative):
it will produce a new :class:`_engine.Result` object each time
against its stored set of rows.
+ .. seealso::
+
+ :ref:`do_orm_execute_re_executing` - example usage within the
+ ORM to implement a result-set cache.
+
"""
return FrozenResult(self)
@@ -1173,12 +1178,28 @@ class FrozenResult(object):
frozen = result.freeze()
- r1 = frozen()
- r2 = frozen()
+ unfrozen_result_one = frozen()
+
+ for row in unfrozen_result_one:
+ print(row)
+
+ unfrozen_result_two = frozen()
+ rows = unfrozen_result_two.all()
+
# ... etc
.. versionadded:: 1.4
+ .. seealso::
+
+ .. seealso::
+
+ :ref:`do_orm_execute_re_executing` - example usage within the
+ ORM to implement a result-set cache.
+
+ :func:`_orm.loading.merge_frozen_result` - ORM function to merge
+ a frozen result back into a :class:`_orm.Session`.
+
"""
def __init__(self, result):