Edit File: functions.cpython-37.pyc
B ��4]� � @ 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 e� e!�Z"e� d d � �Z#ej$d d d �Z%dwd"d#�Z&G d$d%� d%e ee �Z'G d&d'� d'e�Z(G d(d)� d)e)�Z*e*� Z+e*d*d+�Z,G d,d-� d-e'�Z-G d.d/� d/e �Z.G d0d1� d1e�/e.e-��Z0e&d2e� e&d3e� G d4d5� d5e0�Z1G d6d7� d7e0�Z2G d8d9� d9e0�Z3G d:d;� d;e3�Z4G d<d=� d=e3�Z5G d>d?� d?e3�Z6G d@dA� dAe3�Z7G dBdC� dCe0�Z8G dDdE� dEe0�Z9G dFdG� dGe0�Z:G dHdI� dIe0�Z;G dJdK� dKe0�Z<G dLdM� dMe2�Z=G dNdO� dOe2�Z>G dPdQ� dQe2�Z?G dRdS� dSe2�Z@G dTdU� dUe2�ZAG dVdW� dWe2�ZBG dXdY� dYe2�ZCG dZd[� d[e2�ZDG d\d]� d]e2�ZEG d^d_� d_e0�ZFG d`da� dae0�ZGG dbdc� dceG�ZHG ddde� deeG�ZIG dfdg� dgeG�ZJG dhdi� die0�ZKG djdk� dke0�ZLG dldm� dme0�ZMG dndo� doe0�ZNG dpdq� dqe0�ZOG drds� dse0�ZPG dtdu� due0�ZQdvS )xz6SQL 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)�Extract)�FunctionFilter)�Grouping)�literal_column)�Over)� WithinGroup)�Alias)� FromClause)�Select)� VisitableType� c C s t �t�S )N)r � defaultdict�dict� r r �K/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/sql/functions.py�<lambda>( � r Zcase_sensitive_functionzHSymbol to mark the functions that are switched into case-sensitive mode.)�name�doc�_defaultc C s� t | }t| }| }| �� } | |kr�|| tk r�||| krVt�d�| �� ||| < q�t�d�|t|| � � �d �� t|| < nN| |kr�||| kr�t�d�t || � � �|�� q�t�d�|�� n||| < ||| |< dS )z�Associate 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). zLThe GenericFunction '{}' is already registered and is going to be overriden.z�GenericFunction '{}' 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.� z�GenericFunction(s) '{}' are already registered with different letter cases and might interact with '{}'. GenericFunction objects will be fully case-insensitive in a future release.N) � _registry�_case_sensitive_registry�lower�_CASE_SENSITIVEr �warn�formatZwarn_deprecated�list�keys�sorted)� identifier�fn�packageZreg�case_sensitive_regZraw_identifierr r r �register_function0 s4 r3 c s� e Zd ZdZdZdZdd� Zdd� Zedd � �Z e j d d � �Z d)d d�Z dd� Zdd� Zdd� Zedd� �Zdd� Zefdd�Zdd � Zd*d d �Zd d � Zd!d"� Zd#d$� Zd+d%d&�Zd,� fd'd(� Z� Z S )-�FunctionElementa< Base for SQL function-oriented constructs. .. seealso:: :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 s> � fdd�|D �}� j p t|�� _ t|tjdd���� � _dS )z/Construct a :class:`.FunctionElement`. c s g | ]}t |� j��qS r )r r" )�.0�c)�selfr r � <listcomp>� s z,FunctionElement.__init__.<locals>.<listcomp>T)�operator�group_contentsN)� _has_args�boolr r �comma_op� self_group� clause_expr)r7 �clauses�kwargs�argsr )r7 r �__init__� s zFunctionElement.__init__c C s |� | ||�S )N)Z_execute_function)r7 Z connectionZ multiparams�paramsr r r �_execute_on_connection� s z&FunctionElement._execute_on_connectionc C s t | �d��S )a2 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:`.select` with the desired columns:: from sqlalchemy.sql import column stmt = select([column('x'), column('y')]). select_from(func.myfunction()) N)r �label)r7 r r r �columns� s zFunctionElement.columnsc C s | j jS )z}Return the underlying :class:`.ClauseList` which contains the arguments for this :class:`.FunctionElement`. )r? �element)r7 r r r r@ � s zFunctionElement.clausesNc C s t | ||||d�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_by�order_by�rows�range_)r )r7 rI rJ rK rL r r r �over� s zFunctionElement.overc G s t | f|�� S )ay 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 )r7 rJ r r r � within_group� s z FunctionElement.within_groupc G s |s| S t | f|�� 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 )r7 Z criterionr r r �filter� s zFunctionElement.filterc C s t | ||�S )a^ 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:`.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)r7 � left_index� right_indexr r r � as_comparison� s ?z FunctionElement.as_comparisonc C s | j jS )N)r@ � _from_objects)r7 r r r rT 5 s z FunctionElement._from_objectsc K s | j fS )N)r? )r7 rA r r r � get_children9 s z FunctionElement.get_childrenc K s( || j f|�| _ | �� tj�| � d S )N)r? Z_reset_exportedr4 r@ Z_reset)r7 �clone�kwr r r �_copy_internals< s z FunctionElement._copy_internalsc C s 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 )r7 rN r r r �within_group_typeA s z!FunctionElement.within_group_typec C s t �| |�S )a_ Produce a :class:`.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 Z _construct)r7 r" Zflatr r r �aliasM s zFunctionElement.aliasc C s" t | g�}| jr |jf | j�}|S )z�Produce a :func:`~.expression.select` construct against this :class:`.FunctionElement`. This is shorthand for:: s = select([function_element]) )r Z_execution_optionsZexecution_options)r7 �sr r r �selectm s zFunctionElement.selectc C s | � � �� �� S )ar 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:`.Connection` or :class:`.Engine`. )r\ �execute�scalar)r7 r r r r^ { s zFunctionElement.scalarc C s | � � �� S )aY 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:`.Connection` or :class:`.Engine`. )r\ r] )r7 r r r r] � s zFunctionElement.executec C s t d ||| jd|d�S )NT)�_compared_to_operator�_compared_to_type�unique�type_)r �type)r7 r9 �objrb r r r � _bind_param� s zFunctionElement._bind_paramc s6 |t jkr t| jtj�r t| �S tt| �j |d�S d S )N)�against) r �getitem� isinstancerc r �ARRAYr �superr4 r> )r7 rf )� __class__r r r> � s zFunctionElement.self_group)NNNN)NF)N)N) �__name__� __module__� __qualname__�__doc__� packagenamesr; rC rE �propertyrG r Zmemoized_propertyr@ rM rN rO rS rT rU r rX rY rZ r\ r^ r] re r> � __classcell__r r )rk r r4 r s* A r4 c s\ e Zd Z� fdd�Zedd� �Zejdd� �Zedd� �Zejdd� �Z� fd d �Z� Z S ) rP c sR |j j |d }|j j |d }|| _|| _|| _tt| �j||tjt j d� d S )Nr )rb ) r@ � sql_functionrQ rR rj rP rC r Zfunction_as_comparison_opr Z BOOLEANTYPE)r7 r0 rQ rR �left�right)rk r r rC � s zFunctionAsBinary.__init__c C s | j jj| jd S )Nr )rs r@ rQ )r7 r r r rt � s zFunctionAsBinary.leftc C s || j jj| jd < d S )Nr )rs r@ rQ )r7 �valuer r r rt � s c C s | j jj| jd S )Nr )rs r@ rR )r7 r r r ru � s zFunctionAsBinary.rightc C s || j jj| jd < d S )Nr )rs r@ rR )r7 rv r r r ru � s c s0 |� d�}|| jf|�| _tt| �jf |� d S )NrV )�poprs rj rP rX )r7 rW rV )rk r r rX � s z FunctionAsBinary._copy_internals) rl rm rn rC rq rt �setterru rX rr r r )rk r rP � s rP c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �_FunctionGeneratorz;Generate :class:`.Function` objects based on getattr calls.c K s g | _ || _d S )N)�_FunctionGenerator__names�opts)r7 r{ r r r rC � s z_FunctionGenerator.__init__c C sl |� d�r4y | j| S tk r0 t|��Y qJX n|�d�rJ|dd� }tf | j�}t| j�|g |_|S )N�__�_r% ���) � startswith�__dict__�KeyError�AttributeError�endswithry r{ r, rz )r7 r" �fr r r � __getattr__� s z _FunctionGenerator.__getattr__c O s� | j �� }|�|� t| j�}|dkr2| j\}}n |dkrLd| jd }}nd }|d k r�t| �|�� �}|tkr�t | }|�|�� ��|�}|d k r�|||�S t | jd f|�d| jdd� i|��S )Nr r r$ r% r~ rp ) r{ �copy�update�lenrz r& �getr( r) r' �Function) r7 r6 rA �o�tokensr1 �fname�funcr2 r r r �__call__� s" z_FunctionGenerator.__call__N)rl rm rn ro rC r� r� r r r r ry � s ry F)�groupc @ s& e Zd ZdZdZdd� Zddd�ZdS ) r� aY 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. �functionc O sP |� dd�pg | _|| _|�dd�| _t�|�dd��| _tj | f|�|� dS )z�Construct a :class:`.Function`. The :data:`.func` construct is normally used to construct new :class:`.Function` instances. rp N�bindrb ) rw rp r" r� �_bindr � to_instancerc r4 rC )r7 r" r@ rW r r r rC _ s zFunction.__init__Nc C s t | j||| j|dd�S )NT)r_ r` rb ra )r r" rc )r7 r9 rd rb r r r re m s zFunction._bind_param)N)rl rm rn ro Z__visit_name__rC re r r r r r� M s r� c s e Zd Z� fdd�Z� ZS )� _GenericMetac s� t j| jkrv|�d|� | _}|�d|� | _}|�dd�}d|krN|d | _t| dd�| _ | j rpt || |� nd| _ t t | �� |||� d S )Nr" r/ r1 r$ Z__return_type__� _registerT)r Z Annotated�__mro__r� r" r/ rw rc �getattrr� r3 rj r� rC )�clsZclsname�basesZclsdictr" r/ r1 )rk r r rC y s z_GenericMeta.__init__)rl rm rn rC rr r r )rk r r� x s r� c @ s e Zd ZdZdZdZdd� 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() TFc s� |� dd �}|d kr&� fdd�|D �}� jp2t|�� _g � _|�dd �� _t|tjdd��� � � _ t � |� dd �p|t � dd ��� _d S ) N� _parsed_argsc s g | ]}t |� j��qS r )r r" )r5 r6 )r7 r r r8 � s z,GenericFunction.__init__.<locals>.<listcomp>r� T)r9 r: rb rc )rw r; r< rp r� r� r r r= r> r? r r� r� rc )r7 rB rA Z parsed_argsr )r7 r rC � s zGenericFunction.__init__N)rl rm rn ro Zcoerce_argumentsr� rC r r r r r� � s =r� �cast�extractc @ s0 e Zd ZdZe�� Zd Zdd� Ze dd� �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 K s, t |tj�std��|�dd �| _|| _d S )Nz0next_value() accepts a Sequence object as input.r� )rh r �Sequence�AssertionErrorr� r� �sequence)r7 �seqrW r r r rC � s znext_value.__init__c C s g S )Nr )r7 r r r rT � s znext_value._from_objectsN) rl rm rn ro r �Integerrc r" rC rq rT r r r r r� � s r� c @ s e Zd Zdd� ZdS )� AnsiFunctionc O s t j| f|�|� d S )N)r� rC )r7 rB rA r r r rC � s zAnsiFunction.__init__N)rl rm rn rC r r r r r� � s r� c s e Zd ZdZ� fdd�Z� ZS )�ReturnTypeFromArgszADefine a function whose return type is the same as its arguments.c s@ � fdd�|D �}|� dt|�� ||d< tt� �j||� d S )Nc s g | ]}t |� j��qS r )r r" )r5 r6 )r7 r r r8 s z/ReturnTypeFromArgs.__init__.<locals>.<listcomp>rb r� )� setdefaultr rj r� rC )r7 rB rA )rk )r7 r rC s zReturnTypeFromArgs.__init__)rl rm rn ro rC rr r r )rk r r� s r� c @ s e Zd ZdZdS )�coalesceTN)rl rm rn r; r r r r r� s r� c @ s e Zd ZdS )�maxN)rl rm rn r r r r r� s r� c @ s e Zd ZdS )�minN)rl rm rn r r r r r� s r� c @ s e Zd ZdS )�sumN)rl rm rn r r r r r� s r� c @ s e Zd ZejZdS )�nowN)rl rm rn r �DateTimerc r r r r r� s r� c @ s e Zd ZejZdS )�concatN)rl rm rn r �Stringrc r r r r r� s r� c @ s e Zd ZejZdd� ZdS )� char_lengthc K s t j| |f|� d S )N)r� rC )r7 �argrA r r r rC ' s zchar_length.__init__N)rl rm rn r r� rc rC r r r r r� $ s r� c @ s e Zd ZdZdS )�randomTN)rl rm rn r; r r r r r� + s r� c s( e Zd ZdZejZd� fdd� Z� ZS )�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 s( |d krt d�}tt| �j|f|� d S )N�*)r rj r� rC )r7 Z expressionrA )rk r r rC F s zcount.__init__)N) rl rm rn ro r r� rc rC rr r r )rk r r� / s r� c @ s e Zd ZejZdS )� current_dateN)rl rm rn r ZDaterc r r r r r� L s r� c @ s e Zd ZejZdS )� current_timeN)rl rm rn r ZTimerc r r r r r� P s r� c @ s e Zd ZejZdS )�current_timestampN)rl rm rn r r� rc r r r r r� T s r� c @ s e Zd ZejZdS )� current_userN)rl rm rn r r� rc r r r r r� X s r� c @ s e Zd ZejZdS )� localtimeN)rl rm rn r r� rc r r r r r� \ s r� c @ s e Zd ZejZdS )�localtimestampN)rl rm rn r r� rc r r r r r� ` s r� c @ s e Zd ZejZdS )� session_userN)rl rm rn r r� rc r r r r r� d s r� c @ s e Zd ZejZdS )�sysdateN)rl rm rn r r� rc r r r r r� h s r� c @ s e Zd ZejZdS )�userN)rl rm rn r r� rc r r r r r� l s r� c s& e Zd ZdZejZ� fdd�Z� ZS )� 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 sl dd� |D �}|� dtj�}d|krNt|�}t|tj�rB||d< n ||�|d< ||d< tt| �j||� d S )Nc S s g | ] }t |��qS r )r )r5 r6 r r r r8 � s z&array_agg.__init__.<locals>.<listcomp>Z_default_array_typerb r� )rw r ri r rh rj r� rC )r7 rB rA Zdefault_array_typeZtype_from_args)rk r r rC � s zarray_agg.__init__) rl rm rn ro r ri rc rC rr r r )rk r r� p s r� c @ s e Zd ZdZdZdd� ZdS )� OrderedSetAggz�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.Fc C sF | j j}t�|j�}| jr8t|j�dkr8t� |d j �S |d j S d S )Nr r% ) r? rH �sqlutilZunwrap_order_byrJ �array_for_multi_clauser� r@ r ri rc )r7 rN Z func_clausesrJ r r r rY � s z OrderedSetAgg.within_group_typeN)rl rm rn ro r� rY r r r r r� � s r� c @ s 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)rl rm rn ro r r r r r� � s r� c @ s 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 TN)rl rm rn ro r� r r r r r� � s r� c @ s 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 TN)rl rm rn ro r� r r r r r� � s r� c @ s e Zd ZdZe�� 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 N)rl rm rn ro r r� rc r r r r r� � s r� c @ s e Zd ZdZe�� 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 N)rl rm rn ro r r� rc r r r r r� � s r� c @ s e Zd ZdZe�� 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 N)rl rm rn ro r �Numericrc r r r r r� � s r� c @ s e Zd ZdZe�� 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 N)rl rm rn ro r r� rc r r r r r� s r� c @ s e Zd ZdZdZdS )�cubeaN 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 TN)rl rm rn ro r; r r r r r� s r� c @ s e Zd ZdZdZdS )�rollupaN 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 TN)rl rm rn ro r; r r r r r� s r� c @ s e Zd ZdZdZdS )� grouping_setsa% 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 TN)rl rm rn ro r; r r r r r� 0 s r� N)r$ )Rro � r r r r r r� �baser r �elementsr r r r r r r r r r r r r r Z selectabler r r Zvisitorsr r r r& r' �symbolr) r3 r4 rP �objectry r� �modifierr� r� �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� r r r r �<module> s� B >&0F +Q %