DOCSP-35973: Delete Many usage example #2837
Conversation
docs/usage-examples/deleteMany.txt
Outdated
| 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. |
There was a problem hiding this comment.
Suggestion:
I think linking to the Fundamentals > Write Operations page "Delete Documents" section could be more directly helpful. Since that content hasn't been merged yet, I would suggest creating a cleanup task in the cleanup ticket.
docs/usage-examples/deleteMany.txt
Outdated
| :class: singlecol | ||
|
|
||
| You can delete multiple documents in a collection by calling the ``delete()`` method on an | ||
| Eloquent model or a query builder. |
There was a problem hiding this comment.
Suggestion:
The example currently shows it being chained to the results of the "where()" method rather than directly on the Eloquent model or by using the query builder DB facade.
I could be wrong, but I don't think it's a static method available on the model. I think it could be better to include a description of the way it's being called in the example, or to change the example to match one of the ways described.
|
|
||
| - Uses the ``Movie`` Eloquent model to represent the ``movies`` collection in the | ||
| ``sample_mflix`` database | ||
| - Deletes documents from the ``movies`` collection that match a query filter |
There was a problem hiding this comment.
Suggestion:
Similar to prior feedback, I think printing the output should be mentioned or the code that prints should be hidden.
docs/usage-examples/deleteMany.txt
Outdated
|
|
||
| - ``where()``: matches documents in which the value of the ``year`` field is less than or | ||
| equal to ``1910`` | ||
| - ``delete()``: deletes the retrieved documents |
There was a problem hiding this comment.
Suggestion:
I think it could be helpful to add some information about the value printed even if it seems self-explanatory. E.g.
"The delete() method returns the number of documents successfully deleted"
|
|
||
| .. tip:: | ||
|
|
||
| To learn more about deleting documents with {+odm-short+}, see the :ref:`laravel-fundamentals-delete-documents` |
There was a problem hiding this comment.
Note: this PR will be merged after #2829
* DOCSP-35973: Delete Many usage example
Adds a usage example demonstrating how to delete multiple documents in a single operation
JIRA - https://jira.mongodb.org/browse/DOCSP-35973
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/laravel/DOCSP-35973/usage-examples/deleteMany/
Checklist