mongocli atlas dataLakes list
On this page
mongocli atlas dataLakes commands control the functionality previously named Data Lake, which is now called Data Federation in the Atlas UI. The mongocli atlas dataLakes commands will continue to work for Data Federation without interruption. MongoDB's new Data Lake functionality doesn't include CLI commands. When we introduce a new set of CLI commands for our new Data Lake functionality, we will reach out to you to prevent any interruption of service.This version of the documentation is archived and no longer supported. View the current documentation to learn how to update your version of the MongoDB CLI.
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Return all federated database instances for your project.
To learn more about Atlas Data Federation (previously named Atlas Data Lake), see https://www.mongodb.com/docs/atlas/data-federation/overview/.
Syntax
mongocli atlas dataLakes list [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for list | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# Return a JSON-formatted list of all federated database instances in the project with the ID 5e2211c17a3e5a48f5497de3: mongocli atlas dataLakes list --projectId 5e2211c17a3e5a48f5497de3 --output json