Skip to content

Commit 9ec1bae

Browse files
authored
docsp-27681 - move example classes (#150)
1 parent d86ba3f commit 9ec1bae

File tree

10 files changed

+108
-213
lines changed

10 files changed

+108
-213
lines changed

source/usage-examples.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Usage Examples
55
==============
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code, .NET, operation
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -60,3 +67,27 @@ your MongoDB instance:
6067

6168
For more information about connecting to your MongoDB instance, see the
6269
:ref:`Connection Guide <csharp-connection>`.
70+
71+
Example Classes
72+
---------------
73+
74+
The usage examples in this section show how to perform operations on documents
75+
in the ``restaurants`` collection. The examples use the following ``Restaurant``,
76+
``Address``, and ``GradeEntry`` classes to model the data in this collection:
77+
78+
.. literalinclude:: /includes/code-examples/Restaurant.cs
79+
:language: csharp
80+
:copyable:
81+
:dedent:
82+
83+
.. literalinclude:: /includes/code-examples/Address.cs
84+
:language: csharp
85+
:copyable:
86+
:dedent:
87+
88+
.. literalinclude:: /includes/code-examples/GradeEntry.cs
89+
:language: csharp
90+
:copyable:
91+
:dedent:
92+
93+
.. include:: /includes/convention-pack-note.rst

source/usage-examples/deleteMany.txt

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Delete Many Documents
55
=====================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, .NET, operation
813

914
.. contents:: On this page
1015
:local:
@@ -18,26 +23,6 @@ method or the ``DeleteManyAsync()`` asynchronous method on a collection object.
1823
Example
1924
-------
2025

21-
The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry``
22-
classes as models:
23-
24-
.. literalinclude:: /includes/code-examples/Restaurant.cs
25-
:language: csharp
26-
:copyable:
27-
:dedent:
28-
29-
.. literalinclude:: /includes/code-examples/Address.cs
30-
:language: csharp
31-
:copyable:
32-
:dedent:
33-
34-
.. literalinclude:: /includes/code-examples/GradeEntry.cs
35-
:language: csharp
36-
:copyable:
37-
:dedent:
38-
39-
.. include:: /includes/convention-pack-note.rst
40-
4126
The following code deletes all documents in the ``restaurants`` collection whose
4227
``borough`` field value equals the word "Brooklyn".
4328

source/usage-examples/deleteOne.txt

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Delete a Document
55
=================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, .NET, operation
813

914
.. contents:: On this page
1015
:local:
@@ -22,31 +27,11 @@ You can delete a document from a collection by using the synchronous
2227

2328
To learn more about using ``DeleteMany()``, see :ref:`csharp-delete-many`.
2429

25-
Examples
26-
--------
27-
28-
The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry``
29-
classes as models:
30-
31-
.. literalinclude:: /includes/code-examples/Restaurant.cs
32-
:language: csharp
33-
:copyable:
34-
:dedent:
35-
36-
.. literalinclude:: /includes/code-examples/Address.cs
37-
:language: csharp
38-
:copyable:
39-
:dedent:
40-
41-
.. literalinclude:: /includes/code-examples/GradeEntry.cs
42-
:language: csharp
43-
:copyable:
44-
:dedent:
45-
46-
.. include:: /includes/convention-pack-note.rst
30+
Example
31+
-------
4732

48-
Delete a Document Using Builders
49-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33+
Delete a Document by Using Builders
34+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5035

5136
The following example uses ``Builders`` to delete a document in
5237
the ``restaurants`` collection with the ``name`` "Ready Penny Inn".

source/usage-examples/findMany.txt

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Find Multiple Documents
55
=======================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, .NET, operation
813

914
.. contents:: On this page
1015
:local:
@@ -15,31 +20,11 @@ Find Multiple Documents
1520
You can retrieve multiple documents from a collection by using the
1621
``Find()`` method.
1722

18-
Examples
19-
--------
20-
21-
The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry``
22-
classes as models:
23-
24-
.. literalinclude:: /includes/code-examples/Restaurant.cs
25-
:language: csharp
26-
:copyable:
27-
:dedent:
28-
29-
.. literalinclude:: /includes/code-examples/Address.cs
30-
:language: csharp
31-
:copyable:
32-
:dedent:
33-
34-
.. literalinclude:: /includes/code-examples/GradeEntry.cs
35-
:language: csharp
36-
:copyable:
37-
:dedent:
38-
39-
.. include:: /includes/convention-pack-note.rst
23+
Example
24+
-------
4025

41-
Find Documents Using Builders
42-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26+
Find Documents by Using Builders
27+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4328

4429
The following example uses ``Builders`` to find documents in
4530
the ``restaurants`` collection with the ``cuisine`` "Pizza".
@@ -77,8 +62,8 @@ corresponding code.
7762
find multiple documents, see
7863
`Synchronous Find Multiple Example <{+example+}/find-many/FindMany.cs>`__.
7964

80-
Find Documents Using LINQ
81-
~~~~~~~~~~~~~~~~~~~~~~~~~
65+
Find Documents by Using LINQ
66+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8267

8368
The following example uses LINQ to find documents in the
8469
``restaurants`` collection with the ``cuisine`` "Pizza".

source/usage-examples/findOne.txt

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Find a Document
55
===============
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, .NET, operation
813

914
.. contents:: On this page
1015
:local:
@@ -14,31 +19,11 @@ Find a Document
1419

1520
You can retrieve a document by using the ``Find()`` method on a collection object.
1621

17-
Examples
18-
--------
19-
20-
The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry``
21-
classes as models:
22-
23-
.. literalinclude:: /includes/code-examples/Restaurant.cs
24-
:language: csharp
25-
:copyable:
26-
:dedent:
27-
28-
.. literalinclude:: /includes/code-examples/Address.cs
29-
:language: csharp
30-
:copyable:
31-
:dedent:
32-
33-
.. literalinclude:: /includes/code-examples/GradeEntry.cs
34-
:language: csharp
35-
:copyable:
36-
:dedent:
37-
38-
.. include:: /includes/convention-pack-note.rst
22+
Example
23+
-------
3924

40-
Find a Document Using Builders
41-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25+
Find a Document by Using Builders
26+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4227

4328
The following example uses ``Builders`` to find a document in the ``restaurants``
4429
collection that has a ``name`` field with a value of "Bagels N Buns".
@@ -74,8 +59,8 @@ corresponding code.
7459
For a fully runnable example of using the ``Find()`` method
7560
to synchronously find one document, see the `Synchronous Find One Example <{+example+}/find-one/FindOne.cs>`__.
7661

77-
Find a Document Using LINQ
78-
~~~~~~~~~~~~~~~~~~~~~~~~~~
62+
Find a Document by Using LINQ
63+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7964

8065
The following example uses LINQ to find a document in the ``restaurants``
8166
collection that has a ``name`` field with a value of "Bagels N Buns".

source/usage-examples/insertMany.txt

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Insert Multiple Documents
55
=========================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, .NET, operation
813

914
.. contents:: On this page
1015
:local:
@@ -15,29 +20,9 @@ Insert Multiple Documents
1520
You can insert multiple documents into a collection by using the synchronous
1621
``InsertMany()`` method or the asynchronous ``InsertManyAsync()`` method.
1722

18-
Examples
19-
--------
20-
21-
The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry``
22-
classes as models:
23-
24-
.. literalinclude:: /includes/code-examples/Restaurant.cs
25-
:language: csharp
26-
:copyable:
27-
:dedent:
28-
29-
.. literalinclude:: /includes/code-examples/Address.cs
30-
:language: csharp
31-
:copyable:
32-
:dedent:
33-
34-
.. literalinclude:: /includes/code-examples/GradeEntry.cs
35-
:language: csharp
36-
:copyable:
37-
:dedent:
23+
Example
24+
-------
3825

39-
.. include:: /includes/convention-pack-note.rst
40-
4126
The following example inserts multiple documents into
4227
the ``restaurants`` collection.
4328

source/usage-examples/insertOne.txt

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Insert a Document
55
=================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, .NET, operation
813

914
.. contents:: On this page
1015
:local:
@@ -15,31 +20,10 @@ Insert a Document
1520
You can insert a single document into a collection by using the synchronous
1621
``InsertOne()`` method, or the asynchronous ``InsertOneAsync()`` method.
1722

18-
Examples
19-
--------
23+
Example
24+
-------
2025

21-
The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry``
22-
classes as models:
23-
24-
.. literalinclude:: /includes/code-examples/Restaurant.cs
25-
:language: csharp
26-
:copyable:
27-
:dedent:
28-
29-
.. literalinclude:: /includes/code-examples/Address.cs
30-
:language: csharp
31-
:copyable:
32-
:dedent:
33-
34-
.. literalinclude:: /includes/code-examples/GradeEntry.cs
35-
:language: csharp
36-
:copyable:
37-
:dedent:
38-
39-
.. include:: /includes/convention-pack-note.rst
40-
41-
The following example inserts a document into
42-
the ``restaurants`` collection.
26+
The following example inserts a document into the ``restaurants`` collection.
4327

4428
Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to see the
4529
corresponding code.

source/usage-examples/replaceOne.txt

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Replace a Document
55
==================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, .NET, operation
813

914
.. contents:: On this page
1015
:local:
@@ -18,26 +23,6 @@ or the ``ReplaceOneAsync()`` asynchronous method on a collection object.
1823
Example
1924
-------
2025

21-
The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry``
22-
classes as models:
23-
24-
.. literalinclude:: /includes/code-examples/Restaurant.cs
25-
:language: csharp
26-
:copyable:
27-
:dedent:
28-
29-
.. literalinclude:: /includes/code-examples/Address.cs
30-
:language: csharp
31-
:copyable:
32-
:dedent:
33-
34-
.. literalinclude:: /includes/code-examples/GradeEntry.cs
35-
:language: csharp
36-
:copyable:
37-
:dedent:
38-
39-
.. include:: /includes/convention-pack-note.rst
40-
4126
The following code replaces the first document in the ``restaurants`` collection that has a
4227
value of "Pizza" in the ``cuisine`` field. After the replacement, this document will
4328
have a ``name`` field with a value of "Mongo's Pizza" and new values for the

0 commit comments

Comments
 (0)