Finding Documents

Last updated on

One of the important tasks is retrieving documents from a collection. MongoDB help us to make this process, but understanding how to use PHP to query your database is important. Below, we will explain everything you need to know about finding documents in MongoDB using PHP, with a strong focus on code and detailed explanations.

Before you get started, you need to establish a connection to your MongoDB server. Here is the basic setup.

Finding Documents with find()

The find() method retrieves multiple documents based on a query filter. Here is an example:

$filter = ['status' => 'active'];
$options = [
    'projection' => ['_id' => 0, 'name' => 1, 'email' => 1],
    'sort' => ['name' => 1]
];

$documents = $collection->find($filter, $options);

foreach ($documents as $document) {
    print_r($document);
}
  • $filter: Specifies the criteria for selecting documents. In this case, it retrieves documents where the status field is active.
  • $options: Allows customization of the query. Here:'projection': Limits the fields returned, excluding _id and including name and email.'sort': Orders the results by name in ascending order.
  • 'projection': Limits the fields returned, excluding _id and including name and email.
  • 'sort': Orders the results by name in ascending order.
  • $collection->find(): Executes the query.
  • The foreach loop iterates through the results and prints each document.

In the following section, you will learn how to get only one document from database using MongoDB in PHP.

Finding a Single Document with findOne()

If you only need one document, use findOne():

$filter = ['email' => 'example@example.com'];

document = $collection->findOne($filter);
print_r($document);
  • This retrieves the first document where the email matches the given value.
  • Unlike find(), findOne() does not require a loop since it returns a single document.

Comparison Operators

MongoDB supports advanced queries with operators like $gt (greater than), $lt (less than), $in, etc. Here is an example:

$filter = [
    'age' => ['$gt' => 18],
    'status' => ['$in' => ['active', 'pending']]
];

$options = ['sort' => ['age' => -1]];

$documents = $collection->find($filter, $options);

foreach ($documents as $document) {
    print_r($document);
}
  • $gt: Matches documents where age is greater than 18.
  • $in: Matches documents where status is either active or pending.
  • The sort option orders results by age in descending order.

Limiting and Skipping Results

To control the number of documents retrieved, use limit and skip:

<?php
$filter = [];
$options = [
    'limit' => 5,
    'skip' => 10
];

$documents = $collection->find($filter, $options);

foreach ($documents as $document) {
    print_r($document);
}
?>
  • limit: Retrieves up to 5 documents.
  • skip: Skips the first 10 documents before starting to retrieve results.

Counting Documents

If you want to count the number of documents matching a query, use countDocuments():

$filter = ['status' => 'active'];

$count = $collection->countDocuments($filter);
echo "Total active documents: $count";

Let's simmarize it.

Wrapping Up

Retrieving documents from a MongoDB collection is one of the important tasks when working with databases. With MongoDB, the process is streamlined, but using PHP to query your database requires a clear understanding of the methods and options available.

Let's recap the points covered in this tutorial:

  • Setting Up:Before diving into queries, it is crucial to establish a connection to your MongoDB server. This setup lays the foundation for all database operations.
  • Using find():The find() method retrieves multiple documents based on specified filters and options.Filters like $filter = ['status' => 'active']; refine the selection.Options like 'projection' and 'sort' customize the fields retrieved and the order of the results.
  • The find() method retrieves multiple documents based on specified filters and options.
  • Filters like $filter = ['status' => 'active']; refine the selection.
  • Options like 'projection' and 'sort' customize the fields retrieved and the order of the results.
  • Working with findOne():For scenarios where you only need one document, findOne() is the go-to method.This simplifies the process as it does not require a loop to process results.
  • For scenarios where you only need one document, findOne() is the go-to method.
  • This simplifies the process as it does not require a loop to process results.
  • Comparison Operators:MongoDB supports advanced queries with operators such as $gt, $lt, and $in.These operators enable more flexible filtering, such as retrieving users over 18 or filtering by multiple statuses.
  • MongoDB supports advanced queries with operators such as $gt, $lt, and $in.
  • These operators enable more flexible filtering, such as retrieving users over 18 or filtering by multiple statuses.
  • Limiting and Skipping Results:Using 'limit' and 'skip', you can control how many documents are retrieved and where the retrieval starts.This is especially useful for implementing pagination in your applications.
  • Using 'limit' and 'skip', you can control how many documents are retrieved and where the retrieval starts.
  • This is especially useful for implementing pagination in your applications.
  • Counting Documents:The countDocuments() method provides the total number of documents matching a query, helping you understand the scope of your data.
  • The countDocuments() method provides the total number of documents matching a query, helping you understand the scope of your data.

In this tutorial, you learned how to retrieve documents from a MongoDB collection using PHP, with examples and detailed explanations for each method. 

Thank you for reading. Happy Coding!

Frequently Asked Questions (FAQs)

  • What is the `find()` method in MongoDB using PHP?

    The find() method retrieves multiple documents from a MongoDB collection based on a query filter. It allows customization using options like projection and sort.

  • How can I retrieve a single document in MongoDB with PHP?

    Use the findOne() method to retrieve a single document. It does not require looping as it directly returns the first matched document.

  • What are some commonly used query operators in MongoDB?

    MongoDB supports operators like $gt (greater than), $lt (less than), and $in (matches multiple values in an array) for advanced filtering.

  • How can I limit and skip results in MongoDB queries?

    You can use the limit option to specify the number of documents to retrieve and the skip option to start retrieving documents after a specified number.

  • How do I count the number of matching documents in MongoDB with PHP?

    $filter = ['status' => 'active'];
   $count = $collection->countDocuments($filter);
   echo "Total active documents: $count";

  • What is the purpose of the projection option in MongoDB queries?

    The projection option limits the fields returned in the query results. For example: 
    'projection' => ['_id' => 0, 'name' => 1, 'email' => 1];
    This excludes the _id field and includes only name and email.

  • How can I sort documents in MongoDB queries?

    Use the sort option to specify the order of the results. For example: 
    'sort' => ['name' => 1];
    This sorts documents by the name field in ascending order.
Share on: