Docs Menu
Docs Home
/
MongoDB Manual
/ / / /

Installation Requirements

On this page

  • Overview
  • What You Need
  • Learn More

Learn about the applications and libraries you must install to use Queryable Encryption.

Before you can use Queryable Encryption, set up the following items in your development environment:

  • (Optional) Download the Automatic Encryption Shared Library. The Automatic Encryption Shared Library replaces mongocryptd and does not require spawning a new process.

  • Install a MongoDB Driver Compatible with Queryable Encryption.

  • Start an Atlas Cluster or a MongoDB Enterprise instance

    Warning

    You can use Queryable Encryption only with MongoDB 7.0 and later, which may not yet be available in MongoDB Atlas.

  • Install specific driver dependencies. To see the list of dependencies for your driver, select the tab corresponding to the language you would like to use to complete this guide:

Dependency Name
Description

x64 Support

Queryable Encryption requires x64 support.

Dependency Name
Description

The libmongocrypt library contains bindings to communicate with the native library that manages the encryption.

Dependency Name
Description

The mongodb-crypt library contains bindings to communicate with the native library that manages the encryption.

Dependency Name
Description

NodeJS wrapper for the libmongocrypt encryption library. The libmongocrypt library contains bindings to communicate with the native library that manages the encryption.

Note

When using Node.js driver version 6.0.0 or later, mongodb-client-encryption must have the same major version number as the driver.

For example, Node.js driver v6.x.x requires mongodb-client-encryption v6.x.x.

Dependency Name
Description

Python wrapper for the libmongocrypt encryption library. The libmongocrypt library contains bindings to communicate with the native library that manages the encryption.

To start using Queryable Encryption, see Quick Start.

To learn how to use Queryable Encryption with a remote Key Management System, see Tutorials.

Back

Features