1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
Selectables, Tables, FROM objects
=================================
The term "selectable" refers to any object that rows can be selected from;
in SQLAlchemy, these objects descend from :class:`_expression.FromClause` and their
distinguishing feature is their :attr:`_expression.FromClause.c` attribute, which is
a namespace of all the columns contained within the FROM clause (these
elements are themselves :class:`_expression.ColumnElement` subclasses).
.. currentmodule:: sqlalchemy.sql.expression
.. _selectable_foundational_constructors:
Selectable Foundational Constructors
--------------------------------------
Top level "FROM clause" and "SELECT" constructors.
.. autofunction:: except_
.. autofunction:: except_all
.. autofunction:: exists
.. autofunction:: intersect
.. autofunction:: intersect_all
.. autofunction:: select
.. autofunction:: table
.. autofunction:: union
.. autofunction:: union_all
.. autofunction:: values
.. _fromclause_modifier_constructors:
Selectable Modifier Constructors
---------------------------------
Functions listed here are more commonly available as methods from
:class:`_sql.FromClause` and :class:`_sql.Selectable` elements, for example,
the :func:`_sql.alias` function is usually invoked via the
:meth:`_sql.FromClause.alias` method.
.. autofunction:: alias
.. autofunction:: cte
.. autofunction:: join
.. autofunction:: lateral
.. autofunction:: outerjoin
.. autofunction:: tablesample
Selectable Class Documentation
--------------------------------
The classes here are generated using the constructors listed at
:ref:`selectable_foundational_constructors` and
:ref:`fromclause_modifier_constructors`.
.. autoclass:: Alias
:members:
.. autoclass:: AliasedReturnsRows
:members:
.. autoclass:: CompoundSelect
:inherited-members: ClauseElement
:members:
.. autoclass:: CTE
:members:
.. autoclass:: Executable
:members:
.. autoclass:: Exists
:members:
.. autoclass:: FromClause
:members:
.. autoclass:: GenerativeSelect
:members:
.. autoclass:: HasCTE
:members:
.. autoclass:: HasPrefixes
:members:
.. autoclass:: HasSuffixes
:members:
.. autoclass:: Join
:members:
.. autoclass:: Lateral
:members:
.. autoclass:: ReturnsRows
:members:
:inherited-members: ClauseElement
.. autoclass:: ScalarSelect
:members:
.. autoclass:: Select
:members:
:inherited-members: ClauseElement
:exclude-members: memoized_attribute, memoized_instancemethod, append_correlation, append_column, append_prefix, append_whereclause, append_having, append_from, append_order_by, append_group_by
.. autoclass:: Selectable
:members:
:inherited-members: ClauseElement
.. autoclass:: SelectBase
:members:
:inherited-members: ClauseElement
:exclude-members: memoized_attribute, memoized_instancemethod
.. autoclass:: Subquery
:members:
.. autoclass:: TableClause
:members:
:inherited-members:
.. autoclass:: TableSample
:members:
.. autoclass:: TableValuedAlias
:members:
.. autoclass:: TextualSelect
:members:
:inherited-members:
.. autoclass:: Values
:members:
Label Style Constants
---------------------
Constants used with the :meth:`_sql.GenerativeSelect.set_label_style`
method.
.. autodata:: LABEL_STYLE_DISAMBIGUATE_ONLY
.. autodata:: LABEL_STYLE_NONE
.. autodata:: LABEL_STYLE_TABLENAME_PLUS_COL
.. data:: LABEL_STYLE_DEFAULT
The default label style, refers to :data:`_sql.LABEL_STYLE_DISAMBIGUATE_ONLY`.
.. versionadded:: 1.4
.. seealso::
:meth:`_sql.Select.set_label_style`
:meth:`_sql.Select.get_label_style`
|
