From db00ac46847563f7d32beb1dd4ecbf18531fd15e Mon Sep 17 00:00:00 2001 From: Bailey Pearson Date: Mon, 3 Jun 2024 15:33:01 -0600 Subject: [PATCH] docs: remove 6.8+ documentation from 6.7 API docs (#4127) --- docs/6.7/index.html | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/docs/6.7/index.html b/docs/6.7/index.html index 4261eff3fc..96ccca71ab 100644 --- a/docs/6.7/index.html +++ b/docs/6.7/index.html @@ -66,15 +66,6 @@

mongodb

HISTORY.md -

Release Integrity

The GitHub release contains a detached signature file for the NPM package (named -mongodb-X.Y.Z.tgz.sig).

-

The following command returns the link npm package.

-
npm view mongodb@vX.Y.Z dist.tarball 
-
-

Using the result of the above command, a curl command can return the official npm package for the release.

-

To verify the integrity of the downloaded package, run the following command:

-
gpg --verify mongodb-X.Y.Z.tgz.sig mongodb-X.Y.Z.tgz
-

Bugs / Feature Requests

Think you’ve found a bug? Want to see a new feature in node-mongodb-native? Please open a case in our issue management tool, JIRA:

-
const { MongoClient } = require('mongodb');
// or as an es module:
// import { MongoClient } from 'mongodb'

// Connection URL
const url = 'mongodb://localhost:27017';
const client = new MongoClient(url);

// Database Name
const dbName = 'myProject';

async function main() {
  // Use connect method to connect to the server
  await client.connect();
  console.log('Connected successfully to server');
  const db = client.db(dbName);
  const collection = db.collection('documents');

  // the following code examples can be pasted here...

  return 'done.';
}

main()
  .then(console.log)
  .catch(console.error)
  .finally(() => client.close());
+
const { MongoClient } = require('mongodb');
// or as an es module:
// import { MongoClient } from 'mongodb'

// Connection URL
const url = 'mongodb://localhost:27017';
const client = new MongoClient(url);

// Database Name
const dbName = 'myProject';

async function main() {
  // Use connect method to connect to the server
  await client.connect();
  console.log('Connected successfully to server');
  const db = client.db(dbName);
  const collection = db.collection('documents');

  // the following code examples can be pasted here...

  return 'done.';
}

main()
  .then(console.log)
  .catch(console.error)
  .finally(() => client.close());
 

 
Run your app from the command line with:

 
node app.js
@@ -214,29 +205,29 @@ 
mongodb

 
The application should print Connected successfully to server to the console.

 
Insert a Document
Add to app.js the following function which uses the insertMany
 method to add three documents to the documents collection.

-
const insertResult = await collection.insertMany([{ a: 1 }, { a: 2 }, { a: 3 }]);
console.log('Inserted documents =>', insertResult);
+
const insertResult = await collection.insertMany([{ a: 1 }, { a: 2 }, { a: 3 }]);
console.log('Inserted documents =>', insertResult);
 

 
The insertMany command returns an object with information about the insert operations.

 
Find All Documents
Add a query that returns all the documents.

-
const findResult = await collection.find({}).toArray();
console.log('Found documents =>', findResult);
+
const findResult = await collection.find({}).toArray();
console.log('Found documents =>', findResult);
 

 
This query returns all the documents in the documents collection.
 If you add this below the insertMany example, you'll see the documents you've inserted.

 
Find Documents with a Query Filter
Add a query filter to find only documents which meet the query criteria.

-
const filteredDocs = await collection.find({ a: 3 }).toArray();
console.log('Found documents filtered by { a: 3 } =>', filteredDocs);
+
const filteredDocs = await collection.find({ a: 3 }).toArray();
console.log('Found documents filtered by { a: 3 } =>', filteredDocs);
 

 
Only the documents which match 'a' : 3 should be returned.

 
Update a document
The following operation updates a document in the documents collection.

-
const updateResult = await collection.updateOne({ a: 3 }, { $set: { b: 1 } });
console.log('Updated documents =>', updateResult);
+
const updateResult = await collection.updateOne({ a: 3 }, { $set: { b: 1 } });
console.log('Updated documents =>', updateResult);
 

 
The method updates the first document where the field a is equal to 3 by adding a new field b to the document set to 1. updateResult contains information about whether there was a matching document to update or not.

 
Remove a document
Remove the document where the field a is equal to 3.

-
const deleteResult = await collection.deleteMany({ a: 3 });
console.log('Deleted documents =>', deleteResult);
+
const deleteResult = await collection.deleteMany({ a: 3 });
console.log('Deleted documents =>', deleteResult);
 

 
Index a Collection
Indexes can improve your application's
 performance. The following function creates an index on the a field in the
 documents collection.

-
const indexName = await collection.createIndex({ a: 1 });
console.log('index name =', indexName);
+
const indexName = await collection.createIndex({ a: 1 });
console.log('index name =', indexName);
 

 
For more detailed information, see the indexing strategies page.

 
Error Handling
If you need to filter certain errors from our driver, we have a helpful tree of errors described in etc/notes/errors.md.

@@ -244,7 +235,7 @@ 
mongodb

 We guarantee instanceof checks will pass according to semver guidelines, but errors may be sub-classed or their messages may change at any time, even patch releases, as we see fit to increase the helpfulness of the errors.

 
Any new errors we add to the driver will directly extend an existing error class and no existing error will be moved to a different parent class outside of a major release.
 This means instanceof will always be able to accurately capture the errors that our driver throws.

-
const client = new MongoClient(url);
await client.connect();
const collection = client.db().collection('collection');

try {
  await collection.insertOne({ _id: 1 });
  await collection.insertOne({ _id: 1 }); // duplicate key error
} catch (error) {
  if (error instanceof MongoServerError) {
    console.log(`Error worth logging: ${error}`); // special case for some reason
  }
  throw error; // still want to crash
}
+
const client = new MongoClient(url);
await client.connect();
const collection = client.db().collection('collection');

try {
  await collection.insertOne({ _id: 1 });
  await collection.insertOne({ _id: 1 }); // duplicate key error
} catch (error) {
  if (error instanceof MongoServerError) {
    console.log(`Error worth logging: ${error}`); // special case for some reason
  }
  throw error; // still want to crash
}
 

 
Nightly releases
If you need to test with a change from the latest main branch, our mongodb npm package has nightly versions released under the nightly tag.

 
npm install mongodb@nightly
@@ -290,7 +281,6 @@ 
Quick Links
 
  •