From a87dee37a163175f15185282746a9d5f791f304a Mon Sep 17 00:00:00 2001 From: Nick Larew Date: Mon, 14 Apr 2025 11:08:26 -0500 Subject: [PATCH] Add missing meta descriptions (#1074) * Add missing meta descriptions * Apply suggestions from code review --------- Co-authored-by: Rachel Mackintosh <148898879+rachel-mack@users.noreply.github.com> (cherry picked from commit 3c73d8704151b2b9e1a3fe908fa54c2fd5fdae1c) --- source/aggregation-tutorials.txt | 1 + source/aggregation-tutorials/filtered-subset.txt | 1 + source/aggregation-tutorials/group-total.txt | 1 + source/aggregation-tutorials/multi-field-join.txt | 1 + source/aggregation-tutorials/one-to-one-join.txt | 1 + source/aggregation-tutorials/unpack-arrays.txt | 1 + source/connection-troubleshooting.txt | 1 + source/faq.txt | 3 +++ source/fundamentals.txt | 3 +++ source/fundamentals/aggregation.txt | 3 +++ source/fundamentals/authentication.txt | 3 +++ source/fundamentals/authentication/enterprise-mechanisms.txt | 1 + source/fundamentals/authentication/mechanisms.txt | 3 +++ source/fundamentals/bson.txt | 3 +++ source/fundamentals/bson/undefined-values.txt | 3 +++ source/fundamentals/bson/utf8-validation.txt | 3 +++ source/fundamentals/collations.txt | 3 +++ source/fundamentals/connection/connection-options.txt | 1 + source/fundamentals/connection/network-compression.txt | 3 +++ source/fundamentals/connection/socks.txt | 3 +++ source/fundamentals/connection/tls.txt | 1 + source/fundamentals/crud/compound-operations.txt | 1 + source/fundamentals/crud/query-document.txt | 3 +++ source/fundamentals/crud/read-operations/cursor.txt | 3 +++ source/fundamentals/crud/read-operations/geo.txt | 3 +++ source/fundamentals/crud/read-operations/limit.txt | 3 +++ source/fundamentals/crud/read-operations/project.txt | 3 +++ source/fundamentals/crud/read-operations/skip.txt | 3 +++ source/fundamentals/crud/read-operations/sort.txt | 3 +++ source/fundamentals/crud/read-operations/text.txt | 3 +++ source/fundamentals/crud/read-write-pref.txt | 1 + source/fundamentals/crud/write-operations/delete.txt | 3 +++ source/fundamentals/crud/write-operations/embedded-arrays.txt | 3 +++ source/fundamentals/crud/write-operations/insert.txt | 1 + source/fundamentals/crud/write-operations/modify.txt | 3 +++ source/fundamentals/crud/write-operations/pkFactory.txt | 3 +++ source/fundamentals/crud/write-operations/upsert.txt | 1 + source/fundamentals/encrypt-fields.txt | 1 + source/fundamentals/gridfs.txt | 1 + source/fundamentals/indexes.txt | 1 + source/fundamentals/logging.txt | 1 + source/fundamentals/monitoring.txt | 3 +++ source/fundamentals/monitoring/cluster-monitoring.txt | 1 + source/fundamentals/monitoring/command-monitoring.txt | 1 + source/fundamentals/monitoring/connection-monitoring.txt | 1 + source/fundamentals/promises.txt | 1 + source/fundamentals/run-command.txt | 3 +++ source/fundamentals/stable-api.txt | 1 + source/fundamentals/time-series.txt | 3 +++ source/fundamentals/transactions.txt | 1 + source/fundamentals/typescript.txt | 1 + source/issues-and-help.txt | 3 +++ source/quick-start/connect-to-mongodb.txt | 3 +++ source/quick-start/create-a-connection-string.txt | 3 +++ source/quick-start/create-a-deployment.txt | 3 +++ source/quick-start/download-and-install.txt | 3 +++ source/quick-start/next-steps.txt | 3 +++ source/upgrade.txt | 1 + source/usage-examples/bulkWrite.txt | 3 +++ source/usage-examples/changeStream.txt | 3 +++ source/usage-examples/command.txt | 1 + source/usage-examples/count.txt | 3 +++ source/usage-examples/delete-operations.txt | 3 +++ source/usage-examples/deleteMany.txt | 3 +++ source/usage-examples/deleteOne.txt | 3 +++ source/usage-examples/distinct.txt | 3 +++ source/usage-examples/insertMany.txt | 3 +++ source/usage-examples/replaceOne.txt | 3 +++ source/usage-examples/transaction-conv.txt | 3 +++ source/usage-examples/transaction-core.txt | 3 +++ source/usage-examples/transactions.txt | 3 +++ source/usage-examples/updateMany.txt | 3 +++ source/usage-examples/updateOne.txt | 3 +++ source/whats-new.txt | 1 + 74 files changed, 166 insertions(+) diff --git a/source/aggregation-tutorials.txt b/source/aggregation-tutorials.txt index 8feb8eee9..8b545467b 100644 --- a/source/aggregation-tutorials.txt +++ b/source/aggregation-tutorials.txt @@ -10,6 +10,7 @@ Aggregation Tutorials .. meta:: :keywords: node.js, code example, runnable app + :description: Explore step-by-step aggregation tutorials for common tasks using the MongoDB Node.js Driver, including setup instructions and runnable code examples. .. contents:: On this page :local: diff --git a/source/aggregation-tutorials/filtered-subset.txt b/source/aggregation-tutorials/filtered-subset.txt index 6ba0de3a8..9549a15eb 100644 --- a/source/aggregation-tutorials/filtered-subset.txt +++ b/source/aggregation-tutorials/filtered-subset.txt @@ -16,6 +16,7 @@ Filtered Subset .. meta:: :keywords: code example, node.js, sort, limit, aggregation + :description: Learn to use the MongoDB Node.js Driver to create an aggregation pipeline that filters, sorts, and formats a subset of documents in a MongoDB collection. Introduction ------------ diff --git a/source/aggregation-tutorials/group-total.txt b/source/aggregation-tutorials/group-total.txt index 9ba4e25ef..9bc66a784 100644 --- a/source/aggregation-tutorials/group-total.txt +++ b/source/aggregation-tutorials/group-total.txt @@ -16,6 +16,7 @@ Group and Total .. meta:: :keywords: code example, node.js, analyze, aggregation + :description: Learn to use the MongoDB Node.js Driver to construct an aggregation pipeline that groups and analyzes data. Introduction ------------ diff --git a/source/aggregation-tutorials/multi-field-join.txt b/source/aggregation-tutorials/multi-field-join.txt index 9ab6c4188..605676177 100644 --- a/source/aggregation-tutorials/multi-field-join.txt +++ b/source/aggregation-tutorials/multi-field-join.txt @@ -16,6 +16,7 @@ Multi-Field Join .. meta:: :keywords: code example, node.js, lookup, aggregation + :description: Learn to perform a multi-field join using the MongoDB Node.js Driver to combine data from two collections in an aggregation pipeline. Introduction ------------ diff --git a/source/aggregation-tutorials/one-to-one-join.txt b/source/aggregation-tutorials/one-to-one-join.txt index 6e946b055..e0b944a58 100644 --- a/source/aggregation-tutorials/one-to-one-join.txt +++ b/source/aggregation-tutorials/one-to-one-join.txt @@ -16,6 +16,7 @@ One-to-One Join .. meta:: :keywords: code example, node.js, lookup, aggregation + :description: Learn to perform a one-to-one join using the MongoDB Node.js Driver to combine data from two collections in an aggregation pipeline. Introduction ------------ diff --git a/source/aggregation-tutorials/unpack-arrays.txt b/source/aggregation-tutorials/unpack-arrays.txt index 0f0013e8c..392183452 100644 --- a/source/aggregation-tutorials/unpack-arrays.txt +++ b/source/aggregation-tutorials/unpack-arrays.txt @@ -16,6 +16,7 @@ Unpack Arrays and Group .. meta:: :keywords: code example, node.js, analyze, array + :description: Learn to use the MongoDB Node.js Driver to create an aggregation pipeline that unpacks arrays, filters, groups, and computes fields in MongoDB. Introduction ------------ diff --git a/source/connection-troubleshooting.txt b/source/connection-troubleshooting.txt index 04f10c5c6..db3f56544 100644 --- a/source/connection-troubleshooting.txt +++ b/source/connection-troubleshooting.txt @@ -10,6 +10,7 @@ Connection Troubleshooting .. meta:: :keywords: code example, node.js, disconnected, help + :description: Troubleshoot connection issues with the MongoDB Node.js Driver by checking connection strings, configuring firewalls, and adjusting settings like `maxPoolSize` and `connectTimeoutMS`. .. contents:: On this page :local: diff --git a/source/faq.txt b/source/faq.txt index 7467c93c3..c472fc187 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -4,6 +4,9 @@ FAQ === +.. meta:: + :description: Find answers to frequently asked questions about the MongoDB Node.js Driver, including connection pooling, timeouts, and handling network behavior. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals.txt b/source/fundamentals.txt index e307628cf..b5ef4e2ab 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -2,6 +2,9 @@ Fundamentals ============ +.. meta:: + :description: Explore tasks using the MongoDB Node.js Driver, including connecting, authenticating, reading, writing, and managing transactions in MongoDB. + .. default-domain:: mongodb .. toctree:: diff --git a/source/fundamentals/aggregation.txt b/source/fundamentals/aggregation.txt index 1ef5f1f7b..a158b589a 100644 --- a/source/fundamentals/aggregation.txt +++ b/source/fundamentals/aggregation.txt @@ -5,6 +5,9 @@ Aggregation =========== +.. meta:: + :description: Learn to use aggregation operations in the MongoDB Node.js Driver to create pipelines for data transformation and summarization. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt index f2b30c277..2a6c3ef6f 100644 --- a/source/fundamentals/authentication.txt +++ b/source/fundamentals/authentication.txt @@ -4,6 +4,9 @@ Authentication ============== +.. meta:: + :description: Authenticate using the MongoDB Node.js Driver with various supported authentication mechanisms. + .. default-domain:: mongodb .. toctree:: diff --git a/source/fundamentals/authentication/enterprise-mechanisms.txt b/source/fundamentals/authentication/enterprise-mechanisms.txt index 750b79934..a233a857d 100644 --- a/source/fundamentals/authentication/enterprise-mechanisms.txt +++ b/source/fundamentals/authentication/enterprise-mechanisms.txt @@ -16,6 +16,7 @@ Enterprise Authentication Mechanisms .. meta:: :keywords: ldap, encryption, principal, tls + :description: Explore sample code for connecting to MongoDB using enterprise authentication mechanisms like Kerberos, LDAP, and MONGODB-OIDC with the MongoDB Node.js Driver. In this guide, you can find sample code for connection to MongoDB with each authentication mechanism available in the MongoDB Enterprise Edition: diff --git a/source/fundamentals/authentication/mechanisms.txt b/source/fundamentals/authentication/mechanisms.txt index b4b6a681d..5ba01f5f1 100644 --- a/source/fundamentals/authentication/mechanisms.txt +++ b/source/fundamentals/authentication/mechanisms.txt @@ -4,6 +4,9 @@ Authentication Mechanisms ========================= +.. meta:: + :description: Explore sample code for connecting to MongoDB using various authentication mechanisms with the MongoDB Node.js Driver, including `SCRAM-SHA-256`, `SCRAM-SHA-1`, `MONGODB-CR`, `MONGODB-AWS`, and `X.509`. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/bson.txt b/source/fundamentals/bson.txt index 9d1b77b54..145f875b4 100644 --- a/source/fundamentals/bson.txt +++ b/source/fundamentals/bson.txt @@ -4,6 +4,9 @@ BSON Settings ============= +.. meta:: + :description: Configure BSON serialization settings in your application with the MongoDB Node.js Driver, including handling undefined values and UTF-8 validation. + .. toctree:: :caption: BSON settings diff --git a/source/fundamentals/bson/undefined-values.txt b/source/fundamentals/bson/undefined-values.txt index d1801ba0b..e1ebbef71 100644 --- a/source/fundamentals/bson/undefined-values.txt +++ b/source/fundamentals/bson/undefined-values.txt @@ -4,6 +4,9 @@ Undefined Values ================ +.. meta:: + :description: Learn to control the serialization of undefined values in MongoDB Node.js Driver by using the ignoreUndefined setting at various levels. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/bson/utf8-validation.txt b/source/fundamentals/bson/utf8-validation.txt index 1e2adc7a8..a31e7e72f 100644 --- a/source/fundamentals/bson/utf8-validation.txt +++ b/source/fundamentals/bson/utf8-validation.txt @@ -4,6 +4,9 @@ UTF-8 Validation ================ +.. meta:: + :description: Learn how to enable or disable UTF-8 validation in the MongoDB Node.js Driver to manage data encoding and processing overhead. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/collations.txt b/source/fundamentals/collations.txt index 66b4dd6a2..a4474eb21 100644 --- a/source/fundamentals/collations.txt +++ b/source/fundamentals/collations.txt @@ -4,6 +4,9 @@ Collations ========== +.. meta:: + :description: Learn how to use collations to apply specific sorting rules for string operations based on language and locale preferences with the MongoDB Node.js Driver. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/connection/connection-options.txt b/source/fundamentals/connection/connection-options.txt index 5958ed528..e0f4cb4ff 100644 --- a/source/fundamentals/connection/connection-options.txt +++ b/source/fundamentals/connection/connection-options.txt @@ -10,6 +10,7 @@ Connection Options .. meta:: :keywords: node.js, customize + :description: Explore connection and authentication options available in the MongoDB Node.js Driver, including settings for app name, authentication mechanisms, and TLS configurations. This section explains the MongoDB connection and authentication options supported by the {+driver-short+} that you can set within a ``MongoClientOptions`` instance. diff --git a/source/fundamentals/connection/network-compression.txt b/source/fundamentals/connection/network-compression.txt index 000c42ae1..a89579e5d 100644 --- a/source/fundamentals/connection/network-compression.txt +++ b/source/fundamentals/connection/network-compression.txt @@ -4,6 +4,9 @@ Network Compression =================== +.. meta:: + :description: Enable network compression in the MongoDB Node.js Driver to reduce data transfer using Snappy, Zlib, or Zstandard algorithms. + You can enable a driver option to compress messages, which reduces the amount of data passed over the network between MongoDB and your application. diff --git a/source/fundamentals/connection/socks.txt b/source/fundamentals/connection/socks.txt index 998d77a76..44b650a1b 100644 --- a/source/fundamentals/connection/socks.txt +++ b/source/fundamentals/connection/socks.txt @@ -4,6 +4,9 @@ Enable SOCKS5 Proxy Support =========================== +.. meta:: + :description: Learn how to connect to MongoDB using a SOCKS5 proxy by configuring the MongoDB Node.js Driver with the necessary proxy options. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/connection/tls.txt b/source/fundamentals/connection/tls.txt index 635140897..0a922e0de 100644 --- a/source/fundamentals/connection/tls.txt +++ b/source/fundamentals/connection/tls.txt @@ -10,6 +10,7 @@ Enable TLS on a Connection .. meta:: :keywords: code example, node.js, security, encrypt + :description: Learn how to connect to MongoDB instances with the MongoDB Node.js Driver by using TLS by enabling the TLS option and providing necessary certificates for secure connections. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/compound-operations.txt b/source/fundamentals/crud/compound-operations.txt index 5de5bc186..6dcc21da9 100644 --- a/source/fundamentals/crud/compound-operations.txt +++ b/source/fundamentals/crud/compound-operations.txt @@ -10,6 +10,7 @@ Compound Operations .. meta:: :keywords: node.js, atomic operation, read, write + :description: Explore how to perform compound operations with the MongoDB Node.js Driver by using methods like findOneAndDelete(), findOneAndUpdate(), and findOneAndReplace() for atomic read-write actions. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/query-document.txt b/source/fundamentals/crud/query-document.txt index 1e13e0f70..c5ce1852e 100644 --- a/source/fundamentals/crud/query-document.txt +++ b/source/fundamentals/crud/query-document.txt @@ -4,6 +4,9 @@ Specify a Query =============== +.. meta:: + :description: Learn how to use query documents with the MongoDB Node.js Driver by using comparison, logical, element, and evaluation operators to filter documents in a collection. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/cursor.txt b/source/fundamentals/crud/read-operations/cursor.txt index 3bacc9d96..d3360c592 100644 --- a/source/fundamentals/crud/read-operations/cursor.txt +++ b/source/fundamentals/crud/read-operations/cursor.txt @@ -4,6 +4,9 @@ Access Data From a Cursor ========================= +.. meta:: + :description: Access data from a cursor in the MongoDB Node.js Driver by using various paradigms like asynchronous iteration, manual iteration, and streaming, while managing resources with utility methods. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/geo.txt b/source/fundamentals/crud/read-operations/geo.txt index 2a17b7b55..8c5a29a6c 100644 --- a/source/fundamentals/crud/read-operations/geo.txt +++ b/source/fundamentals/crud/read-operations/geo.txt @@ -4,6 +4,9 @@ Search Geospatially =================== +.. meta:: + :description: Explore how to perform geospatial queries with the MongoDB Node.js Driver by using geospatial query operators with examples for both Earth-like sphere and 2D plane coordinate systems. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/limit.txt b/source/fundamentals/crud/read-operations/limit.txt index c728a2040..eb15c2694 100644 --- a/source/fundamentals/crud/read-operations/limit.txt +++ b/source/fundamentals/crud/read-operations/limit.txt @@ -4,6 +4,9 @@ Limit the Number of Returned Results ==================================== +.. meta:: + :description: Use the limit() method in the MongoDB Node.js Driver to cap the number of documents returned in a read operation, with examples of combining it with sort and skip options for pagination. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/project.txt b/source/fundamentals/crud/read-operations/project.txt index d1757b8a5..1f23bbc39 100644 --- a/source/fundamentals/crud/read-operations/project.txt +++ b/source/fundamentals/crud/read-operations/project.txt @@ -4,6 +4,9 @@ Specify Which Fields to Return ============================== +.. meta:: + :description: Use projections with the MongoDB Node.js Driver to control which fields are returned in query results, optimizing network bandwidth by including or excluding specific fields. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/skip.txt b/source/fundamentals/crud/read-operations/skip.txt index edb983124..07e6c2460 100644 --- a/source/fundamentals/crud/read-operations/skip.txt +++ b/source/fundamentals/crud/read-operations/skip.txt @@ -4,6 +4,9 @@ Skip Returned Results ===================== +.. meta:: + :description: Use the skip option in MongoDB Node.js Driver read operations to omit a specified number of documents from the beginning of the result set, often combined with the sort option for ordered results. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/sort.txt b/source/fundamentals/crud/read-operations/sort.txt index d67c6b437..889707126 100644 --- a/source/fundamentals/crud/read-operations/sort.txt +++ b/source/fundamentals/crud/read-operations/sort.txt @@ -4,6 +4,9 @@ Sort Results ============ +.. meta:: + :description: Use the sort function in the MongoDB Node.js Driver to order query results by specified fields and resolve ties with other fields. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/text.txt b/source/fundamentals/crud/read-operations/text.txt index ba70480bb..2eb869b33 100644 --- a/source/fundamentals/crud/read-operations/text.txt +++ b/source/fundamentals/crud/read-operations/text.txt @@ -4,6 +4,9 @@ Search Text =========== +.. meta:: + :description: Perform text searches with the MongoDB Node.js Driver using the $text operator to find documents with specified words or phrases, and sort results by relevance. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-write-pref.txt b/source/fundamentals/crud/read-write-pref.txt index 376f64530..6107e624c 100644 --- a/source/fundamentals/crud/read-write-pref.txt +++ b/source/fundamentals/crud/read-write-pref.txt @@ -10,6 +10,7 @@ Specify How CRUD Operations Run on Replica Sets .. meta:: :keywords: node.js, customize, preferences, replica set, consistency + :description: Learn to use the MongoDB Node.js Driver to configure write concern, read concern, and read preference for CRUD operations on replica sets to customize data consistency and availability. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/fundamentals/crud/write-operations/delete.txt index f17db955f..cfb8c374a 100644 --- a/source/fundamentals/crud/write-operations/delete.txt +++ b/source/fundamentals/crud/write-operations/delete.txt @@ -4,6 +4,9 @@ Delete Documents ================ +.. meta:: + :description: Learn how to use deleteOne() and deleteMany() methods in the MongoDB Node.js Driver to remove documents from a collection based on specified query criteria. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/write-operations/embedded-arrays.txt b/source/fundamentals/crud/write-operations/embedded-arrays.txt index e7672312f..668944b9e 100644 --- a/source/fundamentals/crud/write-operations/embedded-arrays.txt +++ b/source/fundamentals/crud/write-operations/embedded-arrays.txt @@ -4,6 +4,9 @@ Update Arrays in a Document =========================== +.. meta:: + :description: Learn how to use array update operators in the MongoDB Node.js Driver to modify embedded arrays in documents, including positional operators. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt index 91458c85a..d6da4aa81 100644 --- a/source/fundamentals/crud/write-operations/insert.txt +++ b/source/fundamentals/crud/write-operations/insert.txt @@ -10,6 +10,7 @@ Insert Documents .. meta:: :keywords: code example, node.js, add data + :description: Learn how to insert single or multiple documents into a MongoDB collection using the MongoDB Node.js Driver, with examples of handling unique _id constraints. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/modify.txt b/source/fundamentals/crud/write-operations/modify.txt index 5c841b28a..06624209d 100644 --- a/source/fundamentals/crud/write-operations/modify.txt +++ b/source/fundamentals/crud/write-operations/modify.txt @@ -4,6 +4,9 @@ Modify Documents ================ +.. meta:: + :description: Modify documents in a collection using update and replace operations in the MongoDB Node.js Driver using updateOne(), updateMany(), and replaceOne() methods. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/write-operations/pkFactory.txt b/source/fundamentals/crud/write-operations/pkFactory.txt index 504c91f67..37456e967 100644 --- a/source/fundamentals/crud/write-operations/pkFactory.txt +++ b/source/fundamentals/crud/write-operations/pkFactory.txt @@ -4,6 +4,9 @@ Generate Custom Values for ``_id`` ================================== +.. meta:: + :description: Learn how to use the MongoDB Node.js Driver to generate custom _id values with a primary key factory during insert operations. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/write-operations/upsert.txt b/source/fundamentals/crud/write-operations/upsert.txt index bab72e7b9..ad400ded8 100644 --- a/source/fundamentals/crud/write-operations/upsert.txt +++ b/source/fundamentals/crud/write-operations/upsert.txt @@ -10,6 +10,7 @@ Insert or Update in a Single Operation .. meta:: :keywords: code example, node.js, write, add data + :description: Streamline your application logic by using the upsert option in the MongoDB Node.js Driver to insert or update documents in a single operation based on their existence. .. contents:: On this page :local: diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index 4276460b8..63b79edfc 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -6,5 +6,6 @@ .. meta:: :keywords: node.js + :description: Encrypt specific document fields using in-use encryption with the MongoDB Node.js Driver to protect sensitive data before sending it to MongoDB. .. sharedinclude:: dbx/encrypt-fields.rst diff --git a/source/fundamentals/gridfs.txt b/source/fundamentals/gridfs.txt index 1b0f9db64..514f300b6 100644 --- a/source/fundamentals/gridfs.txt +++ b/source/fundamentals/gridfs.txt @@ -10,6 +10,7 @@ GridFS .. meta:: :keywords: node.js, code example, file storage + :description: Learn how to store and retrieve large files with the MongoDB Node.js Driver by using GridFS, including creating buckets, uploading, downloading, renaming, and deleting files. .. contents:: On this page :local: diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt index 6dd6c01f8..a01303115 100644 --- a/source/fundamentals/indexes.txt +++ b/source/fundamentals/indexes.txt @@ -10,6 +10,7 @@ Indexes .. meta:: :keywords: node.js, code example, Atlas search + :description: Explore how to create and manage various types of indexes with the MongoDB Node.js Driver to optimize query performance and support efficient data retrieval. .. contents:: On this page :local: diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt index 430d046ed..e2cde5919 100644 --- a/source/fundamentals/logging.txt +++ b/source/fundamentals/logging.txt @@ -10,6 +10,7 @@ Logging .. meta:: :keywords: code example, log, information, monitor + :description: Learn how to monitor and log MongoDB Node.js Driver events. .. contents:: On this page :local: diff --git a/source/fundamentals/monitoring.txt b/source/fundamentals/monitoring.txt index dde3dd3be..cd132fa24 100644 --- a/source/fundamentals/monitoring.txt +++ b/source/fundamentals/monitoring.txt @@ -2,6 +2,9 @@ Monitoring ========== +.. meta:: + :description: Explore cluster, command, and connection pool monitoring in the MongoDB Node.js Driver. + .. facet:: :name: genre :values: reference diff --git a/source/fundamentals/monitoring/cluster-monitoring.txt b/source/fundamentals/monitoring/cluster-monitoring.txt index d6206f288..a09f792c0 100644 --- a/source/fundamentals/monitoring/cluster-monitoring.txt +++ b/source/fundamentals/monitoring/cluster-monitoring.txt @@ -10,6 +10,7 @@ Cluster Monitoring .. meta:: :keywords: code example, node.js, watch + :description: Monitor topology events in a MongoDB instance, replica set, or sharded cluster by subscribing to Server Discovery and Monitoring (SDAM) events with the MongoDB Node.js Driver. .. contents:: On this page :local: diff --git a/source/fundamentals/monitoring/command-monitoring.txt b/source/fundamentals/monitoring/command-monitoring.txt index bbe431fdc..6ee286625 100644 --- a/source/fundamentals/monitoring/command-monitoring.txt +++ b/source/fundamentals/monitoring/command-monitoring.txt @@ -10,6 +10,7 @@ Command Monitoring .. meta:: :keywords: code example, node.js, watch, command status + :description: Monitor the success or failure of MongoDB commands by subscribing to command monitoring events in your application with the MongoDB Node.js Driver. .. contents:: On this page :local: diff --git a/source/fundamentals/monitoring/connection-monitoring.txt b/source/fundamentals/monitoring/connection-monitoring.txt index 3aa3789fa..0c00c65be 100644 --- a/source/fundamentals/monitoring/connection-monitoring.txt +++ b/source/fundamentals/monitoring/connection-monitoring.txt @@ -10,6 +10,7 @@ Connection Pool Monitoring .. meta:: :keywords: code example, node.js, watch, deployment + :description: Monitor the MongoDB Node.js Driver's connection pool by subscribing to connection pool events to understand and debug your application's connection behavior. .. contents:: On this page :local: diff --git a/source/fundamentals/promises.txt b/source/fundamentals/promises.txt index c20e0fc43..933ba6bbd 100644 --- a/source/fundamentals/promises.txt +++ b/source/fundamentals/promises.txt @@ -10,6 +10,7 @@ Promises .. meta:: :keywords: code example, node.js, operation status, chain + :description: Learn to use promises with the MongoDB Node.js Driver for asynchronous operations, including handling success and failure states, chaining, and using the await operation. .. contents:: On this page :local: diff --git a/source/fundamentals/run-command.txt b/source/fundamentals/run-command.txt index d8f27b2e3..4027e6700 100644 --- a/source/fundamentals/run-command.txt +++ b/source/fundamentals/run-command.txt @@ -4,6 +4,9 @@ Run a Command ============== +.. meta:: + :description: Learn how to execute database commands using the MongoDB Node.js Driver, including options and response handling. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/stable-api.txt b/source/fundamentals/stable-api.txt index e31969575..9bc4d7dac 100644 --- a/source/fundamentals/stable-api.txt +++ b/source/fundamentals/stable-api.txt @@ -10,6 +10,7 @@ .. meta:: :keywords: code example, node.js, safe, breaking change + :description: Learn how to use the Stable API feature with the MongoDB Node.js Driver to ensure operations are compatible with a specified API version, preventing backward compatibility issues. .. contents:: On this page :local: diff --git a/source/fundamentals/time-series.txt b/source/fundamentals/time-series.txt index 49b31da51..db1789766 100644 --- a/source/fundamentals/time-series.txt +++ b/source/fundamentals/time-series.txt @@ -2,6 +2,9 @@ Time Series =========== +.. meta:: + :description: Learn about creating and querying time series collections using the MongoDB Node.js Driver. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/transactions.txt b/source/fundamentals/transactions.txt index a2674023d..41e3c9214 100644 --- a/source/fundamentals/transactions.txt +++ b/source/fundamentals/transactions.txt @@ -10,6 +10,7 @@ Transactions .. meta:: :keywords: modify, customize + :description: Learn how to use the MongoDB Node.js Driver to perform transactions, ensuring atomicity and ACID compliance for multi-document operations. .. contents:: On this page :local: diff --git a/source/fundamentals/typescript.txt b/source/fundamentals/typescript.txt index f90f2976b..872c23de9 100644 --- a/source/fundamentals/typescript.txt +++ b/source/fundamentals/typescript.txt @@ -10,6 +10,7 @@ TypeScript .. meta:: :keywords: code example, node.js, static typing + :description: Explore using TypeScript with the MongoDB Node.js Driver, including type parameters, type safety, and handling the _id field. .. contents:: On this page :local: diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index fa2ea1369..f7db25cb2 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -4,6 +4,9 @@ Issues & Help ============= +.. meta:: + :description: Find support for MongoDB Node.js Driver issues through community forums, report bugs or request features in JIRA, and create pull requests to contribute. + .. default-domain:: mongodb Our developer community is vibrant and highly engaged, with extensive experience using Node.js with MongoDB. diff --git a/source/quick-start/connect-to-mongodb.txt b/source/quick-start/connect-to-mongodb.txt index 94f8b753a..45a2eb228 100644 --- a/source/quick-start/connect-to-mongodb.txt +++ b/source/quick-start/connect-to-mongodb.txt @@ -4,6 +4,9 @@ Connect to MongoDB ================== +.. meta:: + :description: Connect to MongoDB using the MongoDB Node.js Driver by creating an application, assigning a connection string, and running a query to retrieve data. + .. procedure:: :style: connected diff --git a/source/quick-start/create-a-connection-string.txt b/source/quick-start/create-a-connection-string.txt index 448f33519..cc580776c 100644 --- a/source/quick-start/create-a-connection-string.txt +++ b/source/quick-start/create-a-connection-string.txt @@ -4,6 +4,9 @@ Create a Connection String ========================== +.. meta:: + :description: Create a connection string for your MongoDB deployment by including the hostname, port, authentication mechanism, and user credentials. + You can connect to your MongoDB deployment by providing a **connection URI**, also called a *connection string*, which instructs the driver on how to connect to a MongoDB deployment diff --git a/source/quick-start/create-a-deployment.txt b/source/quick-start/create-a-deployment.txt index 2bd33caff..a1fade2f2 100644 --- a/source/quick-start/create-a-deployment.txt +++ b/source/quick-start/create-a-deployment.txt @@ -4,6 +4,9 @@ Create a MongoDB Deployment =========================== +.. meta:: + :description: Set up a free tier MongoDB deployment on Atlas, including creating an account, saving credentials, and loading sample data. + You can create a free tier MongoDB deployment on MongoDB Atlas to store and manage your data. MongoDB Atlas hosts and manages your MongoDB database in the cloud. diff --git a/source/quick-start/download-and-install.txt b/source/quick-start/download-and-install.txt index afd316859..76c22f2c6 100644 --- a/source/quick-start/download-and-install.txt +++ b/source/quick-start/download-and-install.txt @@ -4,6 +4,9 @@ Download and Install ==================== +.. meta:: + :description: Install Node.js and npm, create a project directory, and install the MongoDB Node.js Driver. + .. procedure:: :style: connected diff --git a/source/quick-start/next-steps.txt b/source/quick-start/next-steps.txt index f15672dff..55d656e6c 100644 --- a/source/quick-start/next-steps.txt +++ b/source/quick-start/next-steps.txt @@ -4,6 +4,9 @@ Next Steps ========== +.. meta:: + :description: Explore further resources to enhance your understanding of the MongoDB Node.js Driver, including CRUD operations and usage examples. + Congratulations on completing the quick start tutorial! In this tutorial, you created a Node.js application that diff --git a/source/upgrade.txt b/source/upgrade.txt index 05be1daac..c8c4d59f1 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -10,6 +10,7 @@ Upgrade Driver Versions .. meta:: :keywords: backwards compatibility, update + :description: Upgrade your MongoDB Node.js Driver version by ensuring compatibility, addressing breaking changes, and using the Stable API to minimize application modifications. .. contents:: On this page :local: diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt index ee09f89a0..07f6a9089 100644 --- a/source/usage-examples/bulkWrite.txt +++ b/source/usage-examples/bulkWrite.txt @@ -4,6 +4,9 @@ Perform Bulk Operations ======================= +.. meta:: + :description: Perform batch write operations using the bulkWrite() method in the MongoDB Node.js Driver to increase throughput and performance by reducing network round trips. + .. default-domain:: mongodb The ``bulkWrite()`` method performs batch write operations against a diff --git a/source/usage-examples/changeStream.txt b/source/usage-examples/changeStream.txt index 64bdd0d39..7d72a9479 100644 --- a/source/usage-examples/changeStream.txt +++ b/source/usage-examples/changeStream.txt @@ -4,6 +4,9 @@ Watch for Changes ================= +.. meta:: + :description: Monitor changes in MongoDB using the watch() method in the MongoDB Node.js Driver on collections, databases, or clients to open change streams and handle change events. + .. default-domain:: mongodb Open a Change Stream diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt index 855e98c87..971fe227d 100644 --- a/source/usage-examples/command.txt +++ b/source/usage-examples/command.txt @@ -6,6 +6,7 @@ .. meta:: :keywords: code example, multiple, modify, customize, debug + :description: Execute database commands using the command() method on a database instance with the MongoDB Node.js Driver. ===================== Run a Command Example diff --git a/source/usage-examples/count.txt b/source/usage-examples/count.txt index fa4f2c3b4..d995917fd 100644 --- a/source/usage-examples/count.txt +++ b/source/usage-examples/count.txt @@ -4,6 +4,9 @@ Count Documents =============== +.. meta:: + :description: Learn how to count documents in a collection by using the MongoDB Node.js Driver, with methods for both estimated and accurate counts. + The Node.js driver provides two methods for counting documents in a collection: diff --git a/source/usage-examples/delete-operations.txt b/source/usage-examples/delete-operations.txt index bc0a4ecb0..663fbbc68 100644 --- a/source/usage-examples/delete-operations.txt +++ b/source/usage-examples/delete-operations.txt @@ -2,6 +2,9 @@ Delete Operations ================= +.. meta:: + :description: Explore examples of deleting single or multiple documents using the MongoDB Node.js Driver. + .. default-domain:: mongodb .. toctree:: diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt index 8019cced3..761307040 100644 --- a/source/usage-examples/deleteMany.txt +++ b/source/usage-examples/deleteMany.txt @@ -4,6 +4,9 @@ Delete Multiple Documents ========================= +.. meta:: + :description: Delete multiple document in a collection with the MongoDB Node.js Driver by using the deleteMany() method with a query to specify which documents to remove. + .. default-domain:: mongodb You can delete multiple documents in a collection at once using the diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt index e06cffad6..693766a1a 100644 --- a/source/usage-examples/deleteOne.txt +++ b/source/usage-examples/deleteOne.txt @@ -4,6 +4,9 @@ Delete a Document ================= +.. meta:: + :description: Delete a single document from a collection with the MongoDB Node.js Driver by using the deleteOne() method with a query to match the document. + .. default-domain:: mongodb You can delete a single document in a collection with diff --git a/source/usage-examples/distinct.txt b/source/usage-examples/distinct.txt index 03ab182bd..428760081 100644 --- a/source/usage-examples/distinct.txt +++ b/source/usage-examples/distinct.txt @@ -4,6 +4,9 @@ Retrieve Distinct Values of a Field =================================== +.. meta:: + :description: Retrieve distinct values of a field in a collection using the distinct() method in the MongoDB Node.js Driver, with examples in JavaScript and TypeScript. + .. default-domain:: mongodb You can retrieve a list of distinct values for a field across a collection by using diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt index 5bf4fb43b..3b89cfa79 100644 --- a/source/usage-examples/insertMany.txt +++ b/source/usage-examples/insertMany.txt @@ -4,6 +4,9 @@ Insert Multiple Documents ========================= +.. meta:: + :description: Insert multiple documents into a collection using the insertMany() method in the MongoDB Node.js Driver. + .. default-domain:: mongodb You can insert multiple documents using the diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt index a0fb6d4b4..fc6d5ee3b 100644 --- a/source/usage-examples/replaceOne.txt +++ b/source/usage-examples/replaceOne.txt @@ -4,6 +4,9 @@ Replace a Document ================== +.. meta:: + :description: Replace a single document in a collection using the replaceOne() method in the MongoDB Node.js Driver, with options for upsert and error handling. + .. default-domain:: mongodb You can replace a single document using the diff --git a/source/usage-examples/transaction-conv.txt b/source/usage-examples/transaction-conv.txt index 1d42d6591..149f99146 100644 --- a/source/usage-examples/transaction-conv.txt +++ b/source/usage-examples/transaction-conv.txt @@ -4,6 +4,9 @@ Use the Convenient Transaction API ================================== +.. meta:: + :description: Perform a transaction using the Convenient Transaction API with the MongoDB Node.js Driver to update data atomically. + .. contents:: On this page :local: :backlinks: none diff --git a/source/usage-examples/transaction-core.txt b/source/usage-examples/transaction-core.txt index bc86f1343..0c2545325 100644 --- a/source/usage-examples/transaction-core.txt +++ b/source/usage-examples/transaction-core.txt @@ -4,6 +4,9 @@ Use the Core API ================ +.. meta:: + :description: Use the Core API with the MongoDB Node.js Driver to update multiple documents in a single transaction. + .. contents:: On this page :local: :backlinks: none diff --git a/source/usage-examples/transactions.txt b/source/usage-examples/transactions.txt index 1d57c11f2..79277686f 100644 --- a/source/usage-examples/transactions.txt +++ b/source/usage-examples/transactions.txt @@ -4,6 +4,9 @@ Perform a Transaction ===================== +.. meta:: + :description: Explore how to perform transactions using the MongoDB Node.js Driver with both the Convenient Transaction API and the Core API. + .. toctree:: :caption: Transaction Usage Examples diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt index 035933362..da6329293 100644 --- a/source/usage-examples/updateMany.txt +++ b/source/usage-examples/updateMany.txt @@ -4,6 +4,9 @@ Update Multiple Documents ========================= +.. meta:: + :description: Update multiple documents in a collection with the MongoDB Node.js Driver by using the updateMany() method with a filter. + .. default-domain:: mongodb You can update multiple documents using the diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt index f6787bfda..2034b693c 100644 --- a/source/usage-examples/updateOne.txt +++ b/source/usage-examples/updateOne.txt @@ -4,6 +4,9 @@ Update a Document ================= +.. meta:: + :description: Update a single document in a MongoDB collection with the in the MongoDB Node.js Driver by using the updateOne() method with options for upserting and handling exceptions. + .. default-domain:: mongodb You can update a single document using the diff --git a/source/whats-new.txt b/source/whats-new.txt index 92238047c..6afd11b7f 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -16,6 +16,7 @@ What's New .. meta:: :keywords: version, update, upgrade, backwards compatibility + :description: Discover the latest features and updates of the in the MongoDB Node.js Driver. Learn what's new in: