docs/documentation/aggregates/metrics/minmax.mdx
min and max return the smallest and largest values of a column, respectively.
SQL's MIN/MAX syntax is supported in beta. To enable it, first run:
SET paradedb.enable_aggregate_custom_scan TO on;
The min aggregation returns the smallest value in a field.
from paradedb import Agg, All, ParadeDB
MockItem.objects.filter(
id=ParadeDB(All())
).aggregate(agg=Agg('{"min": {"field": "rating"}}'))
from sqlalchemy import select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import facets, pdb, search
stmt = (
select(pdb.agg(facets.min(field="rating")))
.select_from(MockItem)
.where(search.all(MockItem.id))
)
with Session(engine) as session:
session.execute(stmt).all()
MockItem.search(:id)
.match_all
.facets_agg(agg: ParadeDB::Aggregations.min(:rating))
agg
----------------
{"value": 1.0}
(1 row)
See the Tantivy documentation for all available options.
With paradedb.enable_aggregate_custom_scan enabled, the following query is equivalent to the above and is executed in the same way.
from django.db.models import Min
from paradedb import All, ParadeDB
MockItem.objects.filter(
id=ParadeDB(All())
).aggregate(min_rating=Min('rating'))
from sqlalchemy import func, select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import search
stmt = (
select(func.min(MockItem.rating))
.select_from(MockItem)
.where(search.all(MockItem.id))
)
with Session(engine) as session:
session.execute(stmt).all()
MockItem.search(:id).match_all.minimum(:rating)
By default, MIN ignores null values. Use COALESCE to include them in the final result:
from django.db.models import Min, Value
from django.db.models.functions import Coalesce
from paradedb import All, ParadeDB
MockItem.objects.filter(
id=ParadeDB(All())
).aggregate(min_rating=Min(Coalesce('rating', Value(0))))
from sqlalchemy import func, select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import search
stmt = (
select(func.min(func.coalesce(MockItem.rating, 0)))
.select_from(MockItem)
.where(search.all(MockItem.id))
)
with Session(engine) as session:
session.execute(stmt).all()
rating = MockItem.arel_table[:rating]
coalesced_rating = Arel::Nodes::NamedFunction.new("COALESCE", [rating, Arel::Nodes.build_quoted(0)])
MockItem.search(:id).match_all.minimum(coalesced_rating)
The max aggregation returns the largest value in a field.
from paradedb import Agg, All, ParadeDB
MockItem.objects.filter(
id=ParadeDB(All())
).aggregate(agg=Agg('{"max": {"field": "rating"}}'))
from sqlalchemy import select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import facets, pdb, search
stmt = (
select(pdb.agg(facets.max(field="rating")))
.select_from(MockItem)
.where(search.all(MockItem.id))
)
with Session(engine) as session:
session.execute(stmt).all()
MockItem.search(:id)
.match_all
.facets_agg(agg: ParadeDB::Aggregations.max(:rating))
agg
----------------
{"value": 5.0}
(1 row)
With paradedb.enable_aggregate_custom_scan enabled, the following query is equivalent to the above and is executed in the same way.
from django.db.models import Max
from paradedb import All, ParadeDB
MockItem.objects.filter(
id=ParadeDB(All())
).aggregate(max_rating=Max('rating'))
from sqlalchemy import func, select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import search
stmt = (
select(func.max(MockItem.rating))
.select_from(MockItem)
.where(search.all(MockItem.id))
)
with Session(engine) as session:
session.execute(stmt).all()
MockItem.search(:id).match_all.maximum(:rating)
By default, MAX ignores null values. Use COALESCE to include them in the final result:
from django.db.models import Max, Value
from django.db.models.functions import Coalesce
from paradedb import All, ParadeDB
MockItem.objects.filter(
id=ParadeDB(All())
).aggregate(max_rating=Max(Coalesce('rating', Value(0))))
from sqlalchemy import func, select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import search
stmt = (
select(func.max(func.coalesce(MockItem.rating, 0)))
.select_from(MockItem)
.where(search.all(MockItem.id))
)
with Session(engine) as session:
session.execute(stmt).all()
rating = MockItem.arel_table[:rating]
coalesced_rating = Arel::Nodes::NamedFunction.new("COALESCE", [rating, Arel::Nodes.build_quoted(0)])
MockItem.search(:id).match_all.maximum(coalesced_rating)