> ## Documentation Index
> Fetch the complete documentation index at: https://www.paradedb.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Sum

> Compute the sum of a field

The sum aggregation computes the sum of a field.

```sql SQL theme={null}
SELECT pdb.agg('{"sum": {"field": "rating"}}') FROM mock_items
WHERE id @@@ pdb.all();
```

```ts Drizzle theme={null}
import { search } from "@paradedb/drizzle-paradedb";

await db
  .select({
    agg: search.agg({ sum: { field: "rating" } }),
  })
  .from(mockItems)
  .where(search.all(mockItems.id));
```

```python Django theme={null}
from paradedb import Agg, All, ParadeDB

MockItem.objects.filter(
    id=ParadeDB(All())
).aggregate(agg=Agg('{"sum": {"field": "rating"}}'))
```

```python SQLAlchemy theme={null}
from sqlalchemy import select
from sqlalchemy.orm import Session
from paradedb.sqlalchemy import facets, pdb, search

stmt = (
    select(pdb.agg(facets.sum(field="rating")))
    .select_from(MockItem)
    .where(search.all(MockItem.id))
)

with Session(engine) as session:
    session.execute(stmt).all()
```

```ruby Rails theme={null}
MockItem.search(:id)
        .match_all
        .facets_agg(agg: ParadeDB::Aggregations.sum(:rating))
```

```cs EF Core theme={null}
await dbContext
    .MockItems.Where(item => EF.Functions.All(item.Id))
    .Select(item => EF.Functions.Agg(new { sum = new { field = "rating" } }))
    .ToListAsync();
```

```ini Expected Response theme={null}
       agg
------------------
 {"value": 158.0}
(1 row)
```

See the [Tantivy documentation](https://docs.rs/tantivy/latest/tantivy/aggregation/metric/struct.SumAggregation.html) for all available options.

## SQL Sum Syntax

SQL's `SUM` syntax is supported in beta and is enabled by default. To disable it, run

```sql theme={null}
SET paradedb.enable_aggregate_custom_scan TO off;
```

The following query is equivalent to the above and is executed in the same way.

```sql SQL theme={null}
SELECT SUM(rating) FROM mock_items
WHERE id @@@ pdb.all();
```

By default, `SUM` ignores null values. Use `COALESCE` to include them in the final sum:

```sql SQL theme={null}
SELECT SUM(COALESCE(rating, 0)) FROM mock_items
WHERE id @@@ pdb.all();
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.