summaryrefslogtreecommitdiff
path: root/doc/build/core/functions.rst
blob: 8a3c5221fd15670f46da42923f832f2891e408b6 (plain)
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
.. _functions_toplevel:
.. _generic_functions:

=========================
SQL and Generic Functions
=========================

.. currentmodule:: sqlalchemy.sql.functions

SQL functions which are known to SQLAlchemy with regards to database-specific
rendering, return types and argument behavior. Generic functions are invoked
like all SQL functions, using the :attr:`func` attribute::

    select(func.count()).select_from(sometable)

Note that any name not known to :attr:`func` generates the function name as is
- there is no restriction on what SQL functions can be called, known or
unknown to SQLAlchemy, built-in or user defined. The section here only
describes those functions where SQLAlchemy already knows what argument and
return types are in use.

.. seealso::

    :ref:`tutorial_functions` - in the :ref:`unified_tutorial`

.. automodule:: sqlalchemy.sql.functions
   :members:
   :exclude-members: func