,hI %SrSSKJr SSKrSSKrSSKJr SSKJr SSKJr SSKJ r SSKJ r SS KJ r SS KJ r SS KJ r SS KJr SS KJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJ r SSKJ!r! SSKJ"r" SSKJ#r# SSKJ$r$ SS K%J&r& SS!K%J'r' SS"K%J(r( SS#K%J)r) SS$K%J*r* SS%K%J+r+ SS&K%J,r, SS'K%J-r- SS(K%J.r. SS)K%J/r/ SS*K%J0r0 SS+K%J1r1 SS,K%J2r2 SS-K3J4r4 SS.K3J5r5 SS/K3J6r6 SS0KJ7r7 SS1KJ8r8 SS2K9J:r: S3SKJr \(a`SS4KJ;r; SS5KJr> SS8KJ?r? SS9KJ@r@ SS:KJArA SS;K%JBrB SSKJErE S3S?KFJGrG S3S@KHJIrI S3SAKJJKrK S3SBKJJLrL S3SCKMJNrN \"SD\SE9rO\"SF\SE9rP\R"\R5rSSG\TSH'SSSIjjrU"SJSK\"\+\O\4\#5rV"SLSM\'\5rW"SNSO\0\O5rX"SPSQ5rY\Y"5rZ\YR\Zl\Y"SRSS9r["STSU\V\O5r\"SVSW\\\O5r]\U"SX\)5 \U"SY\,5 "SZS[\]\^5r_"S\S]\]\O5r`"S^S_\]\O5ra"S`Sa\a\O5rb"SbSc\a\O5rc"SdSe\a\O5rd"SfSg\a\O5re"ShSi\]\R5rf"SjSk\]\g5rh"SlSm\]\^5ri"SnSo\]\j5rk"SpSq\]\^5rl"SrSs\`\R5rn"StSu\`\R5rp"SvSw\`\R5rq"SxSy\`\g5rr"SzS{\`\R5rs"S|S}\`\R5rt"S~S\`\g5ru"SS\`\R5rv"SS\`\g5rw"SS\a\ \O5rx"SS\]\O5ry"SS\y\O5rz"SS\y\O5r{"SS\y\O5r|"SS\]\^5r}"SS\]\^5r~"SS\]\R5r"SS\]\R5r"SS\]\O5r"SS\]\O5r"SS\]\O5r"SS\]\g5rg)z4SQL function API, factories, and built-in functions.) annotationsN)Any)cast)Dict)List)Mapping)Optional)overload)Sequence)Tuple)Type) TYPE_CHECKING)TypeVar)Union) annotation) coercions) operators)roles)schema)sqltypes)type_api)util)is_table_value_type)_entity_namespace)ColumnCollection) Executable) Generative) HasMemoized)_type_from_args)BinaryExpression) BindParameter)Cast) ClauseList) ColumnElement)ExtractFunctionFilter)Grouping)literal_column) NamedColumnOver WithinGroup) FromClause)Select)TableValuedAlias)TableValueType) TypeEngine)InternalTraversal) _ByArgument)_ColumnExpressionArgument)"_ColumnExpressionOrLiteralArgument)#_ColumnExpressionOrStrLabelArgument) _StarOrOne)_TypeEngineArgument)_EntityNamespace) ClauseElement)KeyedColumnElement)TableValuedColumn) OperatorType) Connection) CursorResult)_CoreMultiExecuteParams)CoreExecuteOptionsParameter)Self_T)bound_Sz5util.defaultdict[str, Dict[str, Type[Function[Any]]]] _registryc[Un[U5R5nX;a%[R"SR U55 XU'g)zAssociate a callable with a particular func. name. This is normally called by GenericFunction, 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.N)rJstrlowerrwarnformat) identifierfnpackageregs P/var/www/auris/envauris/lib/python3.13/site-packages/sqlalchemy/sql/functions.pyregister_functionrUZsL G CZ&&(J  ))/ );  Oc&^\rSrSr%SrS\R 4S\R4S\R4/r Sr S\ S'S r S r S rS \ S'S \ S 'S \ S'S\ S'S*SjrS r\S+U4Sjj5rS,SjrS-S.SjjrS/SjrS0S1Sjjr\R0S2Sj5r\R4S2Sj5r\S3Sj5r\S2Sj5r\R>S4Sj5r S S S S S S.S5Sjjr!S6Sjr"\#S7Sj5r$\#S8Sj5r$S9S jr$S:S!jr%\S+S"j5r&S;S#jr'S0SS&jjr*S-S?U4S'jjjr+\S@S(j5r,S)r-U=r.$)AFunctionElementrahBase for SQL function-oriented constructs. This is a `generic type `_, meaning that type checkers and IDEs can be instructed on the types to expect in a :class:`_engine.Result` for this function. See :class:`.GenericFunction` for an example of how this is done. .. seealso:: :ref:`tutorial_functions` - in the :ref:`unified_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. clause_expr_with_ordinality_table_value_typezTuple[str, ...] packagenamesFNzOptional[TableValueType]r primary_key _is_clone_ofz Grouping[Any]c $UVs/sH3n[R"[RU[ USS5US9PM5 nnUR =(d [ U5Ul[[U[RSS.65Ul gs snf)aConstruct 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` nameNrbapply_propagate_attrsToperatorgroup_contents) rexpectrExpressionElementRolegetattr _has_argsboolr)r$rcomma_oprZ)selfclausescargss rT__init__FunctionElement.__init__s2:    ++T640&*    : 54:# $ 2 24 O : s:B c@>[TU]=(d [USS5$)Nrb)super _proxy_keyrj)rn __class__s rTrvFunctionElement._proxy_keysw!@WT64%@@rVc&URXU5$N)_execute_function)rn connectiondistilled_paramsexecution_optionss rT_execute_on_connection&FunctionElement._execute_on_connections ++ $5  rVc[XU5$)aReturn a column expression that's against this :class:`_functions.FunctionElement` as a scalar table-valued expression. The returned expression is similar to that returned by a single column accessed off of a :meth:`_functions.FunctionElement.table_valued` construct, except no FROM clause is generated; the function is rendered in the similar way as a scalar subquery. E.g.: .. sourcecode:: pycon+sql >>> from sqlalchemy import func, select >>> fn = func.jsonb_each("{'k', 'v'}").scalar_table_valued("key") >>> print(select(fn)) {printsql}SELECT (jsonb_each(:jsonb_each_1)).key .. versionadded:: 1.4.0b2 .. seealso:: :meth:`_functions.FunctionElement.table_valued` :meth:`_functions.FunctionElement.alias` :meth:`_functions.FunctionElement.column_valued` )ScalarFunctionColumn)rnrbtype_s rTscalar_table_valued#FunctionElement.scalar_table_valuedsB$D66rVcUR5nURSS5nURSS5nURSS5nU(a X4- nSUl[U6=UlUlUR XeS9$)aP Return a :class:`_sql.TableValuedAlias` representation of this :class:`_functions.FunctionElement` with table-valued expressions added. e.g.: .. sourcecode:: pycon+sql >>> fn = func.generate_series(1, 5).table_valued( ... "value", "start", "stop", "step" ... ) >>> print(select(fn)) {printsql}SELECT anon_1.value, anon_1.start, anon_1.stop, anon_1.step FROM generate_series(:generate_series_1, :generate_series_2) AS anon_1{stop} >>> print(select(fn.c.value, fn.c.stop).where(fn.c.value > 2)) {printsql}SELECT anon_1.value, anon_1.stop FROM generate_series(:generate_series_1, :generate_series_2) AS anon_1 WHERE anon_1.value > :value_1{stop} A WITH ORDINALITY expression may be generated by passing the keyword argument "with_ordinality": .. sourcecode:: pycon+sql >>> fn = func.generate_series(4, 1, -1).table_valued( ... "gen", with_ordinality="ordinality" ... ) >>> print(select(fn)) {printsql}SELECT anon_1.gen, anon_1.ordinality FROM generate_series(:generate_series_1, :generate_series_2, :generate_series_3) WITH ORDINALITY AS anon_1 :param \*expr: A series of string column names that will be added to the ``.c`` collection of the resulting :class:`_sql.TableValuedAlias` construct as columns. :func:`_sql.column` objects with or without datatypes may also be used. :param name: optional name to assign to the alias name that's generated. If omitted, a unique anonymizing name is used. :param with_ordinality: string name that when present results in the ``WITH ORDINALITY`` clause being added to the alias, and the given string name will be added as a column to the .c collection of the resulting :class:`_sql.TableValuedAlias`. :param joins_implicitly: when True, the table valued function may be used in the FROM clause without any explicit JOIN to other tables in the SQL query, and no "cartesian product" warning will be generated. May be useful for SQL functions such as ``func.json_each()``. .. versionadded:: 1.4.33 .. versionadded:: 1.4.0b2 .. seealso:: :ref:`tutorial_functions_table_valued` - in the :ref:`unified_tutorial` :ref:`postgresql_table_valued` - in the :ref:`postgresql_toplevel` documentation :meth:`_functions.FunctionElement.scalar_table_valued` - variant of :meth:`_functions.FunctionElement.table_valued` which delivers the complete table valued expression as a scalar column expression :meth:`_functions.FunctionElement.column_valued` :meth:`_sql.TableValuedAlias.render_derived` - renders the alias using a derived column clause, e.g. ``AS name(col1, col2, ...)`` with_ordinalityNjoins_implicitlyrbTrbr) _generatepopr[r3typer\alias)rnexprkwnew_funcrrrbs rT table_valuedFunctionElement.table_valuedsV>>#&&!2D966"4d;vvfd#  & &D(,H %5CT5JJ 2~~4~KKrVc4URXS9R$)aReturn this :class:`_functions.FunctionElement` as a column expression that selects from itself as a FROM clause. E.g.: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, func >>> gs = func.generate_series(1, 5, -1).column_valued() >>> print(select(gs)) {printsql}SELECT anon_1 FROM generate_series(:generate_series_1, :generate_series_2, :generate_series_3) AS anon_1 This is shorthand for:: gs = func.generate_series(1, 5, -1).alias().column :param name: optional name to assign to the alias name that's generated. If omitted, a unique anonymizing name is used. :param joins_implicitly: when True, the "table" portion of the column valued function may be a member of the FROM clause without any explicit JOIN to other tables in the SQL query, and no "cartesian product" warning will be generated. May be useful for SQL functions such as ``func.json_array_elements()``. .. versionadded:: 1.4.46 .. seealso:: :ref:`tutorial_functions_column_valued` - in the :ref:`unified_tutorial` :ref:`postgresql_column_valued` - in the :ref:`postgresql_toplevel` documentation :meth:`_functions.FunctionElement.table_valued` r)rcolumnrnrbrs rT column_valuedFunctionElement.column_valuedGsRzztzGNNNrVcUR$)aThe set of columns exported by this :class:`.FunctionElement`. This is a placeholder collection that allows the function to be placed in the FROM clause of a statement: .. sourcecode:: pycon+sql >>> from sqlalchemy import column, select, func >>> stmt = select(column("x"), column("y")).select_from(func.myfunction()) >>> print(stmt) {printsql}SELECT x, y FROM myfunction() The above form is a legacy feature that is now superseded by the fully capable :meth:`_functions.FunctionElement.table_valued` method; see that method for details. .. seealso:: :meth:`_functions.FunctionElement.table_valued` - generates table-valued SQL function expressions. )rprns rTcolumnsFunctionElement.columnsrs 0vv rVcj[URVs/sHoRU4PM snS9$s snf)z-synonym for :attr:`.FunctionElement.columns`.r)r_all_selected_columnskey)rncols rTrpFunctionElement.cs4 /3/I/IJ/Iggs^/IJ  Js0c[UR5(a"[SURR5nU$UR S5/nU$)N!Sequence[KeyedColumnElement[Any]])rrr _elementslabel)rncolss rTr%FunctionElement._all_selected_columnssI tyy ) )3TYY5H5HD  JJt$%D rVcUR$rzrrs rTexported_columns FunctionElement.exported_columnss||rVcJ[[URR5$)zmReturn the underlying :class:`.ClauseList` which contains the arguments for this :class:`.FunctionElement`. )rr$rZelementrs rTroFunctionElement.clausess J 0 0 8 899rV partition_byorder_byrowsrange_groupsc [UUUUUUS9$)aProduce 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. .. seealso:: :func:`_expression.over` :ref:`tutorial_window_functions` - in the :ref:`unified_tutorial` rr,)rnrrrrrs rToverFunctionElement.overs$B %   rVc[U/UQ76$)aProduce 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. .. seealso:: :ref:`tutorial_functions_within_group` - in the :ref:`unified_tutorial` r.)rnrs rT within_groupFunctionElement.within_groups$4+(++rVcgrzr]rs rTfilterFunctionElement.filters!rVcgrzr])rn_FunctionElement__criterion0 criterions rTrrs !rVc,U(dU$[U/UQ76$)aProduce 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) .. seealso:: :ref:`tutorial_functions_within_group` - in the :ref:`unified_tutorial` :class:`.FunctionFilter` :func:`.funcfilter` r')rnrs rTrrs:Kd/Y//rVc[XU5$)a Interpret this expression as a boolean comparison between two values. This method is used for an ORM use case described at :ref:`relationship_custom_operator_sql_function`. 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 .. seealso:: :ref:`relationship_custom_operator_sql_function` - example use within the ORM )FunctionAsBinary)rn left_index right_indexs rT as_comparisonFunctionElement.as_comparisonsV +>>rVc.URR$rz)ro _from_objectsrs rTrFunctionElement._from_objectsds||)))rVcg)zFor 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])rnrs rTwithin_group_type!FunctionElement.within_group_typehsrVcD[R"UUURUS9$)aProduce a :class:`_expression.Alias` construct against this :class:`.FunctionElement`. .. tip:: The :meth:`_functions.FunctionElement.alias` method is part of the mechanism by which "table valued" SQL functions are created. However, most use cases are covered by higher level methods on :class:`_functions.FunctionElement` including :meth:`_functions.FunctionElement.table_valued`, and :meth:`_functions.FunctionElement.column_valued`. This construct wraps the function in a named alias which is suitable for the FROM clause, in the style accepted for example by PostgreSQL. A column expression is also provided using the special ``.column`` attribute, which may be used to refer to the output of the function as a scalar value in the columns or where clause, for a backend such as PostgreSQL. For a full table-valued expression, use the :meth:`_functions.FunctionElement.table_valued` method first to establish named columns. e.g.: .. sourcecode:: pycon+sql >>> from sqlalchemy import func, select, column >>> data_view = func.unnest([1, 2, 3]).alias("data_view") >>> print(select(data_view.column)) {printsql}SELECT data_view FROM unnest(:unnest_1) AS data_view The :meth:`_functions.FunctionElement.column_valued` method provides a shortcut for the above pattern: .. sourcecode:: pycon+sql >>> data_view = func.unnest([1, 2, 3]).column_valued("data_view") >>> print(select(data_view)) {printsql}SELECT data_view FROM unnest(:unnest_1) AS data_view .. versionadded:: 1.4.0b2 Added the ``.column`` accessor :param name: alias name, will be rendered as ``AS `` in the FROM clause :param joins_implicitly: when True, the table valued function may be used in the FROM clause without any explicit JOIN to other tables in the SQL query, and no "cartesian product" warning will be generated. May be useful for SQL functions such as ``func.json_each()``. .. versionadded:: 1.4.33 .. seealso:: :ref:`tutorial_functions_table_valued` - in the :ref:`unified_tutorial` :meth:`_functions.FunctionElement.table_valued` :meth:`_functions.FunctionElement.scalar_table_valued` :meth:`_functions.FunctionElement.column_valued` )rbtable_value_typer)r2 _constructrrs rTrFunctionElement.aliasvs(R ** !YY-   rVcv[U5nUR(aUR"S0URD6nU$)zProduce a :func:`_expression.select` construct against this :class:`.FunctionElement`. This is shorthand for:: s = select(function_element) r])r1_execution_optionsr~)rnss rTselectFunctionElement.selects4   " "##>d&=&=>ArVc <[SU4UURSUUS.UD6$)NT)_compared_to_operator_compared_to_typeuniquer expanding)r"rrnrfobjrrrs rT _bind_paramFunctionElement._bind_params;    #+"ii    rVc>U[RLa4[UR[R 5(a [ U5$[TU]!US9$)N)against) rgetitem isinstancerrARRAYr)ru self_group)rnrrws rTrFunctionElement.self_groupsK i'' 'J IIx~~- - D> !7%g%6 6rVc,[UR5$)zjoverrides FromClause.entity_namespace as functions are generally column expressions and not FromClauses. )rrZrs rTentity_namespace FunctionElement.entity_namespaces!!1!122rV)rkrZ)ro'_ColumnExpressionOrLiteralArgument[Any]returnNonerr)r|rBr}rDr~rErzCursorResult[Any]rz)rbrLr!Optional[_TypeEngineArgument[_T]]rzScalarFunctionColumn[_T])rz(_ColumnExpressionOrStrLabelArgument[Any]rrrr2NF)rb Optional[str]rrlrzTableValuedColumn[_T])rz.ColumnCollection[str, KeyedColumnElement[Any]])rr)rr$) rOptional[_ByArgument]rrr-Optional[Tuple[Optional[int], Optional[int]]]rrrrrzOver[_T])r_ColumnExpressionArgument[Any]rzWithinGroup[_T])rrF)r_ColumnExpressionArgument[bool]rrrzFunctionFilter[_T])rrrzUnion[Self, FunctionFilter[_T]])rintrrrr)rzWithinGroup[_S]rzOptional[TypeEngine[_S]])rbrrrlrr2)rzSelect[Tuple[_T]] rfrArrrzOptional[TypeEngine[_T]]rrlrrrzBindParameter[_T])rzOptional[OperatorType]rr>)rr=)/__name__ __module__ __qualname____firstlineno____doc__r5dp_clauseelement dp_booleandp_has_cache_key_traverse_internalsr^__annotations__rkr[r\rr_non_anon_labelpropertyrvrrrrrro_non_memoized_propertyrro_memoized_propertyrprrrmemoized_attributerorrr rrrrrrrrr__static_attributes__ __classcell__rws@rTrXrXrs^, )::; .99: /@@A %'L/&I26/6 ?  @O AA  2 7    EI!7!7 A!7 !!7FWL=WLEHWL WLtDI)O!)O<@)O )OV ""#2      7 ##:$:/3*.>B@D@D( ,( ( ( < ( > ( >(  ( T,7, ,(!! !5!4!  !! 090 (0BK?K?,/K? K?Z** +  ! DIN !N <@N N ` $+/    (        & 7 733rVrXcX\rSrSr%S\R 4S\R 4S\R 4S\R4/rS\ S'S\ S'S\ S'SSjr SS jr \ SS j5r \ RSS j5r \ SS j5r\RSS j5r\(d\ r\rSrgSrg)ri sql_functionrr modifiersFunctionElement[Any]rc0[R"XU5$rz)r%_gen_cache_key)rnanon_map bindparamss rTr FunctionAsBinary._gen_cache_key s++DJGGrVcXlX lX0l[RUl[ RUlSUl SUl 0Ul g)NT) r rrrfunction_as_comparison_oprfr BOOLEANTYPErnegate_is_implicitly_booleanr )rnrQrrs rTrrFunctionAsBinary.__init__ sE$&!;; ((  &*#rVcbURRRURS- $Nrr rorrs rT left_exprFunctionAsBinary.left_exprs(  ((0011DEErVcbXRRRURS- 'grrrnvalues rTrrs%AF!!))$//A*=>rVcbURRRURS- $rr rorrs rT right_exprFunctionAsBinary.right_expr"s*  ((001A1AA1EFFrVcbXRRRURS- 'grr rs rTr!r"&s'BG!!))$*:*:Q*>?rV)rrr rrfrr rN)rrrrrr)rQr rrrrrr)rColumnElement[Any])rr$rr)rrrrr5r dp_plain_obj dp_plain_dictrrr rrrrsetterr!rleftrightrr]rVrTrrs *;;< (556 )667 '556 '&OH & 47 FI   FFGGGGHH  rVrc\rSrSrSrS\R 4S\R4S\R4/r Sr Sr S S Sjjr S r g) ri2scalar_function_columnrbrrQFNcRXlX l[R"U5Ulgrz)rQrbr to_instancer)rnrQrbrs rTrrScalarFunctionColumn.__init__>s"  ((/ rV)rQrbrrz)rQzFunctionElement[_T]rbrLrrrr)rrrr__visit_name__r5 dp_anon_namedp_typerr is_literaltablerrrr]rVrTrr2s-N "//0 "**+  112 J E 48 0  0 01 0  0 0rVrcz\rSrSrSrSSj5r\S?Sj5rS?Sjr\ (Ga~\ S@Sj5r \ SAS j5r \SBS j5r \SCS j5r \SDS j5r SES jr \ SFSj5r\ SGSj5r\SHSj5r\SISj5r\SJSj5rSKSjr\ SLSj5r\ SMSj5r\ SNSj5r\ SOSj5r\ SPSj5r\ SQSj5r\ SRSj5r\ SSSj5r\ STSj5r\ SUSj5r\ SVSj5r\ SWSj5r\ SXS j5r\SYS!j5r\SZS"j5r\S[S#j5rS\S$jr\S]S%j5r\S^S&j5r\S_S'j5rS`S(jr\ SaS)j5r \ SbS*j5r!\ ScS+j5r"\ SdS,j5r#\ SeS-j5r$\ SfS.j5r%\ SgS/j5r&\ ShS0j5r'\ SiS1j5r(\ SjS2j5r)\ SkS3j5r*\SlS4j5r+\SmS5j5r+\SnS6j5r+SoS7jr+\ SpS8j5r,\ SqS9j5r-S:r.g;S:r.g;)r_FunctionGeneratoriLa Generate SQL function expressions. :data:`.func` is a special object instance which generates SQL functions based on name-based attributes, e.g.: .. sourcecode:: pycon+sql >>> print(func.count(1)) {printsql}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: .. sourcecode:: pycon+sql >>> print(select(func.count(table.c.id))) {printsql}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: .. sourcecode:: pycon+sql >>> print(func.current_timestamp()) {printsql}CURRENT_TIMESTAMP To call functions which are present in dot-separated packages, specify them in the same manner: .. sourcecode:: pycon+sql >>> print(func.stats.yield_curve(5, 10)) {printsql}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: .. sourcecode:: pycon+sql >>> print( ... func.my_string("hi", type_=Unicode) ... + " " ... + func.my_string("there", type_=Unicode) ... ) {printsql}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:`tutorial_functions` - in the :ref:`unified_tutorial` :class:`.Function` c /UlXlgrz)_FunctionGenerator__namesopts)rnr8s rTrr_FunctionGenerator.__init__s"$  rVc URS5(aURU$UR S5(aUSSn[ S0UR D6n[UR5U/-UlU$![a [U5ef=f)N___rr]) startswith__dict__KeyErrorAttributeErrorendswithr5r8listr7)rnrbfs rT __getattr___FunctionGenerator.__getattr__s ??4  +}}T**]]3  ":D  + +&$/  +$T** +s A77B cgrzr])rnrrpkwargss rT__call___FunctionGenerator.__call__srVcgrzr])rnrprHs rTrIrJADrVc URR5nURU5 [UR5nUS:XaURupVOUS:XaSURSpeOSnUb1[ UR WR55nUbU"U0UD6$[URS/UQ7S[URSS50UD6$)Nr6r_defaultrr=r^) r8copyupdatelenr7rJgetrMFunctiontuple)rnrprHotokensrRfnamefuncs rTrIrJs IINN  T\\" Q;!\\NGU q['aUG  W%))%++-8DQ}!}$ LL  GH +0a1C+D LM  rVcgrzr]rs rTaggregate_strings$_FunctionGenerator.aggregate_strings@CrVcgrzr]rs rT ansifunction_FunctionGenerator.ansifunctions;>rVcgrzr]rnrrqrHs rT array_agg_FunctionGenerator.array_agg  rVcgrzr]ras rTrbrcrdrVcgrzr]ras rTrbrcrdrVcgrzr]ras rTrbrcs  rVcgrzr]rs rTr_FunctionGenerator.cast+.rVcgrzr]rs rT char_length_FunctionGenerator.char_length s47rVcgrzr]ras rTcoalesce_FunctionGenerator.coalesce rVcgrzr]ras rTrorprqrVcgrzr]ras rTrorp!rqrVcgrzr]ras rTrorp)s rVcgrzr]rs rTconcat_FunctionGenerator.concat0*-rVcgrzr]rs rTcount_FunctionGenerator.count3s(+rVcgrzr]rs rTcube_FunctionGenerator.cube6rjrVcgrzr]rs rT cume_dist_FunctionGenerator.cume_dist903rVcgrzr]rs rT current_date_FunctionGenerator.current_date<69rVcgrzr]rs rT current_time_FunctionGenerator.current_time?rrVcgrzr]rs rTcurrent_timestamp$_FunctionGenerator.current_timestampBr\rVcgrzr]rs rT current_user_FunctionGenerator.current_userErrVcgrzr]rs rT dense_rank_FunctionGenerator.dense_rankH25rVcgrzr]rs rTextract_FunctionGenerator.extractK,/rVcgrzr]rs rT grouping_sets _FunctionGenerator.grouping_setsN=@rVcgrzr]rs rT localtime_FunctionGenerator.localtimeQrrVcgrzr]rs rTlocaltimestamp!_FunctionGenerator.localtimestampTs:=rVcgrzr]ras rTmax_FunctionGenerator.max\ rVcgrzr]ras rTrrdrrVcgrzr]ras rTrrlrrVcgrzr]ras rTrrt rVcgrzr]ras rTmin_FunctionGenerator.minrrVcgrzr]ras rTrrrrVcgrzr]ras rTrrrrVcgrzr]ras rTrrrrVcgrzr]rs rTmode_FunctionGenerator.moderjrVcgrzr]rs rT next_value_FunctionGenerator.next_valuerrVcgrzr]rs rTnow_FunctionGenerator.nows$'rVcgrzr]rs rT orderedsetagg _FunctionGenerator.orderedsetaggrrVcgrzr]rs rT percent_rank_FunctionGenerator.percent_rankrrVcgrzr]rs rTpercentile_cont"_FunctionGenerator.percentile_contrLrVcgrzr]rs rTpercentile_disc"_FunctionGenerator.percentile_discrLrVcgrzr]rs rTrandom_FunctionGenerator.randomrxrVcgrzr]rs rTrank_FunctionGenerator.rank&)rVcgrzr]rs rTrollup_FunctionGenerator.rollups/2rVcgrzr]rs rT session_user_FunctionGenerator.session_userrrVcgrzr]ras rTsum_FunctionGenerator.sumrrVcgrzr]ras rTrrrrVcgrzr]ras rTrrrrVcgrzr]ras rTrrrrVcgrzr]rs rTsysdate_FunctionGenerator.sysdaterrVcgrzr]rs rTuser_FunctionGenerator.userrrV)__namesr8N)r8rrr)rbrLrr5)rprr_TypeEngineArgument[_T]rHrrz Function[_T])rprrHrrz Function[Any])rzType[aggregate_strings])rzType[AnsiFunction[Any]])rColumnElement[_T]rqrrHrr array_agg[_T])r_ColumnExpressionArgument[_T]rqrrHrrr)rrGrqrrHrrr)r&_ColumnExpressionOrLiteralArgument[_T]rqrrHrrr)rzType[Cast[Any]])rzType[char_length])rrrqrrHrr coalesce[_T])rrrqrrHrrr)rrGrqrrHrrr)rrrqrrHrrr)rz Type[concat])rz Type[count])rzType[cube[Any]])rzType[cume_dist])rzType[current_date])rzType[current_time])rzType[current_timestamp])rzType[current_user])rzType[dense_rank])rz Type[Extract])rzType[grouping_sets[Any]])rzType[localtime])rzType[localtimestamp])rrrqrrHrrmax[_T])rrrqrrHrrr)rrGrqrrHrrr)rrrqrrHrrr)rrrqrrHrrmin[_T])rrrqrrHrrr)rrGrqrrHrrr)rrrqrrHrrr)rzType[mode[Any]])rzType[next_value])rz Type[now])rzType[OrderedSetAgg[Any]])rzType[percent_rank])rzType[percentile_cont[Any]])rzType[percentile_disc[Any]])rz Type[random])rz Type[rank])rzType[rollup[Any]])rzType[session_user])rrrqrrHrrsum[_T])rrrqrrHrrr)rrGrqrrHrrr)rrrqrrHrrr)rz Type[sysdate])rz Type[user])/rrrrrrrrEr rIrrrZr^rbrrlrorvrzr}rrrrrrrrrrrrrrrrrrrrrrrrrrrr]rVrTr5r5LsRWr 5AD DD , C C > >  " ;         . ;          ;        7 ;      . . 7 7  " ;          . ;           ;         7 ;       - - + + . . 3 3 9 9 9 9 C C 9 9 5 5 / / @ @ 3 3 = =  " ;          . ;           ;         7 ;        " ;          . ;           ;         7 ;       . . 5 5 ' ' @ @ 9 9 D D D D - - ) ) 2 2 9 9  " ;          . ;           ;         7 ;       / / ) )erVr5F)groupcX\rSrSr%SrSr\RS\R4S\R4S\R4/-rS\ S'S\ S'S \ S'\ S S S .SS jj5r\ S S S .SS jj5rSSS .SSjjrSSSjjrSrg)rSiaDescribe 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:`tutorial_functions` - in the :ref:`unified_tutorial` :data:`.func` - namespace which produces registered or ad-hoc :class:`.Function` instances. :class:`.GenericFunction` - allows creation of registered function types. functionr^rbrrLrPzTypeEngine[_T].)rr^cgrzr]rnrbrr^ros rTrrFunction.__init__1rVcgrzr]rs rTrrr:rrVNcU=(d SUlXl[R"U5Ul[ R "U/UQ76 g)z~Construct a :class:`.Function`. The :data:`.func` construct is normally used to construct new :class:`.Function` instances. r]N)r^rbrr-rrXrrrs rTrrrCs=).B ((/   00rVc P[URU4UURUSUS.UD6$)NT)rrrrr)r"rbrrs rTrFunction._bind_paramYs? II   #+"ii    rV)rbr^r) rbrLrorrrr^Optional[Tuple[str, ...]]rr) rbrLrorrrr^rrr) rbrLrorrrr^rrrrr)rrrrrr/rXrr5r% dp_stringr1rr rrrrr]rVrTrSrSs@ N)== *778 ",,- "**+A IO   25 9  0    *-25 :'  0   4826 11:11 1 0 1  14+/    (         rVrSc~^\rSrSr%SrSrSrS\S'SrS U4Sjjr \ S Sj5r S Sjr S r U=r$) GenericFunctionima< 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() inherit_cache = True 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" inherit_cache = True 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" inherit_cache = True The above function will render as follows: .. sourcecode:: pycon+sql >>> print(func.geo.buffer()) {printsql}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" inherit_cache = True The above function will render as: .. sourcecode:: pycon+sql >>> print(func.geo.buffer()) {printsql}"ST_Buffer"() Type parameters for this class as a `generic type `_ can be passed and should match the type seen in a :class:`_engine.Result`. For example:: class as_utc(GenericFunction[datetime.datetime]): type = DateTime() inherit_cache = True The above indicates that the following expression returns a ``datetime`` object:: connection.scalar(select(func.as_utc())) .. 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. Trl _registerc>[RUR;a&URURUR 5 [ TU]5 grz)r Annotated__mro___register_generic_functionrr?ru__init_subclass__)clsrws rTr!GenericFunction.__init_subclass__s8   s{{ 2  * *3<< F !#rVcURSU5=UlnURSU5=UlnURSS5nSU;a USUl[ USS5UlUR (a [ X@U5 gSUlg)NrbrPrRrN__return_type__rT)rRrbrPrrjrrU)rclsnameclsdictrbrPrRs rTr*GenericFunction._register_generic_functions"++fg664&-kk,&EE++i4  '01CH [$7  == jw 7!CMrVc URSS5nUc?UVs/sH2n[R"[RUUR US9PM4 nnUR =(d [U5UlSUl[[U[RSS.65Ul [R"URSS5=(d [!USS55Ulgs snf)N _parsed_argsrcr]Trerr)rrrhrrirbrkrlr^r)r$rrmrZrr-rjr)rnrqrH parsed_argsrps rTrrGenericFunction.__init__sjj6  A   //*.   <4 +<# CN++D   (( JJw % Dvt)D  %s9C')rkrZr^r)rr)rrLrzMapping[str, Any]rr)rqrrHrrr)rrrrrcoerce_arguments inherit_cacherrbr classmethodrrrrrrs@rTrrmstl\MO D$ !!$5! !!( < HK   rVrrrc\rSrSrSr\R "5rSrS\ R4/r S Sjr S Sjr \S Sj5rSrg) rizRepresent 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. sequencec [U[R5(dS5eXl[R "UR =(d [USS55Ulg)Nz0next_value() accepts a Sequence object as input.r) rrr r rr- data_typerjr)rnseqrs rTrrnext_value.__init__.sX    > = >  (( MM 8WT648  rVc [U[5=(a- URRURR:H$rz)rrr rb)rnotherrs rTcomparenext_value.compare7s2 uj ) : ""enn&9&99 rVc/$rzr]rs rTrnext_value._from_objects=s rV)r rN)rzschema.Sequencerrrr)rrrrrrlr)rrrrrrIntegerrrbr5dp_named_ddl_elementrrrrrrrr]rVrTrrsS    D D &;;<  rVrc2\rSrSrSrSrSSjrSrg) AnsiFunctioniBzEDefine a function in "ansi" format, which doesn't render parenthesis.Tc8[R"U/UQ70UD6 grz)rrr)rnrqrHs rTrrAnsiFunction.__init__Gs   777rVr]NrqrrHrrr)rrrrrr rrrr]rVrTrrBs'OM838?B8 8rVrc^\rSrSrSrSr\S Sj5r\S Sj5r\S Sj5rS U4SjjrSrU=r $) ReturnTypeFromArgsiMzKDefine a function whose return type is bound to the type of its arguments. Tcgrzr]ras rTrrReturnTypeFromArgs.__init__Y rVcgrzr]ras rTrrr!ar"rVcgrzr]ras rTrrr!ir"rVc >UVs/sH2n[R"[RUURUS9PM4 nnUR S[ U55 XBS'[TU] "U0UD6 gs snf)Nrcrr) rrhrrirb setdefaultr rurr)rnrqrHrpfn_argsrws rTrrr!qs1    ++YY&*    1  '?7#;\rSrSrSr\R "5rSrSr g)rizThe SQL now() datetime function. SQLAlchemy dialects will usually render this particular function in a backend-specific way, such as rendering it as ``CURRENT_TIMESTAMP``. Tr]N rrrrrrDateTimerr rr]rVrTrrs    DMrVrc>\rSrSrSr\R "5rSrSr g)rviaThe SQL CONCAT() function, which concatenates strings. E.g.: .. sourcecode:: pycon+sql >>> print(select(func.concat("a", "b"))) {printsql}SELECT concat(:concat_2, :concat_3) AS concat_1 String concatenation in SQLAlchemy is more commonly available using the Python ``+`` operator with string datatypes, which will render a backend-specific concatenation operator, such as : .. sourcecode:: pycon+sql >>> print(select(literal("a") + "b")) {printsql}SELECT :param_1 || :param_2 AS anon_1 Tr]N rrrrrrStringrr rr]rVrTrvrvs* ?? DMrVrvcV^\rSrSrSr\R "5rSrSU4Sjjr Sr U=r $)rlizThe CHAR_LENGTH() SQL function.Tc (>[TU]"U40UD6 grzrurr)rnargrrws rTrrchar_length.__init__s ##rVr])r7z_ColumnExpressionArgument[str]rrrr rrrrrrrrr rrrrrs@rTrlrls#)    DM$$rVrlc \rSrSrSrSrSrSrg)rizThe RANDOM() SQL function.Tr]Nrrrrrrkr rr]rVrTrrs$IMrVrcf^\rSrSrSr\R "5rSrSSU4Sjjjr Sr U=r $)rziaThe 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: .. sourcecode:: sql SELECT count(*) AS count_1 FROM some_table Tc D>Uc [S5n[TU]"U40UD6 g)N*)r*rurr)rn expressionrHrws rTrrcount.__init__s'  ',J .v.rVr]rz)r?z7Union[_ColumnExpressionArgument[Any], _StarOrOne, None]rHrrrr9rs@rTrzrzsJ.    DM  /  /  /  / /rVrzc>\rSrSrSr\R "5rSrSr g)riz The CURRENT_DATE() SQL function.Tr]N) rrrrrrDaterr rr]rVrTrr* ==?DMrVrc>\rSrSrSr\R "5rSrSr g)riz The CURRENT_TIME() SQL function.Tr]N) rrrrrrTimerr rr]rVrTrrrCrVrc>\rSrSrSr\R "5rSrSr g)riz%The CURRENT_TIMESTAMP() SQL function.Tr]Nr/r]rVrTrrs/    DMrVrc>\rSrSrSr\R "5rSrSr g)riz The CURRENT_USER() SQL function.Tr]Nr2r]rVrTrr* ?? DMrVrc>\rSrSrSr\R "5rSrSr g)rizThe localtime() SQL function.Tr]Nr/r]rVrTrrs'    DMrVrc>\rSrSrSr\R "5rSrSr g)riz"The localtimestamp() SQL function.Tr]Nr/r]rVrTrrs,    DMrVrc>\rSrSrSr\R "5rSrSr g)ri#z The SESSION_USER() SQL function.Tr]Nr2r]rVrTrr#rHrVrc>\rSrSrSr\R "5rSrSr g)ri*zThe SYSDATE() SQL function.Tr]Nr/r]rVrTrr*s%    DMrVrc>\rSrSrSr\R "5rSrSr g)ri1zThe USER() SQL function.Tr]Nr2r]rVrTrr1s" ?? DMrVrc@^\rSrSrSrSrSU4SjjrSrU=r$)rbi8aiSupport 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]) .. seealso:: :func:`_postgresql.array_agg` - PostgreSQL-specific version that returns :class:`_postgresql.ARRAY`, which has PG-specific operators added. Tc \>UVs/sH&n[R"[RX0S9PM( nnUR S[ R 5nSU;a9[U5n[U[ R 5(aXbS'O U"USS9US'XBS'[TU]("U0UD6 gs snf)N)rd_default_array_typerr) dimensionsr) rrhrrirrrr rrurr)rnrqrHrpr'default_array_typetype_from_argsrws rTrrarray_agg.__init__Ls 1    ++Q  1 $ZZ(=x~~N & ,W5N.(..99"0w"4"q#w")~ ',V,#1 s-B)r]r) rrrrrr rrrrrs@rTrbrb8s1"M-3-?B- --rVrbc2\rSrSrSrSrSrSSjrSrg) OrderedSetAggiczDefine 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.FTcB[[URR5n[R "UR 5nUR(a<[UR5S:a#[R"USR5$USR$)Nrr) rr$rZrsqlutilunwrap_order_byrarray_for_multi_clauserQrorrr)rnr func_clausesrs rTrOrderedSetAgg.within_group_typeks{J(8(8(@(@A 181H1H  ! !2   & &3|/C/C+Dq+H>>(1+"2"23 3A;## #rVr]N)rzWithinGroup[Any]rzTypeEngine[Any]) rrrrrrZr rrr]rVrTrVrVcs)5#M $, $  $rVrVc\rSrSrSrSrSrg)rixzImplement 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. Tr]Nr*r]rVrTrrxsMrVrc \rSrSrSrSrSrSrg)riadImplement 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. Tr]NrrrrrrZr rr]rVrTrr "MrVrc \rSrSrSrSrSrSrg)riadImplement 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. Tr]Nr_r]rVrTrrr`rVrc>\rSrSrSr\R "5rSrSr g)rizImplement 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`. Tr]N rrrrrrrrr rr]rVrTrr    DMrVrc>\rSrSrSr\R "5rSrSr g)rizImplement 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`. Tr]Nrcr]rVrTrrrdrVrcJ\rSrSr%Sr\R "5rS\S'Sr Sr g)rizImplement 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`. !sqltypes.Numeric[decimal.Decimal]rTr]N rrrrrrNumericrrr rr]rVrTrr"/7.>.>.@D +@MrVrcJ\rSrSr%Sr\R "5rS\S'Sr Sr g)rizImplement 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`. rgrTr]Nrhr]rVrTrrrjrVrc \rSrSrSrSrSrSrg)r}ia7Implement 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 Tr]Nr;r]rVrTr}r} IMrVr}c \rSrSrSrSrSrSrg)ria;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 Tr]Nr;r]rVrTrrrmrVrc \rSrSrSrSrSrSrg)riaImplement 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 Tr]Nr;r]rVrTrrs4IMrVrcf^\rSrSrSr\R "5rSrSr SU4Sjjr Sr U=r $)rZi aImplement a generic string aggregation function. This function will concatenate non-null values into a string and separate the values by a delimiter. This function is compiled on a per-backend basis, into functions such as ``group_concat()``, ``string_agg()``, or ``LISTAGG()``. e.g. Example usage with delimiter '.':: stmt = select(func.aggregate_strings(table.c.str_col, ".")) The return type of this function is :class:`.String`. .. versionadded: 2.0.21 Tc$>[TU]X5 grzr6)rnclause separatorrws rTrraggregate_strings.__init__7s +rVr])rrrrsrLrr) rrrrrrr3rrkr rrrrrs@rTrZrZ sB$ ?? DIM,4,AD, ,,rVrZ)rN)rPrLrQzType[Function[Any]]rRrLrr)r __future__rdatetimedecimaltypingrrrrrr r r r r rrrrrrrrrrrrX_typingrbaserrrrrelementsr r!r"r#r$r%r&r(r)r*r+r-r/ selectabler0r1r2r3r4visitorsr5r7r8r9r:r;r<r=r>r?r@rA engine.baserB engine.cursorrCengine.interfacesrDrE util.typingrFrGrI defaultdictdictrJrrUrXrrr5rXmodifierrSrrrrrrorrrrrLrvrlfloatrrzdatertimerrrrrrrrrbrVrrrrrDecimalrrr}rrrZr]rVrTrsZ;" (#"%&# #$$!!"($ '$2;<#,&',+'(,;?" T T T @ >H,7: 0I 3j-"3ZI 3X1',1h0;r?04\*\*B !)) E *w r"w ti hrli X&$)W%"%"J8?2&82-,2-j!"%  R   R   R  /(++ , _S !4 $/#& $_U #$/OC $/N< .< . X%6%67<$ X../\("3"34<$l8,,-< (-"8B<0(-V$OB'$* =   mB'  mB'  ?3   %  ?7??3  0 ?2 $_R $OB'>,,,rV