From dc6f436339e10b9bd0d1f008ad1fd91bb590850a Mon Sep 17 00:00:00 2001 From: Nick Larew Date: Thu, 10 Apr 2025 17:39:13 -0500 Subject: [PATCH 1/3] Add missing meta descriptions --- source/compatibility.txt | 3 +++ source/connection-troubleshooting.txt | 1 + source/faq.txt | 1 + source/fundamentals.txt | 3 +++ source/fundamentals/aggregation.txt | 3 +++ source/fundamentals/auth.txt | 3 +++ source/fundamentals/bson.txt | 1 + source/fundamentals/collations.txt | 3 +++ source/fundamentals/connections.txt | 3 +++ source/fundamentals/connections/network-compression.txt | 3 +++ source/fundamentals/connections/tls.txt | 1 + source/fundamentals/context.txt | 1 + source/fundamentals/crud.txt | 3 +++ source/fundamentals/crud/compound-operations.txt | 3 +++ source/fundamentals/crud/read-operations/changestream.txt | 1 + source/fundamentals/crud/read-operations/count.txt | 3 +++ source/fundamentals/crud/read-operations/cursor.txt | 1 + source/fundamentals/crud/read-operations/distinct.txt | 1 + source/fundamentals/crud/read-operations/limit.txt | 1 + source/fundamentals/crud/read-operations/project.txt | 1 + source/fundamentals/crud/read-operations/query-document.txt | 3 +++ source/fundamentals/crud/read-operations/retrieve.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/write-operations/bulk.txt | 3 +++ 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 | 1 + source/fundamentals/crud/write-operations/upsert.txt | 1 + source/fundamentals/crud/write-read-pref.txt | 1 + source/fundamentals/encrypt-fields.txt | 1 + source/fundamentals/enterprise-auth.txt | 1 + source/fundamentals/geo.txt | 1 + source/fundamentals/gridfs.txt | 1 + source/fundamentals/indexes.txt | 1 + source/fundamentals/logging.txt | 3 +++ 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/run-command.txt | 3 +++ source/fundamentals/stable-api.txt | 3 +++ source/fundamentals/time-series.txt | 3 +++ source/fundamentals/transactions.txt | 1 + source/issues-and-help.txt | 1 + source/quick-reference.txt | 3 +++ source/quick-start.txt | 1 + source/usage-examples.txt | 1 + source/usage-examples/bulkWrite.txt | 3 +++ source/usage-examples/command.txt | 3 +++ source/usage-examples/count.txt | 3 +++ source/usage-examples/deleteMany.txt | 3 +++ source/usage-examples/deleteOne.txt | 3 +++ source/usage-examples/distinct.txt | 3 +++ source/usage-examples/find.txt | 3 +++ source/usage-examples/findOne.txt | 3 +++ source/usage-examples/insertMany.txt | 3 +++ source/usage-examples/insertOne.txt | 3 +++ source/usage-examples/replaceOne.txt | 3 +++ source/usage-examples/struct-tagging.txt | 3 +++ source/usage-examples/updateMany.txt | 3 +++ source/usage-examples/updateOne.txt | 3 +++ source/whats-new.txt | 1 + 65 files changed, 141 insertions(+) diff --git a/source/compatibility.txt b/source/compatibility.txt index 8db5224e..3333cc07 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -4,6 +4,9 @@ Compatibility ============= +.. meta:: + :description: Check the recommended MongoDB Go Driver versions for compatibility with different MongoDB server versions. + .. contents:: On this page :local: :backlinks: none diff --git a/source/connection-troubleshooting.txt b/source/connection-troubleshooting.txt index b57a040b..a9be4458 100644 --- a/source/connection-troubleshooting.txt +++ b/source/connection-troubleshooting.txt @@ -10,6 +10,7 @@ Connection Troubleshooting .. meta:: :keywords: code example, disconnected, deployment + :description: Troubleshoot connection issues with the MongoDB Go Driver by verifying connection strings, authentication mechanisms, and firewall settings. .. contents:: On this page :local: diff --git a/source/faq.txt b/source/faq.txt index 53635b18..98db3d60 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -10,6 +10,7 @@ FAQ .. meta:: :keywords: code example, connection error, question, help + :description: Find answers to common questions about the Go driver, including connection pooling, error handling, and BSON to JSON conversion. .. contents:: On this page :local: diff --git a/source/fundamentals.txt b/source/fundamentals.txt index c395aa5a..c8a07a54 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -2,6 +2,9 @@ Fundamentals ============ +.. meta:: + :description: Explore tasks like connecting to MongoDB, performing transactions, and working with BSON using the Go driver. + .. toctree:: :titlesonly: :maxdepth: 1 diff --git a/source/fundamentals/aggregation.txt b/source/fundamentals/aggregation.txt index 79255109..fccb3357 100644 --- a/source/fundamentals/aggregation.txt +++ b/source/fundamentals/aggregation.txt @@ -4,6 +4,9 @@ Aggregation =========== +.. meta:: + :description: Explore how to use aggregation operations in the MongoDB Go Driver, including examples of grouping, sorting, and filtering data in collections. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/auth.txt b/source/fundamentals/auth.txt index cbe84f8d..810cd2a0 100644 --- a/source/fundamentals/auth.txt +++ b/source/fundamentals/auth.txt @@ -4,6 +4,9 @@ Authentication Mechanisms ========================= +.. meta:: + :description: Learn how to use various authentication mechanisms with the Go driver for MongoDB, including SCRAM, 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 c003b632..950c8119 100644 --- a/source/fundamentals/bson.txt +++ b/source/fundamentals/bson.txt @@ -16,6 +16,7 @@ Work with BSON .. meta:: :keywords: code examples, serialization + :description: Learn how the Go driver handles BSON data conversion, including marshalling and unmarshalling, and how to use struct tags and BSON options. Overview -------- diff --git a/source/fundamentals/collations.txt b/source/fundamentals/collations.txt index 27ac42e9..1a2380b1 100644 --- a/source/fundamentals/collations.txt +++ b/source/fundamentals/collations.txt @@ -4,6 +4,9 @@ Collations ========== +.. meta:: + :description: Learn how to use collations in MongoDB to order query results by string values according to specific language and locale conventions. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/connections.txt b/source/fundamentals/connections.txt index 7dce48a8..6d3dace3 100644 --- a/source/fundamentals/connections.txt +++ b/source/fundamentals/connections.txt @@ -4,6 +4,9 @@ Connections =========== +.. meta:: + :description: Explore how to configure connections to a MongoDB deployment using the Go driver, including options for TLS and network compression. + .. toctree:: Connection Guide diff --git a/source/fundamentals/connections/network-compression.txt b/source/fundamentals/connections/network-compression.txt index 6ce2c47d..435a47db 100644 --- a/source/fundamentals/connections/network-compression.txt +++ b/source/fundamentals/connections/network-compression.txt @@ -4,6 +4,9 @@ Network Compression =================== +.. meta:: + :description: Learn how to enable network compression in the Go driver for MongoDB using Snappy, Zlib, or Zstandard algorithms to reduce data transfer. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/connections/tls.txt b/source/fundamentals/connections/tls.txt index d8b3b9bd..96ca46ca 100644 --- a/source/fundamentals/connections/tls.txt +++ b/source/fundamentals/connections/tls.txt @@ -10,6 +10,7 @@ Enable and Configure TLS .. meta:: :keywords: code example, security, connection options + :description: Learn how to secure your MongoDB connection using TLS by enabling TLS options and configuring certificates in your Go application. .. contents:: On this page :local: diff --git a/source/fundamentals/context.txt b/source/fundamentals/context.txt index 310c4cab..b2487b0d 100644 --- a/source/fundamentals/context.txt +++ b/source/fundamentals/context.txt @@ -10,6 +10,7 @@ Context .. meta:: :keywords: code example, unblock + :description: Learn how to use the context package in Go to manage timeouts and cancellations for blocking method calls in the MongoDB Go driver. .. contents:: On this page :local: diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index a2d4642d..dca24ca5 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -4,6 +4,9 @@ CRUD Operations =============== +.. meta:: + :description: Explore how to perform CRUD operations in MongoDB using the Go driver, including creating, reading, updating, and deleting documents. + .. toctree:: :caption: CRUD Operations diff --git a/source/fundamentals/crud/compound-operations.txt b/source/fundamentals/crud/compound-operations.txt index 26e5712c..e2a95cb8 100644 --- a/source/fundamentals/crud/compound-operations.txt +++ b/source/fundamentals/crud/compound-operations.txt @@ -4,6 +4,9 @@ Compound Operations =================== +.. meta:: + :description: Learn how to perform compound operations in MongoDB using Go, combining read and write actions into a single atomic operation to prevent data alteration. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/read-operations/changestream.txt b/source/fundamentals/crud/read-operations/changestream.txt index d104a959..13c8d553 100644 --- a/source/fundamentals/crud/read-operations/changestream.txt +++ b/source/fundamentals/crud/read-operations/changestream.txt @@ -11,6 +11,7 @@ Monitor Data Changes .. meta:: :keywords: code example, delta + :description: Learn how to monitor document changes in MongoDB using change streams, including opening streams and modifying output with pipelines and options. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/read-operations/count.txt b/source/fundamentals/crud/read-operations/count.txt index 7f43e7c1..6c1ce856 100644 --- a/source/fundamentals/crud/read-operations/count.txt +++ b/source/fundamentals/crud/read-operations/count.txt @@ -4,6 +4,9 @@ Count Documents =============== +.. meta:: + :description: Learn to count documents in a MongoDB collection using Go, including accurate, estimated, and aggregation-based methods. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/read-operations/cursor.txt b/source/fundamentals/crud/read-operations/cursor.txt index 70eff598..9bedf310 100644 --- a/source/fundamentals/crud/read-operations/cursor.txt +++ b/source/fundamentals/crud/read-operations/cursor.txt @@ -10,6 +10,7 @@ Access Data From a Cursor .. meta:: :keywords: code example, read operation, see results, iterate + :description: Learn to access data using a cursor in Go, including retrieving documents individually or in batches, and closing the cursor to free resources. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/read-operations/distinct.txt b/source/fundamentals/crud/read-operations/distinct.txt index d0124762..c409602b 100644 --- a/source/fundamentals/crud/read-operations/distinct.txt +++ b/source/fundamentals/crud/read-operations/distinct.txt @@ -10,6 +10,7 @@ Retrieve Distinct Values .. meta:: :keywords: read operation, code example + :description: Learn how to retrieve distinct values for a specified field in a collection using the `Distinct()` method in Go. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/read-operations/limit.txt b/source/fundamentals/crud/read-operations/limit.txt index be0b683d..9d377b7f 100644 --- a/source/fundamentals/crud/read-operations/limit.txt +++ b/source/fundamentals/crud/read-operations/limit.txt @@ -10,6 +10,7 @@ Limit the Number of Returned Results .. meta:: :keywords: read operation, code example, pipeline, customize output + :description: Learn how to limit the number of documents returned in MongoDB read operations using the Go driver, including examples with sorting and aggregation. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/read-operations/project.txt b/source/fundamentals/crud/read-operations/project.txt index 2ba832c9..f5740538 100644 --- a/source/fundamentals/crud/read-operations/project.txt +++ b/source/fundamentals/crud/read-operations/project.txt @@ -10,6 +10,7 @@ Specify Which Fields to Return .. meta:: :keywords: read, code example, pipeline stage, customize output + :description: Learn how to specify which fields to return in MongoDB documents using projections in Go, including examples for including or excluding fields. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/read-operations/query-document.txt b/source/fundamentals/crud/read-operations/query-document.txt index 255cbc7e..18c3bac0 100644 --- a/source/fundamentals/crud/read-operations/query-document.txt +++ b/source/fundamentals/crud/read-operations/query-document.txt @@ -4,6 +4,9 @@ Specify a Query =============== +.. meta:: + :description: Learn how to specify queries in Go to match subsets of documents using filters, operators, and various criteria. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt index ded9cbdc..b794d8bd 100644 --- a/source/fundamentals/crud/read-operations/retrieve.txt +++ b/source/fundamentals/crud/read-operations/retrieve.txt @@ -4,6 +4,9 @@ Retrieve Data ============== +.. meta:: + :description: Learn how to retrieve data from MongoDB collections using read operations, including find and aggregation methods, with examples in Go. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/read-operations/skip.txt b/source/fundamentals/crud/read-operations/skip.txt index 9fc6ac34..260cb309 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: Learn how to skip a specified number of results in MongoDB read operations using the `SetSkip()` method or the `$skip` stage in aggregation pipelines. + .. 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 7f2b7a8e..a6f99671 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: Learn how to sort query results in Go using ascending or descending order, handle ties, and apply sorting in aggregation pipelines. + .. 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 46f71126..b5cf3417 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: Learn how to perform text searches in MongoDB using Go, including creating text indexes and sorting results by relevance. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/write-operations/bulk.txt b/source/fundamentals/crud/write-operations/bulk.txt index 63756523..e7968957 100644 --- a/source/fundamentals/crud/write-operations/bulk.txt +++ b/source/fundamentals/crud/write-operations/bulk.txt @@ -4,6 +4,9 @@ Bulk Operations =============== +.. meta:: + :description: Learn to perform bulk write operations in Go, including inserts, updates, replacements, and deletions, using the BulkWrite method. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/fundamentals/crud/write-operations/delete.txt index 634bb525..a94c0f41 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 remove documents from MongoDB collections using delete operations like `DeleteOne()` and `DeleteMany()`, with examples and options. + .. 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 d8b920af..0e57b733 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 update array elements in MongoDB documents using positional operators and the `FindOneAndUpdate()` method in Go. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt index b8e9221e..4c9e1b8d 100644 --- a/source/fundamentals/crud/write-operations/insert.txt +++ b/source/fundamentals/crud/write-operations/insert.txt @@ -10,6 +10,7 @@ Insert a Document .. meta:: :keywords: code example, write operation, add data + :description: Learn how to insert documents into a MongoDB collection using the `InsertOne()` and `InsertMany()` methods, with options to modify their behavior. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/modify.txt b/source/fundamentals/crud/write-operations/modify.txt index e093e944..3e3ca89e 100644 --- a/source/fundamentals/crud/write-operations/modify.txt +++ b/source/fundamentals/crud/write-operations/modify.txt @@ -10,6 +10,7 @@ Modify Documents .. meta:: :keywords: code example, write operation, change data + :description: Learn how to modify MongoDB documents using update and replace operations, including methods like `UpdateOne()`, `UpdateMany()`, and `ReplaceOne()`. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/upsert.txt b/source/fundamentals/crud/write-operations/upsert.txt index 865a2971..f9dc2949 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, write, add data + :description: Learn how to perform an upsert in MongoDB using Go, which updates existing documents or inserts new ones if no match is found. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-read-pref.txt b/source/fundamentals/crud/write-read-pref.txt index 26c171e2..62847b1c 100644 --- a/source/fundamentals/crud/write-read-pref.txt +++ b/source/fundamentals/crud/write-read-pref.txt @@ -10,6 +10,7 @@ Modify Execution of CRUD Operations .. meta:: :keywords: code example, replica set, consistency + :description: Learn how to modify CRUD operations in the MongoDB Go Driver using write concern, read concern, and read preference configurations for replica sets. .. contents:: On this page :local: diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index 4c6b15bb..ec3e2fab 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -6,5 +6,6 @@ .. meta:: :keywords: privacy, security + :description: Use the Go driver to encrypt document fields with in-use encryption, protecting sensitive data like credit card numbers and health information. .. sharedinclude:: dbx/encrypt-fields.rst \ No newline at end of file diff --git a/source/fundamentals/enterprise-auth.txt b/source/fundamentals/enterprise-auth.txt index 39c8bd3a..a2b1a3ae 100644 --- a/source/fundamentals/enterprise-auth.txt +++ b/source/fundamentals/enterprise-auth.txt @@ -10,6 +10,7 @@ Enterprise Authentication Mechanisms .. meta:: :keywords: security, code example, credentials + :description: Learn how to authenticate in MongoDB using Enterprise Edition mechanisms like GSSAPI/Kerberos and LDAP, with examples for Go driver integration. .. contents:: On this page :local: diff --git a/source/fundamentals/geo.txt b/source/fundamentals/geo.txt index 79fc0260..474e4113 100644 --- a/source/fundamentals/geo.txt +++ b/source/fundamentals/geo.txt @@ -10,6 +10,7 @@ Work with Geospatial Data .. meta:: :keywords: code example, coordinates, location, geographic + :description: Learn to work with geospatial data in MongoDB using GeoJSON and legacy formats, create geospatial indexes, and perform queries with the Go driver. .. contents:: On this page :local: diff --git a/source/fundamentals/gridfs.txt b/source/fundamentals/gridfs.txt index 53c6efe8..87ef7449 100644 --- a/source/fundamentals/gridfs.txt +++ b/source/fundamentals/gridfs.txt @@ -10,6 +10,7 @@ GridFS .. meta:: :keywords: code example, large files, storage, images + :description: Learn how to store and retrieve large files in MongoDB using GridFS, which splits files into chunks and manages them in a bucket for efficient access. .. contents:: On this page :local: diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt index 4f56f4ee..92768652 100644 --- a/source/fundamentals/indexes.txt +++ b/source/fundamentals/indexes.txt @@ -10,6 +10,7 @@ Indexes .. meta:: :keywords: code example + :description: Learn how to use indexes in the MongoDB Go Driver to improve query performance and support various operations like updates and deletes. .. contents:: On this page :local: diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt index fde4ef1c..bef91d51 100644 --- a/source/fundamentals/logging.txt +++ b/source/fundamentals/logging.txt @@ -4,6 +4,9 @@ Logging ======= +.. meta:: + :description: Configure logging in your Go application using the MongoDB driver to record events, set severity levels, and integrate custom or third-party loggers. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/monitoring.txt b/source/fundamentals/monitoring.txt index ceb1c1e6..0b47891d 100644 --- a/source/fundamentals/monitoring.txt +++ b/source/fundamentals/monitoring.txt @@ -4,6 +4,9 @@ Monitoring ========== +.. meta:: + :description: Explore monitoring techniques for cluster configuration, command execution, and connection pool changes in Go. + .. toctree:: :caption: Monitoring categories diff --git a/source/fundamentals/monitoring/cluster-monitoring.txt b/source/fundamentals/monitoring/cluster-monitoring.txt index 48335547..f50d67ec 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, server, topology + :description: Monitor topology events in MongoDB using the Go driver to track cluster changes, assess health, and perform capacity planning by subscribing to SDAM events. .. contents:: On this page :local: diff --git a/source/fundamentals/monitoring/command-monitoring.txt b/source/fundamentals/monitoring/command-monitoring.txt index bdbd1d88..046a3a0a 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, operation + :description: Learn to monitor MongoDB command events using the Go driver to track query performance and resolve bottlenecks. .. contents:: On this page :local: diff --git a/source/fundamentals/monitoring/connection-monitoring.txt b/source/fundamentals/monitoring/connection-monitoring.txt index 319f737e..f384074f 100644 --- a/source/fundamentals/monitoring/connection-monitoring.txt +++ b/source/fundamentals/monitoring/connection-monitoring.txt @@ -10,6 +10,7 @@ Connection Monitoring .. meta:: :keywords: code example, performance, monitor + :description: Monitor the Go driver's connection pool by subscribing to connection pool events to optimize performance and understand the client lifecycle. .. contents:: On this page :local: diff --git a/source/fundamentals/run-command.txt b/source/fundamentals/run-command.txt index 89f9b055..c36a1721 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 Go driver, including methods for running commands and handling responses. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/stable-api.txt b/source/fundamentals/stable-api.txt index 64943fc7..46b853b8 100644 --- a/source/fundamentals/stable-api.txt +++ b/source/fundamentals/stable-api.txt @@ -4,6 +4,9 @@ {+stable-api+} ============== +.. meta:: + :description: Learn how to specify Stable API compatibility in the MongoDB Go Driver to ensure operations align with a defined API version. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/time-series.txt b/source/fundamentals/time-series.txt index b8503fd3..d0bae4d2 100644 --- a/source/fundamentals/time-series.txt +++ b/source/fundamentals/time-series.txt @@ -4,6 +4,9 @@ Time Series Collections ======================= +.. meta:: + :description: Learn how to create and query time series collections using the MongoDB Go Driver, including setting up time fields and checking collection creation. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/transactions.txt b/source/fundamentals/transactions.txt index e7ab7329..1b00bc57 100644 --- a/source/fundamentals/transactions.txt +++ b/source/fundamentals/transactions.txt @@ -10,6 +10,7 @@ Transactions .. meta:: :keywords: code example, rollback, undo operation + :description: Learn to perform transactions using the MongoDB Go Driver, including creating sessions, starting transactions, and committing multi-document operations. .. contents:: On this page :local: diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index 506808fb..e057119d 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -10,6 +10,7 @@ Issues & Help .. meta:: :keywords: suggestion, github + :description: Find support for the Go driver through community forums, report bugs or feature requests via JIRA, and contribute with pull requests following guidelines. We are lucky to have a vibrant MongoDB Go community that includes users with varying levels of experience using the Go driver. We find the quickest diff --git a/source/quick-reference.txt b/source/quick-reference.txt index bb313fdf..530c5ba6 100644 --- a/source/quick-reference.txt +++ b/source/quick-reference.txt @@ -4,6 +4,9 @@ Quick Reference =============== +.. meta:: + :description: Explore Go driver syntax for MongoDB commands, including find, insert, update, delete, and more, with links to API documentation and usage examples. + .. default-domain:: mongodb This page shows the driver syntax for several MongoDB commands and links to diff --git a/source/quick-start.txt b/source/quick-start.txt index c0463e54..c09e609b 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -16,6 +16,7 @@ Go Driver Quick Start .. meta:: :keywords: tutorial, get started, code example + :description: Learn to connect a Go application to a MongoDB Atlas cluster using the MongoDB Go Driver, including setting up a project, creating a cluster, and running queries. .. include:: /includes/quick-start/overview.rst diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 96c879e4..a1a82df0 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -16,6 +16,7 @@ Usage Examples .. meta:: :keywords: read, write, example, code example + :description: Explore Go usage examples for common MongoDB operations, including finding, inserting, updating, and deleting documents, as well as monitoring data changes. .. toctree:: diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt index d4158b33..14346bb1 100644 --- a/source/usage-examples/bulkWrite.txt +++ b/source/usage-examples/bulkWrite.txt @@ -4,6 +4,9 @@ Perform Bulk Operations ======================= +.. meta:: + :description: Perform bulk write operations on a collection using the `BulkWrite()` method in Go, including replace and update actions. + You can perform bulk write operations on a collection by using the ``BulkWrite()`` method. diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt index 7a4d1bd4..955deba8 100644 --- a/source/usage-examples/command.txt +++ b/source/usage-examples/command.txt @@ -4,6 +4,9 @@ Run a Command Example ===================== +.. meta:: + :description: Learn how to execute commands on a MongoDB server using the `RunCommand()` method in Go, with an example retrieving database statistics. + .. default-domain:: mongodb You can run commands directly on your MongoDB server by using the diff --git a/source/usage-examples/count.txt b/source/usage-examples/count.txt index 2167ebbc..3746f7cd 100644 --- a/source/usage-examples/count.txt +++ b/source/usage-examples/count.txt @@ -4,6 +4,9 @@ Count Documents Method Example ============================== +.. meta:: + :description: Learn to use `EstimatedDocumentCount()` and `CountDocuments()` methods in Go to approximate and count documents in a MongoDB collection. + You can get an approximation on the number of documents in a collection by using the ``EstimatedDocumentCount()`` method and an exact number of documents in a collection by using the ``CountDocuments()`` diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt index 3a28233a..78cc389d 100644 --- a/source/usage-examples/deleteMany.txt +++ b/source/usage-examples/deleteMany.txt @@ -4,6 +4,9 @@ Delete Multiple Documents ========================= +.. meta:: + :description: Learn how to delete multiple documents from a collection using the `DeleteMany()` method in Go. + .. default-domain:: mongodb You can delete multiple documents in a collection by using the diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt index cc8c3824..5e1040f4 100644 --- a/source/usage-examples/deleteOne.txt +++ b/source/usage-examples/deleteOne.txt @@ -4,6 +4,9 @@ Delete a Document ================= +.. meta:: + :description: Learn how to delete a document from a collection using the `DeleteOne()` method in Go, demonstrated with a `movies` collection example. + You can delete a document in a collection by using the ``DeleteOne()`` method. diff --git a/source/usage-examples/distinct.txt b/source/usage-examples/distinct.txt index 5c056700..f61c7d3a 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 Go, demonstrated with a `movies` collection example. + You can retrieve a list of distinct values for a field across a collection by using the ``Distinct()`` method. diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt index c8a10c8b..459f7a3b 100644 --- a/source/usage-examples/find.txt +++ b/source/usage-examples/find.txt @@ -4,6 +4,9 @@ Find Multiple Documents ======================= +.. meta:: + :description: Find multiple documents in a collection using the `Find()` method in Go, filtering by specific criteria like cuisine type. + You can find multiple documents in a collection by using the ``Find()`` method. diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt index 95a97d50..7d68ddce 100644 --- a/source/usage-examples/findOne.txt +++ b/source/usage-examples/findOne.txt @@ -4,6 +4,9 @@ Find a Document =============== +.. meta:: + :description: Retrieve a single document from a collection using the `FindOne()` method in Go, with an example filtering by restaurant name. + .. default-domain:: mongodb You can retrieve a single document from a collection by using the diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt index 443dab70..4fdb5580 100644 --- a/source/usage-examples/insertMany.txt +++ b/source/usage-examples/insertMany.txt @@ -4,6 +4,9 @@ Insert Multiple Documents ========================= +.. meta:: + :description: Learn how to insert multiple documents into a MongoDB collection using the `InsertMany()` method in Go. + .. default-domain:: mongodb You can insert multiple documents into a collection by using the ``InsertMany()`` diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt index c4eff808..e0666001 100644 --- a/source/usage-examples/insertOne.txt +++ b/source/usage-examples/insertOne.txt @@ -4,6 +4,9 @@ Insert a Document Example ========================= +.. meta:: + :description: Learn how to insert a document into a MongoDB collection using the `InsertOne()` method in Go, with an example using a `Restaurant` struct. + .. default-domain:: mongodb You can insert a document into a collection by using the ``InsertOne()`` diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt index c92b09ef..c188e027 100644 --- a/source/usage-examples/replaceOne.txt +++ b/source/usage-examples/replaceOne.txt @@ -4,6 +4,9 @@ Replace a Document ================== +.. meta:: + :description: Learn how to replace a document in a MongoDB collection using the `ReplaceOne()` method with a Go example. + .. default-domain:: mongodb You can replace a document in a collection by using the ``ReplaceOne()`` diff --git a/source/usage-examples/struct-tagging.txt b/source/usage-examples/struct-tagging.txt index 5810fa9d..44ccd2f8 100644 --- a/source/usage-examples/struct-tagging.txt +++ b/source/usage-examples/struct-tagging.txt @@ -4,6 +4,9 @@ Use Struct Tags =============== +.. meta:: + :description: Learn how to use struct tags in Go to control BSON field names when inserting documents with the Go Driver. + You can specify the way that the Go Driver converts Go structs to :manual:`BSON ` by using struct tags. diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt index 97a81bee..c18b20d0 100644 --- a/source/usage-examples/updateMany.txt +++ b/source/usage-examples/updateMany.txt @@ -4,6 +4,9 @@ Update Multiple Documents ========================= +.. meta:: + :description: Learn how to update multiple documents in a collection using the `UpdateMany()` method in Go, with an example that adjusts prices in a specific market. + You can update multiple documents in a collection by using the ``UpdateMany()`` method. diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt index dfb37c87..c4a432d4 100644 --- a/source/usage-examples/updateOne.txt +++ b/source/usage-examples/updateOne.txt @@ -4,6 +4,9 @@ Update a Document ================= +.. meta:: + :description: Learn how to update a document in a collection using the `UpdateOne()` method in Go, including adding a new field to a matched document. + You can update a document in a collection by using the ``UpdateOne()`` method. diff --git a/source/whats-new.txt b/source/whats-new.txt index 0d2b3e9f..9d060341 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -16,6 +16,7 @@ What's New .. meta:: :keywords: update, backward compatibility + :description: Discover the latest updates and features in the Go driver, including OpenID Connect support, streamlined APIs, and improved error handling in version 2.0. .. tip:: Release Notes From 11cb1e5e50d7e91a952550d09bbd3b2b97c16326 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh <148898879+rachel-mack@users.noreply.github.com> Date: Mon, 14 Apr 2025 10:19:06 -0400 Subject: [PATCH 2/3] Apply suggestions from code review --- source/fundamentals/crud/read-operations/distinct.txt | 2 +- source/fundamentals/crud/read-operations/retrieve.txt | 2 +- source/fundamentals/crud/read-operations/skip.txt | 2 +- source/fundamentals/crud/read-operations/sort.txt | 2 +- source/fundamentals/crud/read-operations/text.txt | 2 +- source/fundamentals/crud/write-operations/bulk.txt | 2 +- source/fundamentals/crud/write-operations/delete.txt | 2 +- source/fundamentals/crud/write-operations/embedded-arrays.txt | 2 +- source/fundamentals/crud/write-operations/insert.txt | 2 +- source/fundamentals/crud/write-operations/modify.txt | 2 +- source/fundamentals/gridfs.txt | 2 +- source/fundamentals/logging.txt | 2 +- source/fundamentals/monitoring/connection-monitoring.txt | 2 +- source/fundamentals/run-command.txt | 2 +- source/issues-and-help.txt | 2 +- source/usage-examples/bulkWrite.txt | 2 +- source/usage-examples/command.txt | 2 +- source/usage-examples/count.txt | 2 +- source/usage-examples/deleteMany.txt | 2 +- source/usage-examples/deleteOne.txt | 2 +- source/usage-examples/distinct.txt | 2 +- source/usage-examples/find.txt | 2 +- source/usage-examples/findOne.txt | 2 +- source/usage-examples/insertMany.txt | 2 +- source/usage-examples/insertOne.txt | 2 +- source/usage-examples/replaceOne.txt | 2 +- source/usage-examples/struct-tagging.txt | 2 +- source/usage-examples/updateMany.txt | 2 +- source/usage-examples/updateOne.txt | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) diff --git a/source/fundamentals/crud/read-operations/distinct.txt b/source/fundamentals/crud/read-operations/distinct.txt index c409602b..36d599e9 100644 --- a/source/fundamentals/crud/read-operations/distinct.txt +++ b/source/fundamentals/crud/read-operations/distinct.txt @@ -10,7 +10,7 @@ Retrieve Distinct Values .. meta:: :keywords: read operation, code example - :description: Learn how to retrieve distinct values for a specified field in a collection using the `Distinct()` method in Go. + :description: Learn how to retrieve distinct values for a specified field in a collection using the Distinct() method in Go. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt index b794d8bd..48fc0d30 100644 --- a/source/fundamentals/crud/read-operations/retrieve.txt +++ b/source/fundamentals/crud/read-operations/retrieve.txt @@ -5,7 +5,7 @@ Retrieve Data ============== .. meta:: - :description: Learn how to retrieve data from MongoDB collections using read operations, including find and aggregation methods, with examples in Go. + :description: Learn how to retrieve data by using MongoDB Go Driver read operations, including find and aggregation methods. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/read-operations/skip.txt b/source/fundamentals/crud/read-operations/skip.txt index 260cb309..9458460f 100644 --- a/source/fundamentals/crud/read-operations/skip.txt +++ b/source/fundamentals/crud/read-operations/skip.txt @@ -5,7 +5,7 @@ Skip Returned Results ===================== .. meta:: - :description: Learn how to skip a specified number of results in MongoDB read operations using the `SetSkip()` method or the `$skip` stage in aggregation pipelines. + :description: Learn how to skip a specified number of results in MongoDB read operations using the setSkip() method or the $skip stage in aggregation pipelines. .. default-domain:: mongodb diff --git a/source/fundamentals/crud/read-operations/sort.txt b/source/fundamentals/crud/read-operations/sort.txt index a6f99671..a3fba2c5 100644 --- a/source/fundamentals/crud/read-operations/sort.txt +++ b/source/fundamentals/crud/read-operations/sort.txt @@ -5,7 +5,7 @@ Sort Results ============ .. meta:: - :description: Learn how to sort query results in Go using ascending or descending order, handle ties, and apply sorting in aggregation pipelines. + :description: Learn how to sort query results, handle ties, and apply sorting in aggregation pipelines with the MongoDB Go Driver. .. default-domain:: mongodb diff --git a/source/fundamentals/crud/read-operations/text.txt b/source/fundamentals/crud/read-operations/text.txt index b5cf3417..38505737 100644 --- a/source/fundamentals/crud/read-operations/text.txt +++ b/source/fundamentals/crud/read-operations/text.txt @@ -5,7 +5,7 @@ Search Text =========== .. meta:: - :description: Learn how to perform text searches in MongoDB using Go, including creating text indexes and sorting results by relevance. + :description: Learn how to perform text searches with the MongoDB Go Driver, including creating text indexes and sorting results by relevance. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/bulk.txt b/source/fundamentals/crud/write-operations/bulk.txt index e7968957..9f79301e 100644 --- a/source/fundamentals/crud/write-operations/bulk.txt +++ b/source/fundamentals/crud/write-operations/bulk.txt @@ -5,7 +5,7 @@ Bulk Operations =============== .. meta:: - :description: Learn to perform bulk write operations in Go, including inserts, updates, replacements, and deletions, using the BulkWrite method. + :description: Learn to perform bulk write operations with the MongoDB Go Driver, including inserts, updates, replacements, and deletions, using the bulkWrite() method. .. default-domain:: mongodb diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/fundamentals/crud/write-operations/delete.txt index a94c0f41..2d075d50 100644 --- a/source/fundamentals/crud/write-operations/delete.txt +++ b/source/fundamentals/crud/write-operations/delete.txt @@ -5,7 +5,7 @@ Delete Documents ================ .. meta:: - :description: Learn how to remove documents from MongoDB collections using delete operations like `DeleteOne()` and `DeleteMany()`, with examples and options. + :description: Learn how to remove documents from collections with the deleteOne() and deleteMany() methods in the MongoDB Go Driver, with examples and options. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/embedded-arrays.txt b/source/fundamentals/crud/write-operations/embedded-arrays.txt index 0e57b733..724394fd 100644 --- a/source/fundamentals/crud/write-operations/embedded-arrays.txt +++ b/source/fundamentals/crud/write-operations/embedded-arrays.txt @@ -5,7 +5,7 @@ Update Arrays in a Document =========================== .. meta:: - :description: Learn how to update array elements in MongoDB documents using positional operators and the `FindOneAndUpdate()` method in Go. + :description: Learn how to update array elements in documents using positional operators and the findOneAndUpdate() method in the MongoDB Go Driver. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt index 4c9e1b8d..581d8326 100644 --- a/source/fundamentals/crud/write-operations/insert.txt +++ b/source/fundamentals/crud/write-operations/insert.txt @@ -10,7 +10,7 @@ Insert a Document .. meta:: :keywords: code example, write operation, add data - :description: Learn how to insert documents into a MongoDB collection using the `InsertOne()` and `InsertMany()` methods, with options to modify their behavior. + :description: Learn how to insert documents into a MongoDB collection using the insertOne() and insertMany() methods, with options to modify their behavior. .. contents:: On this page :local: diff --git a/source/fundamentals/crud/write-operations/modify.txt b/source/fundamentals/crud/write-operations/modify.txt index 3e3ca89e..6f021206 100644 --- a/source/fundamentals/crud/write-operations/modify.txt +++ b/source/fundamentals/crud/write-operations/modify.txt @@ -10,7 +10,7 @@ Modify Documents .. meta:: :keywords: code example, write operation, change data - :description: Learn how to modify MongoDB documents using update and replace operations, including methods like `UpdateOne()`, `UpdateMany()`, and `ReplaceOne()`. + :description: Learn how to modify MongoDB documents using update and replace operations, including methods like updateOne(), updateMany(), and replaceOne(). .. contents:: On this page :local: diff --git a/source/fundamentals/gridfs.txt b/source/fundamentals/gridfs.txt index 87ef7449..35ad5391 100644 --- a/source/fundamentals/gridfs.txt +++ b/source/fundamentals/gridfs.txt @@ -10,7 +10,7 @@ GridFS .. meta:: :keywords: code example, large files, storage, images - :description: Learn how to store and retrieve large files in MongoDB using GridFS, which splits files into chunks and manages them in a bucket for efficient access. + :description: Learn how to store and retrieve large files in the MongoDB Go Driver using GridFS, which splits files into chunks and manages them in a bucket for efficient access. .. contents:: On this page :local: diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt index bef91d51..04a80f01 100644 --- a/source/fundamentals/logging.txt +++ b/source/fundamentals/logging.txt @@ -5,7 +5,7 @@ Logging ======= .. meta:: - :description: Configure logging in your Go application using the MongoDB driver to record events, set severity levels, and integrate custom or third-party loggers. + :description: Configure logging in your Go application using the MongoDB Go Driver to record events, set severity levels, and integrate custom or third-party loggers. .. contents:: On this page :local: diff --git a/source/fundamentals/monitoring/connection-monitoring.txt b/source/fundamentals/monitoring/connection-monitoring.txt index f384074f..f09d9c31 100644 --- a/source/fundamentals/monitoring/connection-monitoring.txt +++ b/source/fundamentals/monitoring/connection-monitoring.txt @@ -10,7 +10,7 @@ Connection Monitoring .. meta:: :keywords: code example, performance, monitor - :description: Monitor the Go driver's connection pool by subscribing to connection pool events to optimize performance and understand the client lifecycle. + :description: Monitor the Mongo DB Go Driver's connection pool by subscribing to connection pool events to optimize performance and understand the client lifecycle. .. contents:: On this page :local: diff --git a/source/fundamentals/run-command.txt b/source/fundamentals/run-command.txt index c36a1721..e1cafd68 100644 --- a/source/fundamentals/run-command.txt +++ b/source/fundamentals/run-command.txt @@ -5,7 +5,7 @@ Run a Command ============= .. meta:: - :description: Learn how to execute database commands using the Go driver, including methods for running commands and handling responses. + :description: Learn how to execute database commands using the MongoDB Go Driver, including methods for running commands and handling responses. .. contents:: On this page :local: diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index e057119d..39902616 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -10,7 +10,7 @@ Issues & Help .. meta:: :keywords: suggestion, github - :description: Find support for the Go driver through community forums, report bugs or feature requests via JIRA, and contribute with pull requests following guidelines. + :description: Find support for the MongoDB Go Driver through community forums, report bugs or feature requests via JIRA, and create pull requests to contribute. We are lucky to have a vibrant MongoDB Go community that includes users with varying levels of experience using the Go driver. We find the quickest diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt index 14346bb1..8a21d761 100644 --- a/source/usage-examples/bulkWrite.txt +++ b/source/usage-examples/bulkWrite.txt @@ -5,7 +5,7 @@ Perform Bulk Operations ======================= .. meta:: - :description: Perform bulk write operations on a collection using the `BulkWrite()` method in Go, including replace and update actions. + :description: Perform bulk write operations on a collection using the bulkWrite() method in the MongoDB Go Driver, including replace and update actions. You can perform bulk write operations on a collection by using the ``BulkWrite()`` method. diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt index 955deba8..82bcecce 100644 --- a/source/usage-examples/command.txt +++ b/source/usage-examples/command.txt @@ -5,7 +5,7 @@ Run a Command Example ===================== .. meta:: - :description: Learn how to execute commands on a MongoDB server using the `RunCommand()` method in Go, with an example retrieving database statistics. + :description: Learn how to execute commands on a MongoDB server using the runCommand() method in Go, with an example retrieving database statistics. .. default-domain:: mongodb diff --git a/source/usage-examples/count.txt b/source/usage-examples/count.txt index 3746f7cd..7bbb821a 100644 --- a/source/usage-examples/count.txt +++ b/source/usage-examples/count.txt @@ -5,7 +5,7 @@ Count Documents Method Example ============================== .. meta:: - :description: Learn to use `EstimatedDocumentCount()` and `CountDocuments()` methods in Go to approximate and count documents in a MongoDB collection. + :description: Learn to use estimatedDocumentCount() and countDocuments() methods in the MongoDB Go Driver to approximate and count documents in a collection. You can get an approximation on the number of documents in a collection by using the ``EstimatedDocumentCount()`` method and an exact diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt index 78cc389d..05984844 100644 --- a/source/usage-examples/deleteMany.txt +++ b/source/usage-examples/deleteMany.txt @@ -5,7 +5,7 @@ Delete Multiple Documents ========================= .. meta:: - :description: Learn how to delete multiple documents from a collection using the `DeleteMany()` method in Go. + :description: Learn how to delete multiple documents from a collection using the deleteMany() method in the MongoDB Go Driver. .. default-domain:: mongodb diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt index 5e1040f4..bd0baba3 100644 --- a/source/usage-examples/deleteOne.txt +++ b/source/usage-examples/deleteOne.txt @@ -5,7 +5,7 @@ Delete a Document ================= .. meta:: - :description: Learn how to delete a document from a collection using the `DeleteOne()` method in Go, demonstrated with a `movies` collection example. + :description: Learn how to delete a document from a collection using the deleteOne() method in the MongoDB Go Driver. You can delete a document in a collection by using the ``DeleteOne()`` method. diff --git a/source/usage-examples/distinct.txt b/source/usage-examples/distinct.txt index f61c7d3a..cb3ec1af 100644 --- a/source/usage-examples/distinct.txt +++ b/source/usage-examples/distinct.txt @@ -5,7 +5,7 @@ Retrieve Distinct Values of a Field =================================== .. meta:: - :description: Retrieve distinct values of a field in a collection using the `Distinct()` method in Go, demonstrated with a `movies` collection example. + :description: Retrieve distinct values of a field in a collection using the distinct() method in the MongoDB Go Driver. You can retrieve a list of distinct values for a field across a collection by using the ``Distinct()`` method. diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt index 459f7a3b..2a4c27fe 100644 --- a/source/usage-examples/find.txt +++ b/source/usage-examples/find.txt @@ -5,7 +5,7 @@ Find Multiple Documents ======================= .. meta:: - :description: Find multiple documents in a collection using the `Find()` method in Go, filtering by specific criteria like cuisine type. + :description: Find multiple documents in a collection using the find() method in the MongoDB Go Driver. You can find multiple documents in a collection by using the ``Find()`` method. diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt index 7d68ddce..4d0e9737 100644 --- a/source/usage-examples/findOne.txt +++ b/source/usage-examples/findOne.txt @@ -5,7 +5,7 @@ Find a Document =============== .. meta:: - :description: Retrieve a single document from a collection using the `FindOne()` method in Go, with an example filtering by restaurant name. + :description: Retrieve a single document from a collection using the findOne() method in the MongoDB Go Driver. .. default-domain:: mongodb diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt index 4fdb5580..87550ff9 100644 --- a/source/usage-examples/insertMany.txt +++ b/source/usage-examples/insertMany.txt @@ -5,7 +5,7 @@ Insert Multiple Documents ========================= .. meta:: - :description: Learn how to insert multiple documents into a MongoDB collection using the `InsertMany()` method in Go. + :description: Learn how to insert multiple documents into a collection using the insertMany() method in the MongoDB Go Driver. .. default-domain:: mongodb diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt index e0666001..25cae79e 100644 --- a/source/usage-examples/insertOne.txt +++ b/source/usage-examples/insertOne.txt @@ -5,7 +5,7 @@ Insert a Document Example ========================= .. meta:: - :description: Learn how to insert a document into a MongoDB collection using the `InsertOne()` method in Go, with an example using a `Restaurant` struct. + :description: Learn how to insert a document into a collection using the insertOne() method in the MongoDB Go Driver. .. default-domain:: mongodb diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt index c188e027..953dc92a 100644 --- a/source/usage-examples/replaceOne.txt +++ b/source/usage-examples/replaceOne.txt @@ -5,7 +5,7 @@ Replace a Document ================== .. meta:: - :description: Learn how to replace a document in a MongoDB collection using the `ReplaceOne()` method with a Go example. + :description: Learn how to replace a document in a MongoDB collection using the replaceOne() method with the MongoDB Go Driver. .. default-domain:: mongodb diff --git a/source/usage-examples/struct-tagging.txt b/source/usage-examples/struct-tagging.txt index 44ccd2f8..40a82b24 100644 --- a/source/usage-examples/struct-tagging.txt +++ b/source/usage-examples/struct-tagging.txt @@ -5,7 +5,7 @@ Use Struct Tags =============== .. meta:: - :description: Learn how to use struct tags in Go to control BSON field names when inserting documents with the Go Driver. + :description: Learn how to use struct tags in Go to control BSON field names when inserting documents with the MongoDB Go Driver. You can specify the way that the Go Driver converts Go structs to :manual:`BSON ` by using struct tags. diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt index c18b20d0..eb2a2e4f 100644 --- a/source/usage-examples/updateMany.txt +++ b/source/usage-examples/updateMany.txt @@ -5,7 +5,7 @@ Update Multiple Documents ========================= .. meta:: - :description: Learn how to update multiple documents in a collection using the `UpdateMany()` method in Go, with an example that adjusts prices in a specific market. + :description: Learn how to update multiple documents in a collection using the updateMany() method in the MongoDB Go Driver. You can update multiple documents in a collection by using the ``UpdateMany()`` method. diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt index c4a432d4..919fb98c 100644 --- a/source/usage-examples/updateOne.txt +++ b/source/usage-examples/updateOne.txt @@ -5,7 +5,7 @@ Update a Document ================= .. meta:: - :description: Learn how to update a document in a collection using the `UpdateOne()` method in Go, including adding a new field to a matched document. + :description: Learn how to update a document in a collection using the updateOne() method in the MongoDB Go Driver. You can update a document in a collection by using the ``UpdateOne()`` method. From d17fce5ee7e39aa431a117aa011fb9bebf533b68 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh <148898879+rachel-mack@users.noreply.github.com> Date: Mon, 14 Apr 2025 10:27:53 -0400 Subject: [PATCH 3/3] Apply suggestions from code review --- source/faq.txt | 2 +- source/fundamentals.txt | 2 +- source/fundamentals/auth.txt | 2 +- source/fundamentals/bson.txt | 2 +- source/fundamentals/connections.txt | 2 +- source/fundamentals/connections/network-compression.txt | 2 +- source/fundamentals/crud.txt | 2 +- source/fundamentals/crud/read-operations/limit.txt | 2 +- source/fundamentals/encrypt-fields.txt | 2 +- source/fundamentals/enterprise-auth.txt | 2 +- source/fundamentals/geo.txt | 2 +- source/fundamentals/monitoring/cluster-monitoring.txt | 2 +- source/quick-reference.txt | 2 +- source/whats-new.txt | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 98db3d60..c38a73e8 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -10,7 +10,7 @@ FAQ .. meta:: :keywords: code example, connection error, question, help - :description: Find answers to common questions about the Go driver, including connection pooling, error handling, and BSON to JSON conversion. + :description: Find answers to common questions about the MongoDB Go Driver, including connection pooling, error handling, and BSON to JSON conversion. .. contents:: On this page :local: diff --git a/source/fundamentals.txt b/source/fundamentals.txt index c8a07a54..98e30700 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -3,7 +3,7 @@ Fundamentals ============ .. meta:: - :description: Explore tasks like connecting to MongoDB, performing transactions, and working with BSON using the Go driver. + :description: Explore tasks like connecting to MongoDB, performing transactions, and working with BSON using the MongoDB Go Driver. .. toctree:: :titlesonly: diff --git a/source/fundamentals/auth.txt b/source/fundamentals/auth.txt index 810cd2a0..eda165ad 100644 --- a/source/fundamentals/auth.txt +++ b/source/fundamentals/auth.txt @@ -5,7 +5,7 @@ Authentication Mechanisms ========================= .. meta:: - :description: Learn how to use various authentication mechanisms with the Go driver for MongoDB, including SCRAM, MONGODB-AWS, and X.509. + :description: Learn how to use various authentication mechanisms with the MongoDB Go Driver, including SCRAM, MONGODB-AWS, and X.509. .. contents:: On this page :local: diff --git a/source/fundamentals/bson.txt b/source/fundamentals/bson.txt index 950c8119..2cadcb55 100644 --- a/source/fundamentals/bson.txt +++ b/source/fundamentals/bson.txt @@ -16,7 +16,7 @@ Work with BSON .. meta:: :keywords: code examples, serialization - :description: Learn how the Go driver handles BSON data conversion, including marshalling and unmarshalling, and how to use struct tags and BSON options. + :description: Learn how the MongoDB Go Driver handles BSON data conversion, including marshalling and unmarshalling, and how to use struct tags and BSON options. Overview -------- diff --git a/source/fundamentals/connections.txt b/source/fundamentals/connections.txt index 6d3dace3..7bb9145e 100644 --- a/source/fundamentals/connections.txt +++ b/source/fundamentals/connections.txt @@ -5,7 +5,7 @@ Connections =========== .. meta:: - :description: Explore how to configure connections to a MongoDB deployment using the Go driver, including options for TLS and network compression. + :description: Explore how to configure connections to a MongoDB deployment using the MongoDB Go Driver, including options for TLS and network compression. .. toctree:: diff --git a/source/fundamentals/connections/network-compression.txt b/source/fundamentals/connections/network-compression.txt index 435a47db..ae9285ae 100644 --- a/source/fundamentals/connections/network-compression.txt +++ b/source/fundamentals/connections/network-compression.txt @@ -5,7 +5,7 @@ Network Compression =================== .. meta:: - :description: Learn how to enable network compression in the Go driver for MongoDB using Snappy, Zlib, or Zstandard algorithms to reduce data transfer. + :description: Learn how to enable network compression in the MongoDB Go Driver for MongoDB using Snappy, Zlib, or Zstandard algorithms to reduce data transfer. .. contents:: On this page :local: diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index dca24ca5..3fcff3c9 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -5,7 +5,7 @@ CRUD Operations =============== .. meta:: - :description: Explore how to perform CRUD operations in MongoDB using the Go driver, including creating, reading, updating, and deleting documents. + :description: Explore how to perform CRUD operations using the MongoDB Go Driver, including creating, reading, updating, and deleting documents. .. toctree:: :caption: CRUD Operations diff --git a/source/fundamentals/crud/read-operations/limit.txt b/source/fundamentals/crud/read-operations/limit.txt index 9d377b7f..226c97fd 100644 --- a/source/fundamentals/crud/read-operations/limit.txt +++ b/source/fundamentals/crud/read-operations/limit.txt @@ -10,7 +10,7 @@ Limit the Number of Returned Results .. meta:: :keywords: read operation, code example, pipeline, customize output - :description: Learn how to limit the number of documents returned in MongoDB read operations using the Go driver, including examples with sorting and aggregation. + :description: Learn how to limit the number of documents returned in read operations using the MongoDB Go Driver, including examples with sorting and aggregation. .. contents:: On this page :local: diff --git a/source/fundamentals/encrypt-fields.txt b/source/fundamentals/encrypt-fields.txt index ec3e2fab..a6acd45b 100644 --- a/source/fundamentals/encrypt-fields.txt +++ b/source/fundamentals/encrypt-fields.txt @@ -6,6 +6,6 @@ .. meta:: :keywords: privacy, security - :description: Use the Go driver to encrypt document fields with in-use encryption, protecting sensitive data like credit card numbers and health information. + :description: Use the MongoDB Go Driver to encrypt document fields with in-use encryption, protecting sensitive data like credit card numbers and health information. .. sharedinclude:: dbx/encrypt-fields.rst \ No newline at end of file diff --git a/source/fundamentals/enterprise-auth.txt b/source/fundamentals/enterprise-auth.txt index a2b1a3ae..1bd2e585 100644 --- a/source/fundamentals/enterprise-auth.txt +++ b/source/fundamentals/enterprise-auth.txt @@ -10,7 +10,7 @@ Enterprise Authentication Mechanisms .. meta:: :keywords: security, code example, credentials - :description: Learn how to authenticate in MongoDB using Enterprise Edition mechanisms like GSSAPI/Kerberos and LDAP, with examples for Go driver integration. + :description: Learn how to authenticate with the MongoDB Go Driver using Enterprise Edition mechanisms like GSSAPI/Kerberos and LDAP, with examples. .. contents:: On this page :local: diff --git a/source/fundamentals/geo.txt b/source/fundamentals/geo.txt index 474e4113..74450e0c 100644 --- a/source/fundamentals/geo.txt +++ b/source/fundamentals/geo.txt @@ -10,7 +10,7 @@ Work with Geospatial Data .. meta:: :keywords: code example, coordinates, location, geographic - :description: Learn to work with geospatial data in MongoDB using GeoJSON and legacy formats, create geospatial indexes, and perform queries with the Go driver. + :description: Learn to work with geospatial data in the MongoDB Go Driver using GeoJSON and legacy formats, create geospatial indexes, and perform queries. .. contents:: On this page :local: diff --git a/source/fundamentals/monitoring/cluster-monitoring.txt b/source/fundamentals/monitoring/cluster-monitoring.txt index f50d67ec..8bc1441a 100644 --- a/source/fundamentals/monitoring/cluster-monitoring.txt +++ b/source/fundamentals/monitoring/cluster-monitoring.txt @@ -10,7 +10,7 @@ Cluster Monitoring .. meta:: :keywords: code example, server, topology - :description: Monitor topology events in MongoDB using the Go driver to track cluster changes, assess health, and perform capacity planning by subscribing to SDAM events. + :description: Monitor topology events with the MongoDB Go Driver to track cluster changes, assess health, and perform capacity planning by subscribing to SDAM events. .. contents:: On this page :local: diff --git a/source/quick-reference.txt b/source/quick-reference.txt index 530c5ba6..93a7cc37 100644 --- a/source/quick-reference.txt +++ b/source/quick-reference.txt @@ -5,7 +5,7 @@ Quick Reference =============== .. meta:: - :description: Explore Go driver syntax for MongoDB commands, including find, insert, update, delete, and more, with links to API documentation and usage examples. + :description: Explore with the MongoDB Go Driver syntax for various commands, including find, insert, update, delete, and more, with links to API documentation and usage examples. .. default-domain:: mongodb diff --git a/source/whats-new.txt b/source/whats-new.txt index 9d060341..76bd0106 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -16,7 +16,7 @@ What's New .. meta:: :keywords: update, backward compatibility - :description: Discover the latest updates and features in the Go driver, including OpenID Connect support, streamlined APIs, and improved error handling in version 2.0. + :description: Discover the latest updates and features in the with the MongoDB Go Driver, including OpenID Connect support, streamlined APIs, and improved error handling in version 2.0. .. tip:: Release Notes