SQLAlchemy 1.3 Documentation
SQLAlchemy Core
- SQL Expression Language Tutorial
- SQL Statements and Expressions API
- Column Elements and Expressions
- Selectables, Tables, FROM objects
- Insert, Updates, Deletes
- SQL and Generic Functions¶
AnsiFunction
Function
FunctionAsBinary
FunctionElement
FunctionElement.__init__()
FunctionElement.alias()
FunctionElement.as_comparison()
FunctionElement.clauses
FunctionElement.columns
FunctionElement.execute()
FunctionElement.filter()
FunctionElement.get_children()
FunctionElement.over()
FunctionElement.packagenames
FunctionElement.scalar()
FunctionElement.select()
FunctionElement.self_group()
FunctionElement.within_group()
FunctionElement.within_group_type()
GenericFunction
OrderedSetAgg
ReturnTypeFromArgs
array_agg
char_length
coalesce
concat
count
cube
cume_dist
current_date
current_time
current_timestamp
current_user
dense_rank
grouping_sets
localtime
localtimestamp
max
min
mode
next_value
now
percent_rank
percentile_cont
percentile_disc
random
rank
register_function()
rollup
session_user
sum
sysdate
user
- Custom SQL Constructs and Compilation Extension
- Expression Serializer Extension
- Visitor and Traversal Utilities
- Schema Definition Language
- Column and Data Types
- Engine and Connection Use
- Core API Basics
Project Versions
- Previous: Insert, Updates, Deletes
- Next: Custom SQL Constructs and Compilation Extension
- Up: Home
- On this page:
- SQL and Generic Functions
AnsiFunction
Function
FunctionAsBinary
FunctionElement
FunctionElement.__init__()
FunctionElement.alias()
FunctionElement.as_comparison()
FunctionElement.clauses
FunctionElement.columns
FunctionElement.execute()
FunctionElement.filter()
FunctionElement.get_children()
FunctionElement.over()
FunctionElement.packagenames
FunctionElement.scalar()
FunctionElement.select()
FunctionElement.self_group()
FunctionElement.within_group()
FunctionElement.within_group_type()
GenericFunction
OrderedSetAgg
ReturnTypeFromArgs
array_agg
char_length
coalesce
concat
count
cube
cume_dist
current_date
current_time
current_timestamp
current_user
dense_rank
grouping_sets
localtime
localtimestamp
max
min
mode
next_value
now
percent_rank
percentile_cont
percentile_disc
random
rank
register_function()
rollup
session_user
sum
sysdate
user
SQL and Generic Functions¶
SQL functions which are known to SQLAlchemy with regards to database-specific
rendering, return types and argument behavior. Generic functions are invoked
like all SQL functions, using the func
attribute:
select([func.count()]).select_from(sometable)
Note that any name not known to func
generates the function name as is
- there is no restriction on what SQL functions can be called, known or
unknown to SQLAlchemy, built-in or user defined. The section here only
describes those functions where SQLAlchemy already knows what argument and
return types are in use.
SQL function API, factories, and built-in functions.
Object Name | Description |
---|---|
Support for the ARRAY_AGG function. |
|
The ANSI COUNT aggregate function. With no arguments, emits COUNT *. |
|
Implement the |
|
Implement the |
|
Implement the |
|
Describe a named SQL function. |
|
Base for SQL function-oriented constructs. |
|
Define a ‘generic’ function. |
|
Implement the |
|
Implement the |
|
Represent the ‘next value’, given a |
|
Define a function where the return type is based on the sort
expression type as defined by the expression passed to the
|
|
Implement the |
|
Implement the |
|
Implement the |
|
Implement the |
|
register_function(identifier, fn[, package]) |
Associate a callable with a particular func. name. |
Define a function whose return type is the same as its arguments. |
|
Implement the |
|
- class sqlalchemy.sql.functions.AnsiFunction(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.AnsiFunction
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.AnsiFunction.
identifier = 'AnsiFunction'¶
-
attribute
sqlalchemy.sql.functions.AnsiFunction.
name = 'AnsiFunction'¶
-
attribute
- class sqlalchemy.sql.functions.Function(name, *clauses, **kw)¶
Describe a named SQL function.
The
Function
object is typically generated from thefunc
generation object.- Parameters:
*clauses¶ – list of column expressions that form the arguments of the SQL function call.
type_¶ – optional
TypeEngine
datatype object that will be used as the return value of the column expression generated by this function call.packagenames¶ –
a string which indicates package prefix names to be prepended to the function name when the SQL is generated. The
func
generator creates these when it is called using dotted format, e.g.:func.mypackage.some_function(col1, col2)
See also
func
- namespace which produces registered or ad-hocFunction
instances.GenericFunction
- allows creation of registered function types.Members
Class signature
class
sqlalchemy.sql.functions.Function
(sqlalchemy.sql.functions.FunctionElement
)-
method
sqlalchemy.sql.functions.Function.
__init__(name, *clauses, **kw)¶ Construct a
Function
.The
func
construct is normally used to construct newFunction
instances.
- class sqlalchemy.sql.functions.FunctionAsBinary(fn, left_index, right_index)¶
-
Class signature
class
sqlalchemy.sql.functions.FunctionAsBinary
(sqlalchemy.sql.expression.BinaryExpression
)-
attribute
sqlalchemy.sql.functions.FunctionAsBinary.
left¶
-
attribute
sqlalchemy.sql.functions.FunctionAsBinary.
right¶
-
attribute
- class sqlalchemy.sql.functions.FunctionElement(*clauses, **kwargs)¶
Base for SQL function-oriented constructs.
See also
Functions - in the Core tutorial
Function
- named SQL function.func
- namespace which produces registered or ad-hocFunction
instances.GenericFunction
- allows creation of registered function types.Members
__init__(), alias(), as_comparison(), clauses, columns, execute(), filter(), get_children(), over(), packagenames, scalar(), select(), self_group(), within_group(), within_group_type()
Class signature
class
sqlalchemy.sql.functions.FunctionElement
(sqlalchemy.sql.expression.Executable
,sqlalchemy.sql.expression.ColumnElement
,sqlalchemy.sql.expression.FromClause
)-
method
sqlalchemy.sql.functions.FunctionElement.
__init__(*clauses, **kwargs)¶ Construct a
FunctionElement
.
-
method
sqlalchemy.sql.functions.FunctionElement.
alias(name=None, flat=False)¶ Produce a
Alias
construct against thisFunctionElement
.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:
SELECT data_view FROM sometable, unnest(sometable.data) AS data_view
New in version 0.9.8: The
FunctionElement.alias()
method is now supported. Previously, this method’s behavior was undefined and did not behave consistently across versions.
-
method
sqlalchemy.sql.functions.FunctionElement.
as_comparison(left_index, right_index)¶ 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
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
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
relationship.primaryjoin
parameter. The return value is a containment object calledFunctionAsBinary
.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.
- Parameters:
New in version 1.3.
-
attribute
sqlalchemy.sql.functions.FunctionElement.
clauses¶ Return the underlying
ClauseList
which contains the arguments for thisFunctionElement
.
-
attribute
sqlalchemy.sql.functions.FunctionElement.
columns¶ The set of columns exported by this
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
select()
with the desired columns:from sqlalchemy.sql import column stmt = select([column('x'), column('y')]).\ select_from(func.myfunction())
-
method
sqlalchemy.sql.functions.FunctionElement.
execute()¶ Execute this
FunctionElement
against an embedded ‘bind’.This first calls
FunctionElement.select()
to produce a SELECT construct.Note that
FunctionElement
can be passed to theConnectable.execute()
method ofConnection
orEngine
.
-
method
sqlalchemy.sql.functions.FunctionElement.
filter(*criterion)¶ 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)
New in version 1.0.0.
-
method
sqlalchemy.sql.functions.FunctionElement.
get_children(**kwargs)¶ Return immediate child elements of this
ClauseElement
.This is used for visit traversal.
**kwargs may contain flags that change the collection that is returned, for example to return a subset of items in order to cut down on larger traversals, or to return child items from a different context (such as schema-level collections instead of clause-level).
-
method
sqlalchemy.sql.functions.FunctionElement.
over(partition_by=None, order_by=None, rows=None, range_=None)¶ 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
over()
for a full description.
-
attribute
sqlalchemy.sql.functions.FunctionElement.
packagenames = ()¶
-
method
sqlalchemy.sql.functions.FunctionElement.
scalar()¶ Execute this
FunctionElement
against an embedded ‘bind’ and return a scalar value.This first calls
FunctionElement.select()
to produce a SELECT construct.Note that
FunctionElement
can be passed to theConnectable.scalar()
method ofConnection
orEngine
.
-
method
sqlalchemy.sql.functions.FunctionElement.
select()¶ Produce a
select()
construct against thisFunctionElement
.This is shorthand for:
s = select([function_element])
-
method
sqlalchemy.sql.functions.FunctionElement.
self_group(against=None)¶ Apply a ‘grouping’ to this
ClauseElement
.This method is overridden by subclasses to return a “grouping” construct, i.e. parenthesis. In particular it’s used by “binary” expressions to provide a grouping around themselves when placed into a larger expression, as well as by
select()
constructs when placed into the FROM clause of anotherselect()
. (Note that subqueries should be normally created using theSelect.alias()
method, as many platforms require nested SELECT statements to be named).As expressions are composed together, the application of
self_group()
is automatic - end-user code should never need to use this method directly. Note that SQLAlchemy’s clause constructs take operator precedence into account - so parenthesis might not be needed, for example, in an expression likex OR (y AND z)
- AND takes precedence over OR.The base
self_group()
method ofClauseElement
just returns self.
-
method
sqlalchemy.sql.functions.FunctionElement.
within_group(*order_by)¶ Produce a WITHIN GROUP (ORDER BY expr) clause against this function.
Used against so-called “ordered set aggregate” and “hypothetical set aggregate” functions, including
percentile_cont
,rank
,dense_rank
, etc.See
within_group()
for a full description.New in version 1.1.
-
method
sqlalchemy.sql.functions.FunctionElement.
within_group_type(within_group)¶ For types that define their return type as based on the criteria within a WITHIN GROUP (ORDER BY) expression, called by the
WithinGroup
construct.Returns None by default, in which case the function’s normal
.type
is used.
-
method
- class sqlalchemy.sql.functions.GenericFunction(*args, **kwargs)¶
Define a ‘generic’ function.
A generic function is a pre-established
Function
class that is instantiated automatically when called by name from thefunc
attribute. Note that calling any name fromfunc
has the effect that a newFunction
instance is created automatically, given that name. The primary use case for defining aGenericFunction
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
GenericFunction
are automatically registered under the name of the class. For example, a user-defined functionas_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
GenericFunction
. Third party libraries containing many functions may want to use this in order to avoid name conflicts with other systems. For example, if ouras_utc()
function were part of a package “time”:class as_utc(GenericFunction): type = DateTime package = "time"
The above function would be available from
func
using the package nametime
:print(select([func.time.as_utc()]))
A final option is to allow the function to be accessed from one name in
func
but to render as a different name. Theidentifier
attribute will override the name used to access the function as loaded fromfunc
, but will retain the usage ofname
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
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"()
New in version 1.3.13: The
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.Members
Class signature
class
sqlalchemy.sql.functions.GenericFunction
(sqlalchemy.sql.functions.Function
)-
attribute
sqlalchemy.sql.functions.GenericFunction.
coerce_arguments = True¶
-
attribute
sqlalchemy.sql.functions.GenericFunction.
identifier = 'GenericFunction'¶
-
attribute
sqlalchemy.sql.functions.GenericFunction.
name = 'GenericFunction'¶
-
attribute
- class sqlalchemy.sql.functions.OrderedSetAgg(*args, **kwargs)¶
Define a function where the return type is based on the sort expression type as defined by the expression passed to the
FunctionElement.within_group()
method.Members
array_for_multi_clause, identifier, name, within_group_type()
Class signature
class
sqlalchemy.sql.functions.OrderedSetAgg
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.OrderedSetAgg.
array_for_multi_clause = False¶
-
attribute
sqlalchemy.sql.functions.OrderedSetAgg.
identifier = 'OrderedSetAgg'¶
-
attribute
sqlalchemy.sql.functions.OrderedSetAgg.
name = 'OrderedSetAgg'¶
-
method
sqlalchemy.sql.functions.OrderedSetAgg.
within_group_type(within_group)¶ For types that define their return type as based on the criteria within a WITHIN GROUP (ORDER BY) expression, called by the
WithinGroup
construct.Returns None by default, in which case the function’s normal
.type
is used.
-
attribute
- class sqlalchemy.sql.functions.ReturnTypeFromArgs(*args, **kwargs)¶
Define a function whose return type is the same as its arguments.
Members
Class signature
class
sqlalchemy.sql.functions.ReturnTypeFromArgs
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.ReturnTypeFromArgs.
identifier = 'ReturnTypeFromArgs'¶
-
attribute
sqlalchemy.sql.functions.ReturnTypeFromArgs.
name = 'ReturnTypeFromArgs'¶
-
attribute
- class sqlalchemy.sql.functions.array_agg(*args, **kwargs)¶
Support for the ARRAY_AGG function.
The
func.array_agg(expr)
construct returns an expression of typeARRAY
.e.g.:
stmt = select([func.array_agg(table.c.values)[2:5]])
New in version 1.1.
See also
array_agg()
- PostgreSQL-specific version that returnsARRAY
, which has PG-specific operators added.Members
Class signature
class
sqlalchemy.sql.functions.array_agg
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.array_agg.
identifier = 'array_agg'¶
-
attribute
sqlalchemy.sql.functions.array_agg.
name = 'array_agg'¶
-
attribute
sqlalchemy.sql.functions.array_agg.
type¶ alias of
ARRAY
-
attribute
- class sqlalchemy.sql.functions.char_length(arg, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.char_length
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.char_length.
identifier = 'char_length'¶
-
attribute
sqlalchemy.sql.functions.char_length.
name = 'char_length'¶
-
attribute
sqlalchemy.sql.functions.char_length.
type¶ alias of
Integer
-
attribute
- class sqlalchemy.sql.functions.coalesce(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.coalesce
(sqlalchemy.sql.functions.ReturnTypeFromArgs
)-
attribute
sqlalchemy.sql.functions.coalesce.
identifier = 'coalesce'¶
-
attribute
sqlalchemy.sql.functions.coalesce.
name = 'coalesce'¶
-
attribute
- class sqlalchemy.sql.functions.concat(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.concat
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.concat.
identifier = 'concat'¶
-
attribute
sqlalchemy.sql.functions.concat.
name = 'concat'¶
-
attribute
sqlalchemy.sql.functions.concat.
type¶ alias of
String
-
attribute
- class sqlalchemy.sql.functions.count(expression=None, **kwargs)¶
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
Members
Class signature
class
sqlalchemy.sql.functions.count
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.count.
identifier = 'count'¶
-
attribute
sqlalchemy.sql.functions.count.
name = 'count'¶
-
attribute
sqlalchemy.sql.functions.count.
type¶ alias of
Integer
-
attribute
- class sqlalchemy.sql.functions.cube(*args, **kwargs)¶
Implement the
CUBE
grouping operation.This function is used as part of the GROUP BY of a statement, e.g.
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))
New in version 1.2.
Members
Class signature
class
sqlalchemy.sql.functions.cube
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.cube.
identifier = 'cube'¶
-
attribute
sqlalchemy.sql.functions.cube.
name = 'cube'¶
-
attribute
- class sqlalchemy.sql.functions.cume_dist(*args, **kwargs)¶
Implement the
cume_dist
hypothetical-set aggregate function.This function must be used with the
FunctionElement.within_group()
modifier to supply a sort expression to operate upon.The return type of this function is
Numeric
.New in version 1.1.
Members
Class signature
class
sqlalchemy.sql.functions.cume_dist
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.cume_dist.
identifier = 'cume_dist'¶
-
attribute
sqlalchemy.sql.functions.cume_dist.
name = 'cume_dist'¶
-
attribute
sqlalchemy.sql.functions.cume_dist.
type = Numeric()¶
-
attribute
- class sqlalchemy.sql.functions.current_date(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.current_date
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.current_date.
identifier = 'current_date'¶
-
attribute
sqlalchemy.sql.functions.current_date.
name = 'current_date'¶
-
attribute
sqlalchemy.sql.functions.current_date.
type¶ alias of
Date
-
attribute
- class sqlalchemy.sql.functions.current_time(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.current_time
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.current_time.
identifier = 'current_time'¶
-
attribute
sqlalchemy.sql.functions.current_time.
name = 'current_time'¶
-
attribute
sqlalchemy.sql.functions.current_time.
type¶ alias of
Time
-
attribute
- class sqlalchemy.sql.functions.current_timestamp(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.current_timestamp
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.current_timestamp.
identifier = 'current_timestamp'¶
-
attribute
sqlalchemy.sql.functions.current_timestamp.
name = 'current_timestamp'¶
-
attribute
sqlalchemy.sql.functions.current_timestamp.
type¶ alias of
DateTime
-
attribute
- class sqlalchemy.sql.functions.current_user(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.current_user
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.current_user.
identifier = 'current_user'¶
-
attribute
sqlalchemy.sql.functions.current_user.
name = 'current_user'¶
-
attribute
sqlalchemy.sql.functions.current_user.
type¶ alias of
String
-
attribute
- class sqlalchemy.sql.functions.dense_rank(*args, **kwargs)¶
Implement the
dense_rank
hypothetical-set aggregate function.This function must be used with the
FunctionElement.within_group()
modifier to supply a sort expression to operate upon.The return type of this function is
Integer
.New in version 1.1.
Members
Class signature
class
sqlalchemy.sql.functions.dense_rank
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.dense_rank.
identifier = 'dense_rank'¶
-
attribute
sqlalchemy.sql.functions.dense_rank.
name = 'dense_rank'¶
-
attribute
sqlalchemy.sql.functions.dense_rank.
type = Integer()¶
-
attribute
- class sqlalchemy.sql.functions.grouping_sets(*args, **kwargs)¶
Implement the
GROUPING SETS
grouping operation.This function is used as part of the GROUP BY of a statement, e.g.
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
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), ) )
New in version 1.2.
Members
Class signature
class
sqlalchemy.sql.functions.grouping_sets
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.grouping_sets.
identifier = 'grouping_sets'¶
-
attribute
sqlalchemy.sql.functions.grouping_sets.
name = 'grouping_sets'¶
-
attribute
- class sqlalchemy.sql.functions.localtime(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.localtime
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.localtime.
identifier = 'localtime'¶
-
attribute
sqlalchemy.sql.functions.localtime.
name = 'localtime'¶
-
attribute
sqlalchemy.sql.functions.localtime.
type¶ alias of
DateTime
-
attribute
- class sqlalchemy.sql.functions.localtimestamp(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.localtimestamp
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.localtimestamp.
identifier = 'localtimestamp'¶
-
attribute
sqlalchemy.sql.functions.localtimestamp.
name = 'localtimestamp'¶
-
attribute
sqlalchemy.sql.functions.localtimestamp.
type¶ alias of
DateTime
-
attribute
- class sqlalchemy.sql.functions.max(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.max
(sqlalchemy.sql.functions.ReturnTypeFromArgs
)-
attribute
sqlalchemy.sql.functions.max.
identifier = 'max'¶
-
attribute
sqlalchemy.sql.functions.max.
name = 'max'¶
-
attribute
- class sqlalchemy.sql.functions.min(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.min
(sqlalchemy.sql.functions.ReturnTypeFromArgs
)-
attribute
sqlalchemy.sql.functions.min.
identifier = 'min'¶
-
attribute
sqlalchemy.sql.functions.min.
name = 'min'¶
-
attribute
- class sqlalchemy.sql.functions.mode(*args, **kwargs)¶
Implement the
mode
ordered-set aggregate function.This function must be used with the
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.
New in version 1.1.
Members
Class signature
class
sqlalchemy.sql.functions.mode
(sqlalchemy.sql.functions.OrderedSetAgg
)-
attribute
sqlalchemy.sql.functions.mode.
identifier = 'mode'¶
-
attribute
sqlalchemy.sql.functions.mode.
name = 'mode'¶
-
attribute
- class sqlalchemy.sql.functions.next_value(seq, **kw)¶
Represent the ‘next value’, given a
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.
Members
Class signature
class
sqlalchemy.sql.functions.next_value
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.next_value.
identifier = 'next_value'¶
-
attribute
sqlalchemy.sql.functions.next_value.
name = 'next_value'¶
-
attribute
sqlalchemy.sql.functions.next_value.
type = Integer()¶
-
attribute
- class sqlalchemy.sql.functions.now(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.now
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.now.
identifier = 'now'¶
-
attribute
sqlalchemy.sql.functions.now.
name = 'now'¶
-
attribute
sqlalchemy.sql.functions.now.
type¶ alias of
DateTime
-
attribute
- class sqlalchemy.sql.functions.percent_rank(*args, **kwargs)¶
Implement the
percent_rank
hypothetical-set aggregate function.This function must be used with the
FunctionElement.within_group()
modifier to supply a sort expression to operate upon.The return type of this function is
Numeric
.New in version 1.1.
Members
Class signature
class
sqlalchemy.sql.functions.percent_rank
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.percent_rank.
identifier = 'percent_rank'¶
-
attribute
sqlalchemy.sql.functions.percent_rank.
name = 'percent_rank'¶
-
attribute
sqlalchemy.sql.functions.percent_rank.
type = Numeric()¶
-
attribute
- class sqlalchemy.sql.functions.percentile_cont(*args, **kwargs)¶
Implement the
percentile_cont
ordered-set aggregate function.This function must be used with the
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
ARRAY
of the sort expression’s type.New in version 1.1.
Members
Class signature
class
sqlalchemy.sql.functions.percentile_cont
(sqlalchemy.sql.functions.OrderedSetAgg
)-
attribute
sqlalchemy.sql.functions.percentile_cont.
array_for_multi_clause = True¶
-
attribute
sqlalchemy.sql.functions.percentile_cont.
identifier = 'percentile_cont'¶
-
attribute
sqlalchemy.sql.functions.percentile_cont.
name = 'percentile_cont'¶
-
attribute
- class sqlalchemy.sql.functions.percentile_disc(*args, **kwargs)¶
Implement the
percentile_disc
ordered-set aggregate function.This function must be used with the
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
ARRAY
of the sort expression’s type.New in version 1.1.
Members
Class signature
class
sqlalchemy.sql.functions.percentile_disc
(sqlalchemy.sql.functions.OrderedSetAgg
)-
attribute
sqlalchemy.sql.functions.percentile_disc.
array_for_multi_clause = True¶
-
attribute
sqlalchemy.sql.functions.percentile_disc.
identifier = 'percentile_disc'¶
-
attribute
sqlalchemy.sql.functions.percentile_disc.
name = 'percentile_disc'¶
-
attribute
- class sqlalchemy.sql.functions.random(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.random
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.random.
identifier = 'random'¶
-
attribute
sqlalchemy.sql.functions.random.
name = 'random'¶
-
attribute
- class sqlalchemy.sql.functions.rank(*args, **kwargs)¶
Implement the
rank
hypothetical-set aggregate function.This function must be used with the
FunctionElement.within_group()
modifier to supply a sort expression to operate upon.The return type of this function is
Integer
.New in version 1.1.
Members
Class signature
class
sqlalchemy.sql.functions.rank
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.rank.
identifier = 'rank'¶
-
attribute
sqlalchemy.sql.functions.rank.
name = 'rank'¶
-
attribute
sqlalchemy.sql.functions.rank.
type = Integer()¶
-
attribute
- function sqlalchemy.sql.functions.register_function(identifier, fn, package='_default')¶
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
func
accessor (i.e. CAST, EXTRACT).
- class sqlalchemy.sql.functions.rollup(*args, **kwargs)¶
Implement the
ROLLUP
grouping operation.This function is used as part of the GROUP BY of a statement, e.g.
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))
New in version 1.2.
Members
Class signature
class
sqlalchemy.sql.functions.rollup
(sqlalchemy.sql.functions.GenericFunction
)-
attribute
sqlalchemy.sql.functions.rollup.
identifier = 'rollup'¶
-
attribute
sqlalchemy.sql.functions.rollup.
name = 'rollup'¶
-
attribute
- class sqlalchemy.sql.functions.session_user(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.session_user
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.session_user.
identifier = 'session_user'¶
-
attribute
sqlalchemy.sql.functions.session_user.
name = 'session_user'¶
-
attribute
sqlalchemy.sql.functions.session_user.
type¶ alias of
String
-
attribute
- class sqlalchemy.sql.functions.sum(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.sum
(sqlalchemy.sql.functions.ReturnTypeFromArgs
)-
attribute
sqlalchemy.sql.functions.sum.
identifier = 'sum'¶
-
attribute
sqlalchemy.sql.functions.sum.
name = 'sum'¶
-
attribute
- class sqlalchemy.sql.functions.sysdate(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.sysdate
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.sysdate.
identifier = 'sysdate'¶
-
attribute
sqlalchemy.sql.functions.sysdate.
name = 'sysdate'¶
-
attribute
sqlalchemy.sql.functions.sysdate.
type¶ alias of
DateTime
-
attribute
- class sqlalchemy.sql.functions.user(*args, **kwargs)¶
Members
Class signature
class
sqlalchemy.sql.functions.user
(sqlalchemy.sql.functions.AnsiFunction
)-
attribute
sqlalchemy.sql.functions.user.
identifier = 'user'¶
-
attribute
sqlalchemy.sql.functions.user.
name = 'user'¶
-
attribute
sqlalchemy.sql.functions.user.
type¶ alias of
String
-
attribute
flambé! the dragon and The Alchemist image designs created and generously donated by Rotem Yaari.
Created using Sphinx 7.2.6. Documentation last generated: Sat 06 Jan 2024 12:15:54 PM