Home

⌘K

WARNING You're browsing the documentation for an upcoming version of Laravel. The documentation and features of this release are subject to change.

Database: Query Builder

Introduction

Laravel's database query builder provides a convenient, fluent interface to creating and running database queries. It can be used to perform most database operations in your application and works perfectly with all of Laravel's supported database systems.

The Laravel query builder uses PDO parameter binding to protect your application against SQL injection attacks. There is no need to clean or sanitize strings passed to the query builder as query bindings.

PDO does not support binding column names. Therefore, you should never allow user input to dictate the column names referenced by your queries, including "order by" columns.

Running Database Queries

Retrieving All Rows From a Table

You may use thetable method provided by theDB facade to begin a query. Thetable method returns a fluent query builder instance for the given table, allowing you to chain more constraints onto the query and then finally retrieve the results of the query using theget method:

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Support\Facades\DB;
 6use Illuminate\View\View;
 7 
 8classUserControllerextendsController
 9{
10/**
11     * Show a list of all of the application's users.
12*/
13publicfunctionindex():View
14    {
15$users=DB::table('users')->get();
16 
17returnview('user.index',['users'=>$users]);
18    }
19}
<?phpnamespace App\Http\Controllers;use Illuminate\Support\Facades\DB;use Illuminate\View\View;class UserController extends Controller{    /**     * Show a list of all of the application's users.     */    public function index(): View    {        $users = DB::table('users')->get();        return view('user.index', ['users' => $users]);    }}

Theget method returns anIlluminate\Support\Collection instance containing the results of the query where each result is an instance of the PHPstdClass object. You may access each column's value by accessing the column as a property of the object:

1use Illuminate\Support\Facades\DB;
2 
3$users=DB::table('users')->get();
4 
5foreach ($usersas$user) {
6echo$user->name;
7}
use Illuminate\Support\Facades\DB;$users = DB::table('users')->get();foreach ($users as $user) {    echo $user->name;}

Laravel collections provide a variety of extremely powerful methods for mapping and reducing data. For more information on Laravel collections, check out thecollection documentation.

Retrieving a Single Row / Column From a Table

If you just need to retrieve a single row from a database table, you may use theDB facade'sfirst method. This method will return a singlestdClass object:

1$user=DB::table('users')->where('name','John')->first();
2 
3return$user->email;
$user = DB::table('users')->where('name', 'John')->first();return $user->email;

If you would like to retrieve a single row from a database table, but throw anIlluminate\Database\RecordNotFoundException if no matching row is found, you may use thefirstOrFail method. If theRecordNotFoundException is not caught, a 404 HTTP response is automatically sent back to the client:

1$user=DB::table('users')->where('name','John')->firstOrFail();
$user = DB::table('users')->where('name', 'John')->firstOrFail();

If you don't need an entire row, you may extract a single value from a record using thevalue method. This method will return the value of the column directly:

1$email=DB::table('users')->where('name','John')->value('email');
$email = DB::table('users')->where('name', 'John')->value('email');

To retrieve a single row by itsid column value, use thefind method:

1$user=DB::table('users')->find(3);
$user = DB::table('users')->find(3);

Retrieving a List of Column Values

If you would like to retrieve anIlluminate\Support\Collection instance containing the values of a single column, you may use thepluck method. In this example, we'll retrieve a collection of user titles:

1use Illuminate\Support\Facades\DB;
2 
3$titles=DB::table('users')->pluck('title');
4 
5foreach ($titlesas$title) {
6echo$title;
7}
use Illuminate\Support\Facades\DB;$titles = DB::table('users')->pluck('title');foreach ($titles as $title) {    echo $title;}

You may specify the column that the resulting collection should use as its keys by providing a second argument to thepluck method:

1$titles=DB::table('users')->pluck('title','name');
2 
3foreach ($titlesas$name=>$title) {
4echo$title;
5}
$titles = DB::table('users')->pluck('title', 'name');foreach ($titles as $name => $title) {    echo $title;}

Chunking Results

If you need to work with thousands of database records, consider using thechunk method provided by theDB facade. This method retrieves a small chunk of results at a time and feeds each chunk into a closure for processing. For example, let's retrieve the entireusers table in chunks of 100 records at a time:

1use Illuminate\Support\Collection;
2use Illuminate\Support\Facades\DB;
3 
4DB::table('users')->orderBy('id')->chunk(100,function(Collection$users) {
5foreach ($usersas$user) {
6// ...
7    }
8});
use Illuminate\Support\Collection;use Illuminate\Support\Facades\DB;DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {    foreach ($users as $user) {        // ...    }});

You may stop further chunks from being processed by returningfalse from the closure:

1DB::table('users')->orderBy('id')->chunk(100,function(Collection$users) {
2// Process the records...
3 
4returnfalse;
5});
DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {    // Process the records...    return false;});

If you are updating database records while chunking results, your chunk results could change in unexpected ways. If you plan to update the retrieved records while chunking, it is always best to use thechunkById method instead. This method will automatically paginate the results based on the record's primary key:

1DB::table('users')->where('active',false)
2->chunkById(100,function(Collection$users) {
3foreach ($usersas$user) {
4DB::table('users')
5->where('id',$user->id)
6->update(['active'=>true]);
7        }
8    });
DB::table('users')->where('active', false)    ->chunkById(100, function (Collection $users) {        foreach ($users as $user) {            DB::table('users')                ->where('id', $user->id)                ->update(['active' => true]);        }    });

Since thechunkById andlazyById methods add their own "where" conditions to the query being executed, you should typicallylogically group your own conditions within a closure:

1DB::table('users')->where(function($query) {
2$query->where('credits',1)->orWhere('credits',2);
3})->chunkById(100,function(Collection$users) {
4foreach ($usersas$user) {
5DB::table('users')
6->where('id',$user->id)
7->update(['credits'=>3]);
8    }
9});
DB::table('users')->where(function ($query) {    $query->where('credits', 1)->orWhere('credits', 2);})->chunkById(100, function (Collection $users) {    foreach ($users as $user) {        DB::table('users')            ->where('id', $user->id)            ->update(['credits' => 3]);    }});

When updating or deleting records inside the chunk callback, any changes to the primary key or foreign keys could affect the chunk query. This could potentially result in records not being included in the chunked results.

Streaming Results Lazily

Thelazy method works similarly tothechunk method in the sense that it executes the query in chunks. However, instead of passing each chunk into a callback, thelazy() method returns aLazyCollection, which lets you interact with the results as a single stream:

1use Illuminate\Support\Facades\DB;
2 
3DB::table('users')->orderBy('id')->lazy()->each(function(object$user) {
4// ...
5});
use Illuminate\Support\Facades\DB;DB::table('users')->orderBy('id')->lazy()->each(function (object $user) {    // ...});

Once again, if you plan to update the retrieved records while iterating over them, it is best to use thelazyById orlazyByIdDesc methods instead. These methods will automatically paginate the results based on the record's primary key:

1DB::table('users')->where('active',false)
2->lazyById()->each(function(object$user) {
3DB::table('users')
4->where('id',$user->id)
5->update(['active'=>true]);
6    });
DB::table('users')->where('active', false)    ->lazyById()->each(function (object $user) {        DB::table('users')            ->where('id', $user->id)            ->update(['active' => true]);    });

When updating or deleting records while iterating over them, any changes to the primary key or foreign keys could affect the chunk query. This could potentially result in records not being included in the results.

Aggregates

The query builder also provides a variety of methods for retrieving aggregate values likecount,max,min,avg, andsum. You may call any of these methods after constructing your query:

1use Illuminate\Support\Facades\DB;
2 
3$users=DB::table('users')->count();
4 
5$price=DB::table('orders')->max('price');
use Illuminate\Support\Facades\DB;$users = DB::table('users')->count();$price = DB::table('orders')->max('price');

Of course, you may combine these methods with other clauses to fine-tune how your aggregate value is calculated:

1$price=DB::table('orders')
2->where('finalized',1)
3->avg('price');
$price = DB::table('orders')    ->where('finalized', 1)    ->avg('price');

Determining if Records Exist

Instead of using thecount method to determine if any records exist that match your query's constraints, you may use theexists anddoesntExist methods:

1if (DB::table('orders')->where('finalized',1)->exists()) {
2// ...
3}
4 
5if (DB::table('orders')->where('finalized',1)->doesntExist()) {
6// ...
7}
if (DB::table('orders')->where('finalized', 1)->exists()) {    // ...}if (DB::table('orders')->where('finalized', 1)->doesntExist()) {    // ...}

Select Statements

Specifying a Select Clause

You may not always want to select all columns from a database table. Using theselect method, you can specify a custom "select" clause for the query:

1use Illuminate\Support\Facades\DB;
2 
3$users=DB::table('users')
4->select('name','email as user_email')
5->get();
use Illuminate\Support\Facades\DB;$users = DB::table('users')    ->select('name', 'email as user_email')    ->get();

Thedistinct method allows you to force the query to return distinct results:

1$users=DB::table('users')->distinct()->get();
$users = DB::table('users')->distinct()->get();

If you already have a query builder instance and you wish to add a column to its existing select clause, you may use theaddSelect method:

1$query=DB::table('users')->select('name');
2 
3$users=$query->addSelect('age')->get();
$query = DB::table('users')->select('name');$users = $query->addSelect('age')->get();

Raw Expressions

Sometimes you may need to insert an arbitrary string into a query. To create a raw string expression, you may use theraw method provided by theDB facade:

1$users=DB::table('users')
2->select(DB::raw('count(*) as user_count, status'))
3->where('status','<>',1)
4->groupBy('status')
5->get();
$users = DB::table('users')    ->select(DB::raw('count(*) as user_count, status'))    ->where('status', '<>', 1)    ->groupBy('status')    ->get();

Raw statements will be injected into the query as strings, so you should be extremely careful to avoid creating SQL injection vulnerabilities.

Raw Methods

Instead of using theDB::raw method, you may also use the following methods to insert a raw expression into various parts of your query.Remember, Laravel cannot guarantee that any query using raw expressions is protected against SQL injection vulnerabilities.

`selectRaw`

TheselectRaw method can be used in place ofaddSelect(DB::raw(/* ... */)). This method accepts an optional array of bindings as its second argument:

1$orders=DB::table('orders')
2->selectRaw('price * ? as price_with_tax', [1.0825])
3->get();
$orders = DB::table('orders')    ->selectRaw('price * ? as price_with_tax', [1.0825])    ->get();

`whereRaw / orWhereRaw`

ThewhereRaw andorWhereRaw methods can be used to inject a raw "where" clause into your query. These methods accept an optional array of bindings as their second argument:

1$orders=DB::table('orders')
2->whereRaw('price > IF(state = "TX", ?, 100)', [200])
3->get();
$orders = DB::table('orders')    ->whereRaw('price > IF(state = "TX", ?, 100)', [200])    ->get();

`havingRaw / orHavingRaw`

ThehavingRaw andorHavingRaw methods may be used to provide a raw string as the value of the "having" clause. These methods accept an optional array of bindings as their second argument:

1$orders=DB::table('orders')
2->select('department',DB::raw('SUM(price) as total_sales'))
3->groupBy('department')
4->havingRaw('SUM(price) > ?', [2500])
5->get();
$orders = DB::table('orders')    ->select('department', DB::raw('SUM(price) as total_sales'))    ->groupBy('department')    ->havingRaw('SUM(price) > ?', [2500])    ->get();

`orderByRaw`

TheorderByRaw method may be used to provide a raw string as the value of the "order by" clause:

1$orders=DB::table('orders')
2->orderByRaw('updated_at - created_at DESC')
3->get();
$orders = DB::table('orders')    ->orderByRaw('updated_at - created_at DESC')    ->get();

`groupByRaw`

ThegroupByRaw method may be used to provide a raw string as the value of thegroup by clause:

1$orders=DB::table('orders')
2->select('city','state')
3->groupByRaw('city, state')
4->get();
$orders = DB::table('orders')    ->select('city', 'state')    ->groupByRaw('city, state')    ->get();

Joins

Inner Join Clause

The query builder may also be used to add join clauses to your queries. To perform a basic "inner join", you may use thejoin method on a query builder instance. The first argument passed to thejoin method is the name of the table you need to join to, while the remaining arguments specify the column constraints for the join. You may even join multiple tables in a single query:

1use Illuminate\Support\Facades\DB;
2 
3$users=DB::table('users')
4->join('contacts','users.id','=','contacts.user_id')
5->join('orders','users.id','=','orders.user_id')
6->select('users.*','contacts.phone','orders.price')
7->get();
use Illuminate\Support\Facades\DB;$users = DB::table('users')    ->join('contacts', 'users.id', '=', 'contacts.user_id')    ->join('orders', 'users.id', '=', 'orders.user_id')    ->select('users.*', 'contacts.phone', 'orders.price')    ->get();

Left Join / Right Join Clause

If you would like to perform a "left join" or "right join" instead of an "inner join", use theleftJoin orrightJoin methods. These methods have the same signature as thejoin method:

1$users=DB::table('users')
2->leftJoin('posts','users.id','=','posts.user_id')
3->get();
4 
5$users=DB::table('users')
6->rightJoin('posts','users.id','=','posts.user_id')
7->get();
$users = DB::table('users')    ->leftJoin('posts', 'users.id', '=', 'posts.user_id')    ->get();$users = DB::table('users')    ->rightJoin('posts', 'users.id', '=', 'posts.user_id')    ->get();

Cross Join Clause

You may use thecrossJoin method to perform a "cross join". Cross joins generate a cartesian product between the first table and the joined table:

1$sizes=DB::table('sizes')
2->crossJoin('colors')
3->get();
$sizes = DB::table('sizes')    ->crossJoin('colors')    ->get();

Advanced Join Clauses

You may also specify more advanced join clauses. To get started, pass a closure as the second argument to thejoin method. The closure will receive aIlluminate\Database\Query\JoinClause instance which allows you to specify constraints on the "join" clause:

1DB::table('users')
2->join('contacts',function(JoinClause$join) {
3$join->on('users.id','=','contacts.user_id')->orOn(/* ...*/);
4    })
5->get();
DB::table('users')    ->join('contacts', function (JoinClause $join) {        $join->on('users.id', '=', 'contacts.user_id')->orOn(/* ... */);    })    ->get();

If you would like to use a "where" clause on your joins, you may use thewhere andorWhere methods provided by theJoinClause instance. Instead of comparing two columns, these methods will compare the column against a value:

1DB::table('users')
2->join('contacts',function(JoinClause$join) {
3$join->on('users.id','=','contacts.user_id')
4->where('contacts.user_id','>',5);
5    })
6->get();
DB::table('users')    ->join('contacts', function (JoinClause $join) {        $join->on('users.id', '=', 'contacts.user_id')            ->where('contacts.user_id', '>', 5);    })    ->get();

Subquery Joins

You may use thejoinSub,leftJoinSub, andrightJoinSub methods to join a query to a subquery. Each of these methods receives three arguments: the subquery, its table alias, and a closure that defines the related columns. In this example, we will retrieve a collection of users where each user record also contains thecreated_at timestamp of the user's most recently published blog post:

1$latestPosts=DB::table('posts')
2->select('user_id',DB::raw('MAX(created_at) as last_post_created_at'))
3->where('is_published',true)
4->groupBy('user_id');
5 
6$users=DB::table('users')
7->joinSub($latestPosts,'latest_posts',function(JoinClause$join) {
8$join->on('users.id','=','latest_posts.user_id');
9    })->get();
$latestPosts = DB::table('posts')    ->select('user_id', DB::raw('MAX(created_at) as last_post_created_at'))    ->where('is_published', true)    ->groupBy('user_id');$users = DB::table('users')    ->joinSub($latestPosts, 'latest_posts', function (JoinClause $join) {        $join->on('users.id', '=', 'latest_posts.user_id');    })->get();

Lateral Joins

Lateral joins are currently supported by PostgreSQL, MySQL >= 8.0.14, and SQL Server.

You may use thejoinLateral andleftJoinLateral methods to perform a "lateral join" with a subquery. Each of these methods receives two arguments: the subquery and its table alias. The join condition(s) should be specified within thewhere clause of the given subquery. Lateral joins are evaluated for each row and can reference columns outside the subquery.

In this example, we will retrieve a collection of users as well as the user's three most recent blog posts. Each user can produce up to three rows in the result set: one for each of their most recent blog posts. The join condition is specified with awhereColumn clause within the subquery, referencing the current user row:

1$latestPosts=DB::table('posts')
2->select('id as post_id','title as post_title','created_at as post_created_at')
3->whereColumn('user_id','users.id')
4->orderBy('created_at','desc')
5->limit(3);
6 
7$users=DB::table('users')
8->joinLateral($latestPosts,'latest_posts')
9->get();
$latestPosts = DB::table('posts')    ->select('id as post_id', 'title as post_title', 'created_at as post_created_at')    ->whereColumn('user_id', 'users.id')    ->orderBy('created_at', 'desc')    ->limit(3);$users = DB::table('users')    ->joinLateral($latestPosts, 'latest_posts')    ->get();

Unions

The query builder also provides a convenient method to "union" two or more queries together. For example, you may create an initial query and use theunion method to union it with more queries:

1use Illuminate\Support\Facades\DB;
2 
3$first=DB::table('users')
4->whereNull('first_name');
5 
6$users=DB::table('users')
7->whereNull('last_name')
8->union($first)
9->get();
use Illuminate\Support\Facades\DB;$first = DB::table('users')    ->whereNull('first_name');$users = DB::table('users')    ->whereNull('last_name')    ->union($first)    ->get();

In addition to theunion method, the query builder provides aunionAll method. Queries that are combined using theunionAll method will not have their duplicate results removed. TheunionAll method has the same method signature as theunion method.

Basic Where Clauses

Where Clauses

You may use the query builder'swhere method to add "where" clauses to the query. The most basic call to thewhere method requires three arguments. The first argument is the name of the column. The second argument is an operator, which can be any of the database's supported operators. The third argument is the value to compare against the column's value.

For example, the following query retrieves users where the value of thevotes column is equal to100 and the value of theage column is greater than35:

1$users=DB::table('users')
2->where('votes','=',100)
3->where('age','>',35)
4->get();
$users = DB::table('users')    ->where('votes', '=', 100)    ->where('age', '>', 35)    ->get();

For convenience, if you want to verify that a column is= to a given value, you may pass the value as the second argument to thewhere method. Laravel will assume you would like to use the= operator:

1$users=DB::table('users')->where('votes',100)->get();
$users = DB::table('users')->where('votes', 100)->get();

As previously mentioned, you may use any operator that is supported by your database system:

 1$users=DB::table('users')
 2->where('votes','>=',100)
 3->get();
 4 
 5$users=DB::table('users')
 6->where('votes','<>',100)
 7->get();
 8 
 9$users=DB::table('users')
10->where('name','like','T%')
11->get();
$users = DB::table('users')    ->where('votes', '>=', 100)    ->get();$users = DB::table('users')    ->where('votes', '<>', 100)    ->get();$users = DB::table('users')    ->where('name', 'like', 'T%')    ->get();

You may also pass an array of conditions to thewhere function. Each element of the array should be an array containing the three arguments typically passed to thewhere method:

1$users=DB::table('users')->where([
2    ['status','=','1'],
3    ['subscribed','<>','1'],
4])->get();
$users = DB::table('users')->where([    ['status', '=', '1'],    ['subscribed', '<>', '1'],])->get();

PDO does not support binding column names. Therefore, you should never allow user input to dictate the column names referenced by your queries, including "order by" columns.

MySQL and MariaDB automatically typecast strings to integers in string-number comparisons. In this process, non-numeric strings are converted to0, which can lead to unexpected results. For example, if your table has asecret column with a value ofaaa and you runUser::where('secret', 0), that row will be returned. To avoid this, ensure all values are typecast to their appropriate types before using them in queries.

Or Where Clauses

When chaining together calls to the query builder'swhere method, the "where" clauses will be joined together using theand operator. However, you may use theorWhere method to join a clause to the query using theor operator. TheorWhere method accepts the same arguments as thewhere method:

1$users=DB::table('users')
2->where('votes','>',100)
3->orWhere('name','John')
4->get();
$users = DB::table('users')    ->where('votes', '>', 100)    ->orWhere('name', 'John')    ->get();

If you need to group an "or" condition within parentheses, you may pass a closure as the first argument to theorWhere method:

1$users=DB::table('users')
2->where('votes','>',100)
3->orWhere(function(Builder$query) {
4$query->where('name','Abigail')
5->where('votes','>',50);
6        })
7->get();
$users = DB::table('users')    ->where('votes', '>', 100)    ->orWhere(function (Builder $query) {        $query->where('name', 'Abigail')            ->where('votes', '>', 50);        })    ->get();

The example above will produce the following SQL:

1select*from userswhere votes>100or (name='Abigail'and votes>50)
select * from users where votes > 100 or (name = 'Abigail' and votes > 50)

You should always grouporWhere calls in order to avoid unexpected behavior when global scopes are applied.

Where Not Clauses

ThewhereNot andorWhereNot methods may be used to negate a given group of query constraints. For example, the following query excludes products that are on clearance or which have a price that is less than ten:

1$products=DB::table('products')
2->whereNot(function(Builder$query) {
3$query->where('clearance',true)
4->orWhere('price','<',10);
5        })
6->get();
$products = DB::table('products')    ->whereNot(function (Builder $query) {        $query->where('clearance', true)            ->orWhere('price', '<', 10);        })    ->get();

Where Any / All / None Clauses

Sometimes you may need to apply the same query constraints to multiple columns. For example, you may want to retrieve all records where any columns in a given list areLIKE a given value. You may accomplish this using thewhereAny method:

1$users=DB::table('users')
2->where('active',true)
3->whereAny([
4'name',
5'email',
6'phone',
7    ],'like','Example%')
8->get();
$users = DB::table('users')    ->where('active', true)    ->whereAny([        'name',        'email',        'phone',    ], 'like', 'Example%')    ->get();

The query above will result in the following SQL:

1SELECT*
2FROM users
3WHERE active= trueAND (
4nameLIKE'Example%'OR
5    emailLIKE'Example%'OR
6    phoneLIKE'Example%'
7)
SELECT *FROM usersWHERE active = true AND (    name LIKE 'Example%' OR    email LIKE 'Example%' OR    phone LIKE 'Example%')

Similarly, thewhereAll method may be used to retrieve records where all of the given columns match a given constraint:

1$posts=DB::table('posts')
2->where('published',true)
3->whereAll([
4'title',
5'content',
6    ],'like','%Laravel%')
7->get();
$posts = DB::table('posts')    ->where('published', true)    ->whereAll([        'title',        'content',    ], 'like', '%Laravel%')    ->get();

The query above will result in the following SQL:

1SELECT*
2FROM posts
3WHERE published= trueAND (
4    titleLIKE'%Laravel%'AND
5    contentLIKE'%Laravel%'
6)
SELECT *FROM postsWHERE published = true AND (    title LIKE '%Laravel%' AND    content LIKE '%Laravel%')

ThewhereNone method may be used to retrieve records where none of the given columns match a given constraint:

1$posts=DB::table('albums')
2->where('published',true)
3->whereNone([
4'title',
5'lyrics',
6'tags',
7    ],'like','%explicit%')
8->get();
$posts = DB::table('albums')    ->where('published', true)    ->whereNone([        'title',        'lyrics',        'tags',    ], 'like', '%explicit%')    ->get();

The query above will result in the following SQL:

1SELECT*
2FROM albums
3WHERE published= trueANDNOT (
4    titleLIKE'%explicit%'OR
5    lyricsLIKE'%explicit%'OR
6    tagsLIKE'%explicit%'
7)
SELECT *FROM albumsWHERE published = true AND NOT (    title LIKE '%explicit%' OR    lyrics LIKE '%explicit%' OR    tags LIKE '%explicit%')

JSON Where Clauses

Laravel also supports querying JSON column types on databases that provide support for JSON column types. Currently, this includes MariaDB 10.3+, MySQL 8.0+, PostgreSQL 12.0+, SQL Server 2017+, and SQLite 3.39.0+. To query a JSON column, use the-> operator:

1$users=DB::table('users')
2->where('preferences->dining->meal','salad')
3->get();
$users = DB::table('users')    ->where('preferences->dining->meal', 'salad')    ->get();

You may usewhereJsonContains to query JSON arrays:

1$users=DB::table('users')
2->whereJsonContains('options->languages','en')
3->get();
$users = DB::table('users')    ->whereJsonContains('options->languages', 'en')    ->get();

If your application uses the MariaDB, MySQL, or PostgreSQL databases, you may pass an array of values to thewhereJsonContains method:

1$users=DB::table('users')
2->whereJsonContains('options->languages', ['en','de'])
3->get();
$users = DB::table('users')    ->whereJsonContains('options->languages', ['en', 'de'])    ->get();

You may usewhereJsonLength method to query JSON arrays by their length:

1$users=DB::table('users')
2->whereJsonLength('options->languages',0)
3->get();
4 
5$users=DB::table('users')
6->whereJsonLength('options->languages','>',1)
7->get();
$users = DB::table('users')    ->whereJsonLength('options->languages', 0)    ->get();$users = DB::table('users')    ->whereJsonLength('options->languages', '>', 1)    ->get();

Additional Where Clauses

whereLike / orWhereLike / whereNotLike / orWhereNotLike

ThewhereLike method allows you to add "LIKE" clauses to your query for pattern matching. These methods provide a database-agnostic way of performing string matching queries, with the ability to toggle case-sensitivity. By default, string matching is case-insensitive:

1$users=DB::table('users')
2->whereLike('name','%John%')
3->get();
$users = DB::table('users')    ->whereLike('name', '%John%')    ->get();

You can enable a case-sensitive search via thecaseSensitive argument:

1$users=DB::table('users')
2->whereLike('name','%John%', caseSensitive:true)
3->get();
$users = DB::table('users')    ->whereLike('name', '%John%', caseSensitive: true)    ->get();

TheorWhereLike method allows you to add an "or" clause with a LIKE condition:

1$users=DB::table('users')
2->where('votes','>',100)
3->orWhereLike('name','%John%')
4->get();
$users = DB::table('users')    ->where('votes', '>', 100)    ->orWhereLike('name', '%John%')    ->get();

ThewhereNotLike method allows you to add "NOT LIKE" clauses to your query:

1$users=DB::table('users')
2->whereNotLike('name','%John%')
3->get();
$users = DB::table('users')    ->whereNotLike('name', '%John%')    ->get();

Similarly, you can useorWhereNotLike to add an "or" clause with a NOT LIKE condition:

1$users=DB::table('users')
2->where('votes','>',100)
3->orWhereNotLike('name','%John%')
4->get();
$users = DB::table('users')    ->where('votes', '>', 100)    ->orWhereNotLike('name', '%John%')    ->get();

ThewhereLike case-sensitive search option is currently not supported on SQL Server.

whereIn / whereNotIn / orWhereIn / orWhereNotIn

ThewhereIn method verifies that a given column's value is contained within the given array:

1$users=DB::table('users')
2->whereIn('id', [1,2,3])
3->get();
$users = DB::table('users')    ->whereIn('id', [1, 2, 3])    ->get();

ThewhereNotIn method verifies that the given column's value is not contained in the given array:

1$users=DB::table('users')
2->whereNotIn('id', [1,2,3])
3->get();
$users = DB::table('users')    ->whereNotIn('id', [1, 2, 3])    ->get();

You may also provide a query object as thewhereIn method's second argument:

1$activeUsers=DB::table('users')->select('id')->where('is_active',1);
2 
3$users=DB::table('comments')
4->whereIn('user_id',$activeUsers)
5->get();
$activeUsers = DB::table('users')->select('id')->where('is_active', 1);$users = DB::table('comments')    ->whereIn('user_id', $activeUsers)    ->get();

The example above will produce the following SQL:

1select*from commentswhereuser_idin (
2select id
3from users
4where is_active=1
5)
select * from comments where user_id in (    select id    from users    where is_active = 1)

If you are adding a large array of integer bindings to your query, thewhereIntegerInRaw orwhereIntegerNotInRaw methods may be used to greatly reduce your memory usage.

whereBetween / orWhereBetween

ThewhereBetween method verifies that a column's value is between two values:

1$users=DB::table('users')
2->whereBetween('votes', [1,100])
3->get();
$users = DB::table('users')    ->whereBetween('votes', [1, 100])    ->get();

whereNotBetween / orWhereNotBetween

ThewhereNotBetween method verifies that a column's value lies outside of two values:

1$users=DB::table('users')
2->whereNotBetween('votes', [1,100])
3->get();
$users = DB::table('users')    ->whereNotBetween('votes', [1, 100])    ->get();

whereBetweenColumns / whereNotBetweenColumns / orWhereBetweenColumns / orWhereNotBetweenColumns

ThewhereBetweenColumns method verifies that a column's value is between the two values of two columns in the same table row:

1$patients=DB::table('patients')
2->whereBetweenColumns('weight', ['minimum_allowed_weight','maximum_allowed_weight'])
3->get();
$patients = DB::table('patients')    ->whereBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])    ->get();

ThewhereNotBetweenColumns method verifies that a column's value lies outside the two values of two columns in the same table row:

1$patients=DB::table('patients')
2->whereNotBetweenColumns('weight', ['minimum_allowed_weight','maximum_allowed_weight'])
3->get();
$patients = DB::table('patients')    ->whereNotBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])    ->get();

whereNull / whereNotNull / orWhereNull / orWhereNotNull

ThewhereNull method verifies that the value of the given column isNULL:

1$users=DB::table('users')
2->whereNull('updated_at')
3->get();
$users = DB::table('users')    ->whereNull('updated_at')    ->get();

ThewhereNotNull method verifies that the column's value is notNULL:

1$users=DB::table('users')
2->whereNotNull('updated_at')
3->get();
$users = DB::table('users')    ->whereNotNull('updated_at')    ->get();

whereDate / whereMonth / whereDay / whereYear / whereTime

ThewhereDate method may be used to compare a column's value against a date:

1$users=DB::table('users')
2->whereDate('created_at','2016-12-31')
3->get();
$users = DB::table('users')    ->whereDate('created_at', '2016-12-31')    ->get();

ThewhereMonth method may be used to compare a column's value against a specific month:

1$users=DB::table('users')
2->whereMonth('created_at','12')
3->get();
$users = DB::table('users')    ->whereMonth('created_at', '12')    ->get();

ThewhereDay method may be used to compare a column's value against a specific day of the month:

1$users=DB::table('users')
2->whereDay('created_at','31')
3->get();
$users = DB::table('users')    ->whereDay('created_at', '31')    ->get();

ThewhereYear method may be used to compare a column's value against a specific year:

1$users=DB::table('users')
2->whereYear('created_at','2016')
3->get();
$users = DB::table('users')    ->whereYear('created_at', '2016')    ->get();

ThewhereTime method may be used to compare a column's value against a specific time:

1$users=DB::table('users')
2->whereTime('created_at','=','11:20:45')
3->get();
$users = DB::table('users')    ->whereTime('created_at', '=', '11:20:45')    ->get();

wherePast / whereFuture / whereToday / whereBeforeToday / whereAfterToday

ThewherePast andwhereFuture methods may be used to determine if a column's value is in the past or future:

1$invoices=DB::table('invoices')
2->wherePast('due_at')
3->get();
4 
5$invoices=DB::table('invoices')
6->whereFuture('due_at')
7->get();
$invoices = DB::table('invoices')    ->wherePast('due_at')    ->get();$invoices = DB::table('invoices')    ->whereFuture('due_at')    ->get();

ThewhereNowOrPast andwhereNowOrFuture methods may be used to determine if a column's value is in the past or future, inclusive of the current date and time:

1$invoices=DB::table('invoices')
2->whereNowOrPast('due_at')
3->get();
4 
5$invoices=DB::table('invoices')
6->whereNowOrFuture('due_at')
7->get();
$invoices = DB::table('invoices')    ->whereNowOrPast('due_at')    ->get();$invoices = DB::table('invoices')    ->whereNowOrFuture('due_at')    ->get();

ThewhereToday,whereBeforeToday, andwhereAfterToday methods may be used to determine if a column's value is today, before today, or after today, respectively:

 1$invoices=DB::table('invoices')
 2->whereToday('due_at')
 3->get();
 4 
 5$invoices=DB::table('invoices')
 6->whereBeforeToday('due_at')
 7->get();
 8 
 9$invoices=DB::table('invoices')
10->whereAfterToday('due_at')
11->get();
$invoices = DB::table('invoices')    ->whereToday('due_at')    ->get();$invoices = DB::table('invoices')    ->whereBeforeToday('due_at')    ->get();$invoices = DB::table('invoices')    ->whereAfterToday('due_at')    ->get();

Similarly, thewhereTodayOrBefore andwhereTodayOrAfter methods may be used to determine if a column's value is before today or after today, inclusive of today's date:

1$invoices=DB::table('invoices')
2->whereTodayOrBefore('due_at')
3->get();
4 
5$invoices=DB::table('invoices')
6->whereTodayOrAfter('due_at')
7->get();
$invoices = DB::table('invoices')    ->whereTodayOrBefore('due_at')    ->get();$invoices = DB::table('invoices')    ->whereTodayOrAfter('due_at')    ->get();

whereColumn / orWhereColumn

ThewhereColumn method may be used to verify that two columns are equal:

1$users=DB::table('users')
2->whereColumn('first_name','last_name')
3->get();
$users = DB::table('users')    ->whereColumn('first_name', 'last_name')    ->get();

You may also pass a comparison operator to thewhereColumn method:

1$users=DB::table('users')
2->whereColumn('updated_at','>','created_at')
3->get();
$users = DB::table('users')    ->whereColumn('updated_at', '>', 'created_at')    ->get();

You may also pass an array of column comparisons to thewhereColumn method. These conditions will be joined using theand operator:

1$users=DB::table('users')
2->whereColumn([
3        ['first_name','=','last_name'],
4        ['updated_at','>','created_at'],
5    ])->get();
$users = DB::table('users')    ->whereColumn([        ['first_name', '=', 'last_name'],        ['updated_at', '>', 'created_at'],    ])->get();

Logical Grouping

Sometimes you may need to group several "where" clauses within parentheses in order to achieve your query's desired logical grouping. In fact, you should generally always group calls to theorWhere method in parentheses in order to avoid unexpected query behavior. To accomplish this, you may pass a closure to thewhere method:

1$users=DB::table('users')
2->where('name','=','John')
3->where(function(Builder$query) {
4$query->where('votes','>',100)
5->orWhere('title','=','Admin');
6    })
7->get();
$users = DB::table('users')    ->where('name', '=', 'John')    ->where(function (Builder $query) {        $query->where('votes', '>', 100)            ->orWhere('title', '=', 'Admin');    })    ->get();

As you can see, passing a closure into thewhere method instructs the query builder to begin a constraint group. The closure will receive a query builder instance which you can use to set the constraints that should be contained within the parenthesis group. The example above will produce the following SQL:

1select*from userswherename='John'and (votes>100or title='Admin')
select * from users where name = 'John' and (votes > 100 or title = 'Admin')

You should always grouporWhere calls in order to avoid unexpected behavior when global scopes are applied.

Advanced Where Clauses

Where Exists Clauses

ThewhereExists method allows you to write "where exists" SQL clauses. ThewhereExists method accepts a closure which will receive a query builder instance, allowing you to define the query that should be placed inside of the "exists" clause:

1$users=DB::table('users')
2->whereExists(function(Builder$query) {
3$query->select(DB::raw(1))
4->from('orders')
5->whereColumn('orders.user_id','users.id');
6    })
7->get();
$users = DB::table('users')    ->whereExists(function (Builder $query) {        $query->select(DB::raw(1))            ->from('orders')            ->whereColumn('orders.user_id', 'users.id');    })    ->get();

Alternatively, you may provide a query object to thewhereExists method instead of a closure:

1$orders=DB::table('orders')
2->select(DB::raw(1))
3->whereColumn('orders.user_id','users.id');
4 
5$users=DB::table('users')
6->whereExists($orders)
7->get();
$orders = DB::table('orders')    ->select(DB::raw(1))    ->whereColumn('orders.user_id', 'users.id');$users = DB::table('users')    ->whereExists($orders)    ->get();

Both of the examples above will produce the following SQL:

1select*from users
2whereexists (
3select1
4from orders
5whereorders.user_id=users.id
6)
select * from userswhere exists (    select 1    from orders    where orders.user_id = users.id)

Subquery Where Clauses

Sometimes you may need to construct a "where" clause that compares the results of a subquery to a given value. You may accomplish this by passing a closure and a value to thewhere method. For example, the following query will retrieve all users who have a recent "membership" of a given type;

 1use App\Models\User;
 2use Illuminate\Database\Query\Builder;
 3 
 4$users=User::where(function(Builder$query) {
 5$query->select('type')
 6->from('membership')
 7->whereColumn('membership.user_id','users.id')
 8->orderByDesc('membership.start_date')
 9->limit(1);
10},'Pro')->get();
use App\Models\User;use Illuminate\Database\Query\Builder;$users = User::where(function (Builder $query) {    $query->select('type')        ->from('membership')        ->whereColumn('membership.user_id', 'users.id')        ->orderByDesc('membership.start_date')        ->limit(1);}, 'Pro')->get();

Or, you may need to construct a "where" clause that compares a column to the results of a subquery. You may accomplish this by passing a column, operator, and closure to thewhere method. For example, the following query will retrieve all income records where the amount is less than average;

1use App\Models\Income;
2use Illuminate\Database\Query\Builder;
3 
4$incomes=Income::where('amount','<',function(Builder$query) {
5$query->selectRaw('avg(i.amount)')->from('incomes as i');
6})->get();
use App\Models\Income;use Illuminate\Database\Query\Builder;$incomes = Income::where('amount', '<', function (Builder $query) {    $query->selectRaw('avg(i.amount)')->from('incomes as i');})->get();

Full Text Where Clauses

Full text where clauses are currently supported by MariaDB, MySQL, and PostgreSQL.

ThewhereFullText andorWhereFullText methods may be used to add full text "where" clauses to a query for columns that havefull text indexes. These methods will be transformed into the appropriate SQL for the underlying database system by Laravel. For example, aMATCH AGAINST clause will be generated for applications utilizing MariaDB or MySQL:

1$users=DB::table('users')
2->whereFullText('bio','web developer')
3->get();
$users = DB::table('users')    ->whereFullText('bio', 'web developer')    ->get();

Ordering, Grouping, Limit and Offset

Ordering

The`orderBy` Method

TheorderBy method allows you to sort the results of the query by a given column. The first argument accepted by theorderBy method should be the column you wish to sort by, while the second argument determines the direction of the sort and may be eitherasc ordesc:

1$users=DB::table('users')
2->orderBy('name','desc')
3->get();
$users = DB::table('users')    ->orderBy('name', 'desc')    ->get();

To sort by multiple columns, you may simply invokeorderBy as many times as necessary:

1$users=DB::table('users')
2->orderBy('name','desc')
3->orderBy('email','asc')
4->get();
$users = DB::table('users')    ->orderBy('name', 'desc')    ->orderBy('email', 'asc')    ->get();

The`latest` and`oldest` Methods

Thelatest andoldest methods allow you to easily order results by date. By default, the result will be ordered by the table'screated_at column. Or, you may pass the column name that you wish to sort by:

1$user=DB::table('users')
2->latest()
3->first();
$user = DB::table('users')    ->latest()    ->first();

Random Ordering

TheinRandomOrder method may be used to sort the query results randomly. For example, you may use this method to fetch a random user:

1$randomUser=DB::table('users')
2->inRandomOrder()
3->first();
$randomUser = DB::table('users')    ->inRandomOrder()    ->first();

Removing Existing Orderings

Thereorder method removes all of the "order by" clauses that have previously been applied to the query:

1$query=DB::table('users')->orderBy('name');
2 
3$unorderedUsers=$query->reorder()->get();
$query = DB::table('users')->orderBy('name');$unorderedUsers = $query->reorder()->get();

You may pass a column and direction when calling thereorder method in order to remove all existing "order by" clauses and apply an entirely new order to the query:

1$query=DB::table('users')->orderBy('name');
2 
3$usersOrderedByEmail=$query->reorder('email','desc')->get();
$query = DB::table('users')->orderBy('name');$usersOrderedByEmail = $query->reorder('email', 'desc')->get();

Grouping

The`groupBy` and`having` Methods

As you might expect, thegroupBy andhaving methods may be used to group the query results. Thehaving method's signature is similar to that of thewhere method:

1$users=DB::table('users')
2->groupBy('account_id')
3->having('account_id','>',100)
4->get();
$users = DB::table('users')    ->groupBy('account_id')    ->having('account_id', '>', 100)    ->get();

You can use thehavingBetween method to filter the results within a given range:

1$report=DB::table('orders')
2->selectRaw('count(id) as number_of_orders, customer_id')
3->groupBy('customer_id')
4->havingBetween('number_of_orders', [5,15])
5->get();
$report = DB::table('orders')    ->selectRaw('count(id) as number_of_orders, customer_id')    ->groupBy('customer_id')    ->havingBetween('number_of_orders', [5, 15])    ->get();

You may pass multiple arguments to thegroupBy method to group by multiple columns:

1$users=DB::table('users')
2->groupBy('first_name','status')
3->having('account_id','>',100)
4->get();
$users = DB::table('users')    ->groupBy('first_name', 'status')    ->having('account_id', '>', 100)    ->get();

To build more advancedhaving statements, see thehavingRaw method.

Limit and Offset

The`skip` and`take` Methods

You may use theskip andtake methods to limit the number of results returned from the query or to skip a given number of results in the query:

1$users=DB::table('users')->skip(10)->take(5)->get();
$users = DB::table('users')->skip(10)->take(5)->get();

Alternatively, you may use thelimit andoffset methods. These methods are functionally equivalent to thetake andskip methods, respectively:

1$users=DB::table('users')
2->offset(10)
3->limit(5)
4->get();
$users = DB::table('users')    ->offset(10)    ->limit(5)    ->get();

Conditional Clauses

Sometimes you may want certain query clauses to apply to a query based on another condition. For instance, you may only want to apply awhere statement if a given input value is present on the incoming HTTP request. You may accomplish this using thewhen method:

1$role=$request->input('role');
2 
3$users=DB::table('users')
4->when($role,function(Builder$query,string$role) {
5$query->where('role_id',$role);
6    })
7->get();
$role = $request->input('role');$users = DB::table('users')    ->when($role, function (Builder $query, string $role) {        $query->where('role_id', $role);    })    ->get();

Thewhen method only executes the given closure when the first argument istrue. If the first argument isfalse, the closure will not be executed. So, in the example above, the closure given to thewhen method will only be invoked if therole field is present on the incoming request and evaluates totrue.

You may pass another closure as the third argument to thewhen method. This closure will only execute if the first argument evaluates asfalse. To illustrate how this feature may be used, we will use it to configure the default ordering of a query:

1$sortByVotes=$request->boolean('sort_by_votes');
2 
3$users=DB::table('users')
4->when($sortByVotes,function(Builder$query,bool$sortByVotes) {
5$query->orderBy('votes');
6    },function(Builder$query) {
7$query->orderBy('name');
8    })
9->get();
$sortByVotes = $request->boolean('sort_by_votes');$users = DB::table('users')    ->when($sortByVotes, function (Builder $query, bool $sortByVotes) {        $query->orderBy('votes');    }, function (Builder $query) {        $query->orderBy('name');    })    ->get();

Insert Statements

The query builder also provides aninsert method that may be used to insert records into the database table. Theinsert method accepts an array of column names and values:

1DB::table('users')->insert([
2'email'=>'[email protected]',
3'votes'=>0
4]);
DB::table('users')->insert([    'email' => '[email protected]',    'votes' => 0]);

You may insert several records at once by passing an array of arrays. Each array represents a record that should be inserted into the table:

1DB::table('users')->insert([
2    ['email'=>'[email protected]','votes'=>0],
3    ['email'=>'[email protected]','votes'=>0],
4]);
DB::table('users')->insert([    ['email' => '[email protected]', 'votes' => 0],    ['email' => '[email protected]', 'votes' => 0],]);

TheinsertOrIgnore method will ignore errors while inserting records into the database. When using this method, you should be aware that duplicate record errors will be ignored and other types of errors may also be ignored depending on the database engine. For example,insertOrIgnore willbypass MySQL's strict mode:

1DB::table('users')->insertOrIgnore([
2    ['id'=>1,'email'=>'[email protected]'],
3    ['id'=>2,'email'=>'[email protected]'],
4]);
DB::table('users')->insertOrIgnore([    ['id' => 1, 'email' => '[email protected]'],    ['id' => 2, 'email' => '[email protected]'],]);

TheinsertUsing method will insert new records into the table while using a subquery to determine the data that should be inserted:

1DB::table('pruned_users')->insertUsing([
2'id','name','email','email_verified_at'
3],DB::table('users')->select(
4'id','name','email','email_verified_at'
5)->where('updated_at','<=',now()->subMonth()));
DB::table('pruned_users')->insertUsing([    'id', 'name', 'email', 'email_verified_at'], DB::table('users')->select(    'id', 'name', 'email', 'email_verified_at')->where('updated_at', '<=', now()->subMonth()));

Auto-Incrementing IDs

If the table has an auto-incrementing id, use theinsertGetId method to insert a record and then retrieve the ID:

1$id=DB::table('users')->insertGetId(
2    ['email'=>'[email protected]','votes'=>0]
3);
$id = DB::table('users')->insertGetId(    ['email' => '[email protected]', 'votes' => 0]);

When using PostgreSQL theinsertGetId method expects the auto-incrementing column to be namedid. If you would like to retrieve the ID from a different "sequence", you may pass the column name as the second parameter to theinsertGetId method.

Upserts

Theupsert method will insert records that do not exist and update the records that already exist with new values that you may specify. The method's first argument consists of the values to insert or update, while the second argument lists the column(s) that uniquely identify records within the associated table. The method's third and final argument is an array of columns that should be updated if a matching record already exists in the database:

1DB::table('flights')->upsert(
2    [
3        ['departure'=>'Oakland','destination'=>'San Diego','price'=>99],
4        ['departure'=>'Chicago','destination'=>'New York','price'=>150]
5    ],
6    ['departure','destination'],
7    ['price']
8);
DB::table('flights')->upsert(    [        ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],        ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]    ],    ['departure', 'destination'],    ['price']);

