Skip to content

[5.8] Add INSERT IGNORE support to Query Builder #29572

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.

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 17 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions src/Illuminate/Database/Query/Builder.php
Original file line number Diff line number Diff line change
Expand Up @@ -2647,6 +2647,35 @@ public function insert(array $values)
);
}

/**
* Insert ignore a new record into the database.
*
* @param array $values
* @param array|string|null $target Only used for SqlServer
* @return int
*/
public function insertOrIgnore(array $values, $target = null)
{
if (empty($values)) {
return 0;
}

if (! is_array(reset($values))) {
$values = [$values];
} else {
foreach ($values as $key => $value) {
ksort($value);

$values[$key] = $value;
}
}

return $this->connection->affectingStatement(
$this->grammar->compileInsertOrIgnore($this, $values, (array) $target),
$this->cleanBindings(Arr::flatten($values, 1))
);
}

/**
* Insert a new record and get the value of the primary key.
*
Expand Down
13 changes: 13 additions & 0 deletions src/Illuminate/Database/Query/Grammars/Grammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -872,6 +872,19 @@ public function compileInsert(Builder $query, array $values)
return "insert into $table ($columns) values $parameters";
}

/**
* Compile an insert ignore statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param array $target
* @return string
*/
public function compileInsertOrIgnore(Builder $query, array $values, array $target)
{
throw new RuntimeException('This database engine does not support insert or ignore.');
}

/**
* Compile an insert and get ID statement into SQL.
*
Expand Down
13 changes: 13 additions & 0 deletions src/Illuminate/Database/Query/Grammars/MySqlGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,19 @@ public function compileSelect(Builder $query)
return $sql;
}

/**
* Compile an insert ignore statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param array $target
* @return string
*/
public function compileInsertOrIgnore(Builder $query, array $values, array $target)
{
return substr_replace($this->compileInsert($query, $values), ' ignore', 6, 0);
}

/**
* Compile a "JSON contains" statement into SQL.
*
Expand Down
13 changes: 13 additions & 0 deletions src/Illuminate/Database/Query/Grammars/PostgresGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,19 @@ public function compileInsert(Builder $query, array $values)
: parent::compileInsert($query, $values);
}

/**
* Compile an insert ignore statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param array $target
* @return string
*/
public function compileInsertOrIgnore(Builder $query, array $values, array $target)
{
return $this->compileInsert($query, $values).' on conflict do nothing';
}

/**
* Compile an insert and get ID statement into SQL.
*
Expand Down
13 changes: 13 additions & 0 deletions src/Illuminate/Database/Query/Grammars/SQLiteGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,19 @@ public function compileInsert(Builder $query, array $values)
: parent::compileInsert($query, $values);
}

/**
* Compile an insert ignore statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param array $target
* @return string
*/
public function compileInsertOrIgnore(Builder $query, array $values, array $target)
{
return substr_replace($this->compileInsert($query, $values), ' or ignore', 6, 0);
}

/**
* Compile an update statement into SQL.
*
Expand Down
42 changes: 42 additions & 0 deletions src/Illuminate/Database/Query/Grammars/SqlServerGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,48 @@ protected function compileFrom(Builder $query, $table)
return $from;
}

/**
* Compile an "insert ignore" statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param array $target
* @return string
*/
public function compileInsertOrIgnore(Builder $query, array $values, array $target)
{
return $this->compileMerge($query, $values, $target);
}

/**
* Compile a "merge" statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param array $target
* @return string
*/
public function compileMerge(Builder $query, array $values, array $target)
{
$columns = $this->columnize(array_keys(reset($values)));

$sql = "merge {$this->wrapTable($query->from)} ";

$parameters = collect($values)->map(function ($record) {
return "({$this->parameterize($record)})";
})->implode(', ');

$sql .= "using (values $parameters) {$this->wrapTable('laravel_source')} ($columns) ";

$on = collect($target)->map(function ($column) use ($query) {
return "{$this->wrap("laravel_source.$column")} = {$this->wrap("{$query->from}.$column")}";
})->implode(' and ');

$sql .= "on $on when not matched then insert ($columns) values ($columns);";

return $sql;
}

/**
* Compile a "where date" clause.
*
Expand Down
41 changes: 41 additions & 0 deletions tests/Database/DatabaseQueryBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -1867,6 +1867,47 @@ function (Builder $query) {
$this->assertTrue($result);
}

public function testInsertOrIgnoreMethod()
{
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage('This database engine does not support insert or ignore.');

$builder = $this->getBuilder();
$builder->from('users')->insertOrIgnore(['email' => 'foo']);
}

public function testMySqlInsertOrIgnoreMethod()
{
$builder = $this->getMySqlBuilder();
$builder->getConnection()->shouldReceive('affectingStatement')->once()->with('insert ignore into `users` (`email`) values (?)', ['foo'])->andReturn(1);
$result = $builder->from('users')->insertOrIgnore(['email' => 'foo']);
$this->assertEquals(1, $result);
}

public function testPostgresInsertOrIgnoreMethod()
{
$builder = $this->getPostgresBuilder();
$builder->getConnection()->shouldReceive('affectingStatement')->once()->with('insert into "users" ("email") values (?) on conflict do nothing', ['foo'])->andReturn(1);
$result = $builder->from('users')->insertOrIgnore(['email' => 'foo']);
$this->assertEquals(1, $result);
}

public function testSQLiteInsertOrIgnoreMethod()
{
$builder = $this->getSQLiteBuilder();
$builder->getConnection()->shouldReceive('affectingStatement')->once()->with('insert or ignore into "users" ("email") values (?)', ['foo'])->andReturn(1);
$result = $builder->from('users')->insertOrIgnore(['email' => 'foo']);
$this->assertEquals(1, $result);
}

public function testSqlServerInsertOrIgnoreMethod()
{
$builder = $this->getSqlServerBuilder();
$builder->getConnection()->shouldReceive('affectingStatement')->once()->with('merge [users] using (values (?)) [laravel_source] ([email]) on [laravel_source].[email] = [users].[email] when not matched then insert ([email]) values ([email]);', ['foo'])->andReturn(1);
$result = $builder->from('users')->insertOrIgnore(['email' => 'foo'], ['email']);
$this->assertEquals(1, $result);
}

public function testInsertGetIdMethod()
{
$builder = $this->getBuilder();
Expand Down