8
8
This section presents the API reference for the SQL Expression Language. For a full introduction to its usage,
9
9
see :ref:`sqlexpression_toplevel`.
14
The expression package uses functions to construct SQL expressions. The return value of each function is an object instance which is a subclass of :class:`~sqlalchemy.sql.expression.ClauseElement`.
16
.. autofunction:: alias
18
.. autofunction:: and_
22
.. autofunction:: between
24
.. autofunction:: bindparam
26
.. autofunction:: case
28
.. autofunction:: cast
30
.. autofunction:: sqlalchemy.sql.expression.column
32
.. autofunction:: collate
34
.. autofunction:: delete
36
.. autofunction:: desc
38
.. autofunction:: distinct
40
.. autofunction:: except_
42
.. autofunction:: except_all
44
.. autofunction:: exists
46
.. autofunction:: extract
48
.. autofunction:: false
52
.. autofunction:: insert
54
.. autofunction:: intersect
56
.. autofunction:: intersect_all
58
.. autofunction:: join
60
.. autofunction:: label
62
.. autofunction:: literal
64
.. autofunction:: literal_column
66
.. autofunction:: not_
68
.. autofunction:: null
70
.. autofunction:: nullsfirst
72
.. autofunction:: nullslast
76
.. autofunction:: outparam
78
.. autofunction:: outerjoin
80
.. autofunction:: over
82
.. autofunction:: select
84
.. autofunction:: subquery
86
.. autofunction:: sqlalchemy.sql.expression.table
88
.. autofunction:: text
90
.. autofunction:: true
92
.. autofunction:: tuple_
94
.. autofunction:: type_coerce
96
.. autofunction:: union
98
.. autofunction:: union_all
100
.. autofunction:: update
110
.. autoclass:: BinaryExpression
115
.. autoclass:: BindParameter
120
.. autoclass:: ClauseElement
124
.. autoclass:: ClauseList
128
.. autoclass:: ColumnClause
133
.. autoclass:: ColumnCollection
137
.. autoclass:: ColumnElement
142
.. autoclass:: sqlalchemy.sql.operators.ColumnOperators
149
.. autoclass:: CompoundSelect
154
.. autoclass:: sqlalchemy.sql.operators.custom_op
162
.. autoclass:: Delete
167
.. autoclass:: Executable
171
.. autoclass:: FunctionElement
176
.. autoclass:: Function
181
.. autoclass:: FromClause
185
.. autoclass:: Insert
195
.. autoclass:: sqlalchemy.sql.operators.Operators
199
.. autoclass:: Select
204
.. autoclass:: Selectable
208
.. autoclass:: SelectBase
212
.. autoclass:: TableClause
217
.. autoclass:: UnaryExpression
221
.. autoclass:: Update
226
.. autoclass:: UpdateBase
230
.. autoclass:: ValuesBase
234
.. _generic_functions:
239
SQL functions which are known to SQLAlchemy with regards to database-specific
240
rendering, return types and argument behavior. Generic functions are invoked
241
like all SQL functions, using the :attr:`func` attribute::
243
select([func.count()]).select_from(sometable)
245
Note that any name not known to :attr:`func` generates the function name as is
246
- there is no restriction on what SQL functions can be called, known or
247
unknown to SQLAlchemy, built-in or user defined. The section here only
248
describes those functions where SQLAlchemy already knows what argument and
249
return types are in use.
251
.. automodule:: sqlalchemy.sql.functions
added
removed
doc/build/core/expression_api.rst
