Skip to content

Commit ee9869d

Browse files
biniona-mongodbterakilobyte
biniona-mongodb
authored and
terakilobyte
committed
(DOCSP-20836) Delete Guide - Update (#177)
1 parent 63a3756 commit ee9869d

File tree

5 files changed

+123
-24
lines changed

5 files changed

+123
-24
lines changed

‎source/crud/delete.txt

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
:template: guide
2+
3+
========================
4+
Delete Data from MongoDB
5+
========================
6+
7+
Overview
8+
--------
9+
10+
In this guide, you will delete documents from a MongoDB database.
11+
12+
.. time:: 10
13+
14+
What You'll Need
15+
----------------
16+
17+
- .. include:: /includes/prereqs_read_CRUD.rst
18+
19+
- Complete the :doc:`/server/import` guide so that there
20+
is data in your database to delete.
21+
22+
Check Your Environment
23+
----------------------
24+
25+
.. include:: /includes/check_for_drivers_install.rst
26+
27+
Procedure
28+
---------
29+
30+
.. tabs-selector:: drivers
31+
32+
.. procedure::
33+
:style: normal
34+
35+
.. include:: /includes/delete_server.rst
36+
37+
Summary
38+
-------
39+
40+
If you have successfully completed this guide, you have deleted
41+
documents from MongoDB. That completes this introduction to CRUD
42+
operations in MongoDB.
43+
44+
See Also
45+
--------
46+
47+
For other CRUD guides:
48+
49+
- :doc:`/server/insert`
50+
51+
- :doc:`/server/read`
52+
53+
- :doc:`/server/read_queries`
54+
55+
- :doc:`/server/read_operators`
56+
57+
- :doc:`/server/update`
58+
59+
For method reference:
60+
61+
- :method:`db.collection.remove`
62+
63+
- :method:`db.collection.deleteOne`
64+
65+
- :method:`db.collection.deleteMany`
66+
67+
.. guide-next::

‎source/includes/delete_server.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. step:: Connect to your MongoDB instance.
2+
3+
.. include:: /includes/drivers_connect.rst
4+
5+
.. step:: Switch to the ``test`` database.
6+
7+
In this guide, you will delete documents in a collection in the
8+
``test`` database.
9+
10+
.. include:: /includes/bind_db.rst
11+
12+
.. step:: Delete a single document.
13+
14+
The following operation deletes the **first** document with ``status``
15+
equal to ``D``:
16+
17+
.. include:: /includes/driver-example-delete-58.rst
18+
19+
.. include:: /includes/driver-example-delete-result.rst
20+
21+
22+
.. step:: Delete multiple documents.
23+
24+
The following operation deletes *all* of the documents in the
25+
specified ``inventory`` collection with ``status`` equal to ``A``:
26+
27+
.. include:: /includes/driver-example-delete-57.rst
28+
29+
.. include:: /includes/driver-example-delete-result.rst
30+
31+
.. include:: /includes/drivers_close_connection.rst

‎source/includes/driver-example-delete-57.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@
3939

4040
- id: python
4141
content: |
42-
.. literalinclude:: /driver-examples/test_examples.py
42+
.. literalinclude:: /includes/examples/curl_examples/test_examples.py
4343
:language: python
4444
:dedent: 8
4545
:start-after: Start Example 57
4646
:end-before: End Example 57
4747

4848
- id: motor
4949
content: |
50-
.. literalinclude:: /driver-examples/test_examples_motor.py
50+
.. literalinclude:: /includes/examples/curl_examples/test_examples_motor.py
5151
:language: python
5252
:dedent: 8
5353
:start-after: Start Example 57
@@ -79,15 +79,15 @@
7979
8080
- id: java-sync
8181
content: |
82-
.. literalinclude:: /driver-examples/DocumentationSamples.java
82+
.. literalinclude:: /includes/examples/curl_examples/DocumentationSamples.java
8383
:language: java
8484
:dedent: 8
8585
:start-after: Start Example 57
8686
:end-before: End Example 57
8787

8888
- id: go
8989
content: |
90-
.. literalinclude:: /driver-examples/examples.go
90+
.. literalinclude:: /includes/examples/curl_examples/examples.go
9191
:language: go
9292
:dedent: 1
9393
:start-after: Start Example 57
@@ -96,7 +96,7 @@
9696

9797
- id: nodejs
9898
content: |
99-
.. literalinclude:: /driver-examples/examples_tests.js
99+
.. literalinclude:: /includes/examples/curl_examples/examples_tests.js
100100
:language: javascript
101101
:dedent: 8
102102
:start-after: Start Example 57
@@ -105,47 +105,47 @@
105105

106106
# - id: java-async
107107
# content: |
108-
# .. literalinclude:: /driver-examples/AsyncDocumentationSamples.java
108+
# .. literalinclude:: /includes/examples/curl_examples/AsyncDocumentationSamples.java
109109
# :language: java
110110
# :dedent: 8
111111
# :start-after: Start Example 57
112112
# :end-before: End Example 57
113113
#
114114
# - id: php
115115
# content: |
116-
# .. literalinclude:: /driver-examples/DocumentationExamplesTest.php
116+
# .. literalinclude:: /includes/examples/curl_examples/DocumentationExamplesTest.php
117117
# :language: php
118118
# :dedent: 8
119119
# :start-after: Start Example 57
120120
# :end-before: End Example 57
121121
#
122122
# - id: perl
123123
# content: |
124-
# .. literalinclude:: /driver-examples/driver-examples.t
124+
# .. literalinclude:: /includes/examples/curl_examples/driver-examples.t
125125
# :language: perl
126126
# :dedent: 4
127127
# :start-after: Start Example 57
128128
# :end-before: End Example 57
129129
#
130130
# - id: ruby
131131
# content: |
132-
# .. literalinclude:: /driver-examples/shell_examples_spec.rb
132+
# .. literalinclude:: /includes/examples/curl_examples/shell_examples_spec.rb
133133
# :language: ruby
134134
# :dedent: 8
135135
# :start-after: Start Example 57
136136
# :end-before: End Example 57
137137
#
138138
# - id: scala
139139
# content: |
140-
# .. literalinclude:: /driver-examples/DocumentationExampleSpec.scala
140+
# .. literalinclude:: /includes/examples/curl_examples/DocumentationExampleSpec.scala
141141
# :language: scala
142142
# :dedent: 4
143143
# :start-after: Start Example 57
144144
# :end-before: End Example 57
145145

146146
- id: csharp
147147
content: |
148-
.. literalinclude:: /driver-examples/DocumentationExamples.cs
148+
.. literalinclude:: /includes/examples/curl_examples/DocumentationExamples.cs
149149
:language: c#
150150
:dedent: 12
151151
:start-after: Start Example 57

‎source/includes/driver-example-delete-58.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@
3434

3535
- id: python
3636
content: |
37-
.. literalinclude:: /driver-examples/test_examples.py
37+
.. literalinclude:: /includes/examples/curl_examples/test_examples.py
3838
:language: python
3939
:dedent: 8
4040
:start-after: Start Example 58
4141
:end-before: End Example 58
4242

4343
- id: motor
4444
content: |
45-
.. literalinclude:: /driver-examples/test_examples_motor.py
45+
.. literalinclude:: /includes/examples/curl_examples/test_examples_motor.py
4646
:language: python
4747
:dedent: 8
4848
:start-after: Start Example 58
@@ -63,15 +63,15 @@
6363

6464
Before deleting the data, you'll need to assign the ``inventory`` collection in the ``test`` database to a variable:
6565

66-
.. literalinclude:: /driver-examples/assign.go
66+
.. literalinclude:: /includes/examples/go/assign/assign.go
6767
:language: go
6868
:dedent: 1
6969
:start-after: Start Collection
7070
:end-before: End Collection
7171

7272
Followed by:
7373

74-
.. literalinclude:: /driver-examples/examples.go
74+
.. literalinclude:: /includes/examples/curl_examples/examples.go
7575
:language: go
7676
:dedent: 1
7777
:start-after: Start Example 58
@@ -80,15 +80,15 @@
8080

8181
- id: java-sync
8282
content: |
83-
.. literalinclude:: /driver-examples/DocumentationSamples.java
83+
.. literalinclude:: /includes/examples/curl_examples/DocumentationSamples.java
8484
:language: java
8585
:dedent: 8
8686
:start-after: Start Example 58
8787
:end-before: End Example 58
8888

8989
- id: nodejs
9090
content: |
91-
.. literalinclude:: /driver-examples/examples_tests.js
91+
.. literalinclude:: /includes/examples/curl_examples/examples_tests.js
9292
:language: javascript
9393
:dedent: 8
9494
:start-after: Start Example 58
@@ -97,47 +97,47 @@
9797

9898
# - id: java-async
9999
# content: |
100-
# .. literalinclude:: /driver-examples/AsyncDocumentationSamples.java
100+
# .. literalinclude:: /includes/examples/curl_examples/AsyncDocumentationSamples.java
101101
# :language: java
102102
# :dedent: 8
103103
# :start-after: Start Example 58
104104
# :end-before: End Example 58
105105
#
106106
# - id: php
107107
# content: |
108-
# .. literalinclude:: /driver-examples/DocumentationExamplesTest.php
108+
# .. literalinclude:: /includes/examples/curl_examples/DocumentationExamplesTest.php
109109
# :language: php
110110
# :dedent: 8
111111
# :start-after: Start Example 58
112112
# :end-before: End Example 58
113113
#
114114
# - id: perl
115115
# content: |
116-
# .. literalinclude:: /driver-examples/driver-examples.t
116+
# .. literalinclude:: /includes/examples/curl_examples/driver-examples.t
117117
# :language: perl
118118
# :dedent: 4
119119
# :start-after: Start Example 58
120120
# :end-before: End Example 58
121121
#
122122
# - id: ruby
123123
# content: |
124-
# .. literalinclude:: /driver-examples/shell_examples_spec.rb
124+
# .. literalinclude:: /includes/examples/curl_examples/shell_examples_spec.rb
125125
# :language: ruby
126126
# :dedent: 8
127127
# :start-after: Start Example 58
128128
# :end-before: End Example 58
129129
#
130130
# - id: scala
131131
# content: |
132-
# .. literalinclude:: /driver-examples/DocumentationExampleSpec.scala
132+
# .. literalinclude:: /includes/examples/curl_examples/DocumentationExampleSpec.scala
133133
# :language: scala
134134
# :dedent: 4
135135
# :start-after: Start Example 58
136136
# :end-before: End Example 58
137137

138138
- id: csharp
139139
content: |
140-
.. literalinclude:: /driver-examples/DocumentationExamples.cs
140+
.. literalinclude:: /includes/examples/curl_examples/DocumentationExamples.cs
141141
:language: c#
142142
:dedent: 12
143143
:start-after: Start Example 58

‎source/index.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,6 @@ Start with Guides
4343
.. guide:: /crud/read_queries.txt
4444
.. guide:: /crud/update.txt
4545
.. guide:: /crud/read_operators.txt
46-
46+
.. guide:: /crud/delete.txt
47+
4748
.. include:: /chapters/aggregation.rst

0 commit comments

Comments
 (0)