Skip to content

Commit 1be7db5

Browse files
authored
CLOUDP-179700 Update help text of all update commands that have arrays to clarify updating such array will wipe out previous data (#1972)
1 parent b231c6a commit 1be7db5

File tree

47 files changed

+60
-59
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+60
-59
lines changed

docs/atlascli/command/atlas-customDbRoles-update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ Options
6464
* - --inheritedRole
6565
- strings
6666
- false
67-
- List of inherited roles and the database on which the role is granted.
67+
- List of inherited roles and the database on which the role is granted. Passing this flag replaces preexisting data.
6868
* - -o, --output
6969
- string
7070
- false
7171
- Output format. Valid values are json, json-path, go-template, or go-template-file.
7272
* - --privilege
7373
- strings
7474
- false
75-
- List of actions per database and collection. If no database or collections are provided, cluster scope is assumed.
75+
- List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. Passing this flag replaces preexisting data.
7676
* - --projectId
7777
- string
7878
- false

docs/atlascli/command/atlas-dataLakePipelines-update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Options
8080
* - --sinkPartitionField
8181
- strings
8282
- false
83-
- Ordered fields used to physically organize data in the destination.
83+
- Ordered fields used to physically organize data in the destination. Passing this flag replaces preexisting data.
8484
* - --sourceClusterName
8585
- string
8686
- false
@@ -104,7 +104,7 @@ Options
104104
* - --transform
105105
- strings
106106
- false
107-
- Fields to be excluded for this data lake pipeline.
107+
- Fields to be excluded for this data lake pipeline. Passing this flag replaces preexisting data.
108108

109109
Inherited Options
110110
-----------------

docs/atlascli/command/atlas-dbusers-update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ Options
7272
* - --role
7373
- strings
7474
- false
75-
- User's roles and the databases or collections on which the roles apply.
75+
- User's roles and the databases or collections on which the roles apply. Passing this flag replaces preexisting data.
7676
* - --scope
7777
- strings
7878
- false
79-
- Array of clusters and Atlas Data Lakes that this user has access to.
79+
- Array of clusters and Atlas Data Lakes that this user has access to. Passing this flag replaces preexisting data.
8080
* - -u, --username
8181
- string
8282
- false

docs/atlascli/command/atlas-organizations-apiKeys-assign.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Options
7676
* - --role
7777
- strings
7878
- false
79-
- Role or roles that you want to assign to the API key. To assign more than one role, you can specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. Valid values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY.
79+
- Role or roles that you want to assign to the API key. To assign more than one role, you can specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. Valid values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Passing this flag replaces preexisting data.
8080

8181
Inherited Options
8282
-----------------

docs/atlascli/command/atlas-organizations-invitations-update.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Options
7474
* - --role
7575
- strings
7676
- true
77-
- User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY.
77+
- User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Passing this flag replaces preexisting data.
7878

7979
Inherited Options
8080
-----------------

docs/atlascli/command/atlas-projects-invitations-update.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Options
7474
* - --role
7575
- strings
7676
- true
77-
- User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY.
77+
- User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Passing this flag replaces preexisting data.
7878

7979
Inherited Options
8080
-----------------

docs/atlascli/command/atlas-projects-teams-update.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Options
6868
* - --role
6969
- strings
7070
- true
71-
- User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY.
71+
- User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. Passing this flag replaces preexisting data.
7272

7373
Inherited Options
7474
-----------------

docs/mongocli/command/mongocli-atlas-customDbRoles-update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ Options
6464
* - --inheritedRole
6565
- strings
6666
- false
67-
- List of inherited roles and the database on which the role is granted.
67+
- List of inherited roles and the database on which the role is granted. Passing this flag replaces preexisting data.
6868
* - -o, --output
6969
- string
7070
- false
7171
- Output format. Valid values are json, json-path, go-template, or go-template-file.
7272
* - --privilege
7373
- strings
7474
- false
75-
- List of actions per database and collection. If no database or collections are provided, cluster scope is assumed.
75+
- List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. Passing this flag replaces preexisting data.
7676
* - --projectId
7777
- string
7878
- false

docs/mongocli/command/mongocli-atlas-dbusers-update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ Options
7272
* - --role
7373
- strings
7474
- false
75-
- User's roles and the databases or collections on which the roles apply.
75+
- User's roles and the databases or collections on which the roles apply. Passing this flag replaces preexisting data.
7676
* - --scope
7777
- strings
7878
- false
79-
- Array of clusters and Atlas Data Lakes that this user has access to.
79+
- Array of clusters and Atlas Data Lakes that this user has access to. Passing this flag replaces preexisting data.
8080
* - -u, --username
8181
- string
8282
- false

docs/mongocli/command/mongocli-cloud-manager-backups-config-update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ Options
6262
* - --excludedNamespace
6363
- strings
6464
- false
65-
- List of database names and collection names to omit from the backup.
65+
- List of database names and collection names to omit from the backup. Passing this flag replaces preexisting data.
6666
* - -h, --help
6767
-
6868
- false
6969
- help for update
7070
* - --includedNamespace
7171
- strings
7272
- false
73-
- List of database names and collection names to include in the backup.
73+
- List of database names and collection names to include in the backup. Passing this flag replaces preexisting data.
7474
* - -o, --output
7575
- string
7676
- false

0 commit comments

Comments
 (0)