AWS documentdb documentation change
Summary
Entire documentation page for the $comment operator was removed, including examples in MongoDB Shell, Node.js, and Python.
Security assessment
This change removes documentation about the $comment operator, which is used for adding comments to queries for debugging/documentation purposes. There is no evidence in the diff that this removal addresses a security vulnerability or weakness. The change appears to be routine documentation cleanup or restructuring.
Diff
diff --git a/documentdb/latest/developerguide/comment.md b/documentdb/latest/developerguide/comment.md index 7dcff8c54..8b1378917 100644 --- a//documentdb/latest/developerguide/comment.md +++ b//documentdb/latest/developerguide/comment.md @@ -1 +0,0 @@ -[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#comment "Open PDF") @@ -3,107 +1,0 @@ -[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html) - -Example (MongoDB Shell)Code examples - -# $comment - -The `$comment` operator in Amazon DocumentDB is used to attach a comment to a query. This can be useful for providing additional context or information about the query, which can be helpful for debugging or documenting purposes. The attached comment will appear as part of the output of operations like db.currentOp(). - -**Parameters** - - * `string`: The comment attached to the query. - - - - -## Example (MongoDB Shell) - -The following example demonstrates how to use the `$comment` operator in Amazon DocumentDB. - -**Create sample documents** - - - db.users.insertMany([ - { name: "John Doe", age: 30, email: "[email protected]" }, - { name: "Jane Smith", age: 25, email: "[email protected]" }, - { name: "Bob Johnson", age: 35, email: "[email protected]" } - ]); - -**Query example** - - - db.users.find({ age: { $gt: 25 } }, { _id: 0, name: 1, age: 1 }).comment("Retrieve users older than 25"); - -**Output** - - - { "name" : "John Doe", "age" : 30 } - { "name" : "Bob Johnson", "age" : 35 } - -## Code examples - -To view a code example for using the `$comment` command, choose the tab for the language that you want to use: - -Node.js - - - - const { MongoClient } = require('mongodb'); - - async function main() { - const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false'); - const db = client.db('test'); - const users = db.collection('users'); - - const result = await users.find({ age: { $gt: 25 } }, { projection: { _id: 0, name: 1, age: 1 } }) - .comment('Retrieve users older than 25') - .toArray(); - - console.log(result); - - await client.close(); - } - - main(); - -Python - - - - from pymongo import MongoClient - - def main(): - client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false') - db = client.test - users = db.users - - result = list(users.find({ 'age': { '$gt': 25 }}, { '_id': 0, 'name': 1, 'age': 1 }) - .comment('Retrieve users older than 25')) - - print(result) - - client.close() - - if __name__ == '__main__': - main() - - **Javascript is disabled or is unavailable in your browser.** - -To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions. - -[Document Conventions](/general/latest/gr/docconventions.html) - -$bitsAnySet - -$elemMatch - -Did this page help you? - Yes - -Thanks for letting us know we're doing a good job! - -If you've got a moment, please tell us what we did right so we can do more of it. - -Did this page help you? - No - -Thanks for letting us know this page needs work. We're sorry we let you down. - -If you've got a moment, please tell us how we can make the documentation better.