summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/selectable.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2019-07-06 15:47:16 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2019-07-06 15:52:23 -0400
commitdd453e19a79785e91463cd2b37d12a1d0f36c03a (patch)
treed1cf29f40a5c2db1589c9c899d52d73de4f555ac /lib/sqlalchemy/sql/selectable.py
parent91739c774220e135019e4201b21173fcdc2c8c21 (diff)
downloadsqlalchemy-dd453e19a79785e91463cd2b37d12a1d0f36c03a.tar.gz
class level docstring for Subquery
Remove inherited member doc from most selectables, it's too verbose Change-Id: I1b6635fe73342705846c0fab635b46557e560734
Diffstat (limited to 'lib/sqlalchemy/sql/selectable.py')
-rw-r--r--lib/sqlalchemy/sql/selectable.py26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/sqlalchemy/sql/selectable.py b/lib/sqlalchemy/sql/selectable.py
index 2263073c4..c93de8d73 100644
--- a/lib/sqlalchemy/sql/selectable.py
+++ b/lib/sqlalchemy/sql/selectable.py
@@ -1280,6 +1280,10 @@ class Alias(AliasedReturnsRows):
level function as well as the :meth:`.FromClause.alias` method available
on all :class:`.FromClause` subclasses.
+ .. seealso::
+
+ :meth:`.FromClause.alias`
+
"""
__visit_name__ = "alias"
@@ -1710,6 +1714,28 @@ class HasCTE(roles.HasCTERole):
class Subquery(AliasedReturnsRows):
+ """Represent a subquery of a SELECT.
+
+ A :class:`.Subquery` is created by invoking the
+ :meth:`.SelectBase.subquery` method, or for convenience the
+ :class:`.SelectBase.alias` method, on any :class:`.SelectBase` subclass
+ which includes :class:`.Select`, :class:`.CompoundSelect`, and
+ :class:`.TextualSelect`. As rendered in a FROM clause, it represents the
+ body of the SELECT statement inside of parenthesis, followed by the usual
+ "AS <somename>" that defines all "alias" objects.
+
+ The :class:`.Subquery` object is very similar to the :class:`.Alias`
+ object and can be used in an equivalent way. The difference between
+ :class:`.Alias` and :class:`.Subquery` is that :class:`.Alias` always
+ contains a :class:`.FromClause` object whereas :class:`.Subquery`
+ always contains a :class:`.SelectBase` object.
+
+ .. versionadded:: 1.4 The :class:`.Subquery` class was added which now
+ serves the purpose of providing an aliased version of a SELECT
+ statement.
+
+ """
+
__visit_name__ = "subquery"
_is_subquery = True