Back to Paradedb

Range

docs/documentation/aggregates/bucket/range.mdx

0.23.31.8 KB
Original Source

The range aggregation counts the number of occurrences over user-defined buckets. The buckets must be continuous and cannot overlap.

<CodeGroup> ```sql SQL SELECT pdb.agg('{"range": {"field": "rating", "ranges": [{"to": 3.0 }, {"from": 3.0, "to": 6.0} ]}}') FROM mock_items WHERE id @@@ pdb.all(); ```
python
from paradedb import Agg, All, ParadeDB

MockItem.objects.filter(
    id=ParadeDB(All())
).aggregate(agg=Agg('{"range": {"field": "rating", "ranges": [{"to": 3.0}, {"from": 3.0, "to": 6.0}]}}'))
python
from sqlalchemy import select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import facets, pdb, search

stmt = (
    select(
        pdb.agg(
            facets.range(
                field="rating",
                ranges=[{"to": 3.0}, {"from": 3.0, "to": 6.0}],
            )
        )
    )
    .select_from(MockItem)
    .where(search.all(MockItem.id))
)

with Session(engine) as session:
    session.execute(stmt).all()
ruby
MockItem.search(:id)
        .match_all
        .facets_agg(
          agg: ParadeDB::Aggregations.range(
            :rating,
            ranges: [{ to: 3.0 }, { from: 3.0, to: 6.0 }]
          )
        )
</CodeGroup>
ini
                                                                              agg
----------------------------------------------------------------------------------------------------------------------------------------------------------------
 {"buckets": [{"to": 3.0, "key": "*-3", "doc_count": 4}, {"to": 6.0, "key": "3-6", "from": 3.0, "doc_count": 37}, {"key": "6-*", "from": 6.0, "doc_count": 0}]}
(1 row)

See the Tantivy documentation for all available options.