Aggregate Functions
Certain aggregate functions can also be used within SQLAlchemy by using the func module.
To import this module, execute:
from sqlalchemy.sql import func
Once func is imported, the following aggregate functions are available:
COUNT
The following example counts the number of records in a set of groups using the session object's query() method.rs = session.query(func.count(Orders.Id).label("CustomCount"), Orders.DocumentNumber).group_by(Orders.DocumentNumber) for instance in rs: print("Count: ", instance.CustomCount) print("DocumentNumber: ", instance.DocumentNumber) print("---------")
You can also execute COUNT using the session object's execute() method:
rs = session.execute(Orders_table.select().with_only_columns([func.count(Orders_table.c.Id).label("CustomCount"), Orders_table.c.DocumentNumber])group_by(Orders_table.c.DocumentNumber)) for instance in rs:
SUM
This example calculates the cumulative amount of a numeric column in a set of groups.
rs = session.query(func.sum(Orders.AnnualRevenue).label("CustomSum"), Orders.DocumentNumber).group_by(Orders.DocumentNumber) for instance in rs: print("Sum: ", instance.CustomSum) print("DocumentNumber: ", instance.DocumentNumber) print("---------")
You can also invoke SUM using the session object's execute() method.
rs = session.execute(Orders_table.select().with_only_columns([func.sum(Orders_table.c.AnnualRevenue).label("CustomSum"), Orders_table.c.DocumentNumber]).group_by(Orders_table.c.DocumentNumber)) for instance in rs:
AVG
This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:rs = session.query(func.avg(Orders.AnnualRevenue).label("CustomAvg"), Orders.DocumentNumber).group_by(Orders.DocumentNumber) for instance in rs: print("Avg: ", instance.CustomAvg) print("DocumentNumber: ", instance.DocumentNumber) print("---------")
You can also use the session object's execute() method to invoke AVG:
rs = session.execute(Orders_table.select().with_only_columns([func.avg(Orders_table.c.AnnualRevenue).label("CustomAvg"), Orders_table.c.DocumentNumber]).group_by(Orders_table.c.DocumentNumber)) for instance in rs:
MAX and MIN
This example finds the maximum value and minimum value of a numeric column in a set of groups.rs = session.query(func.max(Orders.AnnualRevenue).label("CustomMax"), func.min(Orders.AnnualRevenue).label("CustomMin"), Orders.DocumentNumber).group_by(Orders.DocumentNumber) for instance in rs: print("Max: ", instance.CustomMax) print("Min: ", instance.CustomMin) print("DocumentNumber: ", instance.DocumentNumber) print("---------")
You can also use the session object's execute() method to invoke MAX and MIN:
rs = session.execute(Orders_table.select().with_only_columns([func.max(Orders_table.c.AnnualRevenue).label("CustomMax"), func.min(Orders_table.c.AnnualRevenue).label("CustomMin"), Orders_table.c.DocumentNumber]).group_by(Orders_table.c.DocumentNumber)) for instance in rs: