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(Posts.Id).label("CustomCount"), Posts.ID).group_by(Posts.ID) for instance in rs: print("Count: ", instance.CustomCount) print("ID: ", instance.ID) print("---------")
You can also execute COUNT using the session object's execute() method:
rs = session.execute(Posts_table.select().with_only_columns([func.count(Posts_table.c.Id).label("CustomCount"), Posts_table.c.ID])group_by(Posts_table.c.ID)) 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(Posts.AnnualRevenue).label("CustomSum"), Posts.ID).group_by(Posts.ID) for instance in rs: print("Sum: ", instance.CustomSum) print("ID: ", instance.ID) print("---------")
You can also invoke SUM using the session object's execute() method.
rs = session.execute(Posts_table.select().with_only_columns([func.sum(Posts_table.c.AnnualRevenue).label("CustomSum"), Posts_table.c.ID]).group_by(Posts_table.c.ID)) 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(Posts.AnnualRevenue).label("CustomAvg"), Posts.ID).group_by(Posts.ID) for instance in rs: print("Avg: ", instance.CustomAvg) print("ID: ", instance.ID) print("---------")
You can also use the session object's execute() method to invoke AVG:
rs = session.execute(Posts_table.select().with_only_columns([func.avg(Posts_table.c.AnnualRevenue).label("CustomAvg"), Posts_table.c.ID]).group_by(Posts_table.c.ID)) 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(Posts.AnnualRevenue).label("CustomMax"), func.min(Posts.AnnualRevenue).label("CustomMin"), Posts.ID).group_by(Posts.ID) for instance in rs: print("Max: ", instance.CustomMax) print("Min: ", instance.CustomMin) print("ID: ", instance.ID) print("---------")
You can also use the session object's execute() method to invoke MAX and MIN:
rs = session.execute(Posts_table.select().with_only_columns([func.max(Posts_table.c.AnnualRevenue).label("CustomMax"), func.min(Posts_table.c.AnnualRevenue).label("CustomMin"), Posts_table.c.ID]).group_by(Posts_table.c.ID)) for instance in rs: