DOCSP-21519: node TLDR (#309)

* DOCSP-21519: Quick Reference page

Author: Chris Cho

source/code-snippets/quick-reference.js

@@ -0,0 +1,189 @@
+// ignored first line
+const { MongoClient } = require("mongodb");
+
+// Replace the uri string with your MongoDB deployment's connection string.
+const uri =
+  "<connection URI>";
+
+const client = new MongoClient(uri);
+
+async function query(coll) {
+  await console.log("findOne");
+  const result = await coll.findOne({ title: 'Hamlet' });
+  await console.dir(result);
+}
+
+async function queryMany(coll) {
+  await console.log("find");
+  const cursor = await coll.find({ year: 2005 });
+  await cursor.forEach(console.dir);
+}
+
+async function insertOne(coll) {
+  const result = await coll.insertOne({
+    title: 'Jackie Robinson',
+  });
+  await console.dir(result);
+}
+async function insertMany(coll) {
+  const result = await coll.insertMany([
+    { title: 'Dangal', rating: 'Not Rated' },
+    { title: 'The Boss Baby', rating: 'PG' }
+  ]);
+  await console.dir(result);
+}
+
+async function updateOne(coll) {
+  const result = await coll.updateOne(
+    { title: 'Amadeus' },
+    { $set: { 'imdb.rating': 9.5 } }
+  );
+  await console.dir(result);
+}
+
+async function updateMany(coll) {
+  const result = await coll.updateMany(
+    { year: 2001 },
+    { $inc: { 'imdb.votes': 100 } }
+  );
+
+  await console.dir(result);
+}
+
+async function updateArrayElement(coll) {
+  const result = await coll.updateOne(
+    { title: 'Cosmos' },
+    { $push: { genres: 'Educational' } }
+  );
+  await console.dir(result);
+
+  const findResult = await coll.findOne({title: 'Cosmos'});
+  await console.dir(findResult);
+}
+
+async function replaceDocument(coll) {
+  const result = await coll.replaceOne(
+                { name: 'Deli Llama', address: '2 Nassau St' },
+                { name: 'Lord of the Wings', zipcode: 10001 },
+                { upsert: true}
+             );
+  await console.dir(result);
+
+  const findResult = await coll.findOne({name: 'Lord of the Wings'});
+  await console.dir(findResult);
+}
+
+async function deleteOne(coll) {
+  const result = await coll.deleteOne({ title: 'Congo' });
+  await console.dir(result);
+}
+
+async function deleteMany(coll) {
+  const result = await coll.deleteMany({ title: { $regex: /^Shark.*/ } });
+  await console.dir(result);
+}
+
+async function bulkWriteExample(coll) {
+  const result = await coll.bulkWrite([
+    {
+      insertOne: {
+        document: {
+          title: 'A New Movie',
+          year: 2022
+        }
+      }
+    },
+    {
+      deleteMany: {
+        filter: { year: { $lt: 1970 } }
+      }
+    }
+  ]);
+  await console.dir(result);
+}
+
+async function watchStart(coll) {
+  coll.watch([ { $match: { year: { $gte: 2022 } } } ]);
+}
+
+async function accessCursorIterative(coll) {
+  const cursor = coll.find().limit(10);
+  await cursor.forEach(console.dir);
+}
+
+async function accessCursorArray(coll) {
+  const cursor = coll.find().limit(10);
+  const results = await cursor.toArray();
+  console.log(results);
+}
+
+async function createIndex(coll) {
+  const result = await coll.createIndex({'title':1 , 'year':-1});
+  await console.dir(result);
+}
+
+async function countExample(coll) {
+  const result = await coll.countDocuments({year: 2000});
+  await console.dir(result);
+}
+
+async function skipExample(coll) {
+  const cursor = await coll.find({title: {$regex: /^Rocky/ }}, { skip: 2 });
+  await console.dir(await cursor.toArray());
+}
+
+async function sortExample(coll) {
+  const cursor = await coll.find().limit(50).sort({ year: 1});
+  await cursor.forEach(console.dir);
+}
+
+async function projectExample(coll) {
+  const cursor = coll.find().project({ _id: 0, year: 1, imdb: 1 });
+  await cursor.forEach(console.dir);
+}
+
+async function searchText(coll) {
+  const result = await coll.find({$text: { $search: 'zissou' }}).limit(30).project({title: 1});
+  await result.forEach(console.dir);
+}
+
+async function distinct(coll) {
+  const result = await coll.distinct('year');
+  await console.log(result);
+}
+
+async function run() {
+  try {
+    await client.connect();
+
+    const database = client.db("sample_mflix");
+    const collection = database.collection("movies");
+
+    //await count(collection);
+    //await query(collection);
+    //await queryMany(collection);
+    //await insertOne(collection);
+    //await insertMany(collection);
+    //await updateOne(collection);
+    //await updateMany(collection);
+    //await updateArrayElement(collection);
+    //await replaceDocument(collection);
+    //await deleteOne(collection);
+    //await deleteMany(collection);
+    //await bulkWriteExample(collection);
+    //await watchStart(collection);
+    //await accessCursorIterative(collection);
+    //await accessCursorArray(collection);
+    //await countExample(collection);
+    //await skipExample(collection);
+    //await sortExample(collection);
+    //await projectExample(collection);
+    //await createIndex(collection);
+    //await searchText(collection);
+    //await distinct(collection);
+
+  } finally {
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/fundamentals/crud/read-operations/cursor.txt

@@ -68,6 +68,8 @@ pulling all matching documents into a collection in process memory.
    fetch, the cursor is exhausted which means it ceases to respond to methods
    that access the results.
 
+.. _node-fundamentals-cursor-foreach:
+
 For Each Functional Iteration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -79,6 +81,8 @@ results in a functional style:
    :start-after: start foreach cursor example
    :end-before: end foreach cursor example
 
+.. _node-fundamentals-cursor-array:
+
 Return an Array of All Documents
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

source/fundamentals/crud/read-operations/geo.txt

@@ -1,3 +1,5 @@
+.. _node-fundamentals-geospatial:
+
 ===================
 Search Geospatially
 ===================
@@ -52,9 +54,9 @@ A ``Line`` uses two coordinates: a longitude and a latitude for each end.
 A ``Polygon`` consists of a list of coordinates in which the first and last
 coordinate are the same, effectively closing the polygon. To learn more
 about the GeoJSON shapes you can use in MongoDB, consult the
-:manual:`GeoJSON manual entry </reference/geojson/>`. 
+:manual:`GeoJSON manual entry </reference/geojson/>`.
 
-To enable querying GeoJSON data, you must add the field to a ``2dsphere`` 
+To enable querying GeoJSON data, you must add the field to a ``2dsphere``
 index. The following snippet creates an index on the ``location.geo`` field in
 the ``theaters`` collection using the ``createIndex()`` method:
 
@@ -67,9 +69,9 @@ the ``theaters`` collection using the ``createIndex()`` method:
 Coordinates on a 2D Plane
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can also express geospatial queries using ``x`` and ``y`` coordinates in 
-a two-dimentional Euclidian plane. Until MongoDB, this was the only format 
-compatible with geospatial queries, and are now referred to as 
+You can also express geospatial queries using ``x`` and ``y`` coordinates in
+a two-dimentional Euclidian plane. Until MongoDB, this was the only format
+compatible with geospatial queries, and are now referred to as
 "legacy coordinate pairs".
 
 Legacy coordinate pairs use the following structure:
@@ -78,8 +80,8 @@ Legacy coordinate pairs use the following structure:
 
    <field> : [ x, y ]
 
-The field should contain an array of two values in which the first represents 
-the ``x`` axis value and the second represents the ``y`` axis value. 
+The field should contain an array of two values in which the first represents
+the ``x`` axis value and the second represents the ``y`` axis value.
 
 To enable querying using legacy coordinate pairs, create a ``2d`` index on
 the field on the collection. The following snippet creates an index on the
@@ -90,7 +92,7 @@ the field on the collection. The following snippet creates an index on the
 
    db.shipwrecks({coordinates: "2d"})
 
-See the 
+See the
 :manual:`MongoDB server manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`
 for more information.
 

source/fundamentals/crud/read-operations/limit.txt

@@ -1,3 +1,5 @@
+.. _node-fundamentals-limit:
+
 ====================================
 Limit the Number of Returned Results
 ====================================

source/fundamentals/crud/read-operations/project.txt

@@ -1,3 +1,5 @@
+.. _node-fundamentals-project:
+
 ==============================
 Specify Which Fields to Return
 ==============================

source/fundamentals/crud/read-operations/retrieve.txt

@@ -1,3 +1,5 @@
+.. _node-fundamentals-retrieve-data:
+
 =============
 Retrieve Data
 =============
@@ -18,7 +20,7 @@ Overview
 You can use read operations to retrieve data from your MongoDB database.
 There are multiple types of read operations that access the data in
 different ways. If you want to request results based on a set of criteria
-from the existing set of data, you can use a find operation such as the 
+from the existing set of data, you can use a find operation such as the
 ``find()`` or ``findOne()`` methods.
 
 You can also further specify the information you are requesting by
@@ -29,12 +31,12 @@ including additional parameters or by chaining other methods such as:
 - :doc:`Limit the Number of Returned Results </fundamentals/crud/read-operations/limit>`
 - :doc:`Specify Which Fields to Return </fundamentals/crud/read-operations/project>`
 
-You can also use an aggregation operation to retrieve data. This type of 
-operation allows you to apply an ordered pipeline of transformations to the 
+You can also use an aggregation operation to retrieve data. This type of
+operation allows you to apply an ordered pipeline of transformations to the
 matched data.
 
 If you want to monitor the database for incoming data that matches a set of
-criteria, you can use the watch operation to be notified in real-time when 
+criteria, you can use the watch operation to be notified in real-time when
 matching data is inserted.
 
 .. include:: /includes/access-cursor-note.rst
@@ -70,12 +72,12 @@ matching document or ``null`` if there are no matches.
       :end-before: end find crud example
 
 
-   Once the operation returns, the ``findResult`` variable references a 
+   Once the operation returns, the ``findResult`` variable references a
    ``Cursor``. You can print the documents retrieved using the ``forEach()``
    method as shown below:
 
    .. code-block:: javascript
-      
+
       await cursor.forEach(console.dir);
 
 
@@ -114,12 +116,12 @@ group, and arrange the result data from a collection.
       :end-before: end aggregate crud example
 
 
-   Once the operation returns, the ``aggregateResult`` variable references a 
+   Once the operation returns, the ``aggregateResult`` variable references a
    ``Cursor``. You can print the documents retrieved using the ``forEach()``
    method as shown below:
 
    .. code-block:: javascript
-      
+
       await cursor.forEach(console.dir);
 
 
@@ -137,6 +139,8 @@ group, and arrange the result data from a collection.
 See the MongoDB server manual pages on :manual:`aggregation </aggregation>`
 for more information on how to construct an aggregation pipeline.
 
+.. _node-fundamentals-watch:
+
 Watch / Subscribe
 -----------------
 

source/fundamentals/crud/read-operations/skip.txt

@@ -1,3 +1,5 @@
+.. _node-fundamentals-skip:
+
 =====================
 Skip Returned Results
 =====================

source/fundamentals/crud/read-operations/sort.txt

@@ -1,3 +1,5 @@
+.. _node-fundamentals-sort:
+
 ============
 Sort Results
 ============

source/fundamentals/crud/read-operations/text.txt

@@ -1,3 +1,5 @@
+.. _node-fundamentals-text:
+
 ===========
 Search Text
 ===========
@@ -26,7 +28,7 @@ a **text index** on your collection. See the examples below for sample
 code for creating a text index and using the ``$text`` query operator.
 
 .. include:: /includes/atlas-search.rst
- 
+
 Examples
 --------