atlas clusters sampleData watch
Watch the specified sample data job in your cluster until it completes.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
This command checks the sample data job's status periodically until it reaches an COMPLETED state. If you run the command in the terminal, it blocks the terminal session until the resource state changes to COMPLETED. You can interrupt the command's polling at any time with CTRL-C.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
atlas clusters sampleData watch <id> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
id | string | true | Unique identifier of the sample data job. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for watch | |
--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 | Name of 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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Sample data available.
Examples
# Watch for the sample data job with ID 5e2211c17a3e5a48f5497de3 to complete: atlas clusters sampledata watch 5e2211c17a3e5a48f5497de3