diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-09-26 17:33:01 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-09-26 17:33:01 -0400 |
commit | f357e85f7be34c7a3d28ebf0c37f8f280137ba0a (patch) | |
tree | bd9a97b9fbece2cd41d298d2e152f5b430b2f1ad /lib/sqlalchemy/sql/expression.py | |
parent | 1e6a2096e38a15ff7b02d34ef9fc1cfb8d4ddc69 (diff) | |
download | sqlalchemy-f357e85f7be34c7a3d28ebf0c37f8f280137ba0a.tar.gz |
improved docs on select_from() [ticket:2274]
Diffstat (limited to 'lib/sqlalchemy/sql/expression.py')
-rw-r--r-- | lib/sqlalchemy/sql/expression.py | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/lib/sqlalchemy/sql/expression.py b/lib/sqlalchemy/sql/expression.py index 9a7f5e376..d5a2a5448 100644 --- a/lib/sqlalchemy/sql/expression.py +++ b/lib/sqlalchemy/sql/expression.py @@ -3318,8 +3318,9 @@ class _Exists(_UnaryExpression): return e def select_from(self, clause): - """return a new exists() construct with the given expression set as - its FROM clause. + """return a new :class:`._Exists` construct, applying the given expression + to the :meth:`.Select.select_from` method of the select statement + contained. """ e = self._clone() @@ -4677,8 +4678,16 @@ class Select(_SelectBase): @_generative def select_from(self, fromclause): - """return a new select() construct with the given FROM expression - applied to its list of FROM objects. + """return a new :class:`.Select` construct with the given FROM expression + merged into its list of FROM objects. + + The "from" list is a unique set on the identity of each element, + so adding an already present :class:`.Table` or other selectable + will have no effect. Passing a :class:`.Join` that refers + to an already present :class:`.Table` or other selectable will have + the effect of concealing the presence of that selectable as + an individual element in the rendered FROM list, instead rendering it into a + JOIN clause. """ self.append_from(fromclause) |