sqlalchemy.sql.functions

module documentation

(source)

SQL function API, factories, and built-in functions.

Class	`AnsiFunction`	Define a function in "ansi" format, which doesn't render parenthesis.
Class	`array_agg`	Support for the ARRAY_AGG function.
Class	`char_length`	The CHAR_LENGTH() SQL function.
Class	`coalesce`	Undocumented
Class	`concat`	The SQL CONCAT() function, which concatenates strings.
Class	`count`	The ANSI COUNT aggregate function. With no arguments, emits COUNT \*.
Class	`cube`	Implement the ``CUBE`` grouping operation.
Class	`cume_dist`	Implement the ``cume_dist`` hypothetical-set aggregate function.
Class	`current_date`	The CURRENT_DATE() SQL function.
Class	`current_time`	The CURRENT_TIME() SQL function.
Class	`current_timestamp`	The CURRENT_TIMESTAMP() SQL function.
Class	`current_user`	The CURRENT_USER() SQL function.
Class	`dense_rank`	Implement the ``dense_rank`` hypothetical-set aggregate function.
Class	`Function`	Describe a named SQL function.
Class	`FunctionAsBinary`	Undocumented
Class	`FunctionElement`	Base for SQL function-oriented constructs.
Class	`GenericFunction`	Define a 'generic' function.
Class	`grouping_sets`	Implement the ``GROUPING SETS`` grouping operation.
Class	`localtime`	The localtime() SQL function.
Class	`localtimestamp`	The localtimestamp() SQL function.
Class	`max`	The SQL MAX() aggregate function.
Class	`min`	The SQL MIN() aggregate function.
Class	`mode`	Implement the ``mode`` ordered-set aggregate function.
Class	`next_value`	Represent the 'next value', given a :class:`.Sequence` as its single argument.
Class	`now`	The SQL now() datetime function.
Class	`OrderedSetAgg`	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.
Class	`percent_rank`	Implement the ``percent_rank`` hypothetical-set aggregate function.
Class	`percentile_cont`	Implement the ``percentile_cont`` ordered-set aggregate function.
Class	`percentile_disc`	Implement the ``percentile_disc`` ordered-set aggregate function.
Class	`random`	The RANDOM() SQL function.
Class	`rank`	Implement the ``rank`` hypothetical-set aggregate function.
Class	`ReturnTypeFromArgs`	Define a function whose return type is the same as its arguments.
Class	`rollup`	Implement the ``ROLLUP`` grouping operation.
Class	`ScalarFunctionColumn`	Undocumented
Class	`session_user`	The SESSION_USER() SQL function.
Class	`sum`	The SQL SUM() aggregate function.
Class	`sysdate`	The SYSDATE() SQL function.
Class	`user`	The USER() SQL function.
Function	`register_function`	Associate a callable with a particular func. name.
Variable	`func`	Undocumented
Variable	`modifier`	Undocumented
Class	`_FunctionGenerator`	Generate SQL function expressions.
Type Variable	`_T`	Undocumented
Variable	`_registry`	Undocumented

def register_function(identifier, fn, package='_default'): (source) ¶

Associate 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).

func = (source) ¶

Undocumented

modifier = (source) ¶

Undocumented

_T = (source) ¶

Undocumented

Value

TypeVar('_T',
        bound=Any)

_registry: util.defaultdict[str, Dict[str, Type[Function[Any]]]] = (source) ¶

Undocumented