@mhoc/mongodb-atlas

This is a type-safe API wrapper around the MongoDB Atlas API for NodeJS.

Disclaimers & Limitations

• Mongo, MongoDB, and Atlas are registered trademarks of MongoDB, Inc. This project is not affiliated with them in any way.

• This library is not for querying data in a Mongo database; its for accessing deployed clusters and associated resources on MongoDB's Atlas service.

• This is very pre-release, not well tested, the API could change at any time, and its missing a lot of functionality.

• Use at your own risk.

Installing

npm i @mhoc/mongodb-atlas

Usage

import { AtlasClient } from "@mhoc/mongodb-atlas";

const atlasClient = new AtlasClient({
  publicKey: process.env.PUBLIC_KEY,
  privateKey: process.env.PRIVATE_KEY,
});
const projects = await atlasClient.projects.list();

Supported APIs

• .cloudBackupRestoreJobs.createDownload: create a restore job targeting a .tar.gz file.
• .cloudBackupRestoreJobs.get: get one restore job.
• .cloudBackupRestoreJobs.list: list all restore jobs.
• .cloudBackups.list: list cloud backups for a cluster.
• .clusters.list: list clusters in a project.
• .projects.list: list projects the api key has access to.

Testing

You must provide ATLAS_PUBLIC_KEY and ATLAS_PRIVATE_KEY environment variables for testing to function properly. Only non-mutable query operations are ever tested, and even those may not run properly given everyone would have their Atlas environemnt configured differently.