Skip to content

Commit 166ffcd

Browse files
kanchana-mongodbkanchana-mongodb
authored
Revert "Revert "DOCSP-11191 doc for onlinearchive pause command" (#158)" (#159)
This reverts commit b48c40d.
1 parent b48c40d commit 166ffcd

File tree

6 files changed

+161
-28
lines changed

6 files changed

+161
-28
lines changed

‎source/reference/atlas.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ Atlas ``mongocli`` Commands
5454
Events </reference/atlas/event-commands>
5555
Logs </reference/atlas/log-commands>
5656
Metrics </reference/atlas/metric-commands>
57-
Online Archives </reference/atlas/onlinearchive-commands>
5857
Processes </reference/atlas/process-commands>
5958
Whitelists </reference/atlas/whitelist-commands>
6059
Data Lakes </reference/atlas/datalake-commands>

‎source/reference/atlas/cluster-commands.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ Atlas ``cluster`` Commands
1717
Pause a Cluster </reference/atlas/cluster-pause>
1818
Resume a Cluster </reference/atlas/cluster-start>
1919
Watch a Cluster </reference/atlas/cluster-watch>
20+
Online Archives </reference/atlas/onlinearchive-commands>
2021
Create a Rolling Index </reference/atlas/clusters-indexes-create>

‎source/reference/atlas/onlinearchive-commands.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ Atlas Online Archive Commands
1616
Create an Online Archive </reference/atlas/onlinearchive-create>
1717
Modify an Online Archive </reference/atlas/onlinearchive-update>
1818
Start an Online Archive </reference/atlas/onlinearchive-start>
19+
Pause an Active Online Archive </reference/atlas/onlinearchive-pause>
1920

‎source/reference/atlas/onlinearchive-create.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _mcli-atlas-onlinearchive-create-command:
1+
.. _mcli-atlas-cluster-onlinearchive-create-command:
22

3-
===================================
4-
mongocli atlas onlinearchive create
5-
===================================
3+
===========================================
4+
mongocli atlas cluster onlinearchive create
5+
===========================================
66

77
.. default-domain:: mongodb
88

@@ -18,14 +18,14 @@ The ``onlinearchive create`` command creates an :atlas:`online archive
1818
</online-archive/manage-online-archive/>` for the specified collection in the ``M10`` or higher cluster. You can also create an online archive through the
1919
|service| :atlas:`UI </online-archive/configure-online-archive/>` or :atlas:`API </reference/api/online-archive-create-one/>`.
2020

21-
.. _mcli-atlas-online-archive-create-syntax:
21+
.. _mcli-atlas-cluster-online-archive-create-syntax:
2222

2323
Syntax
2424
------
2525

2626
.. code-block:: text
2727

28-
mongocli atlas onlinearchive create
28+
mongocli atlas cluster onlinearchive create
2929
--archiveAfter <number-of-days>
3030
--clusterName <cluster-name>
3131
--collection <collection-name>
@@ -35,7 +35,7 @@ Syntax
3535
[ --profile|-P <profile-name> ]
3636
[ --projectId <project-ID> ]
3737

38-
.. _mcli-atlas-onlinearchive-create-options:
38+
.. _mcli-atlas-cluster-onlinearchive-create-options:
3939

4040
Options
4141
-------
@@ -49,27 +49,27 @@ Options
4949
- Description
5050
- Required?
5151

52-
* - ``archiveAfter``
52+
* - ``--archiveAfter``
5353
- int
5454
- Number of days after which to archive cluster data.
5555
- yes
5656

57-
* - ``clusterName``
57+
* - ``--clusterName``
5858
- string
5959
- Name of the cluster.
6060
- yes
6161

62-
* - ``collection``
62+
* - ``--collection``
6363
- string
6464
- Name of the collection for which to create an online archive.
6565
- yes
6666

67-
* - ``dateField``
67+
* - ``--dateField``
6868
- string
6969
- Name of an already indexed date field from the documents.
7070
- yes
7171

72-
* - ``db``
72+
* - ``--db``
7373
- string
7474
- Name of the database that contains the collection.
7575
- yes
@@ -100,7 +100,7 @@ Options
100100
:ref:`environment variable <mcli-env-var>`.
101101
- no
102102

103-
.. _mcli-atlas-onlinearchive-create-output:
103+
.. _mcli-atlas-cluster-onlinearchive-create-output:
104104

105105
Output
106106
------
@@ -109,7 +109,7 @@ Output
109109

110110
.. include:: /includes/atlas-online-archive-output.rst
111111

112-
.. _mcli-atlas-onlinearchive-create-egs:
112+
.. _mcli-atlas-cluster-onlinearchive-create-egs:
113113

114114
Examples
115115
--------
@@ -129,7 +129,7 @@ The following examples show two ways to create an online archive using the ``mon
129129

130130
The previous command prints the following fields in |json| format to the
131131
terminal. To learn more about these fields, see
132-
:ref:`mcli-atlas-onlinearchive-create-output`.
132+
:ref:`mcli-atlas-cluster-onlinearchive-create-output`.
133133

134134
.. code-block:: sh
135135
:copyable: false
@@ -161,7 +161,7 @@ The following examples show two ways to create an online archive using the ``mon
161161

162162
The previous command prints the following fields in |json| format to the
163163
terminal. To learn more about these fields, see
164-
:ref:`mcli-atlas-onlinearchive-create-output`.
164+
:ref:`mcli-atlas-cluster-onlinearchive-create-output`.
165165

166166
.. code-block:: sh
167167
:copyable: false

‎source/reference/atlas/onlinearchive-pause.txt

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
.. _mcli-atlas-onlinearchive-pause-command:
2+
3+
==========================================
4+
mongocli atlas cluster onlinearchive pause
5+
==========================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
.. include:: /includes/fact-online-archive-beta.rst
16+
17+
The ``onlinearchive pause`` command pauses an active :atlas:`online archive
18+
</online-archive/manage-online-archive/>` for the specified cluster. You can
19+
also pause an online archive through the |service| :atlas:`UI
20+
</online-archive/pause-resume-online-archive/>` or :atlas:`API
21+
</reference/api/online-archive-update-one/>`.
22+
23+
.. _mcli-atlas-cluster-online-archive-pause-syntax:
24+
25+
Syntax
26+
------
27+
28+
.. code-block:: text
29+
30+
mongocli atlas cluster onlinearchive pause <online-archive-id>
31+
--clusterName <cluster-name>
32+
[ --profile|-P <profile-name> ]
33+
[ --projectId <project-ID> ]
34+
35+
.. _mcli-atlas-cluster-onlinearchive-pause-options:
36+
37+
Options
38+
-------
39+
40+
.. list-table::
41+
:header-rows: 1
42+
:widths: 20 10 60 10
43+
44+
* - Option
45+
- Type
46+
- Description
47+
- Required?
48+
49+
* - ``<online-archive-id>``
50+
- string
51+
- Unique identifier of the online archive to pause.
52+
- yes
53+
54+
* - ``--clusterName``
55+
- string
56+
- Name of the cluster.
57+
- yes
58+
59+
* - ``--profile``, ``-P``
60+
- string
61+
- Name of the profile where the public and private
62+
keys for the project are saved. If omitted, uses the
63+
{+default-profile+}. To learn more about creating a
64+
profile, see :ref:`mcli-configure`.
65+
- no
66+
67+
* - ``--projectId``
68+
- string
69+
- Unique identifier of the project that contains the
70+
cluster. If omitted, uses the project ID in the profile or
71+
:ref:`environment variable <mcli-env-var>`.
72+
- no
73+
74+
.. _mcli-atlas-cluster-onlinearchive-pause-output:
75+
76+
Output
77+
------
78+
79+
.. include:: /includes/command-output-intro.rst
80+
81+
.. include:: /includes/atlas-online-archive-output.rst
82+
83+
.. _mcli-atlas-cluster-onlinearchive-pause-egs:
84+
85+
Examples
86+
--------
87+
88+
The following example uses the ``mongocli atlas cluster onlinearchive pause``
89+
command to pause the specified online archive in the cluster named
90+
``myTestCluster``. It uses the {+default-profile+} to access the project.
91+
92+
.. code-block:: sh
93+
94+
mongocli atlas cluster onlinearchive pause 5f189832e26ec075e10c32d3 --clusterName myTestCluster
95+
96+
The previous command prints the following fields in |json| format to
97+
the terminal. To learn more about these fields, see
98+
:ref:`mcli-atlas-cluster-onlinearchive-pause-output`.
99+
100+
.. code-block:: json
101+
:copyable: false
102+
103+
{
104+
"_id": "5f189832e26ec075e10c32d3",
105+
"clusterName": "myTestCluster",
106+
"collName": "movies",
107+
"criteria": {
108+
"dateField": "released",
109+
"expireAfterDays": 2
110+
},
111+
"dbName": "sample_mflix",
112+
"groupId": "5e2211c17a3e5a48f5497de3",
113+
"partitionFields": [
114+
{
115+
"fieldName": "title",
116+
"fieldType": "string",
117+
"order": 0
118+
},
119+
{
120+
"fieldName": "year",
121+
"fieldType": "int",
122+
"order": 1
123+
},
124+
{
125+
"fieldName": "released",
126+
"fieldType": "date",
127+
"order": 2
128+
}
129+
],
130+
"paused": true,
131+
"state": "PAUSED"
132+
}

‎source/reference/atlas/onlinearchive-start.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _mcli-atlas-onlinearchive-start-command:
1+
.. _mcli-atlas-cluster-onlinearchive-start-command:
22

3-
==================================
4-
mongocli atlas onlinearchive start
5-
==================================
3+
==========================================
4+
mongocli atlas cluster onlinearchive start
5+
==========================================
66

77
.. default-domain:: mongodb
88

@@ -18,19 +18,19 @@ The ``onlinearchive start`` command starts the archiving process for the
1818
specified :atlas:`online archive </online-archive/manage-online-archive/>`
1919
in the specified cluster.
2020

21-
.. _mcli-atlas-online-archive-start-syntax:
21+
.. _mcli-atlas-cluster-online-archive-start-syntax:
2222

2323
Syntax
2424
------
2525

2626
.. code-block:: text
2727

28-
mongocli atlas onlinearchive start <online-archive-id>
28+
mongocli atlas cluster onlinearchive start <online-archive-id>
2929
--clusterName <cluster-name>
3030
[ --profile|-P <profile-name> ]
3131
[ --projectId <project-ID> ]
3232

33-
.. _mcli-atlas-onlinearchive-start-options:
33+
.. _mcli-atlas-cluster-onlinearchive-start-options:
3434

3535
Options
3636
-------
@@ -50,7 +50,7 @@ Options
5050
</online-archive/manage-online-archive/>` to start.
5151
- yes
5252

53-
* - ``clusterName``
53+
* - ``--clusterName``
5454
- string
5555
- Name of the cluster.
5656
- yes
@@ -70,7 +70,7 @@ Options
7070
:ref:`environment variable <mcli-env-var>`.
7171
- no
7272

73-
.. _mcli-atlas-onlinearchive-start-output:
73+
.. _mcli-atlas-cluster-onlinearchive-start-output:
7474

7575
Output
7676
------
@@ -79,7 +79,7 @@ Output
7979

8080
.. include:: /includes/atlas-online-archive-output.rst
8181

82-
.. _mcli-atlas-onlinearchive-start-egs:
82+
.. _mcli-atlas-cluster-onlinearchive-start-egs:
8383

8484
Example
8585
-------
@@ -95,7 +95,7 @@ project.
9595

9696
The previous command prints the following fields in |json| format to the
9797
terminal. To learn more about these fields, see
98-
:ref:`mcli-atlas-onlinearchive-start-output`.
98+
:ref:`mcli-atlas-cluster-onlinearchive-start-output`.
9999

100100
.. code-block:: json
101101
:copyable: false

0 commit comments

Comments
 (0)