# FluentCRM Query Builder

# Introduction

Fluent'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.

TIP

Our Query Builder is compatible the PHP Laravel Framework's Query Builder. If you are familiar with Laravel's Query Builder, you will feel right at home using the FluentCRM's Query Builder.

# Example

Here is an example Fluent Query Builder

$query = fluentCrmDb()->table('fc_contact_relation_items')
            ->select(['item_value', 'status', 'item_type'])
            ->where('provider', 'woo')
            ->whereBetween('created_at', ['2022-12-05 00:00:00', '2022-12-30 23:59:59'])
            ->when($productId, function ($query) use ($productId) {
                return $query->where('item_id', $productId);
            })
            ->orderBy('date', 'ASC');

1
2
3
4
5
6
7
8

# Retrieving Results

# Retrieving All Rows From A Table

You may use the table method on the fluentCrmDb function to begin a query. The table method returns a fluent query builder instance for the given table, allowing you to chain more constraints onto the query and then finally get the results using the get method:

<?php
 
namespace FluentCrm\App\Http\Controllers;
 
class UserController extends Controller
{
    /**
     * Show a list of all the application's subscribers.
     *
     * @return Response
     */
    public function index()
    {
        $subscribers = fluentCrmDb()->table('fc_subscribers')->get();
 
        return [
            'subscribers' => $subscribers
        ];   
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

The get method returns an array containing the results where each result is an instance of the PHP stdClass object. You may access each column's value by accessing the column as a property of the object:

foreach ($subscribers as $subscriber) {
    echo $subscriber->first_name;
}

1
2
3

# Retrieving A Single Row / Column From A Table

If you just need to retrieve a single row from the database table, you may use the first method. This method will return a single stdClass object:

$subscriber = fluentCrmDb()->table('fc_subscribers')->where('first_name', 'John')->first();
 
echo $subscriber->first_name;

1
2
3

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

$email = fluentCrmDb()->table('fc_subscribers')->where('first_name', 'John')->value('email');

# Retrieving A List Of Column Values

If you would like to retrieve an array containing the values of a single column, you may use the pluck method. In this example, we'll retrieve an array of email:

$emails = fluentCrmDb()->table('fc_subscribers')->pluck('email');
 
foreach ($emails as $email) {
    echo $email;
}

1
2
3
4
5

You may also specify a custom key column for the returned Collection:

$emails = fluentCrmDb()->table('fc_subscribers')->pluck('email', 'id');
 
foreach ($emails as $id => $email) {
    echo $email;
}

1
2
3
4
5

# Chunking Results

If you need to work with thousands of database records, consider using the chunk method. This method retrieves a small chunk of the results at a time and feeds each chunk into a Closure for processing. This method is very useful for process thousands of records. For example, let's work with the entire fc_subscribers table in chunks of 100 records at a time:

fluentCrmDb()->table('fc_subscribers')->orderBy('id')->chunk(100, function ($subscribers) {
    foreach ($subscribers as $subscriber) {
        //
    }
});

1
2
3
4
5

You may stop further chunks from being processed by returning false from the Closure:

fluentCrmDb()->table('fc_subscribers')->orderBy('id')->chunk(100, function ($subscribers) {
    // Process the records...
    
    return false;
});

1
2
3
4
5

# Aggregates

The query builder also provides a variety of aggregate methods such as count, max, min, avg, and sum. You may call any of these methods after constructing your query:

$subscribers = fluentCrmDb()->table('fc_subscribers')->count();
 
$price = fluentCrmDb()->table('fc_contact_relations')->max('total_order_value');

1
2
3

Of course, you may combine these methods with other clauses:

$price = fluentCrmDb()->table('fc_contact_relations')
                ->where('provider', 'woo')
                ->avg('total_order_value');

1
2
3

# Determining If Records Exist

Instead of using the count method to determine if any records exist that match your query's constraints, you may use the exists:

return fluentCrmDb()->table('fc_contact_relations')->where('provider', 'woo')->exists();

# Selects

# Specifying A Select Clause

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

$subscribers = fluentCrmDb()->table('fc_subscribers')->select('first_name', 'email as user_email')->get();

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

$subscribers = fluentCrmDb()->table('fc_subscribers')->distinct()->get();

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

$query = fluentCrmDb()->table('fc_subscribers')->select('first_name');
 
$subscribers = $query->addSelect('email')->get();

1
2
3

# Raw Expressions

Sometimes you may need to use a raw expression in a query. To create a raw expression, you may use the raw method:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                     ->select(fluentCrmDb()->raw('count(*) as user_count, status'))
                     ->where('status', '<>', 1)
                     ->groupBy('status')
                     ->get();

1
2
3
4
5

# Raw Methods

Instead of using fluentCrmDb()->raw, you may also use the following methods to insert a raw expression into various parts of your query.

# `selectRaw`

The selectRaw method can be used in place of select(fluentCrmDb()->raw(...)). This method accepts an optional array of bindings as its second argument:

$orders = fluentCrmDb()->table('fc_contact_relations')
                ->selectRaw('total_order_value * ? as price_with_tax', [1.0825])
                ->get();

1
2
3

# `whereRaw / orWhereRaw`

The whereRaw and orWhereRaw 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:

$orders = fluentCrmDb()->table('fc_contact_relations')
                ->whereRaw('total_order_value > IF(state = "TX", ?, 100)', [200])
                ->get();

1
2
3

# `havingRaw / orHavingRaw`

The havingRaw and orHavingRaw methods may be used to set a raw string as the value of the having clause. These methods accept an optional array of bindings as their second argument:

$orders = fluentCrmDb()->table('fc_contact_relations')
                ->select('provider', DB::raw('SUM(total_order_value) as total_sales'))
                ->groupBy('provider')
                ->havingRaw('SUM(total_order_value) > ?', [2500])
                ->get();

1
2
3
4
5

# `orderByRaw`

The orderByRaw method may be used to set a raw string as the value of the order by clause:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->orderByRaw('updated_at - created_at DESC')
                ->get();

1
2
3

# Joins

# Inner Join Clause

The query builder may also be used to write join statements. To perform a basic "inner join", you may use the join method on a query builder instance. The first argument passed to the join method is the name of the table you need to join to, while the remaining arguments specify the column constraints for the join. Of course, as you can see, you can join to multiple tables in a single query:

$subscribers = fluentCrmDb()->table('fc_subscribers')
            ->join('users', 'users.id', '=', 'fc_subscribers.user_id')
            ->select('fc_subscribers.*', 'users.phone')
            ->get();

1
2
3
4

# left Join Clause

If you would like to perform a "left join" instead of an "inner join", use the leftJoin method. The leftJoin method has the same signature as the join method:

$subscribers = fluentCrmDb()->table('fc_subscribers')
            ->leftJoin('users', 'users.id', '=', 'fc_subscribers.user_id')
            ->get();

1
2
3

# Cross Join Clause

To perform a "cross join" use the crossJoin method with the name of the table you wish to cross join to. Cross joins generate a cartesian product between the first table and the joined table:

$subscribers = fluentCrmDb()->table('fc_subscribers')
            ->crossJoin('users')
            ->get();

1
2
3

# Advanced Join Clauses

You may also specify more advanced join clauses. To get started, pass a Closure as the second argument into the join method. The Closure will receive a JoinClause object which allows you to specify constraints on the join clause:

fluentCrmDb()->table('fc_subscribers')
        ->join('users', function ($join) {
            $join->on('fc_subscribers.user_id', '=', 'users.id')->orOn(...);
        })
        ->get();

1
2
3
4
5

If you would like to use a "where" style clause on your joins, you may use the where and orWhere methods on a join. Instead of comparing two columns, these methods will compare the column against a value:

fluentCrmDb()->table('fc_subscribers')
        ->join('users', function ($join) {
            $join->on('fc_subscribers.user_id', '=', 'users.id')
                 ->where('users.id', '>', 5);
        })
        ->get();

1
2
3
4
5
6

# Unions

The query builder also provides a quick way to "union" two queries together. For example, you may create an initial query and use the union method to union it with a second query:

$first = fluentCrmDb()->table('fc_subscribers')
            ->whereNull('first_name');
 
$subscribers = fluentCrmDb()->table('fc_subscribers')
            ->whereNull('last_name')
            ->union($first)
            ->get();

1
2
3
4
5
6
7

# Where Clauses

# Simple Where Clauses

You may use the where method on a query builder instance to add where clauses to the query. The most basic call to where 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. Finally, the third argument is the value to evaluate against the column. For example, here is a query that verifies the value of the "first_name" column is equal to 'John Smith':

$subscribers = fluentCrmDb()->table('fc_subscribers')->where('first_name', '=', 'John Smith')->get();

For convenience, if you want to verify that a column is equal to a given value, you may pass the value directly as the second argument to the where method:

$subscribers = fluentCrmDb()->table('fc_subscribers')->where('first_name', 'John Smith')->get();

Of course, you may use a variety of other operators when writing a where clause:

$orders = fluentCrmDb()->table('fc_contact_relations')
                ->where('total_order_count', '>=', 10)
                ->get();
 
$orders = fluentCrmDb()->table('fc_contact_relations')
                ->where('total_order_count', '<>', 10)
                ->get();
 
$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->where('first_name', 'like', 'T%')
                ->get();

1
2
3
4
5
6
7
8
9
10
11

You may also pass an array of conditions to the where function:

$subscribers = fluentCrmDb()->table('fc_subscribers')->where([
    ['status', '=', '1'],
    ['subscribed', '<>', '1'],
])->get();

1
2
3
4

# Or Statements

You may chain where constraints together as well as add or clauses to the query. The orWhere method accepts the same arguments as the where method:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                    ->where('email', 'like', 'john%')
                    ->orWhere('first_name', 'John')
                    ->get();

1
2
3
4

# Additional Where Clauses

# whereBetween

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

$orders = fluentCrmDb()->table('fc_contact_relations')
             ->whereBetween('total_order_count', [1, 100])->get();

1
2

# whereNotBetween

The whereNotBetween method verifies that a column's value lies outside two values:

$orders = fluentCrmDb()->table('fc_contact_relations')
             ->whereNotBetween('total_order_count', [1, 100])->get();

1
2

# whereIn / whereNotIn

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                    ->whereIn('id', [1, 2, 3])
                    ->get();

1
2
3

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                    ->whereNotIn('id', [1, 2, 3])
                    ->get();

1
2
3

# whereNull / whereNotNull

The whereNull method verifies that the value of the given column is NULL:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                    ->whereNull('updated_at')
                    ->get();

1
2
3

The whereNotNull method verifies that the column's value is not NULL:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                    ->whereNotNull('updated_at')
                    ->get();

1
2
3

# whereDate / whereMonth / whereDay / whereYear / whereTime

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->whereDate('created_at', '2016-12-31')
                ->get();

1
2
3

The whereMonth method may be used to compare a column's value against a specific month of a year:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->whereMonth('created_at', '12')
                ->get();

1
2
3

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->whereDay('created_at', '21')
                ->get();

1
2
3

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->whereYear('created_at', '2022')
                ->get();

1
2
3

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->whereTime('created_at', '11:20:45')
                ->get();

1
2
3

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->whereTimestamp('created_at', '2022-11-21 11:20:45')
                ->get();

1
2
3

# whereColumn

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                 ->whereColumn('first_name', 'last_name')
                ->get();

1
2
3

You may also pass a comparison operator to the method:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                 ->whereColumn('updated_at', '>', 'created_at')
                ->get();

1
2
3

The whereColumn method can also be passed an array of multiple conditions. These conditions will be joined using the and operator:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                 ->whereColumn([
                    ['first_name', '=', 'last_name'],
                    ['updated_at', '>', 'created_at']
                ])->get();

1
2
3
4
5

# Where Exists Clauses

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

fluentCrmDb()->table('fc_subscribers')
            ->whereExists(function ($query) {
                $query->select(fluentCrmDb()->raw(1))
                      ->from('fc_contact_relations')
                      ->whereRaw('fc_contact_relations.subscriber_id = fc_subscribers.id');
            })
            ->get();

1
2
3
4
5
6
7

The query above will produce the following SQL:

select * from fc_subscribers
where exists (
    select 1 from fc_contact_relations where fc_contact_relations.subscriber_id = fc_subscribers.id
)

1
2
3
4

# Ordering, Grouping, Limit, & Offset

# orderBy

The orderBy method allows you to sort the result of the query by a given column. The first argument to the orderBy method should be the column you wish to sort by, while the second argument controls the direction of the sort and may be either asc or desc:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                 ->orderBy('created_at', 'DESC')
                ->get();

1
2
3

# latest / oldest

The latest and oldest methods allow you to easily order results by date. By default, result will be ordered by the created_at column. Or, you may pass the column name that you wish to sort by:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                 ->latest()
                ->get();

1
2
3

# inRandomOrder

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

$subscribers = fluentCrmDb()->table('fc_subscribers')
                 ->inRandomOrder()
                ->get();

1
2
3

# groupBy / having

The groupBy and having methods may be used to group the query results. The having method's signature is similar to that of the where method:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->groupBy('id')
                ->having('id', '>', 100)
                ->get();

1
2
3
4

You may pass multiple arguments to the groupBy method to group by multiple columns:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->groupBy('id', 'status')
                ->having('id', '>', 100)
                ->get();

1
2
3
4

# skip / take

To limit the number of results returned from the query, or to skip a given number of results in the query, you may use the skip and take methods:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->skip(10)
                ->take(5)
                ->get();

1
2
3
4

Alternatively, you may use the limit and offset methods:

$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->limit(10)
                ->offset(5)
                ->get();

1
2
3
4

# Conditional Clauses

Sometimes you may want clauses to apply to a query only when something else is true. For instance, you may only want to apply a where statement if a given input value is present on the incoming request. You may accomplish this using when method:

$user = $request->get('user');
 
$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->when($user, function ($query, $user) {
                    return $query->where('user_id', $user);
                })
                ->get();

1
2
3
4
5
6
7

The when method only executes the given Closure when the first parameter is true. If the first parameter is false, the Closure will not be executed.

You may pass another Closure as the third parameter to the when method. This Closure will execute if the first parameter evaluates as false. To illustrate how this feature may be used, we will use it to configure the default sorting of a query:

$sortBy = null;
 
$subscribers = fluentCrmDb()->table('fc_subscribers')
                ->when($sortBy, function ($query, $sortBy) {
                    return $query->orderBy($sortBy);
                }, function ($query) {
                    return $query->orderBy('first_name');
                })
                ->get();

1
2
3
4
5
6
7
8
9

# Inserts

The query builder also provides an insert method for inserting records into the database table. The insert method accepts an array of column names and values:

fluentCrmDb()->table('fc_tags')->insert(
    ['title' => 'Tag 1', 'description' => 'This is tag 1']
);

1
2
3

You may even insert several records into the table with a single call to insert by passing an array of arrays. Each array represents a row to be inserted into the table:

fluentCrmDb()->table('fc_tags')->insert([
    ['title' => 'Tag 1', 'description' => 'This is tag 1'],
    ['title' => 'Tag 2', 'description' => 'This is tag 2']
]);

1
2
3
4

# Auto-Incrementing IDs

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

fluentCrmDb()->table('fc_tags')->insertGetId(
    ['title' => 'Tag 1', 'description' => 'This is tag 1']
);

1
2
3

# Updates

Of course, in addition to inserting records into the database, the query builder can also update existing records using the update method. The update method, like the insert method, accepts an array of column and value pairs containing the columns to be updated. You may constrain the update query using where clauses:

fluentCrmDb()->table('fc_tags')
            ->where('id', 1)
            ->update(['title' => 'Tag no. 1']);

1
2
3

# Increment & Decrement

The query builder also provides convenient methods for incrementing or decrementing the value of a given column. This is a shortcut, providing a more expressive and terse interface compared to manually writing the update statement.

Both of these methods accept at least one argument: the column to modify. A second argument may optionally be passed to control the amount by which the column should be incremented or decremented:

fluentCrmDb()->table('fc_contact_relations')->increment('total_order_count');
 
fluentCrmDb()->table('fc_contact_relations')->increment('total_order_count', 5);
 
fluentCrmDb()->table('fc_contact_relations')->decrement('total_order_count');
 
fluentCrmDb()->table('fc_contact_relations')->decrement('total_order_count', 5);

1
2
3
4
5
6
7

You may also specify additional columns to update during the operation:

fluentCrmDb()->table('fc_contact_relations')->increment('total_order_count', 1, ['total_order_value' => '99.99']);

# Deletes

The query builder may also be used to delete records from the table via the delete method. You may constrain delete statements by adding where clauses before calling the delete method:

fluentCrmDb()->table('fc_contact_relations')->delete();
 
fluentCrmDb()->table('fc_contact_relations')->where('total_order_count', '>', 100)->delete();

1
2
3

If you wish to truncate the entire table, which will remove all rows and reset the auto-incrementing ID to zero, you may use the truncate method:

fluentCrmDb()->table('fc_contact_relations')->truncate();

# Pessimistic Locking

The query builder also includes a few functions to help you do "pessimistic locking" on your select statements. To run the statement with a "shared lock", you may use the sharedLock method on a query. A shared lock prevents the selected rows from being modified until your transaction commits:

fluentCrmDb()->table('fc_contact_relations')->where('total_order_count', '>', 100)->sharedLock()->get();

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

fluentCrmDb()->table('fc_contact_relations')->where('total_order_count', '>', 100)->lockForUpdate()->get();

← Model Basic Campaign Model →

# FluentCRM Query Builder

# Introduction

# Example

# Retrieving Results

# Retrieving All Rows From A Table

# Retrieving A Single Row / Column From A Table

# Retrieving A List Of Column Values

# Chunking Results

# Aggregates

# Determining If Records Exist

# Selects

# Specifying A Select Clause

# Raw Expressions

# Raw Methods

# selectRaw

# whereRaw / orWhereRaw

# havingRaw / orHavingRaw

# orderByRaw

# Joins

# Inner Join Clause

# left Join Clause

# Cross Join Clause

# Advanced Join Clauses

# Unions

# Where Clauses

# Simple Where Clauses

# Or Statements

# Additional Where Clauses

# whereBetween

# whereNotBetween

# whereIn / whereNotIn

# whereNull / whereNotNull

# whereDate / whereMonth / whereDay / whereYear / whereTime

# whereColumn

# Where Exists Clauses

# Ordering, Grouping, Limit, & Offset

# orderBy

# latest / oldest

# inRandomOrder

# groupBy / having

# skip / take

# Conditional Clauses

# Inserts

# Auto-Incrementing IDs

# Updates

# Increment & Decrement

# Deletes

# Pessimistic Locking

# `selectRaw`

# `whereRaw / orWhereRaw`

# `havingRaw / orHavingRaw`

# `orderByRaw`