forked from mongodb/docs-golang
-
Notifications
You must be signed in to change notification settings - Fork 0
/
quick-reference.txt
477 lines (354 loc) · 13.1 KB
/
quick-reference.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
.. _golang-quick-reference:
===============
Quick Reference
===============
.. default-domain:: mongodb
This page shows the driver syntax for several MongoDB commands and links to
their related reference and API documentation.
.. list-table::
:header-rows: 1
:widths: 25 75
* - Command
- Syntax
* - | **Find a Document**
|
| `API Documentation <{+api+}/mongo#Collection.FindOne>`__
| :ref:`Usage Example <golang-find-one>`
| :ref:`Fundamentals <golang-retrieve>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
err = coll.FindOne(context.TODO(), bson.D{{"firstName", Mike}}).Decode(&result)
.. output::
:language: go
:visible: false
[{firstName Mike}, {lastName Smith} ...]
* - | **Find Multiple Documents**
|
| `API Documentation <{+api+}/mongo#Collection.Find>`__
| :ref:`Usage Example <golang-find-multiple>`
| :ref:`Fundamentals <golang-retrieve>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
cursor, err := coll.Find(context.TODO(), bson.D{{"age", bson.D{{"$gte", 46}}}})
.. output::
:language: go
:visible: false
[{firstName Kyle}, {age 51}, ... ]
[{firstName Omar}, {age 47}, ... ]
* - | **Insert a Document**
|
| `API Documentation <{+api+}/mongo#Collection.InsertOne>`__
| :ref:`Usage Example <golang-insert-one>`
| :ref:`Fundamentals <golang-insert-guide>`
- .. code-block:: go
:copyable: true
result, err := coll.InsertOne(
context.TODO(),
bson.D{
{"animal", "Dog"},
{"breed", "Beagle"}
}
)
* - | **Insert Multiple Documents**
|
| `API Documentation <{+api+}/mongo#Collection.InsertMany>`__
| :ref:`Usage Example <golang-insert-many>`
| :ref:`Fundamentals <golang-insert-guide>`
- .. code-block:: go
:copyable: true
docs := []interface{} {
bson.D{{"firstName", "Erik"}, {"age", 27}},
bson.D{{"firstName", "Mohammad"}, {"lastName", "Ahmad"}, {"age", 10}},
bson.D{{"firstName", "Todd"}},
bson.D{{"firstName", "Juan"}, {"lastName", "Pablo"}}
}
result, err := coll.InsertMany(context.TODO(), docs)
* - | **Update a Document**
|
| `API Documentation <{+api+}/mongo#Collection.UpdateOne>`__
| :ref:`Usage Example <golang-update-one>`
| :ref:`Fundamentals <golang-update-documents>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
result, err := coll.UpdateOne(
context.TODO(),
bson.D{{"firstName", "Erik"}},
bson.D{{"$set", bson.D{{"age", 28}}}}
)
fmt.Printf("The number of modified documents: %d\n", result.ModifiedCount)
.. output::
:language: go
:visible: false
The number of modified documents: 1
* - | **Update Multiple Documents**
|
| `API Documentation <{+api+}/mongo#Collection.UpdateMany>`__
| :ref:`Usage Example <golang-update-many>`
| :ref:`Fundamentals <golang-update-documents>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
result, err := coll.UpdateMany(
context.TODO(),
bson.D{{"age", bson.D{{"$gte", 58}}}},
bson.D{{"$set", bson.D{{"description", "Senior"}}}}
)
fmt.Printf("The number of modified documents: %d\n", result.ModifiedCount)
.. output::
:language: go
:visible: false
The number of modified documents: 4
* - | **Update Arrays in Documents**
|
| `API Documentation <{+api+}/mongo#Collection.UpdateMany>`__
| :ref:`Fundamentals <golang-update-arrays>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
result, err := coll.UpdateMany(
context.TODO(),
bson.D{},
bson.D{{"$push", bson.D{{family, "brother"}}}}
)
.. output::
:language: go
:visible: false
[{firstName Xiao}, {family ["brother"]}, ... ]
[{firstName Omar}, {family ["brother", "mother"]}, ... ]
...
* - | **Replace a Document**
|
| `API Documentation <{+api+}/mongo#Collection.ReplaceOne>`__
| :ref:`Usage Example <golang-replace>`
| :ref:`Fundamentals <golang-replacement-document>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
result, err := coll.ReplaceOne(
context.TODO(),
bson.D{{"firstName", "Mick"}},
bson.D{{"firstName", "Mike"}, {"lastName", "Doe"}}
)
.. output::
:language: go
:visible: false
[{{firstName Mike}, {lastName Doe} }]
* - | **Delete a Document**
|
| `API Documentation <{+api+}/mongo#Collection.DeleteOne>`__
| :ref:`Usage Example <golang-delete-one>`
| :ref:`Fundamentals <golang-delete-guide>`
- .. code-block:: go
:copyable: true
result, err := coll.DeleteOne(
context.TODO(),
bson.D{{"firstName", "Xiao"}}
)
* - | **Delete Multiple Documents**
|
| `API Documentation <{+api+}/mongo#Collection.DeleteMany>`__
| :ref:`Usage Example <golang-delete-many>`
| :ref:`Fundamentals <golang-delete-guide>`
- .. code-block:: go
:copyable: true
results, err := coll.DeleteMany(
context.TODO(),
bson.D{{"age", bson.D{{"$lte", 12}}}}
)
* - | **Bulk Write**
|
| `API Documentation <{+api+}/mongo#Collection.BulkWrite>`__
| :ref:`Usage Example <golang-bulk-ops-usage-example>`
| :ref:`Fundamentals <golang-bulk>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
models := []mongo.WriteModel{
mongo.NewInsertOneModel().SetDocument(bson.D{{"firstName", "John"}, {"age", 5}}),
mongo.NewUpdateOneModel().SetFilter(bson.D{{"firstName", "Juan"}}).
SetUpdate(bson.D{{"$set", bson.D{{"age", 12}}}}),
}
opts := options.BulkWrite().SetOrdered(true)
results, err := coll.BulkWrite(context.TODO(), models, opts)
.. output::
:language: go
:visible: false
[{firstName John}, {age 5} ... ]
[{firstName Juan}, {age 12} ... ]
* - | **Monitor Data Changes**
|
| `API Documentation <{+api+}/mongo#Collection.Watch>`__
| :ref:`Usage Example <golang-usageex-monitor-changes>`
- .. code-block:: go
:copyable: true
pipeline := mongo.Pipeline{bson.D{{"$match", bson.D{{"operationType", "insert"}}}}}
cs, err := coll.Watch(context.TODO(), pipeline)
* - | **Access Data from a Cursor Iteratively**
|
| `API Documentation <{+api+}/mongo#Cursor.Next>`__
| :ref:`Fundamentals <golang-individual-documents>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
cursor, err := coll.Find(context.TODO(), bson.D{})
for cursor.Next(context.TODO()) {
var result bson.D
if err := cursor.Decode(&result); err != nil {
log.Fatal(err)
}
fmt.Println(result)
}
.. output::
:language: go
:visible: false
[{firstName Doug} ... ]
[{firstName Erik} ...]
[{lastName Chang} ...]
...
* - | **Access Data from a Cursor as an Array**
|
| `API Documentation <{+api+}/mongo#Cursor.All>`__
| :ref:`Fundamentals <golang-all-documents>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
cursor, err := coll.Find(context.TODO(), bson.D{})
var results []bson.D
if err = cursor.All(context.TODO(), &results); err != nil {
panic(err)
}
.. output::
:language: go
:visible: false
[{name Mike} ... ]
[{name Edgar} ...]
[{name Freddie} ...]
...
* - | **Count Documents**
|
| `API Documentation <{+api+}/mongo#Collection.CountDocuments>`__
| :ref:`Usage Example <golang-count-usage-example>`
| :ref:`Fundamentals <golang-count-documents>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
count, err := coll.CountDocuments(context.TODO(), bson.D{})
.. output::
:language: go
:visible: false
6
* - | **List the Distinct Documents or Field Values**
| `API Documentation <{+api+}/mongo#Collection.Distinct>`__
| :ref:`Usage Example <golang-distinct-usage-example>`
| :ref:`Fundamentals <golang-retrieve-distinct>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
results, err := coll.Distinct(context.TODO(), "firstName", bson.D{})
.. output::
:language: go
:visible: false
Mike
Xiao
...
* - | **Limit the Number of Documents Retrieved**
|
| `API Documentation <{+api+}/mongo/options#FindOptions.SetLimit>`__
| :ref:`Fundamentals <golang-limit>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
cursor, err := coll.Find(context.TODO(), bson.D{}, options.Find().SetLimit(2))
.. output::
:language: go
:visible: false
[{breed Beagle} ... ]
[{breed German Shepard} ...]
* - | **Skip Retrieved Documents**
|
| `API Documentation <{+api+}/mongo/options#FindOptions.SetSkip>`__
| :ref:`Fundamentals <golang-skip>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
// the collection has 6 documents
cursor, err := coll.Find(context.TODO(), bson.D{}, options.Find().SetSkip(4))
.. output::
:language: go
:visible: false
[{item Pen} ... ]
[{item Chair} ...]
* - | **Sort the Documents When Retrieving Them**
|
| `API Documentation <{+api+}/mongo/options#FindOptions.SetSort>`__
| :ref:`Fundamentals <golang-sort-results>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
cursor, err := coll.Find(context.TODO(), bson.D{}, options.Find().SetSort(bson.D{{"age", 1}}))
.. output::
:language: go
:visible: false
[{firstName Dev} {age 5} ... ]
[{firstName Jose} {age 7} ... ]
[{firstName Om} {age 8} ... ]
* - | **Project Document Fields When Retrieving Them**
|
| `API Documentation <{+api+}/mongo/options#FindOptions.SetProjection>`__
| :ref:`Fundamentals <golang-project>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
cursor, err := coll.Find(
context.TODO(),
bson.D{},
options.Find().SetProjection(
bson.D{{"age", 0}, {"_id",0}}
)
)
.. output::
:language: go
:visible: false
[{firstName Lester}]
[{firstName Wendall} {lastName Griffin}]
...
* - | **Create an Index**
|
| `API Documentation <{+api+}/mongo#IndexView.CreateOne>`__
| :ref:`Fundamentals <golang-indexes>`
- .. code-block:: go
:copyable: true
model := mongo.IndexModel{Keys: bson.D{{"firstName", 1}, {"lastName", -1}}}
name, err := coll.Indexes().CreateOne(context.TODO(), model)
* - | **Search Text**
|
| `API Documentation <{+api+}/mongo#Collection.Find>`__
| :ref:`Fundamentals <golang-search-text>`
- .. io-code-block::
:copyable: true
.. input::
:language: go
// only searches fields with text indexes
cursor, err := coll.Find(context.TODO(), bson.D{{"$text", bson.D{{"$search", "beagle"}}}})
.. output::
:language: go
:visible: false
[{"firstName": "Emily" , "Description": "I love to play sports and walk my beagle."} ... ]