Skip to content

Commit a72a8cf

Browse files
authored
DOCSP-11181: [mongocli] mongocli atlas datalake delete name (#149)
1 parent 9546c07 commit a72a8cf

File tree

2 files changed

+108
-0
lines changed

2 files changed

+108
-0
lines changed

source/reference/atlas/datalake-commands.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ Atlas ``datalake`` Commands
1212
List Data Lakes </reference/atlas/datalake-list>
1313
Describe a Data Lake </reference/atlas/datalake-describe>
1414
Create a Data Lake </reference/atlas/datalake-create>
15+
Delete a Data Lake </reference/atlas/datalake-delete>
1516
Update a Data Lake </reference/atlas/datalake-update>
1617

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
.. _mcli-atlas-datalake-delete-command:
2+
3+
==============================
4+
mongocli atlas datalake delete
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+
The ``datalake delete`` command deletes one `Atlas Data Lake
16+
<https://docs.mongodb.com/datalake/>`__ associated with the
17+
specified |service| project. You can also delete a {+data-lake-short+} with
18+
the :datalake:`Data Lake API </reference/api/dataLakes-delete-one-tenant>`
19+
or with the |service| UI by selecting :guilabel:`Data Lake` from the left-side
20+
navigation.
21+
22+
.. _datalake-delete-syntax:
23+
24+
Syntax
25+
------
26+
27+
.. code-block:: text
28+
:copyable: false
29+
30+
mongocli atlas datalake delete <datalake-name>
31+
[ --force ]
32+
[ --profile|-P <profile-name> ]
33+
[ --projectId <id-of-project> ]
34+
35+
.. include:: /includes/fact-command-line-help.rst
36+
37+
.. _datalake-delete-options:
38+
39+
Options
40+
-------
41+
42+
.. list-table::
43+
:header-rows: 1
44+
:widths: 20 10 60 10
45+
46+
* - Option
47+
- Type
48+
- Description
49+
- Required?
50+
51+
* - ``<datalake-name>``
52+
- string
53+
- Name of the {+data-lake-short+}.
54+
- yes
55+
56+
* - ``--force``
57+
-
58+
- Bypasses the confirmation message.
59+
- no
60+
61+
* - ``--profile``, ``-P``
62+
- string
63+
- Name of the profile where the public and private
64+
keys for the project are saved. If omitted, uses the
65+
{+default-profile+}. To learn more about creating a
66+
profile, see :ref:`mcli-configure`.
67+
- no
68+
69+
* - ``--projectId``
70+
- string
71+
- Unique identifier of the project that contains the
72+
cluster to update. If omitted, uses the project ID in
73+
the profile or :ref:`environment variable <mcli-env-var>`.
74+
- no
75+
76+
.. _datalake-delete-output:
77+
78+
Behavior
79+
--------
80+
81+
You must respond affirmatively to a confirmation request before {+mcli+}
82+
completes a request to delete a {+data-lake-short+}.
83+
84+
Output
85+
------
86+
87+
The command prints the following message to the terminal if the command
88+
succeeds. If the command returns errors, see :ref:`Troubleshooting
89+
<mcli-troubleshooting>` for recommended solutions.
90+
91+
.. code-block:: none
92+
:copyable: false
93+
94+
Data Lake '<datalake-name>' deleted
95+
96+
.. _datalake-delete-example:
97+
98+
Example
99+
-------
100+
101+
The following example uses the ``mongocli atlas datalake delete`` command
102+
to delete a {+data-lake-short+} named ``myDL`` in the specified project. It
103+
uses the {+default-profile+} to access the project.
104+
105+
.. code-block:: text
106+
107+
mongocli atlas datalake delete myDL --projectId 5e2211c17a3e5a48f5497de3

0 commit comments

Comments
 (0)