Skip to content

[5.5] Add Eloquent Features: withSum,withMax,withMin,withAvg etc. #19363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

[5.5] Add Eloquent Features: withSum,withMax,withMin,withAvg etc. #19363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
420e8ce
Merge pull request #1 from laravel/master
xuqihua May 27, 2017
3150b33
Add Eloquent Features: withSum,withMax,withMin,withAvg etc.
xuqihua May 27, 2017
789ae01
styleci fix
xuqihua May 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions src/Illuminate/Database/Eloquent/Concerns/QueriesRelationships.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,117 @@ public function withCount($relations)
return $this;
}

/**
* Add subselect queries to sum the relations.
*
* @param mixed $relations
* @return $this
*/
public function withSum($relations)
{
$relations = is_array($relations) ? $relations : func_get_args();

return $this->withAggregate($relations, 'SUM');
}

/**
* Add subselect queries to max the relations.
*
* @param mixed $relations
* @return $this
*/
public function withMax($relations)
{
$relations = is_array($relations) ? $relations : func_get_args();

return $this->withAggregate($relations, 'MAX');
}

/**
* Add subselect queries to min the relations.
*
* @param mixed $relations
* @return $this
*/
public function withMin($relations)
{
$relations = is_array($relations) ? $relations : func_get_args();

return $this->withAggregate($relations, 'MIN');
}

/**
* Add subselect queries to min the relations.
*
* @param mixed $relations
* @return $this
*/
public function withAvg($relations)
{
$relations = is_array($relations) ? $relations : func_get_args();

return $this->withAggregate($relations, 'AVG');
}

/**
* use the MySQL aggregate functions including AVG COUNT, SUM, MAX and MIN.
*
* @param array $relations
* @param string $function
* @return $this
*/
public function withAggregate($relations, $function = 'COUNT')
{
if (is_null($this->query->columns)) {
$this->query->select([$this->query->from.'.*']);
}

// set to lower
Copy link
Contributor

@jstoone jstoone May 30, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first comment in this review
I would remove the following comment, since the code speaks for it self. 👍

$function = Str::lower($function);

foreach ($this->parseWithRelations($relations) as $name => $constraints) {
// First we will determine if the name has been aliased using an "as" clause on the name
// and if it has we will extract the actual relationship name and the desired name of
// the resulting column. This allows multiple counts on the same relationship name.
$segments = explode(' ', $name);

unset($alias);

if (count($segments) == 3 && Str::lower($segments[1]) == 'as') {
list($name, $alias) = [$segments[0], $segments[2]];
}

// set the default column as * or primary key
$column = ($function == 'count') ? '*' : $this->model->getKeyName();

if (strpos($name, '|') !== false) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double negatives
You can avoid the double negative of not, not having the pipe by using:

if (Str::contains($name, '|')) { /* ... */ }

Pipe vs. comma
And also I would personally choose a comma as a separator, since I find the pipe communicates AND whereas the comma communicates more separation than the pipe. Hope that makes sense.

list($name, $column) = explode('|', $name);
}

$relation = $this->getRelationWithoutConstraints($name);

// Here we will get the relationship count query and prepare to add it to the main query
// as a sub-select. First, we'll get the "has" query and use that to get the relation
// count query. We will normalize the relation name then append _count as the name.
$query = $relation->getRelationExistenceAggregateQuery(
$relation->getRelated()->newQuery(), $this, $function, $column
);

$query->callScope($constraints);

$query->mergeConstraintsFrom($relation->getQuery());

// Finally we will add the proper result column alias to the query and run the subselect
// statement against the query builder. Then we will return the builder instance back
// to the developer for further constraint chaining that needs to take place on it.
$column = snake_case(isset($alias) ? $alias : $name).'_'.$function;

$this->selectSub($query->toBase(), $column);
}

return $this;
}

