diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 6c3c8097..7f690c55 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -4,6 +4,13 @@ Usage Examples ============== +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code, .NET, operation + .. contents:: On this page :local: :backlinks: none @@ -60,3 +67,27 @@ your MongoDB instance: For more information about connecting to your MongoDB instance, see the :ref:`Connection Guide `. + +Example Classes +--------------- + +The usage examples in this section show how to perform operations on documents +in the ``restaurants`` collection. The examples use the following ``Restaurant``, +``Address``, and ``GradeEntry`` classes to model the data in this collection: + +.. literalinclude:: /includes/code-examples/Restaurant.cs + :language: csharp + :copyable: + :dedent: + +.. literalinclude:: /includes/code-examples/Address.cs + :language: csharp + :copyable: + :dedent: + +.. literalinclude:: /includes/code-examples/GradeEntry.cs + :language: csharp + :copyable: + :dedent: + +.. include:: /includes/convention-pack-note.rst diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt index 35bbd3a0..96103487 100644 --- a/source/usage-examples/deleteMany.txt +++ b/source/usage-examples/deleteMany.txt @@ -4,7 +4,12 @@ Delete Many Documents ===================== -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -18,26 +23,6 @@ method or the ``DeleteManyAsync()`` asynchronous method on a collection object. Example ------- -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst - The following code deletes all documents in the ``restaurants`` collection whose ``borough`` field value equals the word "Brooklyn". diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt index 1d4eeb30..edd66963 100644 --- a/source/usage-examples/deleteOne.txt +++ b/source/usage-examples/deleteOne.txt @@ -4,7 +4,12 @@ Delete a Document ================= -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -22,31 +27,11 @@ You can delete a document from a collection by using the synchronous To learn more about using ``DeleteMany()``, see :ref:`csharp-delete-many`. -Examples --------- - -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst +Example +------- -Delete a Document Using Builders -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete a Document by Using Builders +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following example uses ``Builders`` to delete a document in the ``restaurants`` collection with the ``name`` "Ready Penny Inn". diff --git a/source/usage-examples/findMany.txt b/source/usage-examples/findMany.txt index 9e2c2599..81cb98f6 100644 --- a/source/usage-examples/findMany.txt +++ b/source/usage-examples/findMany.txt @@ -4,7 +4,12 @@ Find Multiple Documents ======================= -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -15,31 +20,11 @@ Find Multiple Documents You can retrieve multiple documents from a collection by using the ``Find()`` method. -Examples --------- - -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst +Example +------- -Find Documents Using Builders -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Find Documents by Using Builders +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following example uses ``Builders`` to find documents in the ``restaurants`` collection with the ``cuisine`` "Pizza". @@ -77,8 +62,8 @@ corresponding code. find multiple documents, see `Synchronous Find Multiple Example <{+example+}/find-many/FindMany.cs>`__. -Find Documents Using LINQ -~~~~~~~~~~~~~~~~~~~~~~~~~ +Find Documents by Using LINQ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following example uses LINQ to find documents in the ``restaurants`` collection with the ``cuisine`` "Pizza". diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt index cceac954..9d65265c 100644 --- a/source/usage-examples/findOne.txt +++ b/source/usage-examples/findOne.txt @@ -4,7 +4,12 @@ Find a Document =============== -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -14,31 +19,11 @@ Find a Document You can retrieve a document by using the ``Find()`` method on a collection object. -Examples --------- - -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst +Example +------- -Find a Document Using Builders -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Find a Document by Using Builders +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following example uses ``Builders`` to find a document in the ``restaurants`` collection that has a ``name`` field with a value of "Bagels N Buns". @@ -74,8 +59,8 @@ corresponding code. For a fully runnable example of using the ``Find()`` method to synchronously find one document, see the `Synchronous Find One Example <{+example+}/find-one/FindOne.cs>`__. -Find a Document Using LINQ -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Find a Document by Using LINQ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following example uses LINQ to find a document in the ``restaurants`` collection that has a ``name`` field with a value of "Bagels N Buns". diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt index 9e227673..89f631e8 100644 --- a/source/usage-examples/insertMany.txt +++ b/source/usage-examples/insertMany.txt @@ -4,7 +4,12 @@ Insert Multiple Documents ========================= -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -15,29 +20,9 @@ Insert Multiple Documents You can insert multiple documents into a collection by using the synchronous ``InsertMany()`` method or the asynchronous ``InsertManyAsync()`` method. -Examples --------- - -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: +Example +------- -.. include:: /includes/convention-pack-note.rst - The following example inserts multiple documents into the ``restaurants`` collection. diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt index 3247c778..4ea96a6d 100644 --- a/source/usage-examples/insertOne.txt +++ b/source/usage-examples/insertOne.txt @@ -4,7 +4,12 @@ Insert a Document ================= -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -15,31 +20,10 @@ Insert a Document You can insert a single document into a collection by using the synchronous ``InsertOne()`` method, or the asynchronous ``InsertOneAsync()`` method. -Examples --------- +Example +------- -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst - -The following example inserts a document into -the ``restaurants`` collection. +The following example inserts a document into the ``restaurants`` collection. Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to see the corresponding code. diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt index 80e51393..e82a9e4b 100644 --- a/source/usage-examples/replaceOne.txt +++ b/source/usage-examples/replaceOne.txt @@ -4,7 +4,12 @@ Replace a Document ================== -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -18,26 +23,6 @@ or the ``ReplaceOneAsync()`` asynchronous method on a collection object. Example ------- -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst - The following code replaces the first document in the ``restaurants`` collection that has a value of "Pizza" in the ``cuisine`` field. After the replacement, this document will have a ``name`` field with a value of "Mongo's Pizza" and new values for the diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt index 7348b6b0..65a2763e 100644 --- a/source/usage-examples/updateMany.txt +++ b/source/usage-examples/updateMany.txt @@ -4,7 +4,12 @@ Update Many Documents ===================== -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -18,26 +23,6 @@ a collection object. Example ------- -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst - The following code updates all documents in the ``restaurants`` collection that have a ``cuisine`` field with the value of "Pizza". After the update, these documents will have a ``cuisine`` field with a value of "Pasta and breadsticks". diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt index 8a2264af..eecfb94b 100644 --- a/source/usage-examples/updateOne.txt +++ b/source/usage-examples/updateOne.txt @@ -4,7 +4,12 @@ Update a Document ================= -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, .NET, operation .. contents:: On this page :local: @@ -25,28 +30,8 @@ a ``MongoCollection`` object. This method requires a **query filter**, which spe You can pass an instance of `UpdateOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateOptions.html>`__ to the ``UpdateOne()`` method in order to customize its behavior. -Examples --------- - -The examples on this page use the following ``Restaurant``, ``Address``, and ``GradeEntry`` -classes as models: - -.. literalinclude:: /includes/code-examples/Restaurant.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/Address.cs - :language: csharp - :copyable: - :dedent: - -.. literalinclude:: /includes/code-examples/GradeEntry.cs - :language: csharp - :copyable: - :dedent: - -.. include:: /includes/convention-pack-note.rst +Example +------- The following example uses ``Builders`` to update the ``name`` of the first document named "Bagels N Buns" in the ``restaurants`` collection to