Skip to content

Commit 5c2c234

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-9936 docs for atlas data lake (#3)
* DOCSP-9936 docs for atlas data lake
1 parent 38b1f8b commit 5c2c234

Some content is hidden

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

55 files changed

+1350
-1019
lines changed

‎README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=========================
2-
MongoDB CLI Documentation
3-
=========================
1+
=====================================
2+
MongoDB Atlas Data Lake Documentation
3+
=====================================
44

55
This repository contains documentation for the MongoDB Atlas Data Lake.
66

‎source/admin/determine-query-status.txt‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ documents with the following fields:
6060
* - ``$currentOp.clientMetadata``
6161
- Document
6262
- Additional client information such as the client:
63-
- Application name
64-
- Driver name and version number
65-
- Operating System name, type, architecture, and version number
63+
.. container::
64+
- Application name
65+
- Driver name and version number
66+
- Operating System name, type, architecture, and version number
6667

6768
* - ``$currentOp.active``
6869
- boolean

‎source/admin/manage-namespace-catalog-cli.txt‎

Lines changed: 5 additions & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,6 @@ Manage Namespace Metadata Catalog for Wildcard Collections
88

99
.. include:: /includes/fact-data-lake-beta.rst
1010

11-
.. contents:: On this page
12-
:local:
13-
:backlinks: none
14-
:depth: 2
15-
:class: singlecol
16-
1711
The {+data-lake+} namespace catalog contains namespace metadata
1812
(such as databases, collections, and partitions) for each wildcard (``*``)
1913
collection in each {+data-lake-store+} in the {+data-lake-short+} storage
@@ -31,179 +25,10 @@ refreshed in the background when you:
3125
- :ref:`Update the storage configuration <datalake-setstorageconfig>`.
3226
- Run the ``show collections`` command.
3327
- Query a collection.
34-
- Run the :ref:`adl-updateCatalog-cmd` command.
28+
- Run the :ref:`updateCatalog-cmd` command.
3529

3630
You can determine when the catalog was last updated by using the
37-
:ref:`adl-catalogInfo-cmd` command and can manually update the catalog
38-
by using the :ref:`adl-updateCatalog-cmd` command. You must have the
39-
:authrole:`atlasAdmin` role to update the catalog.
40-
41-
.. _adl-catalogInfo-cmd:
42-
43-
``catalogInfo``
44-
---------------
45-
46-
The ``catalogInfo`` command returns an array of the stores and the
47-
:manual:`ISODate </reference/glossary/#term-isodate>` when the
48-
namespace metadata in the catalog was last updated.
49-
50-
.. _adl-catalogInfo-cmd-syntax:
51-
52-
Syntax
53-
~~~~~~
54-
55-
.. code-block:: text
56-
57-
db.runCommand({ "catalogInfo" : 1, "stores": ["<storeName>"] })
58-
59-
.. _adl-catalogInfo-cmd-usage:
60-
61-
Usage
62-
~~~~~
63-
64-
To retrieve the last updated timestamp for all the stores, run the
65-
following command:
66-
67-
.. code-block:: text
68-
69-
db.runCommand({ "catalogInfo" : 1 })
70-
71-
To retrieve the last updated timestamp for a specific store, run
72-
the following command:
73-
74-
.. code-block:: text
75-
76-
db.runCommand({ "catalogInfo" : 1, "stores": ["<storeName>"] })
77-
78-
To retrieve the last updated timestamp for a list of stores, run
79-
the following command:
80-
81-
.. code-block:: text
82-
83-
db.runCommand({ "catalogInfo" : 1, "stores": ["<storeName>",...] })
84-
85-
.. _adl-catalogInfo-cmd-output:
86-
87-
Output
88-
~~~~~~
89-
90-
The command returns output similar to the following if the command
91-
succeeds:
92-
93-
.. code-block:: json
94-
:copyable: false
95-
96-
{
97-
"ok" : 1,
98-
"stores" : [
99-
{
100-
"<storeName>" : ISODate("<date>")
101-
}
102-
]
103-
}
104-
105-
where:
106-
107-
- ``storeName`` is the name of the |s3| store
108-
- ``date`` is the date and timestamp in :manual:`ISODate
109-
</reference/glossary/#term-isodate>` format
110-
111-
.. _adl-catalogInfo-cmd-eg:
112-
113-
Example
114-
~~~~~~~
115-
116-
The following command returns the last updated date and timestamp for
117-
all the stores.
118-
119-
.. code-block:: json
120-
121-
db.runCommand({"catalogInfo":1})
122-
123-
The previous command returns the following output:
124-
125-
.. code-block:: json
126-
:copyable: false
127-
128-
{
129-
"ok" : 1,
130-
"stores" : [
131-
{
132-
"s3store" : ISODate("2020-03-25T12:35:32.165Z")
133-
},
134-
{
135-
"egS3Store" : ISODate("2020-03-25T12:35:32.165Z")
136-
}
137-
]
138-
}
139-
140-
.. _adl-updateCatalog-cmd:
141-
142-
``updateCatalog``
143-
-----------------
144-
145-
The ``updateCatalog`` command updates the namespace metadata in the
146-
catalog. You can verify by running the :ref:`adl-catalogInfo-cmd` command,
147-
which shows the :manual:`ISODate </reference/glossary/#term-isodate>` when the
148-
catalog was last updated. If you have a large {+data-lake-store+}, it may take
149-
a while to update the catalog.
150-
151-
.. _adl-updateCatalog-cmd-syntax:
152-
153-
Syntax
154-
~~~~~~
155-
156-
.. code-block:: text
157-
158-
db.runCommand({ "updateCatalog" : 1, "background" : true })
159-
160-
.. _adl-updateCatalog-cmd-usage:
161-
162-
Usage
163-
~~~~~
164-
165-
To update the catalog, run the following command:
166-
167-
.. code-block:: text
168-
169-
db.runCommand({ "updateCatalog" : 1 })
170-
171-
The previous command runs in the foreground and is similar to running
172-
the command with ``background`` set to ``false``.
173-
174-
To update the catalog in the background, run the following command:
175-
176-
.. code-block:: text
177-
178-
db.runCommand({ "updateCatalog" : 1, "background" : true })
179-
180-
.. _adl-updateCatalog-cmd-output:
181-
182-
Output
183-
~~~~~~
184-
185-
The command returns the following output:
186-
187-
.. code-block:: json
188-
:copyable: false
189-
190-
{ "ok" : 1 }
191-
192-
.. _adl-updateCatalog-cmd-eg:
193-
194-
Example
195-
~~~~~~~
196-
197-
The following command updates the namespace metadata in the catalog:
198-
199-
.. code-block:: json
200-
201-
db.runCommand({ "updateCatalog" : 1 })
202-
203-
The previous command returns the following output:
204-
205-
.. code-block:: json
206-
:copyable: false
207-
208-
{ "ok" : 1 }
209-
31+
:ref:`catalogInfo-cmd` command and can manually update the catalog
32+
by using the :ref:`updateCatalog-cmd` command. You must have the
33+
:atlas:`atlasAdmin <security-add-mongodb-users/#atlasAdmin>` role
34+
to update the catalog.

‎source/admin/optimize-query-performance.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _optimize-query-perf:
2+
13
======================================
24
Optimize |data-lake| Query Performance
35
======================================

‎source/administration.txt‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
.. _adl-administration:
22

3-
==============
4-
Administration
5-
==============
3+
=========================
4+
Administering |data-lake|
5+
=========================
66

77
.. default-domain:: mongodb
88

9-
.. contents:: On this page
10-
:local:
11-
:backlinks: none
12-
:depth: 1
13-
:class: singlecol
9+
This section contains the following:
10+
11+
- :ref:`Managing Namespace Metadata Catalog for Wildcard Collections
12+
<manage-ns-catalog-cli>`
13+
- :ref:`Optimizing Query Performance <optimize-query-perf>`
14+
- :ref:`Determining Query Status <determine-query-status>`
1415

1516
.. class:: hidden
1617

‎source/config/config-data-lake.txt‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _config-datalake:
22

3-
=============================
4-
Configure {+data-lake-short+}
5-
=============================
3+
===============================
4+
Configuring {+data-lake-short+}
5+
===============================
66

77
.. default-domain:: mongodb
88

@@ -40,8 +40,9 @@ connecting a :binary:`~bin.mongo` shell to the {+data-lake-short+}:
4040

4141
.. note::
4242

43-
Any MongoDB user in the |service| project with the :authrole:`atlasAdmin`
44-
role can retrieve and update the {+data-lake-short+} configuration.
43+
Any MongoDB user in the |service| project with the :atlas:`atlasAdmin
44+
<security-add-mongodb-users/#atlasAdmin>` role can retrieve and update
45+
the {+data-lake-short+} configuration.
4546

4647
.. _datalake-getstorageconfig:
4748

@@ -83,5 +84,8 @@ format, see :ref:`datalake-configuration-format`.
8384
:titlesonly:
8485

8586
/reference/config-files/data-lake-configuration
86-
/supported-unsupported/supported-partition-attributes
8787
/reference/examples/path-syntax-examples
88+
/config/manage-stores-cli
89+
/config/manage-dbs-cli
90+
/config/manage-collections-views-cli
91+
/config/update-region

‎source/config/manage-collections-cli.txt‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎source/config/manage-collections-views-cli.txt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _manage-collections-views-cli:
2+
3+
=============================================================================
4+
Manage Collections and Views in the {+data-lake-short+} Storage Configuration
5+
=============================================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/fact-data-lake-beta.rst
10+
11+
You can manage the collections and views in your {+data-lake+} storage
12+
configuration using the following commands:
13+
14+
- :ref:`dl-create-collection-views-cmd` command to create
15+
a collection that maps to an existing store in the storage
16+
configuration or a view on an existing collection in the storage
17+
configuration.
18+
- :ref:`dl-rename-collection-cmd` command to rename a collection
19+
in the storage configuration to a new name or to an existing
20+
name in the storage configuration.
21+
- :ref:`dl-drop-collection-views-cmd` command to remove a
22+
collection from the database in the storage configuration or a view
23+
on a collection in the storage configuration.

‎source/config/manage-dbs-cli.txt‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,8 @@ Manage Databases in the {+data-lake-short+} Storage Configuration
88

99
.. include:: /includes/fact-data-lake-beta.rst
1010

11-
.. contents:: On this page
12-
:local:
13-
:backlinks: none
14-
:depth: 2
15-
:class: singlecol
16-
17-
Overview
18-
--------
19-
2011
You can manage databases in your {+data-lake+} storage configuration using
2112
the following commands:
2213

23-
- :ref:`datalake-getstorageconfig`
24-
- :ref:`dl-drop-database-cmd`
14+
- :ref:`storageGetConfig <datalake-getstorageconfig>`
15+
- :ref:`dropDatabase <dl-drop-database-cmd>`

‎source/config/manage-stores-cli.txt‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,9 @@ Manage Data Stores in the {+data-lake-short+} Storage Configuration
88

99
.. include:: /includes/fact-data-lake-beta.rst
1010

11-
.. contents:: On this page
12-
:local:
13-
:backlinks: none
14-
:depth: 2
15-
:class: singlecol
16-
1711
You can manage the {+data-lake-stores+} in your {+data-lake+} storage
1812
configuration using the following commands:
1913

2014
- :ref:`dl-create-store-cmd`
2115
- :ref:`dl-list-stores-cmd`
2216
- :ref:`dl-drop-store-cmd`
23-
24-
.. class:: hidden
25-
26-
.. toctree::
27-
:titlesonly:
28-
29-
/reference/cli/create-store
30-
/reference/cli/list-stores
31-
/reference/cli/drop-store

0 commit comments

Comments
 (0)