/**
* Add the "has" condition where clause to the query.
*
Expand Down
16 changes: 16 additions & 0 deletions src/Illuminate/Database/Eloquent/Relations/Relation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,22 @@ public function getRelationExistenceCountQuery(Builder $query, Builder $parentQu
);
}

/**
* Add the constraints for a relationship aggregate query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parentQuery
* @param string $type
* @param string $column
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationExistenceAggregateQuery(Builder $query, Builder $parentQuery, $type, $column)
{
return $this->getRelationExistenceQuery(
$query, $parentQuery, new Expression($type.'('.$this->query->getQuery()->getGrammar()->wrap($column).')')
);
}

/**
* Add the constraints for an internal relationship existence query.
*
Expand Down
192 changes: 192 additions & 0 deletions tests/Database/DatabaseEloquentBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -696,6 +696,198 @@ public function testWithCountMultipleAndPartialRename()
$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select count(*) from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar", (select count(*) from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_count" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithSum()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withSum('foo');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select sum("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_sum" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithSumAndSelect()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withSum('foo');

$this->assertEquals('select "id", (select sum("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_sum" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithSumAndMergedWheres()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withSum(['activeFoo' => function ($q) {
$q->where('bam', '>', 'qux');
}]);

$this->assertEquals('select "id", (select sum("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id" and "bam" > ? and "active" = ?) as "active_foo_sum" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
$this->assertEquals(['qux', true], $builder->getBindings());
}

public function testWithSumAndRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withSum('foo as foo_bar');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select sum("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_sum" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithSumMultipleAndPartialRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withSum(['foo as foo_bar', 'foo']);

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select sum("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_sum", (select sum("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_sum" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMax()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withMax('foo');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select max("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_max" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMaxAndSelect()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withMax('foo');

$this->assertEquals('select "id", (select max("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_max" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMaxAndMergedWheres()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withMax(['activeFoo' => function ($q) {
$q->where('bam', '>', 'qux');
}]);

$this->assertEquals('select "id", (select max("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id" and "bam" > ? and "active" = ?) as "active_foo_max" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
$this->assertEquals(['qux', true], $builder->getBindings());
}

public function testWithMaxAndRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withMax('foo as foo_bar');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select max("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_max" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMaxMultipleAndPartialRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withMax(['foo as foo_bar', 'foo']);

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select max("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_max", (select max("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_max" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMin()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withMin('foo');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select min("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_min" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMinAndSelect()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withMin('foo');

$this->assertEquals('select "id", (select min("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_min" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMinAndMergedWheres()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withMin(['activeFoo' => function ($q) {
$q->where('bam', '>', 'qux');
}]);

$this->assertEquals('select "id", (select min("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id" and "bam" > ? and "active" = ?) as "active_foo_min" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
$this->assertEquals(['qux', true], $builder->getBindings());
}

public function testWithMinAndRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withMin('foo as foo_bar');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select min("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_min" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithMinMultipleAndPartialRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withMin(['foo as foo_bar', 'foo']);

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select min("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_min", (select min("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_min" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithAvg()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withAvg('foo');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select avg("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_avg" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithAvgAndSelect()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withAvg('foo');

$this->assertEquals('select "id", (select avg("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_avg" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithAvgAndMergedWheres()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->select('id')->withAvg(['activeFoo' => function ($q) {
$q->where('bam', '>', 'qux');
}]);

$this->assertEquals('select "id", (select avg("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id" and "bam" > ? and "active" = ?) as "active_foo_avg" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
$this->assertEquals(['qux', true], $builder->getBindings());
}

public function testWithAvgAndRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withAvg('foo as foo_bar');

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select avg("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_avg" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testWithAvgMultipleAndPartialRename()
{
$model = new EloquentBuilderTestModelParentStub;

$builder = $model->withAvg(['foo as foo_bar', 'foo']);

$this->assertEquals('select "eloquent_builder_test_model_parent_stubs".*, (select avg("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_bar_avg", (select avg("id") from "eloquent_builder_test_model_close_related_stubs" where "eloquent_builder_test_model_parent_stubs"."foo_id" = "eloquent_builder_test_model_close_related_stubs"."id") as "foo_avg" from "eloquent_builder_test_model_parent_stubs"', $builder->toSql());
}

public function testHasWithContraintsAndHavingInSubquery()
{
$model = new EloquentBuilderTestModelParentStub;
Expand Down