Skip to content

Commit dd16053

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-16099 Document View Creation in Data Lake UI Configuration Builder (#161)
* DOCSP-16099 Document View Creation in Data Lake UI Configuration Builder * DOCSP-16099 updates for feedback
1 parent ab65ec3 commit dd16053

7 files changed

+317
-8
lines changed

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,27 @@ Manage Collections and Views in the {+data-lake-short+} Storage Configuration
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can create, edit, and delete collections and views in your {+dl+}
16+
storage configuration using the |service| User Interface and the
17+
{+adl+} CLI.
18+
19+
Managing Collections and Views From the UI
20+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
22+
To add, edit, or delete collections and views in your {+dl+} storage
23+
configuration from the |service| User Interface:
24+
25+
.. include:: /includes/steps/manage-colls-views-ui.rst
26+
27+
Managing Collections and Views Through the CLI
28+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29+
930
You can manage the collections and views in your {+data-lake+} storage
1031
configuration using the following commands:
1132

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

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

77
.. default-domain:: mongodb
88

9-
You can manage databases in your {+data-lake+} storage configuration using
10-
the following commands:
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can create, edit, and delete databases in your {+dl+} storage
16+
configuration using the |service| User Interface and the {+adl+} CLI.
17+
18+
Managing Databases From the UI
19+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20+
21+
To add, edit, or delete databases in your {+dl+} storage configuration
22+
from the |service| User Interface:
23+
24+
.. include:: /includes/steps/manage-dbs-ui.rst
25+
26+
Managing Databases Through the CLI
27+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28+
29+
You can manage databases in your {+data-lake+} storage configuration
30+
using the following commands:
1131

1232
- :ref:`storageGetConfig <datalake-getstorageconfig>`
1333
- :ref:`dropDatabase <dl-drop-database-cmd>`

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,26 @@ Manage Data Stores in the {+data-lake-short+} Storage Configuration
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can create, edit, and delete data stores in your {+dl+} storage
16+
configuration using the |service| User Interface and the {+adl+} CLI.
17+
18+
Managing Data Stores From the UI
19+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20+
21+
To add, edit, or delete data stores in your {+dl+} storage
22+
configuration from the |service| User Interface:
23+
24+
.. include:: /includes/steps/manage-data-stores-ui.rst
25+
26+
Managing Data Stores Through the CLI
27+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28+
929
You can manage the {+data-lake-stores+} in your {+data-lake+} storage
1030
configuration using the following commands:
1131

‎source/includes/steps-data-lake-deploy-source.yaml

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,33 +27,56 @@ content: |
2727
---
2828
ref: drag-drop-data-store
2929
level: 4
30-
title: "Create the virtual databases and collections and map the databases and collections to your data store."
30+
title: "Create the virtual databases, collections, and views and map
31+
the databases, collections, and views to your data store."
3132
content: |
3233
3334
a. (Optional) Click the :icon-fa4:`pencil` for the:
3435
3536
- :guilabel:`Data Lake` to specify a name for your {+dl+}.
3637
Defaults to ``Data Lake[n]``.
3738
38-
- :guilabel:`Database` to edit the database name. Defaults to
39-
``Database[n]``.
39+
- Database to edit the database name. Defaults to ``Database[n]``.
4040
4141
Corresponds to :datalakeconf:`databases.[n].name` |json|
4242
configuration setting.
4343
44-
- :guilabel:`Collection` to edit the collection name. Defaults to
44+
- Collection to edit the collection name. Defaults to
4545
``Collection[n]``.
4646
4747
Corresponds to :datalakeconf:`databases.[n].collections.name`
4848
|json| configuration setting.
4949
50+
- View to edit the view name.
51+
5052
You can click:
5153
5254
- :guilabel:`Create Database` to add databases and collections.
5355
- :icon-fa4:`plus` associated with the database to add collections
5456
to the database.
55-
- :icon-fa4:`trash-o` associated with the database or collection
56-
to remove the database or collection.
57+
- :icon-fa4:`plus` associated with the collection to add
58+
:manual:`views </core/views/>` on the collection. To create a
59+
view, you must specify:
60+
61+
- The name of the view.
62+
- The :manual:`pipeline
63+
</core/aggregation-pipeline/#std-label-aggregation-pipeline>`
64+
to apply to the view.
65+
66+
.. note::
67+
68+
The view definition pipeline cannot include the ``$out`` or
69+
the ``$merge`` stage. If the view definition includes
70+
nested pipeline stages such as ``$lookup`` or ``$facet``,
71+
this restriction applies to those nested pipelines as well.
72+
73+
To learn more about views, see:
74+
75+
- :manual:`Views </core/views/>`
76+
- :manual:`db.createView </reference/method/db.createView/>`
77+
78+
- :icon-fa4:`trash-o` associated with the database, collection, or
79+
view to remove it.
5780
5881
#. Drag and drop the data store to map with the collection.
5982

‎source/includes/steps-manage-colls-views-ui.yaml

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
level: 4
3+
ref: manage-colls-views-ui-step1
4+
source:
5+
file: steps-data-lake-deploy-source.yaml
6+
ref: data-lake-log-in
7+
---
8+
level: 4
9+
ref: manage-colls-views-ui-step2
10+
source:
11+
file: steps-data-lake-deploy-source.yaml
12+
ref: data-lake-left-nav
13+
---
14+
title: "Click :guilabel:`Configuration` for the {+dl+} and choose the
15+
configuration method:"
16+
level: 4
17+
ref: manage-colls-views-ui-step3
18+
content: |
19+
20+
- For a guided experience, click :guilabel:`Visual Editor`.
21+
22+
.. note::
23+
24+
The :guilabel:`Visual Editor` doesn't support wildcard
25+
(``*``) collections.
26+
27+
- To edit the raw |json|, click :guilabel:`JSON Editor`.
28+
29+
---
30+
title: "Make necessary changes to the collections and views in your
31+
{+dl+} storage configuration."
32+
level: 4
33+
ref: manage-colls-views-ui-step4
34+
content: |
35+
36+
.. tabs::
37+
38+
.. tab:: Visual Editor
39+
:tabid: visual
40+
41+
- Click the :icon-fa4:`pencil` for the:
42+
43+
- Collection to edit the collection name.
44+
45+
Corresponds to
46+
:datalakeconf:`databases.[n].collections.name` |json|
47+
configuration setting.
48+
49+
- View to edit the view name and pipeline.
50+
51+
Corresponds to
52+
:datalakeconf:`databases.[n].views.[n].name` and
53+
:datalakeconf:`databases.[n].views.[n].pipeline` |json|
54+
configuration settings respectively.
55+
56+
- Click :icon-fa4:`plus` associated with the:
57+
58+
- Database to add collections to the database.
59+
60+
Corresponds to
61+
:datalakeconf:`databases.[n].collections` |json|
62+
configuration setting.
63+
64+
- Collection to add :manual:`views </core/views/>` on the
65+
collection. To create a view, you must specify:
66+
67+
- The name of the view.
68+
- The :manual:`pipeline </core/aggregation-pipeline/#std-label-aggregation-pipeline>`
69+
to apply to the view.
70+
71+
Corresponds to
72+
:datalakeconf:`databases.[n].views` |json| configuration
73+
setting.
74+
75+
- Click :icon-fa4:`trash-o` associated with the collection or
76+
view to remove the collection or view.
77+
78+
.. tab:: JSON Editor
79+
:tabid: json
80+
81+
Edit the |json| configuration settings shown in the UI for
82+
``databases``. To learn more about the configuration settings
83+
for ``collections`` and ``views`` in your database, see
84+
:ref:`datalake-configuration-file`.
85+
86+
---
87+
ref: manage-colls-views-ui-step5
88+
stepnum: 7
89+
inherit:
90+
file: steps-data-lake-deploy-source.yaml
91+
ref: save-configuration
92+
...

‎source/includes/steps-manage-data-stores-ui.yaml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
level: 4
3+
ref: manage-data-stores-ui-step1
4+
source:
5+
file: steps-data-lake-deploy-source.yaml
6+
ref: data-lake-log-in
7+
---
8+
level: 4
9+
ref: manage-data-stores-ui-step2
10+
source:
11+
file: steps-data-lake-deploy-source.yaml
12+
ref: data-lake-left-nav
13+
---
14+
title: "Click :guilabel:`Configuration` for the {+dl+} and choose the
15+
configuration method:"
16+
level: 4
17+
ref: manage-data-stores-step3
18+
content: |
19+
20+
- For a guided experience, click :guilabel:`Visual Editor`.
21+
- To edit the raw |json|, click :guilabel:`JSON Editor`.
22+
23+
---
24+
title: "Make necessary changes to the databases in your {+dl+} storage
25+
configuration."
26+
level: 4
27+
ref: manage-data-stores-ui-step4
28+
content: |
29+
30+
.. tabs::
31+
32+
.. tab:: Visual Editor
33+
:tabid: visual
34+
35+
- Click :guilabel:`Add Data Store` to add a new data store. To
36+
add an:
37+
38+
- |s3| data store, complete step 5 in :ref:`deploy-s3`.
39+
- |service| data store, follow steps 5 to 7 in
40+
:ref:`deploy-atlas-datastore-datalake`.
41+
- |http| data store, follow steps 5 to 7 in
42+
:ref:`deploy-http-datastore-datalake`.
43+
44+
Corresponds to :datalakeconf:`stores` |json| configuration
45+
setting.
46+
47+
- Click the :icon-fa4:`pencil` for the store to edit the
48+
data store name.
49+
50+
Corresponds to :datalakeconf:`stores.[n].name` |json|
51+
configuration setting.
52+
53+
- Click :icon-fa4:`trash-o` associated with the data store to
54+
remove the data store.
55+
56+
.. tab:: JSON Editor
57+
:tabid: json
58+
59+
Edit the |json| configuration settings shown in the UI for
60+
``stores``. To learn more about the ``stores`` configuration
61+
settings for your data store, see :ref:`datalake-configuration-file`.
62+
63+
---
64+
ref: manage-data-stores-ui-step5
65+
stepnum: 7
66+
inherit:
67+
file: steps-data-lake-deploy-source.yaml
68+
ref: save-configuration
69+
...

‎source/includes/steps-manage-dbs-ui.yaml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
level: 4
3+
ref: manage-dbs-ui-step1
4+
source:
5+
file: steps-data-lake-deploy-source.yaml
6+
ref: data-lake-log-in
7+
---
8+
level: 4
9+
ref: manage-dbs-ui-step2
10+
source:
11+
file: steps-data-lake-deploy-source.yaml
12+
ref: data-lake-left-nav
13+
---
14+
title: "Click :guilabel:`Configuration` for the {+dl+} and choose the
15+
configuration method:"
16+
level: 4
17+
ref: manage-dbs-step3
18+
content: |
19+
20+
- For a guided experience, click :guilabel:`Visual Editor`.
21+
- To edit the raw |json|, click :guilabel:`JSON Editor`.
22+
23+
---
24+
title: "Make necessary changes to the databases in your {+dl+} storage
25+
configuration."
26+
level: 4
27+
ref: manage-dbs-ui-step4
28+
content: |
29+
30+
.. tabs::
31+
32+
.. tab:: Visual Editor
33+
:tabid: visual
34+
35+
- Click :guilabel:`Create Database` to add databases and
36+
collections.
37+
38+
Corresponds to :datalakeconf:`databases` |json| configuration
39+
setting.
40+
41+
- Click the :icon-fa4:`pencil` for the database to edit the
42+
database name.
43+
44+
Corresponds to :datalakeconf:`databases.[n].name` |json|
45+
configuration setting.
46+
47+
- Click :icon-fa4:`trash-o` associated with the database to
48+
remove the database.
49+
50+
.. tab:: JSON Editor
51+
:tabid: json
52+
53+
Edit the |json| configuration settings shown in the UI for
54+
``databases``. To learn more about the ``databases``
55+
configuration settings for your data store, see
56+
:ref:`datalake-configuration-file`.
57+
58+
---
59+
ref: manage-dbs-ui-step5
60+
stepnum: 7
61+
inherit:
62+
file: steps-data-lake-deploy-source.yaml
63+
ref: save-configuration
64+
...

0 commit comments

Comments
 (0)