Merge branch 'v3.6' of github.com:mongodb/docs-node into v3.6

Author: Caitlin Davey

snooty.toml

@@ -8,6 +8,7 @@ toc_landing_pages = [
     "/fundamentals",
     "/fundamentals/connection",
     "/fundamentals/crud",
+    "/fundamentals/bson",
     "/usage-examples",
 ]
 sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

source/code-snippets/crud/arrayFilters.js

@@ -1,5 +1,4 @@
 const { MongoClient } = require("mongodb");
-const stream = require("stream");
 
 // Replace the following string with your MongoDB deployment's connection string.
 const uri =
@@ -9,212 +8,88 @@ const client = new MongoClient(uri, {
   useUnifiedTopology: true,
 });
 
-
-async function loadData() {
+async function printData() {
   try {
     await client.connect();
+    const myDB = client.db("test");
+    const myColl = myDB.collection("testColl");
 
-    const database = client.db("test");
-    const pizza = database.collection("pizza");
-
-    await pizza.drop();
-
-    await pizza.insertMany([
-      {
-        name: "Steve Lobsters",
-        address: "731 Yexington Avenue",
-        items: [
-          {
-            type: "pizza",
-            size: "large",
-            toppings: ["pepperoni"],
-          },
-          {
-            type: "pizza",
-            size: "medium",
-            toppings: ["mushrooms", "sausage", "green peppers"],
-            comment: "Extra green peppers please!",
-          },
-          {
-            type: "pizza",
-            size: "large",
-            toppings: ["pineapple, ham"],
-            comment: "red pepper flakes on top",
-          },
-          {
-            type: "calzone",
-            fillings: ["canadian bacon", "sausage", "onion"],
-          },
-          {
-            type: "beverage",
-            name: "Diet Pepsi",
-            size: "16oz",
-          },
-        ],
-      },
-      {
-        name: "Popeye",
-        address:"1 Sweetwater",
-        items: [
-          {
-            type: "pizza",
-            size: "large",
-            toppings: ["garlic", "spinach"]
-          },
-          {
-            type: "calzone",
-            toppings: ["ham"],
-          },
-        ]
-      }
-    ]);
-
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
+    console.log(JSON.stringify(await myColl.find().toArray()));
   } finally {
     await client.close();
   }
 }
 
-
-async function runAllArrayElements() {
-
-  try {
-    await client.connect();
-
-    const database = client.db("test");
-    const pizza = database.collection("pizza");
-
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
-
-    // start allArrayElement example
-    const query = { "name": "Popeye" };
-    const updateDocument = {
-      $push: { "items.$[].toppings": "fresh mozzarella" }
-    };
-    const result = await pizza.updateOne(query, updateDocument);
-    // end allArrayElement example
-    console.log(result.modifiedCount);
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
-  } finally {
-    await client.close();
-  }
-}
 async function runFirstArrayElement() {
-
   try {
     await client.connect();
+    const myDB = client.db("test");
+    const myColl = myDB.collection("testColl");
 
-    const database = client.db("test");
-    const pizza = database.collection("pizza");
-
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
+    console.log(JSON.stringify(await myColl.find().toArray()));
 
     // start firstArrayElement example
-    const query = { name: "Steve Lobsters", "items.type": "pizza" };
+    const query = { "entries.x": { $type : "string" } };
     const updateDocument = {
-      $set: { "items.$.size": "extra large" }
+      $inc: { "entries.$.y": 33 }
     };
-    const result = await pizza.updateOne(query, updateDocument);
+    const result = await myColl.updateOne(query, updateDocument);
     // end firstArrayElement example
     console.log(result.modifiedCount);
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
+    console.log(JSON.stringify(await myColl.find().toArray()));
   } finally {
     await client.close();
   }
 }
 
-
-async function arrayFiltersOne() {
+async function runAllArrayElements() {
   try {
     await client.connect();
+    const myDB = client.db("test");
+    const myColl = myDB.collection("testColl");
 
-    const database = client.db("test");
-    const pizza = database.collection("pizza");
+    console.log(JSON.stringify(await myColl.find().toArray()));
 
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
-
-    // start arrayFiltersOne example
-    const query = { name: "Steve Lobsters" };
+    // start allArrayElement example
+    const query = { date: "5/15/2023" };
     const updateDocument = {
-      $push: { "items.$[orderItem].toppings": "garlic" }
+      $unset: { "calls.$[].duration": "" }
     };
-    const options = {
-      arrayFilters: [{
-        "orderItem.type": "pizza",
-        "orderItem.size": "large",
-      }]
-    };
-
-    const result = await pizza.updateMany(query, updateDocument, options);
-    // end arrayFiltersOne example
-
+    const result = await myColl.updateOne(query, updateDocument);
+    // end allArrayElement example
     console.log(result.modifiedCount);
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
+    console.log(JSON.stringify(await myColl.find().toArray()));
   } finally {
     await client.close();
   }
 }
 
-async function arrayFiltersTwo() {
+async function arrayFiltersIdentifier() {
   try {
     await client.connect();
+    const myDB = client.db("test");
+    const myColl = myDB.collection("testColl");
 
-    const database = client.db("test");
-    const pizza = database.collection("pizza");
-
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
+    console.log(JSON.stringify(await myColl.find().toArray()));
 
-    // start arrayFiltersTwo example
-    const query = { name: "Steve Lobsters" };
+    // start arrayFiltersIdentifier example
+    const query = { date: "11/12/2023" };
     const updateDocument = {
-      $push: { "items.$[item].toppings": "salami" },
+      $mul: { "items.$[i].quantity": 2 }
     };
     const options = {
       arrayFilters: [
         {
-          "item.type": "pizza",
-          "item.toppings": "pepperoni",
-        },
-      ],
+          "i.recipe": "Fried rice",
+          "i.item": { $not: { $regex: "oil" } },
+        }
+      ]
     };
-    const result = await pizza.updateOne(query, updateDocument, options);
-    // end arrayFiltersTwo example
+    const result = await myColl.updateOne(query, updateDocument, options);
+    // end arrayFiltersIdentifier example
     console.log(result.modifiedCount);
 
-    pizza.insertOne({
-      name: "Steve Lobsters",
-      address: "731 Yexington Avenue",
-      items: [
-        {
-          type: "pizza",
-          size: "large",
-          toppings: ["pepperoni"],
-        },
-        {
-          type: "pizza",
-          size: "medium",
-          toppings: ["mushrooms", "sausage", "green peppers"],
-          comment: "Extra green peppers please!",
-        },
-        {
-          type: "pizza",
-          size: "large",
-          toppings: ["pineapple, ham"],
-          comment: "red pepper flakes on top",
-        },
-        {
-          type: "calzone",
-          fillings: ["canadian bacon", "sausage", "onion"],
-        },
-        {
-          type: "beverage",
-          name: "Diet Pepsi",
-          size: "16oz",
-        },
-      ],
-    });
-
-    console.log(JSON.stringify(await (await pizza.find()).toArray()));
+    console.log(JSON.stringify(await myColl.find().toArray()));
   } finally {
     await client.close();
   }

source/code-snippets/indexes/text.js

@@ -15,23 +15,26 @@ async function run() {
     await client.connect();
 
     // begin-idx
-    const database = client.db("sample_mflix");
-    const movies = database.collection("movies");
+    const myDB = client.db("testDB");
+    const myColl = myDB.collection("blogPosts");
 
-    // Create a text index on the "fullplot" field in the
-    // "movies" collection.
-    const result = await movies.createIndex({ fullplot: "text" }, { default_language: "english" });
-    console.log(`Index created: ${result}`);
+    // Create a text index on the "title" and "body" fields
+    const result = await myColl.createIndex(
+      { title: "text", body: "text" },
+      { default_language: "english" },
+      { weights: { body: 10, title: 3 } }
+    );
     // end-idx
+    console.log(`Index created: ${result}`);
 
     // begin-query
-    const query = { $text: { $search: "java coffee shop" } };
-    const projection = { _id: 0, fullplot: 1 };
-    const cursor = movies
-      .find(query)
-      .project(projection);
+    const query = { $text: { $search: "life ahead" } };
+    const projection = { _id: 0, title: 1 };
+    const cursor = myColl.find(query).project(projection);
     // end-query
-
+    for await (const doc of cursor) {
+      console.log(doc);
+    }
   } finally {
     await client.close();
   }

source/faq.txt

@@ -301,35 +301,25 @@ This sets the maximum number of ``file descriptors`` for the process to
 How Can I Prevent a Slow Operation From Delaying Other Operations?
 ------------------------------------------------------------------
 
-A slow operation may delay your other operations that occur after it, if
-the ``maxPoolSize`` has not been set in the
-:ref:`connection options <node-connection-options>`.
-MongoDB is synchronous and uses a single execution thread per socket,
-meaning that MongoDB will execute one single operation per socket at any
-point in time. Any other operation sent to that socket will have to wait
-until the current operation is finished. If you have a slow-running
-operation that holds up other operations, the best solution is to create
-a separate connection pool for the slow operation, isolating it from
-other, faster operations.
-
-.. note::
-    If the number of operations is greater than the value of the
-    ``maxPoolSize`` option and a slow operation occurs, subsequent
-    operations will be delayed.
-
-To create a separate connection pool, instantiate another ``MongoClient``
-call the ``connect()`` method on it. See the following example for the
-syntax you can use to create two clients, each with its own connection
-pool:
-
-.. code-block:: javascript
-
-   const clientA = new MongoClient(uri, options);
-   clientA.connect(); // any method calls on clientA use clientA's connection pool
-
-   const clientB = new MongoClient(uri, options);
-   clientB.connect(); // any method calls on clientB use clientB's connection pool
+To control the maximum size of a connection pool, you can set the
+``maxPoolSize`` option in the :ref:`connection options
+<node-connection-options>`. The default value of ``maxPoolSize`` is
+``100``. If the number of in-use connections to a server reaches
+``maxPoolSize``, the next request to that server will wait 
+until a connection becomes available. To prevent long-running operations
+from slowing down your application, you can increase ``maxPoolSize``.
+
+The driver does not limit the number of requests that can wait for
+sockets to become available. Requests wait for the amount of time
+specified in the ``waitQueueTimeoutMS`` option, which
+defaults to ``0`` (no limit). You should set this option if it is
+more important to stop long-running operations than it is to complete
+every operation.
 
+.. tip::
+   
+   To learn more about connection pooling, see :ref:`How Does Connection
+   Pooling Work in the Node Driver? <node-faq-connection-pool>`.
 
 How Can I Ensure My Connection String Is Valid for a Replica Set?
 -----------------------------------------------------------------

source/fundamentals.txt

@@ -17,6 +17,7 @@ Fundamentals
    /fundamentals/logging
    /fundamentals/monitoring
    /fundamentals/gridfs
-   /fundamentals/csfle
+   /fundamentals/encrypt-fields
+   /fundamentals/bson
 
 .. include:: /includes/fundamentals-sections.rst

source/fundamentals/bson.txt

@@ -0,0 +1,25 @@
+.. _node-bson-control:
+
+=============
+BSON Settings
+=============
+
+.. toctree::
+   :caption: BSON settings
+
+   /fundamentals/bson/undefined-values
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Overview
+--------
+
+Learn how to configure your application's BSON serialization settings.
+The guides in this section describe the following topics:
+
+- :ref:`Undefined Values <node-undefined-values>`: Control how the
+  driver serializes undefined values