mongodb · norareidy · Apr 8, 2024 · Apr 3, 2024 · Apr 3, 2024 · Apr 3, 2024
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Controllers;
+
+use App\Models\Movie;
+use MongoDB\Laravel\Tests\TestCase;
+
+class DeleteOneTest extends TestCase
+{
+    /**
+     * @runInSeparateProcess
+     * @preserveGlobalState disabled
+     */
+    public function testDeleteOne(): void
+    {
+        require_once __DIR__ . '/Movie.php';
+
+        Movie::truncate();
+        Movie::insert([
+            [
+                'title' => 'Capote',
+                'runtime' => 114,
+            ],
+        ]);
+
+        // begin-delete-one
+        $deleted = Movie::where('title', 'Capote')
+            ->orderBy('_id')
+            ->first()
+            ->delete();
+
+        echo 'Deleted documents: ' . $deleted;
+        // end-delete-one
+
+        $this->assertTrue($deleted);
+        $this->expectOutputString('Deleted documents: 1');
+    }
+}
@@ -71,4 +71,5 @@ calls the controller function and returns the result to a web interface.
    :titlesonly:
    :maxdepth: 1
 
-   /usage-examples/updateOne
+   /usage-examples/updateOne
+   /usage-examples/deleteOne
@@ -0,0 +1,66 @@
+.. _laravel-delete-one-usage:
+
+=================
+Delete a Document
+=================
+
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: delete one, remove, code example
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can delete a document in a collection by retrieving a single document and calling
+the ``delete()`` method on an Eloquent model or a query builder.
+
+Pass a query filter to the ``where()`` method, sort the matching documents, and call the
+``first()`` method to retrieve only the first document. Then, delete this matching document
+by calling the ``delete()`` method.
-Pass a query filter to the ``where()`` method, sort the matching documents, and call the
-``first()`` method to retrieve only the first document. Then, delete this matching document
-by calling the ``delete()`` method.
+Perform the following steps to delete a document:
+
+1. Pass a query filter to the ``where()`` method
+2. Sort the matching documents
+3. Call the ``first()`` method to retrieve only the first document 
+4. Delete this matching document by calling the ``delete()`` method.
-Pass a query filter to the ``where()`` method, sort the matching documents, and call the
-``first()`` method to retrieve only the first document. Then, delete this matching document
-by calling the ``delete()`` method.
+To delete a document, pass a query filter to the ``where()`` method, sort the matching documents, and call the
+``first()`` method to retrieve only the first document. Then, delete this matching document
+by calling the ``delete()`` method.
-Pass a query filter to the ``where()`` method, sort the matching documents, and call the
-``first()`` method to retrieve only the first document. Then, delete this matching document
-by calling the ``delete()`` method.
+Perform the following steps to delete a document:
+
+1. Pass a query filter to the ``where()`` method
+2. Sort the matching documents
+3. Call the ``first()`` method to retrieve only the first document 
+4. Delete this matching document by calling the ``delete()`` method.
-Pass a query filter to the ``where()`` method, sort the matching documents, and call the
-``first()`` method to retrieve only the first document. Then, delete this matching document
-by calling the ``delete()`` method.
+To delete a document, pass a query filter to the ``where()`` method, sort the matching documents, and call the
+``first()`` method to retrieve only the first document. Then, delete this matching document
+by calling the ``delete()`` method.
+
+Example
+-------
+
+This usage example performs the following actions:
+
+- Uses the ``Movie`` Eloquent model to represent the ``movies`` collection in the
+  ``sample_mflix`` database.
+- Deletes a document from the ``movies`` collection that matches a query filter.
- Uses the ``Movie`` Eloquent model to represent the ``movies`` collection in the
-  ``sample_mflix`` database.
- Deletes a document from the ``movies`` collection that matches a query filter.
+- Uses the ``Movie`` Eloquent model to represent the ``movies`` collection in the
+  ``sample_mflix`` database.
+- Deletes a document from the ``movies`` collection that matches a query filter.
- Uses the ``Movie`` Eloquent model to represent the ``movies`` collection in the
-  ``sample_mflix`` database.
- Deletes a document from the ``movies`` collection that matches a query filter.
+- Uses the ``Movie`` Eloquent model to represent the ``movies`` collection in the
+  ``sample_mflix`` database.
+- Deletes a document from the ``movies`` collection that matches a query filter.
+
+The example calls the following methods on the ``Movie`` model:
+
+- ``where()``: matches documents in which the value of the ``title`` field is ``'Capote'``.
+- ``orderBy()``: sorts matched documents by their ascending ``_id`` values.
+- ``first()``: retrieves only the first matching document.
+- ``delete()``: deletes the retrieved document.
+
+.. io-code-block::
+   :copyable: true
+
+   .. input:: ../includes/usage-examples/DeleteOneTest.php
+      :start-after: begin-delete-one
+      :end-before: end-delete-one
+      :language: php
+      :dedent:
+
+   .. output::
+      :language: console
+      :visible: false
+
+      Deleted documents: 1
+
+For instructions on editing your Laravel application to run the usage example, see the
+:ref:`Usage Example landing page <laravel-usage-examples>`.
+
+.. tip::
+
+   To learn more about deleting documents with {+odm-short+}, see the `Deleting Models
+   <https://laravel.com/docs/{+laravel-docs-version+}/eloquent#deleting-models>`__ section of the
+   Laravel documentation.
+