Skip to content

Commit c25c646

Browse files
DOCSP-29175 Add how to rename collection (#127)
* DOCSP-29175 add blurb on renaming collection * DOCSP-29175 add blurb on renaming collection * DOCSP-29175 update * DOCSP-29175 update * DOCSP-29175 test staging again * DOCSP-29175 external feedback * DOCSP-29175 copy edit * DOCSP-29175 copy edit * DOCSP-29175 copy edit
1 parent 2de7fed commit c25c646

File tree

3 files changed

+54
-1
lines changed

3 files changed

+54
-1
lines changed

source/mapping-rules/mapping-rule-options/mapping-rule-options.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,5 @@ mapping rule option.
9191
/mapping-rules/mapping-rule-options/new-documents
9292
/mapping-rules/mapping-rule-options/embedded-array
9393
/mapping-rules/mapping-rule-options/embedded-documents
94-
/mapping-rules/mapping-rule-options/time-series
94+
/mapping-rules/mapping-rule-options/time-series
95+
/mapping-rules/mapping-rule-options/rename-collection
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. _rm-rename-collection:
2+
3+
===================
4+
Rename a Collection
5+
===================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can rename a collection on the :guilabel:`Mapping` screen.
14+
15+
About this Task
16+
---------------
17+
18+
You cannot rename a collection to a name that is already in use, nor can you
19+
leave the :guilabel:`Name` text box blank, as both actions result in an
20+
error.
21+
22+
Steps
23+
-----
24+
25+
.. procedure::
26+
27+
.. step:: Select a collection
28+
29+
To select a collection on the :guilabel:`Mapping` screen:
30+
31+
- Click on a collection in the MongoDB diagram, or
32+
- Click on a collection listed under the :guilabel:`MongoDB` header on the
33+
:guilabel:`Schema Model` pane.
34+
35+
.. step:: Enter and save the new name
36+
37+
On the :guilabel:`Mappings` pane, click the :guilabel:`Name` text box and enter
38+
the new name.
39+
40+
Click anywhere outside of the text box to save the changes. The name is updated on
41+
the MongoDB diagram and the :guilabel:`Schema Model` pane.
42+
43+
Learn More
44+
----------
45+
46+
- :ref:`rm-mapping-rule-options`
47+
- :ref:`rm-timeseries`

source/mapping-rules/new-rules-to-mongodb.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ Steps
5454
mapping rule, you can:
5555

5656
- Change the collection name.
57+
58+
To change the collection name, click the :guilabel:`Name` text box and enter
59+
the new name. Click outside of the text box to save the change. If the name
60+
is already in use, you receive a validation error.
61+
5762
- Change field names.
5863
- Include or exclude a field from your sync job by clicking the
5964
:icon-fa5:`check-square` icon next to the field name.

0 commit comments

Comments
 (0)