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