AWS documentdb documentation change
Summary
Added new documentation page for the $regexFindAll operator in Amazon DocumentDB, including syntax, parameters, MongoDB shell example, and code examples in Node.js and Python.
Security assessment
This change adds standard feature documentation for a new operator ($regexFindAll) with no mention of security vulnerabilities, patches, or security incidents. The examples show regular expression usage for data extraction, which is a standard database operation. The connection examples include TLS parameters (tls=true, tlsCAFile) but these are standard secure connection practices, not new security features being documented.
Diff
diff --git a/documentdb/latest/developerguide/regexFindAll.md b/documentdb/latest/developerguide/regexFindAll.md index 8b1378917..4ccb98b35 100644 --- a//documentdb/latest/developerguide/regexFindAll.md +++ b//documentdb/latest/developerguide/regexFindAll.md @@ -0,0 +1 @@ +[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#regexFindAll "Open PDF") @@ -1,0 +3,181 @@ +[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html) + +Example (MongoDB Shell)Code examples + +# $regexFindAll + +Introduced in 5.0 + +The `$regexFindAll` operator in Amazon DocumentDB is used to perform regular expression matching on string fields within documents. It allows you to search for and extract specific substrings that match a given regular expression pattern, returning all matches of the regular expression. + +**Parameters** + + * `input`: The string field or expression to search. + + * `regex`: The regular expression pattern to match. + + * `options`: (optional) An object that specifies optional parameters for the regular expression, such as case-sensitivity and multi-line matching. Supported options are `i` (case-insensitive) and `m` (multi-line). + + + + +## Example (MongoDB Shell) + +The following example demonstrates how to use the `$regexFindAll` operator to extract all letter sequences from the `email` field. + +**Create sample documents** + + + db.users.insertMany([ + { _id: 1, name: "John Doe", email: "[email protected]", phone: "555-1234" }, + { _id: 2, name: "Jane Roe", email: "[email protected]", phone: "555-5678" }, + { _id: 3, name: "Carlos Salazar", email: "[email protected]", phone: "555-3456" }, + { _id: 4, name: "Saanvi Sarkar", email: "[email protected]", phone: "555-7890" } + + ]); + +**Query example** + + + db.users.aggregate([ + { + $project: { + name: 1, + emailMatches: { + $regexFindAll: { input: '$email', regex: '[a-z]+', options: 'i' } + } + } + } + ]) + +**Output** + + + [ + { + _id: 1, + name: 'John Doe', + emailMatches: [ + { match: 'john', idx: 0, captures: [] }, + { match: 'example', idx: 5, captures: [] }, + { match: 'com', idx: 13, captures: [] } + ] + }, + { + _id: 2, + name: 'Jane Roe', + emailMatches: [ + { match: 'jane', idx: 0, captures: [] }, + { match: 'example', idx: 5, captures: [] }, + { match: 'com', idx: 13, captures: [] } + ] + }, + { + _id: 3, + name: 'Carlos Salazar', + emailMatches: [ + { match: 'carlos', idx: 0, captures: [] }, + { match: 'example', idx: 7, captures: [] }, + { match: 'com', idx: 15, captures: [] } + ] + }, + { + _id: 4, + name: 'Saanvi Sarkar', + emailMatches: [ + { match: 'saanvi', idx: 0, captures: [] }, + { match: 'example', idx: 7, captures: [] }, + { match: 'com', idx: 15, captures: [] } + ] + } + ] + +**Note:** If your query is using Amazon DocumentDB planner version 1, you must use a hint to utilize an index. Without a hint, the query may perform a collection scan. To check your planner version and learn more about using hints, see the [Amazon DocumentDB Query Planner documentation](https://docs.aws.amazon.com/documentdb/latest/developerguide/query-planner.html). + +## Code examples + +To view a code example for using the `$regexFindAll` command, choose the tab for the language that you want to use: + +Node.js + + +Here's an example of using the `$regexFind` operator in a Node.js application: + + + 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 results = await users.aggregate([ + { + $project: { + name: 1, + emailMatches: { + $regexFindAll: { input: "$email", regex: "[a-z]+", options: "i" } + } + } + } + ]).toArray(); + + console.log(JSON.stringify(results, null, 2)); + + await client.close(); + } + + main(); + +Python + + +Here's an example of using the `$regexFind` operator in a Python application: + + + from pymongo import MongoClient + + 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'] + + results = list(users.aggregate([ + { + "$project": { + "name": 1, + "emailMatches": { + "$regexFindAll": { + "input": "$email", + "regex": "[a-z]+", + "options": "i" + } + } + } + } + ])) + + print(results) + + client.close() + + **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) + +$regexFind + +$regexMatch + +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.