Read Operations

On this page

Overview

In this guide, you can see code templates of common methods that you can use to read data from MongoDB by using Laravel MongoDB.

To learn more about any of the methods included in this guide, see the links provided in each section.

The following code shows how to retrieve the first matching document from a collection:

SampleModel::where('<field name>', '<value>')
    ->first();

To view a runnable example that finds one document, see the Find a Document usage example.

To learn more about retrieving documents and the first() method, see the Retrieve Data guide.

The following code shows how to retrieve all documents that match a query filter from a collection:

SampleModel::where('<field name>', '<value>')
    ->get();

To view a runnable example that finds documents, see the Find Multiple Documents usage example.

To learn more about retrieving documents, see the Retrieve Data guide.

The following code shows how to retrieve all documents from a collection:

SampleModel::get();
// Or, use the all() method.
SampleModel::all();

To view a runnable example that finds documents, see the Find Multiple Documents usage example.

To learn more about retrieving documents, see the Retrieve Data guide.

The following code shows how to perform a full-text search on a string field in a collection's documents:

SampleModel::where('$text', ['$search' => '<search term or phrase>'])
    ->get();

To learn more about searching on text fields, see the Search Text guide.

The following code shows how to count documents in a collection:

SampleModel::count();
// You can also count documents that match a filter.
SampleModel::where('<field name>', '<value>')
    ->count();

To view a runnable example that counts documents, see the Count Documents usage example.

The following code shows how to retrieve the distinct values of a specified field:

SampleModel::select('<field name>')
    ->distinct()
    ->get();

To view a runnable example that returns distinct field values, see the Retrieve Distinct Field Values usage example.

The following code shows how to skip a specified number of documents returned from MongoDB:

SampleModel::where('<field name>', '<value>')
    ->skip(<number to skip>)
    ->get();

To learn more about modifying how Laravel MongoDB returns results, see the Modify Query Results guide.

The following code shows how to return only a specified number of documents from MongoDB:

SampleModel::where('<field name>', '<value>')
    ->take(<number to return>)
    ->get();

To learn more about modifying how Laravel MongoDB returns results, see the Modify Query Results guide.

The following code shows how to set a sort order on results returned from MongoDB:

SampleModel::where('field name', '<value>')
    ->orderBy('<field to sort on>')
    ->get();

To learn more about modifying how Laravel MongoDB returns results, see the Modify Query Results guide.

The following code shows how to set a read preference when performing a find operation:

SampleModel::where('field name', '<value>')
    ->readPreference(ReadPreference::SECONDARY_PREFERRED)
    ->get();

To learn more about read preferences, see the Set a Read Preference guide.

Back

Configure TLS

Retrieve Data