Skip to content

Commit ca01579

Browse files
sarahsimpersCiprian Tibulca
andauthored
(DOCSP-30812) Removes data type from partition command (#2026)
Co-authored-by: Ciprian Tibulca <[email protected]>
1 parent 8e14751 commit ca01579

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

docs/atlascli/command/atlas-clusters-onlineArchives-create.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Options
7676
* - --partition
7777
- strings
7878
- false
79-
- Fields to use to partition data. You can specify up to two frequently queried fields, separated by a comma, in the following format: <fieldname>:<datatype>. The data type must match the data type of the field in the document.
79+
- Fields to use to partition data. You can specify up to two frequently queried fields separated by a comma.
8080
* - --projectId
8181
- string
8282
- false
@@ -110,4 +110,4 @@ Examples
110110
.. code-block::
111111

112112
# Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection:
113-
atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title:string,year:int --output json -P egAtlasProfile
113+
atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile

docs/mongocli/command/mongocli-atlas-clusters-onlineArchives-create.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Options
7676
* - --partition
7777
- strings
7878
- false
79-
- Fields to use to partition data. You can specify up to two frequently queried fields, separated by a comma, in the following format: <fieldname>:<datatype>. The data type must match the data type of the field in the document.
79+
- Fields to use to partition data. You can specify up to two frequently queried fields separated by a comma.
8080
* - --projectId
8181
- string
8282
- false
@@ -110,4 +110,4 @@ Examples
110110
.. code-block::
111111

112112
# Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection:
113-
mongocli atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title:string,year:int --output json -P egAtlasProfile
113+
mongocli atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile

internal/cli/atlas/clusters/onlinearchive/create.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ To learn more about online archives, see https://www.mongodb.com/docs/atlas/onli
111111
%[1]s clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --output json
112112
113113
# Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection:
114-
%[1]s clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title:string,year:int --output json -P egAtlasProfile `, cli.ExampleAtlasEntryPoint()),
114+
%[1]s clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile `, cli.ExampleAtlasEntryPoint()),
115115
PreRunE: func(cmd *cobra.Command, args []string) error {
116116
if len(opts.partitions) > maxPartitions {
117117
return fmt.Errorf("can only define up to 2 partition fields, got: %d", len(opts.partitions))

internal/usage/usage.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ dbName and collection are required only for built-in roles.`
259259
SystemID = "Unique identifier of the external system that manages this Ops Manager Project."
260260
ExternalSystemName = "Identifying label for the external system that manages this Ops Manager Project."
261261
DateField = "Name of an already indexed date field from the documents."
262-
PartitionFields = "Fields to use to partition data. You can specify up to two frequently queried fields, separated by a comma, in the following format: <fieldname>:<datatype>. The data type must match the data type of the field in the document."
262+
PartitionFields = "Fields to use to partition data. You can specify up to two frequently queried fields separated by a comma."
263263
ArchiveAfter = "Number of days after which to archive cluster data."
264264
TargetProjectID = "Unique identifier of the project that contains the destination cluster for the restore job. You must specify a targetProjectId for automated restores."
265265
APIAccessListIPEntry = "IP address that you want to add to the access list for your API key. To add more than one IP address, you can specify each address with a separate ip flag or specify the all addresses as a comma-separated list using one ip flag. You can't set both ip and cidr in the same command."

0 commit comments

Comments
 (0)