Skip to content
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

Jump to bottom

[6.x] Improvements on subqueries #30307

Merged
merged 3 commits into from
Oct 18, 2019
Merged

[6.x] Improvements on subqueries #30307

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ff93b7
Determine if the value is queryable
sebdesign Oct 16, 2019
ab5ee8a
Add more context about invalid subqueries
sebdesign Oct 16, 2019
6d06919
Remove @throws docblock tags
sebdesign Oct 17, 2019
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
51 changes: 31 additions & 20 deletions src/Illuminate/Database/Query/Builder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,11 +228,7 @@ public function select($columns = ['*'])
$columns = is_array($columns) ? $columns : func_get_args();

foreach ($columns as $as => $column) {
if (is_string($as) && (
$column instanceof self ||
$column instanceof EloquentBuilder ||
$column instanceof Closure
)) {
if (is_string($as) && $this->isQueryable($column)) {
$this->selectSub($column, $as);
} else {
$this->columns[] = $column;
Expand Down Expand Up @@ -315,6 +311,8 @@ public function fromRaw($expression, $bindings = [])
*
* @param \Closure|\Illuminate\Database\Query\Builder|string $query
* @return array
*
* @throws \InvalidArgumentException
driesvints marked this conversation as resolved.
Show resolved Hide resolved
*/
protected function createSub($query)
{
Expand All @@ -335,6 +333,8 @@ protected function createSub($query)
*
* @param mixed $query
* @return array
*
* @throws \InvalidArgumentException
*/
protected function parseSub($query)
{
Expand All @@ -343,10 +343,25 @@ protected function parseSub($query)
} elseif (is_string($query)) {
return [$query, []];
} else {
throw new InvalidArgumentException;
throw new InvalidArgumentException(
'The subquery must be an instance of Closure or Builder, or a string.'
);
}
}

/**
* Determine if the value is a query builder instance or a closure.
*
* @param mixed $value
* @return bool
*/
protected function isQueryable($value)
{
return $value instanceof self ||
$value instanceof EloquentBuilder ||
$value instanceof Closure;
}

/**
* Add a new select column to the query.
*
Expand All @@ -358,11 +373,7 @@ public function addSelect($column)
$columns = is_array($column) ? $column : func_get_args();

foreach ($columns as $as => $column) {
if (is_string($as) && (
$column instanceof self ||
$column instanceof EloquentBuilder ||
$column instanceof Closure
)) {
if (is_string($as) && $this->isQueryable($column)) {
if (is_null($this->columns)) {
$this->select($this->from.'.*');
}
Expand Down Expand Up @@ -403,9 +414,7 @@ public function distinct()
*/
public function from($table, $as = null)
{
if ($table instanceof self ||
$table instanceof EloquentBuilder ||
$table instanceof Closure) {
if ($this->isQueryable($table)) {
return $this->fromSub($table, $as);
}

Expand Down Expand Up @@ -531,6 +540,8 @@ public function leftJoinWhere($table, $first, $operator, $second)
* @param string|null $operator
* @param string|null $second
* @return \Illuminate\Database\Query\Builder|static
*
* @throws \InvalidArgumentException
driesvints marked this conversation as resolved.
Show resolved Hide resolved
*/
public function leftJoinSub($query, $as, $first, $operator = null, $second = null)
{
Expand Down Expand Up @@ -574,6 +585,8 @@ public function rightJoinWhere($table, $first, $operator, $second)
* @param string|null $operator
* @param string|null $second
* @return \Illuminate\Database\Query\Builder|static
*
* @throws \InvalidArgumentException
driesvints marked this conversation as resolved.
Show resolved Hide resolved
*/
public function rightJoinSub($query, $as, $first, $operator = null, $second = null)
{
Expand Down Expand Up @@ -890,9 +903,7 @@ public function whereIn($column, $values, $boolean = 'and', $not = false)
// If the value is a query builder instance we will assume the developer wants to
// look for any values that exists within this given query. So we will add the
// query accordingly so that this query is properly executed when it is run.
if ($values instanceof self ||
$values instanceof EloquentBuilder ||
$values instanceof Closure) {
if ($this->isQueryable($values)) {
[$query, $bindings] = $this->createSub($values);

$values = [new Expression($query)];
Expand Down Expand Up @@ -1806,9 +1817,7 @@ public function orHavingRaw($sql, array $bindings = [])
*/
public function orderBy($column, $direction = 'asc')
{
if ($column instanceof self ||
$column instanceof EloquentBuilder ||
$column instanceof Closure) {
if ($this->isQueryable($column)) {
[$query, $bindings] = $this->createSub($column);

$column = new Expression('('.$query.')');
Expand Down Expand Up @@ -2664,6 +2673,8 @@ public function insertGetId(array $values, $sequence = null)
* @param array $columns
* @param \Closure|\Illuminate\Database\Query\Builder|string $query
* @return int
*
* @throws \InvalidArgumentException
driesvints marked this conversation as resolved.
Show resolved Hide resolved
*/
public function insertUsing(array $columns, $query)
{
Expand Down
31 changes: 31 additions & 0 deletions tests/Database/DatabaseQueryBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1658,6 +1658,10 @@ public function testJoinSub()
$expected .= 'inner join (select * from "contacts" where "name" = ?) as "sub2" on "users"."id" = "sub2"."user_id"';
$this->assertEquals($expected, $builder->toSql());
$this->assertEquals(['foo', 1, 'bar'], $builder->getRawBindings()['join']);

$this->expectException(InvalidArgumentException::class);
$builder = $this->getBuilder();
$builder->from('users')->joinSub(['foo'], 'sub', 'users.id', '=', 'sub.id');
}

public function testJoinSubWithPrefix()
Expand All @@ -1673,13 +1677,21 @@ public function testLeftJoinSub()
$builder = $this->getBuilder();
$builder->from('users')->leftJoinSub($this->getBuilder()->from('contacts'), 'sub', 'users.id', '=', 'sub.id');
$this->assertSame('select * from "users" left join (select * from "contacts") as "sub" on "users"."id" = "sub"."id"', $builder->toSql());

$this->expectException(InvalidArgumentException::class);
$builder = $this->getBuilder();
$builder->from('users')->leftJoinSub(['foo'], 'sub', 'users.id', '=', 'sub.id');
}

public function testRightJoinSub()
{
$builder = $this->getBuilder();
$builder->from('users')->rightJoinSub($this->getBuilder()->from('contacts'), 'sub', 'users.id', '=', 'sub.id');
$this->assertSame('select * from "users" right join (select * from "contacts") as "sub" on "users"."id" = "sub"."id"', $builder->toSql());

$this->expectException(InvalidArgumentException::class);
$builder = $this->getBuilder();
$builder->from('users')->rightJoinSub(['foo'], 'sub', 'users.id', '=', 'sub.id');
}

public function testRawExpressionsInSelect()
Expand Down Expand Up @@ -1917,6 +1929,13 @@ function (Builder $query) {
$this->assertEquals(1, $result);
}

public function testInsertUsingInvalidSubquery()
{
$this->expectException(InvalidArgumentException::class);
$builder = $this->getBuilder();
$builder->from('table1')->insertUsing(['foo'], ['bar']);
}

public function testInsertOrIgnoreMethod()
{
$this->expectException(RuntimeException::class);
Expand Down Expand Up @@ -2869,6 +2888,10 @@ public function testSubSelect()
$builder->selectSub($subBuilder, 'sub');
$this->assertEquals($expectedSql, $builder->toSql());
$this->assertEquals($expectedBindings, $builder->getBindings());

$this->expectException(InvalidArgumentException::class);
$builder = $this->getPostgresBuilder();
$builder->selectSub(['foo'], 'sub');
}

public function testSqlServerWhereDate()
Expand Down Expand Up @@ -3421,6 +3444,10 @@ public function testFromSub()
}, 'sessions')->where('bar', '<', '10');
$this->assertSame('select * from (select max(last_seen_at) as last_seen_at from "user_sessions" where "foo" = ?) as "sessions" where "bar" < ?', $builder->toSql());
$this->assertEquals(['1', '10'], $builder->getBindings());

$this->expectException(InvalidArgumentException::class);
$builder = $this->getBuilder();
$builder->fromSub(['invalid'], 'sessions')->where('bar', '<', '10');
}

public function testFromSubWithPrefix()
Expand All @@ -3441,6 +3468,10 @@ public function testFromSubWithoutBindings()
$query->select(new Raw('max(last_seen_at) as last_seen_at'))->from('user_sessions');
}, 'sessions');
$this->assertSame('select * from (select max(last_seen_at) as last_seen_at from "user_sessions") as "sessions"', $builder->toSql());

$this->expectException(InvalidArgumentException::class);
$builder = $this->getBuilder();
$builder->fromSub(['invalid'], 'sessions');
}

public function testFromRaw()
Expand Down