Make client connection code consistent (#59)

Mohammad Hunan Chughtai · web-flow · commit edf7402477e1 · 2020-02-07T13:39:17.000-05:00
* made client cconn code consistent

* added admonition

* fixed link

* moved note into INCLUDES and literal included

* updated to rst

* made node external

* Attempt to fix formatting

* included note in usage ex

* removed unneeded comma

* moved useUnifiedTopology out of uri

* updated location of note

* placement of connection-guide link node

* Removed unneeded spacing
diff --git a/source/code-snippets/usage-examples/bulkWrite-example.js b/source/code-snippets/usage-examples/bulkWrite-example.js
@@ -1,15 +1,11 @@
 const { MongoClient } = require("mongodb");
 const fs = require("fs");
 
-// Replace the following with your MongoDB deployment's connection
-// string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri, {
-  useNewUrlParser: true,
-  useUnifiedTopology: true
-});
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/command.js b/source/code-snippets/usage-examples/command.js
@@ -1,11 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri);
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/count.js b/source/code-snippets/usage-examples/count.js
@@ -1,15 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection
-// string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri, {
-  useNewUrlParser: true,
-  useUnifiedTopology: true,
-});
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/deleteMany.js b/source/code-snippets/usage-examples/deleteMany.js
@@ -1,15 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection
-// string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri, {
-  useNewUrlParser: true,
-  useUnifiedTopology: true,
-});
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/deleteOne.js b/source/code-snippets/usage-examples/deleteOne.js
@@ -1,15 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection
-// string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri, {
-  useNewUrlParser: true,
-  useUnifiedTopology: true,
-});
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/distinct.js b/source/code-snippets/usage-examples/distinct.js
@@ -1,10 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri);
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
@@ -22,7 +23,6 @@ async function run() {
 
     const distinctValues = await collection.distinct(fieldName, query);
     console.log(distinctValues);
-
   } finally {
     await client.close();
   }
diff --git a/source/code-snippets/usage-examples/find.js b/source/code-snippets/usage-examples/find.js
@@ -1,15 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection
-// string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri, {
-  useNewUrlParser: true,
-  useUnifiedTopology: true,
-});
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/findOne.js b/source/code-snippets/usage-examples/findOne.js
@@ -1,15 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection
-// string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri, {
-  useNewUrlParser: true,
-  useUnifiedTopology: true,
-});
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/insertMany.js b/source/code-snippets/usage-examples/insertMany.js
@@ -1,10 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri);
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/insertOne.js b/source/code-snippets/usage-examples/insertOne.js
@@ -1,10 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri);
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/replaceOne.js b/source/code-snippets/usage-examples/replaceOne.js
@@ -1,11 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri);
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/updateMany.js b/source/code-snippets/usage-examples/updateMany.js
@@ -1,11 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri);
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/code-snippets/usage-examples/updateOne.js b/source/code-snippets/usage-examples/updateOne.js
@@ -1,11 +1,11 @@
 // ignored first line
 const { MongoClient } = require("mongodb");
 
-// Replace the following with your MongoDB deployment's connection string.
+// Replace the following string with your MongoDB deployment's connection string.
 const uri =
   "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
 
-const client = new MongoClient(uri);
+const client = new MongoClient(uri, { useUnifiedTopology: true });
 
 async function run() {
   try {
diff --git a/source/includes/connect-guide-note.rst b/source/includes/connect-guide-note.rst
@@ -0,0 +1,5 @@
+.. note::
+    This example connects to an instance of MongoDB using a
+    :manual:`connection-string </reference/connection-string/>`. To
+    learn more about connecting to your instance of MongoDB, see the
+    `connection guide </fundamentals/connection>`_
diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt
@@ -85,6 +85,8 @@ existing fields in the collection, as in the following:
      "name" : "Marie Conrad"
    }
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/bulkWrite-example.js
    :language: javascript
 
diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt
@@ -26,6 +26,8 @@ the results of the command operation when it completes.
 Example
 -------
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/command.js
   :language: javascript
   :linenos:
diff --git a/source/usage-examples/count.txt b/source/usage-examples/count.txt
@@ -51,5 +51,7 @@ The following example estimates the number of documents in the
 an accurate count of the number of documents in the ``movies``
 collection with ``Canada`` in the ``countries`` field.
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/count.js
   :language: javascript
diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt
@@ -47,5 +47,7 @@ The following snippet deletes multiple documents from the ``movies``
 collection. It uses a **query document** that configures the query to
 match and delete movies with the title "Santa Claus".
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/deleteMany.js
   :language: javascript
diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt
@@ -56,5 +56,7 @@ The following snippet deletes a single document from the ``movies``
 collection. It uses a **query document** that configures the query
 to match only movies with a title of type ``string``.
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/deleteOne.js
   :language: javascript
diff --git a/source/usage-examples/distinct.txt b/source/usage-examples/distinct.txt
@@ -46,6 +46,8 @@ The following snippet retrieves a list of distinct values for the ``year``
 document field from the ``movies`` collection. It uses a query document to
 match movies that include "Barbara Streisand" as a ``director``.
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/distinct.js
   :language: javascript
   :linenos:
diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt
@@ -49,6 +49,8 @@ collection. It uses the following:
   returned documents and explicitly includes only the ``title`` and
   ``imdb`` object (and its embedded fields).
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/find.js
   :language: javascript
   :emphasize-lines: 18
diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt
@@ -43,6 +43,8 @@ collection. It uses the following:
   returned documents and explicitly includes only the ``title`` and
   ``imdb`` object (and its embedded fields).
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/findOne.js
   :language: javascript
   :emphasize-lines: 26
diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt
@@ -27,6 +27,8 @@ unique index rules will throw a ``duplicate key error``.
 Example
 -------
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/insertMany.js
   :language: javascript
   :linenos:
diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt
@@ -25,6 +25,8 @@ has a value of ``1``.
 Example
 -------
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/insertOne.js
   :language: javascript
   :linenos:
diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt
@@ -45,6 +45,8 @@ unique index rule, ``replaceOne()`` throws a ``duplicate key error``.
 Example
 -------
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/replaceOne.js
   :language: javascript
   :linenos:
diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt
@@ -24,6 +24,8 @@ shows the number of modified documents.
 Example
 -------
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/updateMany.js
   :language: javascript
   :linenos:
diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt
@@ -47,6 +47,8 @@ update values for document fields. For more information on update operators,
 see the :manual:`MongoDB update operator reference documentation
 </reference/operator/update/#update-operators>`.
 
+.. include:: /includes/connect-guide-note.rst
+
 .. literalinclude:: /code-snippets/usage-examples/updateOne.js
   :language: javascript
   :linenos:
