summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2013-12-20 19:12:31 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2013-12-20 19:12:31 -0500
commit730b23239365c0392077626d04246e8a62e7f40d (patch)
treec933d81368b10c59a61e279d407dfb2b4dc1316c /lib/sqlalchemy/engine
parent65bd6ec96602ab8b755b9bc25638957a09477de6 (diff)
downloadsqlalchemy-730b23239365c0392077626d04246e8a62e7f40d.tar.gz
- improve documentation for return_defaults() and returned_defaults. [ticket:2852]
Diffstat (limited to 'lib/sqlalchemy/engine')
-rw-r--r--lib/sqlalchemy/engine/result.py10
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/sqlalchemy/engine/result.py b/lib/sqlalchemy/engine/result.py
index 93c7d3b6b..3a613ef5a 100644
--- a/lib/sqlalchemy/engine/result.py
+++ b/lib/sqlalchemy/engine/result.py
@@ -627,10 +627,18 @@ class ResultProxy(object):
@property
def returned_defaults(self):
"""Return the values of default columns that were fetched using
- the ``returned_defaults`` feature.
+ the :meth:`.ValuesBase.return_defaults` feature.
+
+ The value is an instance of :class:`.RowProxy`, or ``None``
+ if :meth:`.ValuesBase.return_defaults` was not used or if the
+ backend does not support RETURNING.
.. versionadded:: 0.9.0
+ .. seealso::
+
+ :meth:`.ValuesBase.return_defaults`
+
"""
return self.context.returned_defaults