In the example above, Laravel will attempt to insert two records. If a record already exists with the samedeparture anddestination column values, Laravel will update that record'sprice column.

All databases except SQL Server require the columns in the second argument of theupsert method to have a "primary" or "unique" index. In addition, the MariaDB and MySQL database drivers ignore the second argument of theupsert method and always use the "primary" and "unique" indexes of the table to detect existing records.

Update Statements

In addition to inserting records into the database, the query builder can also update existing records using theupdate method. Theupdate method, like theinsert method, accepts an array of column and value pairs indicating the columns to be updated. Theupdate method returns the number of affected rows. You may constrain theupdate query usingwhere clauses:

1$affected=DB::table('users')
2->where('id',1)
3->update(['votes'=>1]);
$affected = DB::table('users')    ->where('id', 1)    ->update(['votes' => 1]);

Update or Insert

Sometimes you may want to update an existing record in the database or create it if no matching record exists. In this scenario, theupdateOrInsert method may be used. TheupdateOrInsert method accepts two arguments: an array of conditions by which to find the record, and an array of column and value pairs indicating the columns to be updated.

TheupdateOrInsert method will attempt to locate a matching database record using the first argument's column and value pairs. If the record exists, it will be updated with the values in the second argument. If the record cannot be found, a new record will be inserted with the merged attributes of both arguments:

1DB::table('users')
2->updateOrInsert(
3        ['email'=>'[email protected]','name'=>'John'],
4        ['votes'=>'2']
5    );
DB::table('users')    ->updateOrInsert(        ['email' => '[email protected]', 'name' => 'John'],        ['votes' => '2']    );

You may provide a closure to theupdateOrInsert method to customize the attributes that are updated or inserted into the database based on the existence of a matching record:

 1DB::table('users')->updateOrInsert(
 2    ['user_id'=>$user_id],
 3fn($exists) =>$exists? [
 4'name'=>$data['name'],
 5'email'=>$data['email'],
 6    ]: [
 7'name'=>$data['name'],
 8'email'=>$data['email'],
 9'marketable'=>true,
10    ],
11);
DB::table('users')->updateOrInsert(    ['user_id' => $user_id],    fn ($exists) => $exists ? [        'name' => $data['name'],        'email' => $data['email'],    ] : [        'name' => $data['name'],        'email' => $data['email'],        'marketable' => true,    ],);

Updating JSON Columns

When updating a JSON column, you should use-> syntax to update the appropriate key in the JSON object. This operation is supported on MariaDB 10.3+, MySQL 5.7+, and PostgreSQL 9.5+:

1$affected=DB::table('users')
2->where('id',1)
3->update(['options->enabled'=>true]);
$affected = DB::table('users')    ->where('id', 1)    ->update(['options->enabled' => true]);

