standardized variable naming in code snippets (#143)

kyuan-mongodb · web-flow · commit 7e05aab013a6 · 2021-03-01T13:11:49.000-05:00
diff --git a/source/code-snippets/crud/arrayFilters.js b/source/code-snippets/crud/arrayFilters.js
@@ -12,11 +12,11 @@ async function loadData() {
     await client.connect();
 
     const database = client.db("test");
-    const collection = database.collection("pizza");
+    const pizza = database.collection("pizza");
 
-    await collection.drop();
+    await pizza.drop();
 
-    await collection.insertMany([
+    await pizza.insertMany([
       {
         name: "Steve Lobsters",
         address: "731 Yexington Avenue",
@@ -64,9 +64,9 @@ async function loadData() {
           },
         ]
       }
-    );
+    ]);
 
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
   } finally {
     await client.close();
   }
@@ -79,19 +79,19 @@ async function runAllArrayElements() {
     await client.connect();
 
     const database = client.db("test");
-    const collection = database.collection("pizza");
+    const pizza = database.collection("pizza");
 
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    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 collection.updateOne(query, updateDocument);
+    const result = await pizza.updateOne(query, updateDocument);
     // end allArrayElement example
     console.log(result.modifiedCount);
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
   } finally {
     await client.close();
   }
@@ -102,19 +102,19 @@ async function runFirstArrayElement() {
     await client.connect();
 
     const database = client.db("test");
-    const collection = database.collection("pizza");
+    const pizza = database.collection("pizza");
 
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
 
     // start firstArrayElement example
     const query = { name: "Steve Lobsters", "items.type": "pizza" };
     const updateDocument = {
       $set: { "items.$.size": "extra large" }
     };
-    const result = await collection.updateOne(query, updateDocument);
+    const result = await pizza.updateOne(query, updateDocument);
     // end firstArrayElement example
     console.log(result.modifiedCount);
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
   } finally {
     await client.close();
   }
@@ -126,9 +126,9 @@ async function arrayFiltersOne() {
     await client.connect();
 
     const database = client.db("test");
-    const collection = database.collection("pizza");
+    const pizza = database.collection("pizza");
 
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
 
     // start arrayFiltersOne example
     const query = { name: "Steve Lobsters" };
@@ -142,11 +142,11 @@ async function arrayFiltersOne() {
       }]
     };
 
-    const result = await collection.updateMany(query, updateDocument, options);
+    const result = await pizza.updateMany(query, updateDocument, options);
     // end arrayFiltersOne example
 
     console.log(result.modifiedCount);
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
   } finally {
     await client.close();
   }
@@ -157,9 +157,9 @@ async function arrayFiltersTwo() {
     await client.connect();
 
     const database = client.db("test");
-    const collection = database.collection("pizza");
+    const pizza = database.collection("pizza");
 
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
 
     // start arrayFiltersTwo example
     const query = { name: "Steve Lobsters" };
@@ -174,11 +174,11 @@ async function arrayFiltersTwo() {
         },
       ],
     };
-    const result = await collection.updateOne(query, updateDocument, options);
+    const result = await pizza.updateOne(query, updateDocument, options);
     // end arrayFiltersTwo example
     console.log(result.modifiedCount);
 
-    collection.insertOne({
+    pizza.insertOne({
       name: "Steve Lobsters",
       address: "731 Yexington Avenue",
       items: [
@@ -211,7 +211,7 @@ async function arrayFiltersTwo() {
       ],
     });
 
-    console.log(JSON.stringify(await (await collection.find()).toArray()));
+    console.log(JSON.stringify(await (await pizza.find()).toArray()));
   } finally {
     await client.close();
   }
diff --git a/source/code-snippets/crud/startrek.js b/source/code-snippets/crud/startrek.js
@@ -100,12 +100,12 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
-    await word(collection);
-    await phrase(collection);
-    await negation(collection);
-    await relevance(collection);
+    await word(movies);
+    await phrase(movies);
+    await negation(movies);
+    await relevance(movies);
   } finally {
     await client.close();
   }
diff --git a/source/code-snippets/crud/theaters.js b/source/code-snippets/crud/theaters.js
@@ -63,10 +63,10 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("theaters");
+    const theaters = database.collection("theaters");
 
-    await proximity(collection);
-    await range(collection);
+    await proximity(theaters);
+    await range(theaters);
   } finally {
     await client.close();
   }
