Aggregates (count, sum, avg) in Laravel

Introduction

Aggregates help you quickly get totals or averages from your database without loading all data. They save time and make your app faster.

Counting how many users signed up today.

Adding up all sales to see total revenue.

Finding the average rating of a product.

Checking how many orders are pending.

Calculating the average age of members in a group.

Syntax

Laravel

Model::count();
Model::sum('column');
Model::avg('column');

Use count() to get the number of rows.

Use sum('column') and avg('column') to get totals and averages of a specific column.

Examples

Counts all users in the users table.

Laravel

User::count();

Adds up the total_price column from all orders.

Laravel

Order::sum('total_price');

Calculates the average rating from all reviews.

Laravel

Review::avg('rating');

Sample Program

This example shows how to count products that are in stock, sum all product prices, and find the average price using Laravel's aggregate methods.

Laravel

<?php
use App\Models\Product;

// Count how many products are in stock
$inStockCount = Product::where('in_stock', '>', 0)->count();

// Sum the prices of all products
$totalPrice = Product::sum('price');

// Average price of products
$averagePrice = Product::avg('price');

// Display results
echo "Products in stock: $inStockCount\n";
echo "Total price of products: $totalPrice\n";
echo "Average product price: $averagePrice\n";

Important Notes

Aggregates run directly in the database, so they are very fast.

You can add where clauses before aggregates to filter data.

Remember to import your model with use App\Models\ModelName;.

Summary

Aggregates help get counts, sums, and averages quickly.

Use count(), sum('column'), and avg('column') on your models.

They work well with filters like where to focus on specific data.

Practice

1. What does the count() method do in Laravel Eloquent?

easy

A. Returns the number of records matching the query

B. Calculates the sum of a column

C. Finds the average value of a column

D. Deletes all records in the table

Solution

1. Step 1: Understand the purpose of count()

   The count() method counts how many records match the query conditions.

2. Step 2: Compare with other aggregate methods

   Unlike sum() or avg(), count() returns a number of rows, not a calculation on column values.

3. Final Answer:

   Returns the number of records matching the query -> Option A

4. Quick Check:

   count() = number of records [OK]

Hint: count() counts rows, sum() and avg() work on columns [OK]

Common Mistakes:

• Confusing count() with sum() or avg()
• Thinking count() returns column values
• Assuming count() deletes records

2. Which of the following is the correct syntax to get the sum of the price column using Eloquent?

easy

A. Product::sum(['price']);

B. Product::sum(price);

C. Product->sum('price');

D. Product::sum('price');

Solution

1. Step 1: Identify correct method call syntax

   In Laravel Eloquent, static calls use double colon :: and column names must be strings in quotes.

2. Step 2: Check each option

   Product::sum('price'); uses Product::sum('price'); which is correct. Product::sum(price); misses quotes, C uses arrow on class, D passes array incorrectly.

3. Final Answer:

   Product::sum('price'); -> Option D

4. Quick Check:

   sum('column') needs quotes and :: [OK]

Hint: Use quotes around column name and :: for static call [OK]

Common Mistakes:

• Omitting quotes around column name
• Using -> instead of :: on model class
• Passing column name as array

3. Given the code:

$total = Order::where('status', 'completed')->sum('amount');

What does $total contain?

medium

A. The count of orders with status 'completed'

B. An error because sum() cannot be used with where()

C. The sum of 'amount' for orders with status 'completed'

D. The average 'amount' for all orders

Solution

1. Step 1: Understand the query filter

   The where('status', 'completed') filters orders to only those completed.

2. Step 2: Apply the sum aggregate

   The sum('amount') adds up the 'amount' values of the filtered orders.

3. Final Answer:

   The sum of 'amount' for orders with status 'completed' -> Option C

4. Quick Check:

   where() filters, sum() adds column values [OK]

Hint: where() filters rows, sum() adds column values of filtered rows [OK]

Common Mistakes:

• Thinking sum() returns count of rows
• Believing sum() cannot be chained with where()
• Confusing sum() with avg()

4. What is wrong with this code snippet?

$average = User::avg(age);

medium

A. avg() requires a second parameter

B. Missing quotes around the column name 'age'

C. avg() cannot be used on User model

D. Using avg() without where() causes error

Solution

1. Step 1: Check method parameter syntax

   The avg() method requires the column name as a string, so it must be quoted.

2. Step 2: Identify the error cause

   Without quotes, PHP treats age as a constant or variable, causing an error or unexpected behavior.

3. Final Answer:

   Missing quotes around the column name 'age' -> Option B

4. Quick Check:

   Column names must be strings in quotes [OK]

Hint: Always quote column names in aggregate methods [OK]

Common Mistakes:

• Omitting quotes around column names
• Thinking avg() needs multiple parameters
• Assuming avg() requires where()

5. You want to get the average price of products that are in stock (stock > 0). Which Eloquent query is correct?

hard

A. Product::where('stock', '>', 0)->avg('price');

B. Product::avg('price')->where('stock', '>', 0);

C. Product::where('stock', '>', 0)->sum('price') / Product::count();

D. Product::sum('price')->where('stock', '>', 0) / Product::count();

Solution

1. Step 1: Filter products with stock > 0

   The where('stock', '>', 0) filters only products that are in stock.

2. Step 2: Calculate average price of filtered products

   The avg('price') calculates the average price of those filtered products.

3. Step 3: Check other options for correctness

   Product::avg('price')->where('stock', '>', 0); calls avg() before where(), which is invalid. Manual calculations with sum divided by count do not filter correctly or mix sum and count improperly.

4. Final Answer:

   Product::where('stock', '>', 0)->avg('price'); -> Option A

5. Quick Check:

   Filter first, then aggregate [OK]

Hint: Chain where() before avg() to filter then calculate [OK]

Common Mistakes:

• Calling aggregate before where()
• Manually dividing sum by count without filtering
• Mixing sum() and avg() incorrectly