/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql
Edit: /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyc (39520B)
4]c @ s d Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m
Z
d d l m Z d d
l m
Z
d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z e j e! Z" e j d Z# e j$ d d d d Z% d! d" Z& d# e
e e f d$ YZ' d% e f d& YZ( d' e) f d( YZ* e* Z+ e* d) e, Z- d* e' f d+ YZ. d, e f d- YZ/ d. e j0 e/ e. f d/ YZ1 e& d0 e e& d1 e d2 e1 f d3 YZ2 d4 e1 f d5 YZ3 d6 e1 f d7 YZ4 d8 e4 f d9 YZ5 d: e4 f d; YZ6 d< e4 f d= YZ7 d> e4 f d? YZ8 d@ e1 f dA YZ9 dB e1 f dC YZ: dD e1 f dE YZ; dF e1 f dG YZ< dH e1 f dI YZ= dJ e3 f dK YZ> dL e3 f dM YZ? dN e3 f dO YZ@ dP e3 f dQ YZA dR e3 f dS YZB dT e3 f dU YZC dV e3 f dW YZD dX e3 f dY YZE dZ e3 f d[ YZF d\ e1 f d] YZG d^ e1 f d_ YZH d` eH f da YZI db eH f dc YZJ dd eH f de YZK df e1 f dg YZL dh e1 f di YZM dj e1 f dk YZN dl e1 f dm YZO dn e1 f do YZP dp e1 f dq YZQ dr e1 f ds YZR dt S(u s6 SQL function API, factories, and built-in functions.
i ( t
annotation( t operators( t schema( t sqltypes( t util( t ColumnCollection( t
Executable( t _clone( t _literal_as_binds( t _type_from_args( t BinaryExpression( t
BindParameter( t Cast( t
ClauseList( t
ColumnElement( t Extract( t FunctionFilter( t Grouping( t literal_column( t Over( t WithinGroup( t Alias( t
FromClause( t Select( t
VisitableTypei c C s
t j t S( N( R t defaultdictt dict( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt
( t t namet case_sensitive_functiont docsH Symbol to mark the functions that are switched into case-sensitive mode.t _defaultc C s, t | } t | } | } | j } | | k r | | t k r | | | k ru t j d j | | | | | j d } | | j | | _ t t | j | d S( NRZ ( t popRz Rr RR R\ ( R; R[ RZ ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR\ s ( Rs Rt R@ Rx R} t setterR~ R\ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRR s t _FunctionGeneratorc B s) e Z d Z d Z d Z d Z RS( s; Generate :class:`.Function` objects based on getattr calls.c K s g | _ | | _ d S( N( t _FunctionGenerator__namest opts( R; R ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ s c C s | j d rA y | j | SWq` t k
r= t | q` Xn | j d r` | d d !} n t | j } t | j | g | _ | S( Nt __t _i i( t
startswitht __dict__t KeyErrort AttributeErrort endswithR R R( R ( R; R t f( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt __getattr__ s
c O s | j j } | j | t | j } | d k rI | j \ } } n) | d k rl d | j d } } n d } | d k r t | j | j } | t k r t
| } | j | j j | } n | d k r | | | Sn t | j d d | j d d !| | S( Ni i R i iRv ( R t copyt updatet lenR RG R! t getR# R$ R" t Function( R; R> R= t ot tokensR- t fnamet funcR/ ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt __call__ s"
! ( Rs Rt Ru R@ R R ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t groupR c B s) e Z d Z d Z d Z d d Z RS( sY Describe a named SQL function.
See the superclass :class:`.FunctionElement` for a description
of public methods.
.. seealso::
:data:`.func` - namespace which produces registered or ad-hoc
:class:`.Function` instances.
:class:`.GenericFunction` - allows creation of registered function
types.
t functionc O sn | j d d p g | _ | | _ | j d d | _ t j | j d d | _ t j
| | | d S( s Construct a :class:`.Function`.
The :data:`.func` construct is normally used to construct
new :class:`.Function` instances.
Rv t bindRj N( R RG Rv R R t _bindR t to_instanceRk R2 R@ ( R; R R< R[ ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ _ s
c C s+ t | j | d | d | j d | d t S( NRg Rh Rj Ri ( R R Rk R8 ( R; R3 Rl Rj ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRm m s N( Rs Rt Ru t __visit_name__R@ RG Rm ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR M s t _GenericMetac B s e Z d Z RS( c C s t j | j k r | j d | | _ } | j d | | _ } | j d d } d | k rr | d | _ n t | d t | _
| j
r t | | | q t | _
n t t
| j | | | d S( NR R+ R- R t __return_type__t _register( R t Annotatedt __mro__R R R+ R Rk t getattrR8 R R1 Rr R R@ ( t clst clsnamet basest clsdictR R+ R- ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ y s ( Rs Rt R@ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR x s t GenericFunctionc B s# e Z d Z e Z e Z d Z RS( s 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()
c O s | j d d } | d k rF g | D] } t | | j ^ q% } n | j pX t | | _ g | _ | j d d | _ t d t
j d t | j
| _ t j | j d d p t | d d | _ d S( Nt _parsed_argsR R3 R4 Rj Rk ( R RG R R R5 R6 Rv R R R
R R7 R8 R9 R: R R R Rk ( R; R? R= t parsed_argsR> ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ s ( ( Rs Rt Ru R8 t coerce_argumentsRw R R@ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s =t castt extractt
next_valuec B s8 e Z d Z e j Z d Z d Z e d Z RS( s 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.
R c K s@ t | t j s t d | j d d | _ | | _ d S( Ns0 next_value() accepts a Sequence object as input.R ( Rp R t Sequencet AssertionErrorR RG R t sequence( R; t seqR[ ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ s
c C s g S( N( ( R; ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRV s (
Rs Rt Ru R t IntegerRk R R@ Rx RV ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s
t AnsiFunctionc B s e Z d Z RS( c O s t j | | | d S( N( R R@ ( R; R? R= ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ s ( Rs Rt R@ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t ReturnTypeFromArgsc B s e Z d Z d Z RS( sA Define a function whose return type is the same as its arguments.c O sb g | D] } t | | j ^ q } | j d t | | | d ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ s %
( Rs Rt Ru R@ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t coalescec B s e Z e Z RS( ( Rs Rt R8 R5 ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t maxc B s e Z RS( ( Rs Rt ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t minc B s e Z RS( ( Rs Rt ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t sumc B s e Z RS( ( Rs Rt ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t nowc B s e Z e j Z RS( ( Rs Rt R t DateTimeRk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t concatc B s e Z e j Z RS( ( Rs Rt R t StringRk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t char_lengthc B s e Z e j Z d Z RS( c K s t j | | | d S( N( R R@ ( R; t argR= ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ ' s ( Rs Rt R R Rk R@ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR $ s t randomc B s e Z e Z RS( ( Rs Rt R8 R5 ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR + s t countc B s# e Z d Z e j Z d d Z RS( s 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
c K s8 | d k r t d } n t t | j | | d S( Nt *( RG R Rr R R@ ( R; t
expressionR= ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ F s N( Rs Rt Ru R R Rk RG R@ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR / s t current_datec B s e Z e j Z RS( ( Rs Rt R t DateRk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR L s t current_timec B s e Z e j Z RS( ( Rs Rt R t TimeRk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR P s t current_timestampc B s e Z e j Z RS( ( Rs Rt R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR T s t current_userc B s e Z e j Z RS( ( Rs Rt R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR X s t localtimec B s e Z e j Z RS( ( Rs Rt R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR \ s t localtimestampc B s e Z e j Z RS( ( Rs Rt R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR ` s t session_userc B s e Z e j Z RS( ( Rs Rt R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR d s t sysdatec B s e Z e j Z RS( ( Rs Rt R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR h s t userc B s e Z e j Z RS( ( Rs Rt R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR l s t array_aggc B s e Z d Z e j Z d Z RS( s 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 O s g | D] } t | ^ q } | j d t j } d | k r~ t | } t | t j rk | | d t default_array_typet type_from_args( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR@ s
( Rs Rt Ru R Rq Rk R@ ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR p s t
OrderedSetAggc B s e Z d Z e Z d Z RS( s Define 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.c C s_ | j j } t j | j } | j rP t | j d k rP t j | d j
S| d j
Sd S( Ni i ( R: RI t sqlutilt unwrap_order_byRK t array_for_multi_clauseR R< R Rq Rk ( R; RO t func_clausesRK ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR] s
( Rs Rt Ru Rw R R] ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t modec B s e Z d Z RS( s* 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
( Rs Rt Ru ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s
t percentile_contc B s e Z d Z e Z RS( s 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
( Rs Rt Ru R8 R ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t percentile_discc B s e Z d Z e Z RS( s 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
( Rs Rt Ru R8 R ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t rankc B s e Z d Z e j Z RS( s! 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
( Rs Rt Ru R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s
t
dense_rankc B s e Z d Z e j Z RS( s' 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
( Rs Rt Ru R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s
t percent_rankc B s e Z d Z e j Z RS( s) 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
( Rs Rt Ru R t NumericRk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s
t cume_distc B s e Z d Z e j Z RS( s& 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
( Rs Rt Ru R R Rk ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s
t cubec B s e Z d Z e Z RS( sN Implement the ``CUBE`` grouping operation.
This function is used as part of the GROUP BY of a statement,
e.g. :meth:`.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
( Rs Rt Ru R8 R5 ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t rollupc B s e Z d Z e Z RS( sN Implement the ``ROLLUP`` grouping operation.
This function is used as part of the GROUP BY of a statement,
e.g. :meth:`.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
( Rs Rt Ru R8 R5 ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t
grouping_setsc B s e Z d Z e Z RS( s% Implement the ``GROUPING SETS`` grouping operation.
This function is used as part of the GROUP BY of a statement,
e.g. :meth:`.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
( Rs Rt Ru R8 R5 ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR 0 s N(S Ru R R R R R R R t baseR R t elementsR R R R
R R R
R R R R R R R t
selectableR R R t visitorsR R R R! R" t symbolR$ R1 R2 RR t objectR R Rw t modifierR R t with_metaclassR R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt
s B =&0 F+"Q
%