Increment and Decrement

The query builder also provides convenient methods for incrementing or decrementing the value of a given column. Both of these methods accept at least one argument: the column to modify. A second argument may be provided to specify the amount by which the column should be incremented or decremented:

1DB::table('users')->increment('votes');
2 
3DB::table('users')->increment('votes',5);
4 
5DB::table('users')->decrement('votes');
6 
7DB::table('users')->decrement('votes',5);
DB::table('users')->increment('votes');DB::table('users')->increment('votes', 5);DB::table('users')->decrement('votes');DB::table('users')->decrement('votes', 5);

If needed, you may also specify additional columns to update during the increment or decrement operation:

1DB::table('users')->increment('votes',1, ['name'=>'John']);
DB::table('users')->increment('votes', 1, ['name' => 'John']);

In addition, you may increment or decrement multiple columns at once using theincrementEach anddecrementEach methods:

1DB::table('users')->incrementEach([
2'votes'=>5,
3'balance'=>100,
4]);
DB::table('users')->incrementEach([    'votes' => 5,    'balance' => 100,]);

Delete Statements

The query builder'sdelete method may be used to delete records from the table. Thedelete method returns the number of affected rows. You may constraindelete statements by adding "where" clauses before calling thedelete method:

1$deleted=DB::table('users')->delete();
2 
3$deleted=DB::table('users')->where('votes','>',100)->delete();
$deleted = DB::table('users')->delete();$deleted = DB::table('users')->where('votes', '>', 100)->delete();

