Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/aggregation-tutorials.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions source/aggregation-tutorials/filtered-subset.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
1 change: 1 addition & 0 deletions source/aggregation-tutorials/group-total.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
1 change: 1 addition & 0 deletions source/aggregation-tutorials/multi-field-join.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
1 change: 1 addition & 0 deletions source/aggregation-tutorials/one-to-one-join.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
1 change: 1 addition & 0 deletions source/aggregation-tutorials/unpack-arrays.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
1 change: 1 addition & 0 deletions source/connection-troubleshooting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

.. 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`.

Check failure on line 13 in source/connection-troubleshooting.txt

View workflow job for this annotation

GitHub Actions / vale

[vale] source/connection-troubleshooting.txt#L13

[MongoDB.CommaOxford] Use the Oxford comma in 'js Driver by checking connection strings, configuring firewalls, and adjusting settings like `maxPoolSize` and '.
Raw output
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in 'js Driver by checking connection strings, configuring firewalls, and adjusting settings like `maxPoolSize` and '.", "location": {"path": "source/connection-troubleshooting.txt", "range": {"start": {"line": 13, "column": 71}}}, "severity": "ERROR"}

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/authentication.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Authentication
==============

.. meta::
:description: Authenticate using the MongoDB Node.js Driver with various supported authentication mechanisms.

.. default-domain:: mongodb

.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/authentication/mechanisms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/bson.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/bson/undefined-values.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/bson/utf8-validation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/collations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/connection/connection-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/connection/network-compression.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/connection/socks.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/connection/tls.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/compound-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/query-document.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/cursor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/geo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/limit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/project.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/skip.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/sort.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/text.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/read-write-pref.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

.. 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.

Check failure on line 13 in source/fundamentals/crud/read-write-pref.txt

View workflow job for this annotation

GitHub Actions / vale

[vale] source/fundamentals/crud/read-write-pref.txt#L13

[MongoDB.CommaOxford] Use the Oxford comma in 'js Driver to configure write concern, read concern, and read preference for CRUD operations on replica sets to customize data consistency and '.
Raw output
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in 'js Driver to configure write concern, read concern, and read preference for CRUD operations on replica sets to customize data consistency and '.", "location": {"path": "source/fundamentals/crud/read-write-pref.txt", "range": {"start": {"line": 13, "column": 48}}}, "severity": "ERROR"}

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/write-operations/delete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/write-operations/embedded-arrays.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/write-operations/insert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/write-operations/modify.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/write-operations/pkFactory.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/write-operations/upsert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/encrypt-fields.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions source/fundamentals/gridfs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/logging.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/monitoring/cluster-monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

.. 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.

Check failure on line 13 in source/fundamentals/monitoring/cluster-monitoring.txt

View workflow job for this annotation

GitHub Actions / vale

[vale] source/fundamentals/monitoring/cluster-monitoring.txt#L13

[MongoDB.CommaOxford] Use the Oxford comma in ' Monitor topology events in a MongoDB instance, replica set, or sharded cluster by subscribing to Server Discovery and '.
Raw output
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in ' Monitor topology events in a MongoDB instance, replica set, or sharded cluster by subscribing to Server Discovery and '.", "location": {"path": "source/fundamentals/monitoring/cluster-monitoring.txt", "range": {"start": {"line": 13, "column": 17}}}, "severity": "ERROR"}

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/monitoring/command-monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading
Loading