Navigation

Configure Data Lake

Beta

The Atlas Data Lake is available as a Beta feature. The product and the corresponding documentation may change at any time during the Beta stage. For support, see Atlas Support.

Overview

You can configure Atlas Data Lake using the Data Lake Configuration File. The configuration file defines mappings between your data stores and Data Lake. To learn more about the configuration file including the configuration fields and file format, see Data Lake Configuration File.

You can retrieve and update the Data Lake configuration by connecting a mongo shell to the Data Lake:

  1. From the Atlas UI, select Data Lake from the left-hand navigation.
  2. Click Connect for the Data Lake to which you want to connect.
  3. Click Connect with the Mongo Shell.
  4. Follow the instructions in the Connect modal. If you already have the mongo shell installed, ensure you are running at least the latest stable release of the 3.6 shell.

Note

Any MongoDB user in the Atlas project with the atlasAdmin role can retrieve and update the Data Lake configuration.

Retrieve Data Lake Configuration

Once connected to the Data Lake, you can use the following database commands to retrieve the Data Lake configuration:

use admin
db.runCommand( { "storageGetConfig" : 1 } )

The command returns the current Data Lake configuration. For complete documentation on the configuration fields and file format, see Configuration File Format.

Set or Update Data Lake Configuration

Once connected to the Data Lake, you can use the following database commands to set or update the Data Lake configuration:

use admin
db.runCommand( { "storageSetConfig" : <config> } )

Replace <config> with the Data Lake configuration file. For complete documentation on the configuration fields and file format, see Configuration File Format.