Skip to content

Commit 8cc4712

Browse files
COMPASS-3986: Adding migration information to docs (#225)
* COMPASS-3986: Adding migration information to docs * Formatting tweaks Co-authored-by: jeff-allen-mongo <[email protected]>
1 parent 0e14c00 commit 8cc4712

File tree

2 files changed

+65
-17
lines changed

2 files changed

+65
-17
lines changed

source/index.txt

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@ Available |compass-short| Editions
3838
* - Edition
3939
- Description
4040

41-
* - :guilabel:`Compass Community`
42-
- Designed for developing with MongoDB and includes a
43-
subset of the features of Compass.
44-
4541
* - :guilabel:`Compass`
4642
- Full version of MongoDB Compass, with all features and
4743
capabilities.
@@ -55,6 +51,19 @@ Available |compass-short| Editions
5551
except to the MongoDB server to which |compass-short| connects.
5652
This edition is designed for highly secure environments.
5753

54+
* - :guilabel:`Compass Community`
55+
- .. important::
56+
57+
This version is deprecated. Instead, use the full free version
58+
of |compass|. To learn how to migrate from Compass Community
59+
to the fully-featured Compass edition, see
60+
:ref:`migrate-from-community`.
61+
62+
Designed for developing with MongoDB and includes a
63+
subset of the features of Compass.
64+
65+
66+
5867
.. _compass-feature-table:
5968

6069
Capabilities of |compass-short| Editions
@@ -68,17 +77,17 @@ suit your needs.
6877
:widths: 40 15 15 15 15
6978

7079
* -
71-
- Compass Community
7280
- Compass
7381
- Compass Readonly
7482
- Compass Isolated
83+
- Compass Community *(Deprecated)*
7584

7685
* - Interact with :ref:`documents <compass-documents>`,
7786
:ref:`collections <collection-tab>`, and
7887
:ref:`databases <database-tab>` with full CRUD functionality
7988
- |checkmark|
89+
-
8090
- |checkmark|
81-
-
8291
- |checkmark|
8392

8493
* - Create and execute :ref:`queries <compass-query-bar>` and
@@ -90,47 +99,47 @@ suit your needs.
9099

91100
* - Create and delete :ref:`indexes <compass-indexes>`
92101
- |checkmark|
102+
-
93103
- |checkmark|
94-
-
95104
- |checkmark|
96105

97106
* - View and optimize query performance with visual
98107
:ref:`explain plans <explain-plans>`
99108
- |checkmark|
109+
-
100110
- |checkmark|
101-
-
102111
- |checkmark|
103112

104113
* - Kerberos, LDAP, and x.509 authentication
105-
-
106114
- |checkmark|
107115
- |checkmark|
108116
- |checkmark|
117+
-
109118

110119
* - :doc:`Schema Analysis </schema>`
111-
-
112120
- |checkmark|
113121
- |checkmark|
114122
- |checkmark|
123+
-
115124

116125
* - :doc:`Real Time Server Stats </performance>`
117-
-
118126
- |checkmark|
119127
- |checkmark|
120128
- |checkmark|
129+
-
121130

122131
* - Create, delete and edit :ref:`document validation <validation>`
123132
rules
124-
-
125133
- |checkmark|
126-
-
134+
-
127135
- |checkmark|
136+
-
128137

129138
* - Error collection and crash reporting
130139
- |checkmark|
131140
- |checkmark|
141+
-
132142
- |checkmark|
133-
-
134143

135144
MongoDB Compass is Source Available
136145
-----------------------------------

source/upgrade.txt

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _upgrade-compass:
22

3-
=====================================
4-
Upgrade Compass to the Latest Version
5-
=====================================
3+
=======================
4+
Upgrade MongoDB Compass
5+
=======================
66

77
.. default-domain:: mongodb
88

@@ -42,6 +42,45 @@ You can enable automatic updates to the latest version of Compass on the
4242
Instead, |compass-short| prompts you to upgrade when a new version is
4343
available.
4444

45+
.. _migrate-from-community:
46+
47+
Migrate to Compass from Compass Community
48+
-----------------------------------------
49+
50+
To migrate from Compass Community edition to the fully-featured
51+
edition of Compass and retain any saved data such as saved connection
52+
strings and favorite queries, you must migrate that data to your
53+
new edition of |compass|.
54+
55+
1. Download the fully-featured edition of |compass| from the
56+
{+download-page+}.
57+
58+
#. Refer to the following table to see where your |compass| data
59+
is stored based on your operating system:
60+
61+
.. list-table::
62+
:header-rows: 1
63+
64+
* - Operating System
65+
- Data Location
66+
67+
* - macOS
68+
- ``~/Library/Application Support``
69+
70+
* - Windows
71+
- ``%APPDATA%/Roaming``
72+
73+
* - Linux
74+
- ``$XDG_CONFIG_HOME`` or ``~/.config``
75+
76+
#. Move the following folders from your Compass Community edition folder
77+
to your fully-featured Compass folder:
78+
79+
- ``Connections``
80+
- ``FavoriteQueries``
81+
- ``RecentQueries``
82+
- ``SavedPipelines``
83+
4584
.. seealso::
4685

4786
:ref:`download-install`

0 commit comments

Comments
 (0)