ClientEncryption.createEncryptedCollection() (original) (raw)

New in version 7.0.

ClientEncryption.createEncryptedCollection(dbName, collName, clientEncOpts)

ClientEncryption.createEncryptedCollection creates an encrypted collection specified by collName on the database specified by dbName.

This command is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

ClientEncryption.createEncryptedCollection has the following syntax:

clientEncryption = db.getMongo().getClientEncryption()

clientEncryption.createEncryptedCollection(

  dbName,

  collName,

  {

    provider: kmsProviderName,

    createCollectionOptions: encryptedFieldsMap,

    masterKey: customerMasterKeyCredentials

  }

)

createEncryptedCollection takes these fields:

The mongosh client-side field level and queryable encryption methods require a database connection configured for client-side encryption. If the current database connection was not initiated with client-side field level encryption enabled, either:

• Use the Mongo() constructor from the mongoshto establish a connection with the required client-side field level encryption options. The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
  • Amazon Web Services KMS
  • Azure Key Vault
  • Google Cloud Platform KMS
  • Locally Managed Key

or

• Use the mongosh command line options to establish a connection with the required options. The command line options only support the Amazon Web Services KMS provider for CMK management.

The following example uses a locally managed KMS for the Queryable Encryption configuration.

1. Start mongosh
   Run:
   --nodb means don't connect to a database.
2. Generate a Key String
   Generate a base 64 96-byte string:

const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")  

1. Create an Encryption Options Object
   To create a client-side field level encryption options object, use the TEST_LOCAL_KEY string from the previous step:

   var autoEncryptionOpts = {  
      "keyVaultNamespace" : "encryption.__dataKeys",  
      "kmsProviders" : {  
         "local" : {  
            "key" : BinData(0, TEST_LOCAL_KEY)  
         }  
      }  
   }  

1. Create an Encrypted Client Object
   To create an encrypted client object, use the Mongo()constructor. Replace the mongodb://myMongo.example.net URI with the connection string URI for the target cluster. For example:

encryptedClient = Mongo(  
   "mongodb://myMongo.example.net:27017/?replSetName=myMongo",  
   autoEncryptionOpts  
)  

Create an encryptedFieldsMaps to specify which fields to encrypt:

const encryptedFieldsMap = {

  encryptedFields: {

    fields: [

      {

        path: "secretField",

        bsonType: "string",

        queries: { queryType: "equality" },

      },

    ],

  },

};

Create an encrypted enc.users collection:

clientEncryption = encryptedClient.getClientEncryption();

var result = clientEncryption.createEncryptedCollection(

  "enc",

  "users",

  {

    provider: "local",

    createCollectionOptions: encryptedFieldsMap,

    masterKey: {} // masterKey is optional when provider is local

  }

)

createEncryptedCollection returns a large result object with many fields. Check the value of result.collection to confirm the collection was created in the desired location.

enc> result.collection

enc.users

• For complete documentation on initiating MongoDB connections with client-side field level encryption enabled, see Mongo().
• For a complete example of how to create and query an encrypted collection, see Queryable Encryption Quick Start.