diff --git a/source/code-snippets/indexes/compound.js b/source/code-snippets/indexes/compound.js
@@ -12,8 +12,8 @@ async function run() {
     await client.connect();
 
     // begin-idx
-    const db = client.db("sample_mflix");
-    const movies = db.collection("movies");
+    const database = client.db("sample_mflix");
+    const movies = database.collection("movies");
 
     // Create an ascending index on the "type" and "genre" fields
     // in the "movies" collection.
diff --git a/source/code-snippets/indexes/geo.js b/source/code-snippets/indexes/geo.js
@@ -12,8 +12,8 @@ async function run() {
     await client.connect();
 
     // begin-idx
-    const db = client.db("sample_mflix");
-    const movies = db.collection("movies");
+    const database = client.db("sample_mflix");
+    const movies = database.collection("movies");
 
     // Create a 2dsphere index on the "location.geo" field in the "theaters" collection.
     const result = await movies.createIndex({ "location.geo": "2dsphere" });
diff --git a/source/code-snippets/indexes/multikey.js b/source/code-snippets/indexes/multikey.js
@@ -12,8 +12,8 @@ async function run() {
     await client.connect();
 
     // begin-idx
-    const db = client.db("sample_mflix");
-    const movies = db.collection("movies");
+    const database = client.db("sample_mflix");
+    const movies = database.collection("movies");
 
     // Create a multikey index on the "cast" array field
     // in the "movies" collection.
diff --git a/source/code-snippets/indexes/single-field.js b/source/code-snippets/indexes/single-field.js
@@ -12,8 +12,8 @@ async function run() {
     await client.connect();
 
     // begin-idx
-    const db = client.db("sample_mflix");
-    const movies = db.collection("movies");
+    const database = client.db("sample_mflix");
+    const movies = database.collection("movies");
 
     // Create an ascending index on the "title" field in the
     // "movies" collection.
diff --git a/source/code-snippets/indexes/text.js b/source/code-snippets/indexes/text.js
@@ -12,8 +12,8 @@ async function run() {
     await client.connect();
 
     // begin-idx
-    const db = client.db("sample_mflix");
-    const movies = db.collection("movies");
+    const database = client.db("sample_mflix");
+    const movies = database.collection("movies");
 
     // Create a text index on the "fullplot" field in the
     // "movies" collection.
diff --git a/source/code-snippets/indexes/unique.js b/source/code-snippets/indexes/unique.js
@@ -12,8 +12,8 @@ async function run() {
     await client.connect();
 
     // begin-idx
-    const db = client.db("sample_mflix");
-    const movies = db.collection("movies");
+    const database = client.db("sample_mflix");
+    const movies = database.collection("movies");
 
     // Create a unique index on the "theaterId" field in the "theaters" collection.
     const result = await movies.createIndex({ theaterId: 1 }, { unique: true });
diff --git a/source/code-snippets/usage-examples/bulkWrite.js b/source/code-snippets/usage-examples/bulkWrite.js
@@ -11,9 +11,9 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("theaters");
+    const theaters = database.collection("theaters");
 
-    const result = await collection.bulkWrite([
+    const result = await theaters.bulkWrite([
       { insertOne:
         {
           "document": {
diff --git a/source/code-snippets/usage-examples/changeStream.js b/source/code-snippets/usage-examples/changeStream.js
@@ -11,10 +11,10 @@ async function run() {
   try {
     await client.connect();
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
     // open a Change Stream on the "movies" collection
-    changeStream = collection.watch();
+    changeStream = movies.watch();
 
     // set up a listener when change events are emitted
     changeStream.on("change", next => {
@@ -26,7 +26,7 @@ async function run() {
     // operation is called.
     await new Promise(resolve => {
       setTimeout(async () => {
-        await collection.insertOne({
+        await movies.insertOne({
           test: "sample movie document",
         });
         // wait to close `changeStream` after the listener receives the event
diff --git a/source/code-snippets/usage-examples/deleteMany.js b/source/code-snippets/usage-examples/deleteMany.js
@@ -11,11 +11,11 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
     // Query for all movies with the title "Santa Claus"
     const query = { title: "Santa Claus" };
 
-    const result = await collection.deleteMany(query);
+    const result = await movies.deleteMany(query);
     console.log("Deleted " + result.deletedCount + " documents");
   } finally {
     await client.close();
diff --git a/source/code-snippets/usage-examples/deleteOne.js b/source/code-snippets/usage-examples/deleteOne.js
@@ -11,12 +11,12 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
     // Query for a movie that has a title of type string
     const query = { title: { $type: "string" } };
 
-    const result = await collection.deleteOne(query);
+    const result = await movies.deleteOne(query);
     if (result.deletedCount === 1) {
       console.dir("Successfully deleted one document.");
     } else {
diff --git a/source/code-snippets/usage-examples/distinct.js b/source/code-snippets/usage-examples/distinct.js
@@ -12,15 +12,15 @@ async function run() {
 
     // define a database and collection on which to run the method
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
     // specify the document field
     const fieldName = "year";
 
     // specify an optional query document
     const query = { directors: "Barbra Streisand" };
 
-    const distinctValues = await collection.distinct(fieldName, query);
+    const distinctValues = await movies.distinct(fieldName, query);
 
     console.log(distinctValues);
   } finally {
diff --git a/source/code-snippets/usage-examples/find.js b/source/code-snippets/usage-examples/find.js
@@ -11,7 +11,7 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
     // query for movies that have a runtime less than 15 minutes
     const query = { runtime: { $lt: 15 } };
@@ -23,7 +23,7 @@ async function run() {
       projection: { _id: 0, title: 1, imdb: 1 },
     };
 
-    const cursor = collection.find(query, options);
+    const cursor = movies.find(query, options);
 
     // print a message if no documents were found
     if ((await cursor.count()) === 0) {
diff --git a/source/code-snippets/usage-examples/findOne.js b/source/code-snippets/usage-examples/findOne.js
@@ -11,7 +11,7 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
     // Query for a movie that has the title 'The Room'
     const query = { title: "The Room" };
@@ -23,7 +23,7 @@ async function run() {
       projection: { _id: 0, title: 1, imdb: 1 },
     };
 
-    const movie = await collection.findOne(query, options);
+    const movie = await movies.findOne(query, options);
 
     // since this method returns the matched document, not a cursor, print it directly
     console.log(movie);
diff --git a/source/code-snippets/usage-examples/insertMany.js b/source/code-snippets/usage-examples/insertMany.js
@@ -11,7 +11,7 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
     // create an array of documents to insert
     const docs = [
@@ -23,7 +23,7 @@ async function run() {
     // this option prevents additional documents from being inserted if one fails
     const options = { ordered: true };
 
-    const result = await collection.insertMany(docs, options);
+    const result = await movies.insertMany(docs, options);
     console.log(`${result.insertedCount} documents were inserted`);
   } finally {
     await client.close();
diff --git a/source/code-snippets/usage-examples/insertOne.js b/source/code-snippets/usage-examples/insertOne.js
@@ -11,10 +11,10 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
     // create a document to be inserted
     const doc = { name: "Red", town: "kanto" };
-    const result = await collection.insertOne(doc);
+    const result = await movies.insertOne(doc);
 
     console.log(
       `${result.insertedCount} documents were inserted with the _id: ${result.insertedId}`,
diff --git a/source/code-snippets/usage-examples/replaceOne.js b/source/code-snippets/usage-examples/replaceOne.js
@@ -11,7 +11,7 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const collection = database.collection("movies");
+    const movies = database.collection("movies");
 
     // create a query for a movie to update
     const query = { title: "Blacksmith Scene" };
@@ -26,7 +26,7 @@ async function run() {
         "Robin Sparkles mourns for a relationship with a mall rat at an idyllic beach.",
     };
 
-    const result = await collection.replaceOne(query, replacement, options);
+    const result = await movies.replaceOne(query, replacement, options);
 
     if (result.modifiedCount === 0 && result.upsertedCount === 0) {
       console.log("No changes made to the collection.");
diff --git a/source/code-snippets/usage-examples/updateMany.js b/source/code-snippets/usage-examples/updateMany.js
diff --git a/source/code-snippets/usage-examples/updateOne.js b/source/code-snippets/usage-examples/updateOne.js
diff --git a/source/quick-start.txt b/source/quick-start.txt
