U@Q[S d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm
Z
dd l m Z dd
l m
Z
dd l mZ dd l mZ dd
l mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddlmZ ddlm Z ddlm Z ddl m Z ddlmZ ej e! Z" ej d Z# ej$ d d Z%dud!Z& G d" d#e
ee Z' G d$ d%e Z( G d& d'e) Z* e* Z+e*j e+_ e*d() Z, G d* d+e' Z- G d, d-e Z. G d. d/ ej/ e.e- Z0 e&d0e e&d1e G d2 d3e0 Z1 G d4 d5e0 Z2 G d6 d7e0 Z3 G d8 d9e3 Z4 G d: d;e3 Z5 G d< d=e3 Z6 G d> d?e3 Z7 G d@ dAe0 Z8 G dB dCe0 Z9 G dD dEe0 Z: G dF dGe0 Z; G dH dIe0 Z< G dJ dKe2 Z= G dL dMe2 Z> G dN dOe2 Z? G dP dQe2 Z@ G dR dSe2 ZA G dT dUe2 ZB G dV dWe2 ZC G dX dYe2 ZD G dZ d[e2 ZE G d\ d]e0 ZF G d^ d_e0 ZG G d` daeG ZH G db dceG ZI G dd deeG ZJ G df dge0 ZK G dh die0 ZL G dj dke0 ZM G dl dme0 ZN G dn doe0 ZO G dp dqe0 ZP G dr dse0 ZQdtS )vz6SQL function API, factories, and built-in functions.
)
annotation) operators)schema)sqltypes)util)ColumnCollection)
Executable)_clone_literal_as_binds)_type_from_args)BinaryExpression)
BindParameter)Cast)
ClauseList)
ColumnElement)ExtractFunctionFilter)Grouping)literal_columnOver WithinGroup)Alias)
FromClause)Select)
VisitableType c 4 t j t S N)r defaultdictdict l/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib64/python3.11/site-packages/sqlalchemy/sql/functions.pyr( ( s D4DT4J4J r& case_sensitive_functionzHSymbol to mark the functions that are switched into case-sensitive mode.)namedoc_defaultc t | }t | }| }t j | } | |v r|| t
ur||| v r-t j d | ||| < nt j d |t ||
d t
|| < n| |v r||| vrNt j d t ||
| n-t j d | n||| < ||| |< dS )zAssociate a callable with a particular func. name.
This is normally called by _GenericMeta, but is also
available by itself so that a non-Function construct
can be associated with the :data:`.func` accessor (i.e.
CAST, EXTRACT).
zMThe GenericFunction '{}' is already registered and is going to be overridden.zGenericFunction '{}' is already registered with different letter case, so the previously registered function '{}' is switched into case-sensitive mode. GenericFunction objects will be fully case-insensitive in a future release. zGenericFunction(s) '{}' are already registered with different letter cases and might interact with '{}'. GenericFunction objects will be fully case-insensitive in a future release.zLThe GenericFunction '{}' is already registered and is going to be overriden.N) _registry_case_sensitive_registryr text_typelower_CASE_SENSITIVEwarnformatwarn_deprecatedlistkeyssorted)
identifierfnpackageregcase_sensitive_regraw_identifiers r' register_functionr@ 0 s G
C1': N
++1133J SS_O C C /
; ; ; I--3VJ-?-?
!C
OO
" #)&"+J7<<>>??B# #
.C
OO
) ) ) !3J!? ? ? " #)&-j9>>@@AA"# #
I,,2F>,B,B
J 68z">222r& c e Zd ZdZdZdZd Zd Zed Z e
j d Z dd Z
d
Zd Zd Zed
Zd ZefdZd ZddZd Zd Zd ZddZd fd Z xZ S )FunctionElementaz Base for SQL function-oriented constructs.
.. seealso::
:ref:`coretutorial_functions` - in the Core tutorial
:class:`.Function` - named SQL function.
:data:`.func` - namespace which produces registered or ad-hoc
:class:`.Function` instances.
:class:`.GenericFunction` - allows creation of registered function
types.
r% Fc fd|D } j pt | _ t |t j dd _ dS )aO Construct a :class:`.FunctionElement`.
:param \*clauses: list of column expressions that form the arguments
of the SQL function call.
:param \**kwargs: additional kwargs are typically consumed by
subclasses.
.. seealso::
:data:`.func`
:class:`.Function`
c : g | ]}t |j S r% r r* .0cselfs r'
z,FunctionElement.__init__.. s& AAAA!!TY//AAAr& Toperatorgroup_contentsN) _has_argsboolr r comma_op
self_group clause_expr)rI clauseskwargsargss ` r' __init__zFunctionElement.__init__ sf BAAAAAA 54::%?CY'
*,,
r& c 0 | | || S r" )_execute_function)rI
connection multiparamsparamss r' _execute_on_connectionz&FunctionElement._execute_on_connection s ++D+vFFFr& c F t | d S )a? The set of columns exported by this :class:`.FunctionElement`.
Function objects currently have no result column names built in;
this method returns a single-element column collection with
an anonymously named column.
An interim approach to providing named columns for a function
as a FROM clause is to build a :func:`_expression.select` with the
desired columns::
from sqlalchemy.sql import column
stmt = select([column('x'), column('y')]).\
select_from(func.myfunction())
N)r labelrI s r' columnszFunctionElement.columns s &
4 0 0111r& c | j j S )z}Return the underlying :class:`.ClauseList` which contains
the arguments for this :class:`.FunctionElement`.
)rR elementr_ s r' rS zFunctionElement.clauses s ''r& Nc * t | |||| S )a Produce an OVER clause against this function.
Used against aggregate or so-called "window" functions,
for database backends that support window functions.
The expression::
func.row_number().over(order_by='x')
is shorthand for::
from sqlalchemy import over
over(func.row_number(), order_by='x')
See :func:`_expression.over` for a full description.
) partition_byorder_byrowsrange_r )rI rd re rf rg s r' overzFunctionElement.over s* $ %
r& c t | g|R S )ax Produce a WITHIN GROUP (ORDER BY expr) clause against this function.
Used against so-called "ordered set aggregate" and "hypothetical
set aggregate" functions, including :class:`.percentile_cont`,
:class:`.rank`, :class:`.dense_rank`, etc.
See :func:`_expression.within_group` for a full description.
.. versionadded:: 1.1
r )rI re s r' within_groupz FunctionElement.within_group s 4+(++++r& c $ |s| S t | g|R S )a Produce a FILTER clause against this function.
Used against aggregate and window functions,
for database backends that support the "FILTER" clause.
The expression::
func.count(1).filter(True)
is shorthand for::
from sqlalchemy import funcfilter
funcfilter(func.count(1), True)
.. versionadded:: 1.0.0
.. seealso::
:class:`.FunctionFilter`
:func:`.funcfilter`
r )rI criterions r' filterzFunctionElement.filter s' 2 K d/Y////r& c $ t | || S )ai
Interpret this expression as a boolean comparison between two values.
A hypothetical SQL function "is_equal()" which compares to values
for equality would be written in the Core expression language as::
expr = func.is_equal("a", "b")
If "is_equal()" above is comparing "a" and "b" for equality, the
:meth:`.FunctionElement.as_comparison` method would be invoked as::
expr = func.is_equal("a", "b").as_comparison(1, 2)
Where above, the integer value "1" refers to the first argument of the
"is_equal()" function and the integer value "2" refers to the second.
This would create a :class:`.BinaryExpression` that is equivalent to::
BinaryExpression("a", "b", operator=op.eq)
However, at the SQL level it would still render as
"is_equal('a', 'b')".
The ORM, when it loads a related object or collection, needs to be able
to manipulate the "left" and "right" sides of the ON clause of a JOIN
expression. The purpose of this method is to provide a SQL function
construct that can also supply this information to the ORM, when used
with the :paramref:`_orm.relationship.primaryjoin` parameter.
The return
value is a containment object called :class:`.FunctionAsBinary`.
An ORM example is as follows::
class Venue(Base):
__tablename__ = 'venue'
id = Column(Integer, primary_key=True)
name = Column(String)
descendants = relationship(
"Venue",
primaryjoin=func.instr(
remote(foreign(name)), name + "/"
).as_comparison(1, 2) == 1,
viewonly=True,
order_by=name
)
Above, the "Venue" class can load descendant "Venue" objects by
determining if the name of the parent Venue is contained within the
start of the hypothetical descendant value's name, e.g. "parent1" would
match up to "parent1/child1", but not to "parent2/child1".
Possible use cases include the "materialized path" example given above,
as well as making use of special SQL functions such as geometric
functions to create join conditions.
:param left_index: the integer 1-based index of the function argument
that serves as the "left" side of the expression.
:param right_index: the integer 1-based index of the function argument
that serves as the "right" side of the expression.
.. versionadded:: 1.3
)FunctionAsBinary)rI
left_index right_indexs r'
as_comparisonz FunctionElement.as_comparison s @ j+>>>r& c | j j S r" )rS
_from_objectsr_ s r' rt z FunctionElement._from_objectsE s
|))r& c | j fS r" )rR )rI rT s r' get_childrenz FunctionElement.get_childrenI s ""r& c || j fi || _ | t j | d S r" )rR _reset_exportedrB rS _reset)rI clonekws r' _copy_internalsz FunctionElement._copy_internalsL sN 5!188R88 &&t,,,,,r& c dS )a For types that define their return type as based on the criteria
within a WITHIN GROUP (ORDER BY) expression, called by the
:class:`.WithinGroup` construct.
Returns None by default, in which case the function's normal ``.type``
is used.
Nr% )rI rj s r' within_group_typez!FunctionElement.within_group_typeQ s tr& c , t j | | S )aj Produce a :class:`_expression.Alias` construct against this
:class:`.FunctionElement`.
This construct wraps the function in a named alias which
is suitable for the FROM clause, in the style accepted for example
by PostgreSQL.
e.g.::
from sqlalchemy.sql import column
stmt = select([column('data_view')]).\
select_from(SomeTable).\
select_from(func.unnest(SomeTable.data).alias('data_view')
)
Would produce:
.. sourcecode:: sql
SELECT data_view
FROM sometable, unnest(sometable.data) AS data_view
.. versionadded:: 0.9.8 The :meth:`.FunctionElement.alias` method
is now supported. Previously, this method's behavior was
undefined and did not behave consistently across versions.
)r
_construct)rI r* flats r' aliaszFunctionElement.alias] s < d+++r& c X t | g }| j r |j di | j }|S )zProduce a :func:`_expression.select` construct
against this :class:`.FunctionElement`.
This is shorthand for::
s = select([function_element])
r% )r _execution_optionsexecution_options)rI ss r' selectzFunctionElement.select} s<
D6NN " ?##>>d&=>>Ar& c r | S )a Execute this :class:`.FunctionElement` against an embedded
'bind' and return a scalar value.
This first calls :meth:`~.FunctionElement.select` to
produce a SELECT construct.
Note that :class:`.FunctionElement` can be passed to
the :meth:`.Connectable.scalar` method of :class:`_engine.Connection`
or :class:`_engine.Engine`.
)r executescalarr_ s r' r zFunctionElement.scalar s* {{}}$$&&--///r& c N | S )ag Execute this :class:`.FunctionElement` against an embedded
'bind'.
This first calls :meth:`~.FunctionElement.select` to
produce a SELECT construct.
Note that :class:`.FunctionElement` can be passed to
the :meth:`.Connectable.execute` method of :class:`_engine.Connection`
or :class:`_engine.Engine`.
)r r r_ s r' r zFunctionElement.execute s {{}}$$&&&r& c 6 t d ||| j d| S )NT)_compared_to_operator_compared_to_typeuniquetype_)r typerI rL objr s r' _bind_paramzFunctionElement._bind_param s- "* "i
r& c |t j u r.t | j t j rt
| S t t | | S )N)against)
r getitem
isinstancer r ARRAYr superrB rQ )rI r __class__s r' rQ zFunctionElement.self_group sZ
i' ' 'J Ix~-
-
' D>> ! $//::7:KK Kr& )NNNN)NFr" ) __name__
__module__ __qualname____doc__ packagenamesrN rV r\ propertyr` r memoized_propertyrS rh rj rm rr rt rv r
r| r~ r r r r r rQ
__classcell__r s @r' rB rB r s LI ,G G G 2 2 X2(
( ( (
4
,
,
, 0 0 0:@? @? @?D * * X*# # # %+ - - - -
, , , ,@ 0 0 0 ' ' '
L
L
L
L
L
L
L
L
L
Lr& rB c e Zd Z fdZed Zej d Zed Zej d Z fdZ xZ S )ro c |j j |dz
}|j j |dz
}|| _ || _ || _ t t
| ||t j t j
d S )Nr )r ) rS sql_functionrp rq r ro rV r function_as_comparison_opr BOOLEANTYPE)rI r; rp rq leftrightr s r' rV zFunctionAsBinary.__init__ s z!*q.1
";?3 $&
%%.. /& /
r& c @ | j j j | j dz
S Nr r rS rp r_ s r' r zFunctionAsBinary.left s (0 11DEEr& c > || j j j | j dz
< d S r r rI values r' r zFunctionAsBinary.left s" AF!)$/A*=>>>r& c @ | j j j | j dz
S r r rS rq r_ s r' r zFunctionAsBinary.right s (01AA1EFFr& c > || j j j | j dz
< d S r r r s r' r zFunctionAsBinary.right s# BG!)$*:Q*>???r& c | d } || j fi || _ t t | j di | d S )Nrz r% )popr r ro r| )rI r{ rz r s r' r| z FunctionAsBinary._copy_internals sY w !E$"3 : :r : :5 %%5;;;;;;;r& )
r r r rV r r setterr r| r r s @r' ro ro s
F F XF
[G G [G G G XG \H H \H< < < < < < < < >> print(func.count(1))
count(:param_1)
The returned object is an instance of :class:`.Function`, and is a
column-oriented SQL element like any other, and is used in that way::
>>> print(select([func.count(table.c.id)]))
SELECT count(sometable.id) FROM sometable
Any name can be given to :data:`.func`. If the function name is unknown to
SQLAlchemy, it will be rendered exactly as is. For common SQL functions
which SQLAlchemy is aware of, the name may be interpreted as a *generic
function* which will be compiled appropriately to the target database::
>>> print(func.current_timestamp())
CURRENT_TIMESTAMP
To call functions which are present in dot-separated packages,
specify them in the same manner::
>>> print(func.stats.yield_curve(5, 10))
stats.yield_curve(:yield_curve_1, :yield_curve_2)
SQLAlchemy can be made aware of the return type of functions to enable
type-specific lexical and result-based behavior. For example, to ensure
that a string-based function returns a Unicode value and is similarly
treated as a string in expressions, specify
:class:`~sqlalchemy.types.Unicode` as the type:
>>> print(func.my_string(u'hi', type_=Unicode) + ' ' +
... func.my_string(u'there', type_=Unicode))
my_string(:my_string_1) || :my_string_2 || my_string(:my_string_3)
The object returned by a :data:`.func` call is usually an instance of
:class:`.Function`.
This object meets the "column" interface, including comparison and labeling
functions. The object can also be passed the :meth:`~.Connectable.execute`
method of a :class:`_engine.Connection` or :class:`_engine.Engine`,
where it will be
wrapped inside of a SELECT statement first::
print(connection.execute(func.current_timestamp()).scalar())
In a few exception cases, the :data:`.func` accessor
will redirect a name to a built-in expression such as :func:`.cast`
or :func:`.extract`, as these names have well-known meaning
but are not exactly the same as "functions" from a SQLAlchemy
perspective.
Functions which are interpreted as "generic" functions know how to
calculate their return type automatically. For a listing of known generic
functions, see :ref:`generic_functions`.
.. note::
The :data:`.func` construct has only limited support for calling
standalone "stored procedures", especially those with special
parameterization concerns.
See the section :ref:`stored_procedures` for details on how to use
the DBAPI-level ``callproc()`` method for fully traditional stored
procedures.
.. seealso::
:ref:`coretutorial_functions` - in the Core Tutorial
:class:`.Function`
c " g | _ || _ d S r" )_FunctionGenerator__namesopts)rI r s r' rV z_FunctionGenerator.__init__1 s r& c | d r+ | j | S # t $ r t | w xY w| d r
|dd }t di | j }t | j |gz |_ |S )N___r. r% )
startswith__dict__KeyErrorAttributeErrorendswithr r r7 r )rI r* fs r' __getattr__z _FunctionGenerator.__getattr__5 s ??4
+}T**
+
+
+$T***
+ ]]3
":D + + + + &&$/ s $ >c H | j }| | t | j }|dk r | j \ }}n|dk rd| j d }}nd }|t
| | }|t u rGt | }| | | }| ||i |S t | j d g|R d| j dd i|S )Nr r r, r. r r ) r copyupdatelenr r/ getr2 r3 r0 Function) rI rH rT otokensr< fnamefuncr> s r' __call__z_FunctionGenerator.__call__C s/ INN T\"" Q;; !\NGUU
q[[ ' a UGGG W%))%++--88D&&%=g%F")--ekkmm<<@@GG tQ}!}}$ L
@A
+/<"+=
EF
r& N)r r r r rV r r r% r& r' r r sN J JX
r& r F)groupc $ e Zd ZdZdZd ZddZdS )r a Describe a named SQL function.
The :class:`.Function` object is typically generated from the
:data:`.func` generation object.
:param \*clauses: list of column expressions that form the arguments
of the SQL function call.
:param type\_: optional :class:`.TypeEngine` datatype object that will be
used as the return value of the column expression generated by this
function call.
:param packagenames: a string which indicates package prefix names
to be prepended to the function name when the SQL is generated.
The :data:`.func` generator creates these when it is called using
dotted format, e.g.::
func.mypackage.some_function(col1, col2)
.. seealso::
:ref:`coretutorial_functions`
:data:`.func` - namespace which produces registered or ad-hoc
:class:`.Function` instances.
:class:`.GenericFunction` - allows creation of registered function
types.
functionc | dd pg | _ || _ | dd | _ t j | dd | _ t j | g|R i | dS )zConstruct a :class:`.Function`.
The :data:`.func` construct is normally used to construct
new :class:`.Function` instances.
r Nbindr )
r r r* r _bindr to_instancer rB rV )rI r* rS r{ s r' rV zFunction.__init__ s FF>4 8 8 >B VVFD))
()>)>?? 6666266666r& Nc @ t | j ||| j |d S )NT)r r r r )r r* r r s r' r zFunction._bind_param s/ I "* "i
r& r" )r r r r __visit_name__rV r r% r& r' r r d sI B N 7 7 7
r& r c e Zd Z fdZ xZS ) _GenericMetac t j | j vr| d| x| _ }| d| x| _ }| dd }d|v r
|d | _ t | dd | _ | j rt || | nd| _ t t |
||| d S )Nr* r: r< r, __return_type__ _registerT)r Annotated__mro__r r* r: r r getattrr r@ r r rV )clsclsnamebasesclsdictr* r: r< r s r' rV z_GenericMeta.__init__ s s{ 2 2 %kk&' : : :CHt*1++lD*I*I ICNZ kk)Z88G G++"#45 $Cd ; ;CM }
%!*c7;;;; !%
lC ))'5'BBBBBr& )r r r rV r r s @r' r r sA C C C C C C C C Cr& r c e Zd ZdZdZdZd ZdS )GenericFunctiona Define a 'generic' function.
A generic function is a pre-established :class:`.Function`
class that is instantiated automatically when called
by name from the :data:`.func` attribute. Note that
calling any name from :data:`.func` has the effect that
a new :class:`.Function` instance is created automatically,
given that name. The primary use case for defining
a :class:`.GenericFunction` class is so that a function
of a particular name may be given a fixed return type.
It can also include custom argument parsing schemes as well
as additional methods.
Subclasses of :class:`.GenericFunction` are automatically
registered under the name of the class. For
example, a user-defined function ``as_utc()`` would
be available immediately::
from sqlalchemy.sql.functions import GenericFunction
from sqlalchemy.types import DateTime
class as_utc(GenericFunction):
type = DateTime
print(select([func.as_utc()]))
User-defined generic functions can be organized into
packages by specifying the "package" attribute when defining
:class:`.GenericFunction`. Third party libraries
containing many functions may want to use this in order
to avoid name conflicts with other systems. For example,
if our ``as_utc()`` function were part of a package
"time"::
class as_utc(GenericFunction):
type = DateTime
package = "time"
The above function would be available from :data:`.func`
using the package name ``time``::
print(select([func.time.as_utc()]))
A final option is to allow the function to be accessed
from one name in :data:`.func` but to render as a different name.
The ``identifier`` attribute will override the name used to
access the function as loaded from :data:`.func`, but will retain
the usage of ``name`` as the rendered name::
class GeoBuffer(GenericFunction):
type = Geometry
package = "geo"
name = "ST_Buffer"
identifier = "buffer"
The above function will render as follows::
>>> print(func.geo.buffer())
ST_Buffer()
The name will be rendered as is, however without quoting unless the name
contains special characters that require quoting. To force quoting
on or off for the name, use the :class:`.sqlalchemy.sql.quoted_name`
construct::
from sqlalchemy.sql import quoted_name
class GeoBuffer(GenericFunction):
type = Geometry
package = "geo"
name = quoted_name("ST_Buffer", True)
identifier = "buffer"
The above function will render as::
>>> print(func.geo.buffer())
"ST_Buffer"()
.. versionadded:: 1.3.13 The :class:`.quoted_name` construct is now
recognized for quoting when used with the "name" attribute of the
object, so that quoting can be forced on or off for the function
name.
TFc | dd }| fd|D } j pt | _ g _ | dd _ t
|t j dd _
t j | dd pt dd _ d S )N _parsed_argsc : g | ]}t |j S r% rE rF s r' rJ z,GenericFunction.__init__.. s& IIIq,Q ::IIIr& r TrK r r )r rN rO r r r r r rP rQ rR r r r r )rI rU rT parsed_argss ` r' rV zGenericFunction.__init__ s jj 66 IIIIDIIIK <4 +<+< ZZ--
%?JY'
*,,
( JJw % % Dvt)D)D
r& N)r r r r coerce_argumentsr rV r% r& r' r r s= T Tl I
r& r castextractc P e Zd ZdZ ej Zd Zd Ze d Z
dS )
next_valuea Represent the 'next value', given a :class:`.Sequence`
as its single argument.
Compiles into the appropriate function on each backend,
or will raise NotImplementedError if used on a backend
that does not provide support for sequences.
c t |t j s
J d | dd | _ || _ d S )Nz0next_value() accepts a Sequence object as input.r )r r Sequencer r sequence)rI seqr{ s r' rV znext_value.__init__2 sT
> > = > >
VVFD))
r& c g S r" r% r_ s r' rt znext_value._from_objects9 s r& N) r r r r r Integerr r* rV r rt r% r& r' r r % s_ 8 D D X r& r c e Zd Zd ZdS ) AnsiFunctionc 0 t j | g|R i | d S r" r rV )rI rU rT s r' rV zAnsiFunction.__init__? s) 777777777r& N)r r r rV r% r& r' r r > s# 8 8 8 8 8r& r c " e Zd ZdZ fdZ xZS )ReturnTypeFromArgszADefine a function whose return type is the same as its arguments.c fd|D }| dt | ||d< t t j |i | d S )Nc : g | ]}t |j S r% rE rF s r' rJ z/ReturnTypeFromArgs.__init__..G s& >>>A!!TY//>>>r& r r )
setdefaultr
r r rV )rI rU rT r s ` r' rV zReturnTypeFromArgs.__init__F sn >>>>>>>'?4#8#8999!%~ 0 $''0$A&AAAAAr& )r r r r rV r r s @r' r r C sG KKB B B B B B B B Br& r c e Zd ZdZdS )coalesceTNr r r rN r% r& r' r r M IIIr& r c e Zd ZdS )maxNr r r r% r& r' r r Q Dr& r c e Zd ZdS )minNr r% r& r' r r U r r& r c e Zd ZdS )sumNr r% r& r' r
r
Y r r& r
c e Zd Zej ZdS )nowNr r r r DateTimer r% r& r' r r ] DDDr& r c e Zd Zej ZdS )concatNr r r r Stringr r% r& r' r r a ?DDDr& r c " e Zd Zej Zd ZdS ) char_lengthc , t j | |fi | d S r" r )rI argrT s r' rV zchar_length.__init__h s# s55f55555r& N)r r r r r r rV r% r& r' r r e s+ D6 6 6 6 6r& r c e Zd ZdZdS )randomTNr r% r& r' r r l r r& r c 2 e Zd ZdZej Zd fd Z xZS )counta The ANSI COUNT aggregate function. With no arguments,
emits COUNT \*.
E.g.::
from sqlalchemy import func
from sqlalchemy import select
from sqlalchemy import table, column
my_table = table('some_table', column('id'))
stmt = select([func.count()]).select_from(my_table)
Executing ``stmt`` would emit::
SELECT count(*) AS count_1
FROM some_table
Nc l |t d } t t | j |fi | d S )N*)r r r rV )rI
expressionrT r s r' rV zcount.__init__ sA ',,J#eT#J99&99999r& r" ) r r r r r r r rV r r s @r' r r p sQ ( D: : : : : : : : : :r& r c e Zd Zej ZdS ) current_dateN)r r r r Dater r% r& r' r$ r$ =DDDr& r$ c e Zd Zej ZdS ) current_timeN)r r r r Timer r% r& r' r( r( r& r& r( c e Zd Zej ZdS )current_timestampNr r% r& r' r+ r+ r r& r+ c e Zd Zej ZdS ) current_userNr r% r& r' r- r- r r& r- c e Zd Zej ZdS ) localtimeNr r% r& r' r/ r/ r r& r/ c e Zd Zej ZdS )localtimestampNr r% r& r' r1 r1 r r& r1 c e Zd Zej ZdS ) session_userNr r% r& r' r3 r3 r r& r3 c e Zd Zej ZdS )sysdateNr r% r& r' r5 r5 r r& r5 c e Zd Zej ZdS )userNr r% r& r' r7 r7 r r& r7 c 0 e Zd ZdZej Z fdZ xZS ) array_agga Support for the ARRAY_AGG function.
The ``func.array_agg(expr)`` construct returns an expression of
type :class:`_types.ARRAY`.
e.g.::
stmt = select([func.array_agg(table.c.values)[2:5]])
.. versionadded:: 1.1
.. seealso::
:func:`_postgresql.array_agg` - PostgreSQL-specific version that
returns :class:`_postgresql.ARRAY`, which has PG-specific operators
added.
c , d |D }| dt j }d|vr=t | }t |t j r||d< n || |d< ||d< t t | j |i | d S )Nc , g | ]}t | S r% r )rG rH s r' rJ z&array_agg.__init__.. s! 333!!$$333r& _default_array_typer r )r r r r
r r r9 rV )rI rU rT default_array_typetype_from_argsr s r' rV zarray_agg.__init__ s 33d333 #ZZ(=x~ N N & ,T 2 2N.(.99
E"0w"4"4^"D"Dw!%~ 'i '888888r& ) r r r r r r r rV r r s @r' r9 r9 sK & >D 9 9 9 9 9 9 9 9 9r& r9 c e Zd ZdZdZd ZdS )
OrderedSetAggzDefine a function where the return type is based on the sort
expression type as defined by the expression passed to the
:meth:`.FunctionElement.within_group` method.Fc | j j }t j |j }| j r7t
|j dk r t j |d j
S |d j
S )Nr r. ) rR rb sqlutilunwrap_order_byre array_for_multi_clauser rS r r r )rI rj func_clausesre s r' r~ z OrderedSetAgg.within_group_type sd '/ *<+@AA & $3|/C+D+Dq+H+H>(1+"233 3A;# #r& N)r r r r rD r~ r% r& r' r@ r@ s5 5 5 #$ $ $ $ $r& r@ c e Zd ZdZdS )modea* Implement the ``mode`` ordered-set aggregate function.
This function must be used with the :meth:`.FunctionElement.within_group`
modifier to supply a sort expression to operate upon.
The return type of this function is the same as the sort expression.
.. versionadded:: 1.1
N)r r r r r% r& r' rG rG s r& rG c e Zd ZdZdZdS )percentile_conta Implement the ``percentile_cont`` ordered-set aggregate function.
This function must be used with the :meth:`.FunctionElement.within_group`
modifier to supply a sort expression to operate upon.
The return type of this function is the same as the sort expression,
or if the arguments are an array, an :class:`_types.ARRAY` of the sort
expression's type.
.. versionadded:: 1.1
TNr r r r rD r% r& r' rI rI " "r& rI c e Zd ZdZdZdS )percentile_disca Implement the ``percentile_disc`` ordered-set aggregate function.
This function must be used with the :meth:`.FunctionElement.within_group`
modifier to supply a sort expression to operate upon.
The return type of this function is the same as the sort expression,
or if the arguments are an array, an :class:`_types.ARRAY` of the sort
expression's type.
.. versionadded:: 1.1
TNrJ r% r& r' rM rM rK r& rM c 0 e Zd ZdZ ej ZdS )ranka! Implement the ``rank`` hypothetical-set aggregate function.
This function must be used with the :meth:`.FunctionElement.within_group`
modifier to supply a sort expression to operate upon.
The return type of this function is :class:`.Integer`.
.. versionadded:: 1.1
Nr r r r r r r r% r& r' rO rO * 8 DDDr& rO c 0 e Zd ZdZ ej ZdS )
dense_ranka' Implement the ``dense_rank`` hypothetical-set aggregate function.
This function must be used with the :meth:`.FunctionElement.within_group`
modifier to supply a sort expression to operate upon.
The return type of this function is :class:`.Integer`.
.. versionadded:: 1.1
NrP r% r& r' rS rS $ rQ r& rS c 0 e Zd ZdZ ej ZdS ) percent_ranka) Implement the ``percent_rank`` hypothetical-set aggregate function.
This function must be used with the :meth:`.FunctionElement.within_group`
modifier to supply a sort expression to operate upon.
The return type of this function is :class:`.Numeric`.
.. versionadded:: 1.1
Nr r r r r Numericr r% r& r' rU rU 3 rQ r& rU c 0 e Zd ZdZ ej ZdS ) cume_dista& Implement the ``cume_dist`` hypothetical-set aggregate function.
This function must be used with the :meth:`.FunctionElement.within_group`
modifier to supply a sort expression to operate upon.
The return type of this function is :class:`.Numeric`.
.. versionadded:: 1.1
NrV r% r& r' rY rY B rQ r& rY c e Zd ZdZdZdS )cubeaY Implement the ``CUBE`` grouping operation.
This function is used as part of the GROUP BY of a statement,
e.g. :meth:`_expression.Select.group_by`::
stmt = select(
[func.sum(table.c.value), table.c.col_1, table.c.col_2]
).group_by(func.cube(table.c.col_1, table.c.col_2))
.. versionadded:: 1.2
TNr r r r rN r% r& r' r[ r[ Q IIIr& r[ c e Zd ZdZdZdS )rollupaY Implement the ``ROLLUP`` grouping operation.
This function is used as part of the GROUP BY of a statement,
e.g. :meth:`_expression.Select.group_by`::
stmt = select(
[func.sum(table.c.value), table.c.col_1, table.c.col_2]
).group_by(func.rollup(table.c.col_1, table.c.col_2))
.. versionadded:: 1.2
TNr\ r% r& r' r_ r_ a r] r& r_ c e Zd ZdZdZdS )
grouping_setsa0 Implement the ``GROUPING SETS`` grouping operation.
This function is used as part of the GROUP BY of a statement,
e.g. :meth:`_expression.Select.group_by`::
stmt = select(
[func.sum(table.c.value), table.c.col_1, table.c.col_2]
).group_by(func.grouping_sets(table.c.col_1, table.c.col_2))
In order to group by multiple sets, use the :func:`.tuple_` construct::
from sqlalchemy import tuple_
stmt = select(
[
func.sum(table.c.value),
table.c.col_1, table.c.col_2,
table.c.col_3]
).group_by(
func.grouping_sets(
tuple_(table.c.col_1, table.c.col_2),
tuple_(table.c.value, table.c.col_3),
)
)
.. versionadded:: 1.2
TNr\ r% r& r' ra ra q s : IIIr& ra N)r, )Rr r r r r r rB baser r elementsr
r r
r r r r r r r r r r r
selectabler r r visitorsr r# r$ r/ r0 symbolr3 r@ rB ro objectr r modifierr r with_metaclassr r r r r r r r
r r r r r r$ r( r+ r- r/ r1 r3 r5 r7 r9 r@ rG rI rM rO rS rU rY r[ r_ ra r% r& r' rk sY " " " " " " ' ' ' ' ' ' % % % % % % & & & & & & # # # # # # # # # # # # $ $ $ $ $ $ $ $ $ $ $ $ ! ! ! ! ! ! " " " " " " # # # # # #
D T " " +4+,J,JKK $+ " ?8 ?8 ?8 ?8DIL IL IL IL ILj- IL IL ILX
#< #< #< #< #<' #< #< #