mirror of
https://github.com/sqlalchemy/sqlalchemy.git
synced 2026-05-28 11:35:19 -04:00
Mike Bayer
257 lines
4.5 KiB
ReStructuredText
257 lines
4.5 KiB
ReStructuredText
.. _expression_api_toplevel:
|
|
|
|
SQL Statements and Expressions API
|
|
==================================
|
|
|
|
.. module:: sqlalchemy.sql.expression
|
|
|
|
This section presents the API reference for the SQL Expression Language. For a full introduction to its usage,
|
|
see :ref:`sqlexpression_toplevel`.
|
|
|
|
Functions
|
|
---------
|
|
|
|
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`.
|
|
|
|
.. autofunction:: alias
|
|
|
|
.. autofunction:: and_
|
|
|
|
.. autofunction:: asc
|
|
|
|
.. autofunction:: between
|
|
|
|
.. autofunction:: bindparam
|
|
|
|
.. autofunction:: case
|
|
|
|
.. autofunction:: cast
|
|
|
|
.. autofunction:: sqlalchemy.sql.expression.column
|
|
|
|
.. autofunction:: collate
|
|
|
|
.. autofunction:: delete
|
|
|
|
.. autofunction:: desc
|
|
|
|
.. autofunction:: distinct
|
|
|
|
.. autofunction:: except_
|
|
|
|
.. autofunction:: except_all
|
|
|
|
.. autofunction:: exists
|
|
|
|
.. autofunction:: extract
|
|
|
|
.. autofunction:: false
|
|
|
|
.. autodata:: func
|
|
|
|
.. autofunction:: insert
|
|
|
|
.. autofunction:: intersect
|
|
|
|
.. autofunction:: intersect_all
|
|
|
|
.. autofunction:: join
|
|
|
|
.. autofunction:: label
|
|
|
|
.. autofunction:: literal
|
|
|
|
.. autofunction:: literal_column
|
|
|
|
.. autofunction:: not_
|
|
|
|
.. autofunction:: null
|
|
|
|
.. autofunction:: nullsfirst
|
|
|
|
.. autofunction:: nullslast
|
|
|
|
.. autofunction:: or_
|
|
|
|
.. autofunction:: outparam
|
|
|
|
.. autofunction:: outerjoin
|
|
|
|
.. autofunction:: over
|
|
|
|
.. autofunction:: select
|
|
|
|
.. autofunction:: subquery
|
|
|
|
.. autofunction:: sqlalchemy.sql.expression.table
|
|
|
|
.. autofunction:: text
|
|
|
|
.. autofunction:: true
|
|
|
|
.. autofunction:: tuple_
|
|
|
|
.. autofunction:: type_coerce
|
|
|
|
.. autofunction:: union
|
|
|
|
.. autofunction:: union_all
|
|
|
|
.. autofunction:: update
|
|
|
|
Classes
|
|
-------
|
|
|
|
.. autoclass:: Alias
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: BinaryExpression
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: BindParameter
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: ClauseElement
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: ClauseList
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: ColumnClause
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: ColumnCollection
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: ColumnElement
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: sqlalchemy.sql.operators.ColumnOperators
|
|
:members:
|
|
:special-members:
|
|
:inherited-members:
|
|
:show-inheritance:
|
|
|
|
|
|
.. autoclass:: CompoundSelect
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: sqlalchemy.sql.operators.custom_op
|
|
:members:
|
|
|
|
.. autoclass:: CTE
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: Delete
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: Executable
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: FunctionElement
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: Function
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: FromClause
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: Insert
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: Join
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: sqlalchemy.sql.operators.Operators
|
|
:members:
|
|
:special-members:
|
|
|
|
.. autoclass:: Select
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: Selectable
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: SelectBase
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: TableClause
|
|
:members:
|
|
:show-inheritance:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: UnaryExpression
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: Update
|
|
:members:
|
|
:inherited-members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: UpdateBase
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: ValuesBase
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. _generic_functions:
|
|
|
|
Generic 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.
|
|
|
|
.. automodule:: sqlalchemy.sql.functions
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
|
|
|