Pessimistic Locking

The query builder also includes a few functions to help you achieve "pessimistic locking" when executing yourselect statements. To execute a statement with a "shared lock", you may call thesharedLock method. A shared lock prevents the selected rows from being modified until your transaction is committed:

1DB::table('users')
2->where('votes','>',100)
3->sharedLock()
4->get();
DB::table('users')    ->where('votes', '>', 100)    ->sharedLock()    ->get();

Alternatively, you may use thelockForUpdate method. A "for update" lock prevents the selected records from being modified or from being selected with another shared lock:

1DB::table('users')
2->where('votes','>',100)
3->lockForUpdate()
4->get();
DB::table('users')    ->where('votes', '>', 100)    ->lockForUpdate()    ->get();

While not obligatory, it is recommended to wrap pessimistic locks within atransaction. This ensures that the data retrieved remains unaltered in the database until the entire operation completes. In case of a failure, the transaction will roll back any changes and release the locks automatically:

 1DB::transaction(function() {
 2$sender=DB::table('users')
 3->lockForUpdate()
 4->find(1);
 5 
 6$receiver=DB::table('users')
 7->lockForUpdate();
 8->find(2);
 9 
10if ($sender->balance<100) {
11thrownewRuntimeException('Balance too low.');
12    }
13 
14DB::table('users')
15->where('id',$sender->id)
16->update([
17'balance'=>$sender->balance-100
18        ]);
19 
20DB::table('users')
21->where('id',$receiver->id)
22->update([
23'balance'=>$receiver->balance+100
24        ]);
25});
DB::transaction(function () {    $sender = DB::table('users')        ->lockForUpdate()        ->find(1);    $receiver = DB::table('users')        ->lockForUpdate();        ->find(2);    if ($sender->balance < 100) {        throw new RuntimeException('Balance too low.');    }    DB::table('users')        ->where('id', $sender->id)        ->update([            'balance' => $sender->balance - 100        ]);    DB::table('users')        ->where('id', $receiver->id)        ->update([            'balance' => $receiver->balance + 100        ]);});

Debugging

You may use thedd anddump methods while building a query to dump the current query bindings and SQL. Thedd method will display the debug information and then stop executing the request. Thedump method will display the debug information but allow the request to continue executing:

1DB::table('users')->where('votes','>',100)->dd();
2 
3DB::table('users')->where('votes','>',100)->dump();
DB::table('users')->where('votes', '>', 100)->dd();DB::table('users')->where('votes', '>', 100)->dump();

ThedumpRawSql andddRawSql methods may be invoked on a query to dump the query's SQL with all parameter bindings properly substituted:

1DB::table('users')->where('votes','>',100)->dumpRawSql();
2 
3DB::table('users')->where('votes','>',100)->ddRawSql();
DB::table('users')->where('votes', '>', 100)->dumpRawSql();DB::table('users')->where('votes', '>', 100)->ddRawSql();

Movatterモバイル変換

Prologue

Getting Started

Architecture Concepts

The Basics

Digging Deeper

Security

Database

Eloquent ORM

Testing

Packages

Database: Query Builder

On this page

Products

Packages

Resources

Partners