Documentation
Plugins
Sources
MongoDB Atlas
Overview

MongoDB Atlas Source Plugin

Premium

This is a premium plugin that you can buy here.

The CloudQuery MongoDB Atlas plugin extracts information from your MongoDB Atlas API (opens in a new tab) and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Authentication

You must have a MongoDB Atlas (opens in a new tab) account and an API key.

Configuration

kind: source
# Common source-plugin configuration
spec:
  name: mongodb-atlas
  path: /path/to/downloaded/plugin # Buy from here: https://cloudquery.io/integrations/mongodb-atlas
  registry: local
  version: "PREMIUM"
  tables: ["*"]
  destinations: ["postgresql"]
  # Plugin specific configuration
  spec:
    api_key: your-api-key # string. If empty, extracted from MONGODB_ATLAS_PUBLIC_KEY
    api_secret: your-secret # string. If empty, extracted from MONGODB_ATLAS_PRIVATE_KEY
    # base_url: https://cloud.mongodb.com # string, optional. Extracted from MONGODB_ATLAS_URL. Default: https://cloud.mongodb.com

Make sure you use environment variable expansion in production instead of committing the credentials to the configuration file directly.

MongoDB Atlas Spec

This is the (nested) spec used by this plugin:

  • api_key (string, optional):

    If empty, extracted from MONGODB_ATLAS_PUBLIC_KEY

  • api_secret (string, optional):

    If empty, extracted from MONGODB_ATLAS_PRIVATE_KEY

  • base_url (string, optional):

    If empty, extracted from MONGODB_ATLAS_URL. Default: https://cloud.mongodb.com (opens in a new tab)