Table: mongodbatlas_cluster - Query MongoDB Atlas Clusters using SQL

MongoDB Atlas is a fully managed cloud database service for modern applications. It provides an easy way to deploy, operate, and scale MongoDB in the cloud, removing the operational burden from your shoulders and making it easy to focus on building your applications. MongoDB Atlas Clusters are the heart of your MongoDB deployments, where your data is stored and from where it is served.

Table Usage Guide

The mongodbatlas_cluster table provides insights into MongoDB Atlas Clusters. As a Database Administrator or Developer, you can explore cluster-specific details through this table, including configuration, status, and statistics. Utilize it to uncover information about clusters, such as their current operational status, the configuration settings in use, and performance statistics, which can be useful for monitoring and troubleshooting.

Examples

Basic info

Explore which MongoDB Atlas clusters are associated with specific project IDs to streamline project management and resource allocation.

select
  id,
  name,
  project_id
from
  mongodbatlas_cluster;

select
  id,
  name,
  project_id
from
  mongodbatlas_cluster;

Get auto-scaling details of all clusters

Explore the auto-scaling configurations of your clusters to understand if automatic indexing, disk space adjustments, and scale-down options are enabled. This can be useful in managing resources and optimizing performance in your database environment.

select
  id,
  name,
  auto_scaling ->> 'autoIndexingEnabled' as auto_scaling_auto_indexing_enabled,
  auto_scaling ->> 'diskGBEnabled' as auto_scaling_diskgb_enabled,
  auto_scaling -> 'compute' ->> 'enabled' as auto_scaling_compute_enabled,
  auto_scaling -> 'compute' ->> 'scaleDownEnabled' as autos_caling_compute_scale_down_enabled
from
  mongodbatlas_cluster;

select
  id,
  name,
  json_extract(auto_scaling, '$.autoIndexingEnabled') as auto_scaling_auto_indexing_enabled,
  json_extract(auto_scaling, '$.diskGBEnabled') as auto_scaling_diskgb_enabled,
  json_extract(auto_scaling, '$.compute.enabled') as auto_scaling_compute_enabled,
  json_extract(auto_scaling, '$.compute.scaleDownEnabled') as autos_caling_compute_scale_down_enabled
from
  mongodbatlas_cluster;

Get connection details for clusters

Discover the connection details for clusters to better manage and troubleshoot your MongoDB Atlas setup. This helps in simplifying the process of connecting to your clusters.

select
  id,
  name,
  connection_strings ->> 'standardSrv' as conn_str_standard_srv,
  connection_strings ->> 'standard' as conn_str_standard
from
  mongodbatlas_cluster;

select
  id,
  name,
  json_extract(connection_strings, '$.standardSrv') as conn_str_standard_srv,
  json_extract(connection_strings, '$.standard') as conn_str_standard
from
  mongodbatlas_cluster;

Get all clusters which are replica sets

Determine the areas in which MongoDB Atlas clusters are functioning as replica sets. This can help in managing resource allocation and understanding the distribution of your database workloads.

select
  id,
  name
from
  mongodbatlas_cluster
where
  num_shards = 1;

select
  id,
  name
from
  mongodbatlas_cluster
where
  num_shards = 1;

List clusters with provider backups disabled

Discover the segments that have provider backups disabled in MongoDB Atlas clusters. This can help identify potential risk areas where data might not be recoverable in the event of a system failure.

select
  name,
  cluster_type,
  provider_backup_enabled
from
  mongodbatlas_cluster
where
  provider_backup_enabled = false;

select
  name,
  cluster_type,
  provider_backup_enabled
from
  mongodbatlas_cluster
where
  provider_backup_enabled = 0;

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- mongodbatlas

You can pass the configuration to the command with the --config argument:

steampipe_export_mongodbatlas --config '<your_config>' mongodbatlas_cluster