AWS documentdb documentation change

Service: documentdb · 2026-03-31 · Documentation low

File: documentdb/latest/developerguide/bitsAllClear.md

Summary

Added new documentation page for the $bitsAllClear operator in Amazon DocumentDB, including syntax, parameters, examples in MongoDB Shell, Node.js, and Python with connection examples

Security assessment

This change adds documentation for a new query operator ($bitsAllClear) for bitwise operations. The documentation includes standard code examples with TLS-enabled connections, but there is no evidence of addressing a specific security vulnerability, weakness, or incident. The change appears to be routine feature documentation.

Diff

diff --git a/documentdb/latest/developerguide/bitsAllClear.md b/documentdb/latest/developerguide/bitsAllClear.md
index 8b1378917..b3f21155a 100644
--- a//documentdb/latest/developerguide/bitsAllClear.md
+++ b//documentdb/latest/developerguide/bitsAllClear.md
@@ -0,0 +1 @@
+[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#bitsAllClear "Open PDF")
@@ -1,0 +3,112 @@
+[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html)
+
+Example (MongoDB Shell)Code examples
+
+# $bitsAllClear
+
+The `$bitsAllClear` operator in Amazon DocumentDB is used to match the documents where all the specified bits in a field are cleared (set to 0). This operator can be useful for performing bitwise operations on stored data.
+
+**Parameters**
+
+  * `field`: The field to check for the specified bits being cleared.
+
+  * `value`: The numeric bitmask that specifies which bits should be checked, or a list of bits positions to be checked. A numeric bitmask can be a binary (0b...), decimal, hexadecimal (0x...), octal (0o...), or binary (BinData) form. In a list of bits positions, the position of the least significant bit is 0.
+
+
+
+
+## Example (MongoDB Shell)
+
+The following example demonstrates the usage of the `$bitsAllClear` operator in Amazon DocumentDB.
+
+**Create sample documents**
+    
+    
+    db.collection.insertMany([
+      { _id: 1, bits: 0b1010 },
+      { _id: 2, bits: 0b1100 },
+      { _id: 3, bits: 0b0101 }
+    ]);
+
+**Query example**
+    
+    
+    db.collection.find({
+      bits: { $bitsAllClear: 0b0011 }
+    })
+
+**Output**
+    
+    
+    { "_id" : 2, "bits" : 12 }
+
+The query checks if all the bits specified by the bitmask `0b0011` (the two least significant bits) are cleared in the `bits` field. The document with `_id` 2 satisfies this condition, as its `bits` field has those bits cleared.
+
+## Code examples
+
+To view a code example for using the `$bitsAllClear` command, choose the tab for the language that you want to use:
+
+Node.js
+    
+    
+    
+    const { MongoClient } = require('mongodb');
+    
+    async function example() {
+      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 collection = db.collection('collection');
+    
+      const result = await collection.find({
+        bits: { $bitsAllClear: 0b0011 }
+      }).toArray();
+    
+      console.log(result);
+    
+      await client.close();
+    }
+    
+    example();
+
+Python
+    
+    
+    
+    from pymongo import MongoClient
+    
+    def example():
+        client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
+        db = client['test']
+        collection = db['collection']
+    
+        result = list(collection.find({
+            'bits': { '$bitsAllClear': 0b0011 }
+        }))
+    
+        print(result)
+    
+        client.close()
+    
+    example()
+
+![Warning](https://d1ge0kk1l5kms0.cloudfront.net/images/G/01/webservices/console/warning.png) **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)
+
+$and
+
+$bitsAllSet
+
+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.