|
| 1 | + |
| 2 | +.. _data-sources-view: |
| 3 | +.. _connect-disconnect-data-source: |
| 4 | + |
| 5 | +================================================== |
| 6 | +Connect or Disconnect Data Sources and Deployments |
| 7 | +================================================== |
| 8 | + |
| 9 | +.. default-domain:: mongodb |
| 10 | + |
| 11 | +.. contents:: On this page |
| 12 | + :local: |
| 13 | + :backlinks: none |
| 14 | + :depth: 1 |
| 15 | + :class: singlecol |
| 16 | + |
| 17 | +On the :guilabel:`Data Sources` page, an |service| |
| 18 | +:authrole:`Project Owner` can: |
| 19 | + |
| 20 | +- :ref:`Connect a deployment <connect-deployment>` or |
| 21 | + :ref:`connect a data source <connect-data-source>` to |charts|. |
| 22 | +- :ref:`Disconnect a deployment <disconnect-deployment>` or |
| 23 | + :ref:`disconnect a data source <disconnect-data-source>` from |
| 24 | + |charts|. |
| 25 | + |
| 26 | +To learn more about data sources and deployments, see :ref:`data-sources`. |
| 27 | + |
| 28 | +|charts-short| connects to all deployments and data sources by default. |
| 29 | + |
| 30 | +.. _connect-deployment: |
| 31 | + |
| 32 | +Connect a Deployment to |charts-short| |
| 33 | +-------------------------------------- |
| 34 | + |
| 35 | +You can connect a deployment to |charts-short| to access the |
| 36 | +data for the collections within the deployment in |charts-short|. |
| 37 | + |
| 38 | +To connect a deployment to |charts-short|: |
| 39 | + |
| 40 | +.. procedure:: |
| 41 | + :style: normal |
| 42 | + |
| 43 | + .. include:: /includes/steps-access-deployment.rst |
| 44 | + |
| 45 | + .. include:: /includes/steps-connect-deployment.rst |
| 46 | + |
| 47 | + To learn more about the other information that displays for the |
| 48 | + deployment, see :ref:`manage-deployment`. |
| 49 | + |
| 50 | +.. _add-data-source: |
| 51 | +.. _connect-data-source: |
| 52 | + |
| 53 | +Connect a Data Source to |charts-short| |
| 54 | +--------------------------------------- |
| 55 | + |
| 56 | +Connect a data source to |charts-short| to use its data in your charts. |
| 57 | + |
| 58 | +When you connect a data source, |charts-short| grants the default |
| 59 | +:ref:`permissions <permission-model>` to |charts-short| users. To |
| 60 | +customize the permissions for a data source, see |
| 61 | +:ref:`mod-data-source-permissions`. |
| 62 | + |
| 63 | +To connect a data source to |charts-short|: |
| 64 | + |
| 65 | +.. procedure:: |
| 66 | + :style: normal |
| 67 | + |
| 68 | + .. step:: Connect your deployment. |
| 69 | + |
| 70 | + To learn more, see :ref:`connect-deployment`. |
| 71 | + |
| 72 | + .. step:: In the :guilabel:`Data Access` section, select the database that contains the data source. |
| 73 | + |
| 74 | + Select the database that contains the data source you want to |
| 75 | + connect. The database's data sources display, including |
| 76 | + :ref:`charts views <charts-views>`. |
| 77 | + |
| 78 | + |charts-short| displays the following information about the data source: |
| 79 | + |
| 80 | + .. list-table:: |
| 81 | + :header-rows: 1 |
| 82 | + :widths: 38 72 |
| 83 | + |
| 84 | + * - Column |
| 85 | + - Description |
| 86 | + |
| 87 | + * - :guilabel:`Data Source` |
| 88 | + - Human-readable label that identifies the data source and |
| 89 | + its chart views. |
| 90 | + |
| 91 | + * - :guilabel:`External Users` |
| 92 | + - Label that indicates whether: |
| 93 | + |
| 94 | + - You enabled external user access. |
| 95 | + - The external user connection method is |
| 96 | + :guilabel:`Authenticated` or :guilabel:`Unauthenticated`. |
| 97 | + |
| 98 | + * - :guilabel:`Status` |
| 99 | + - Label that indicates whether you connected the |
| 100 | + data source to |charts|. |
| 101 | + |
| 102 | + .. step:: Click :guilabel:`Manage` next to the data source's information. |
| 103 | + |
| 104 | + The data source's details page displays the following |
| 105 | + information: |
| 106 | + |
| 107 | + .. list-table:: |
| 108 | + :header-rows: 1 |
| 109 | + :widths: 38 72 |
| 110 | + |
| 111 | + * - Field |
| 112 | + - Description |
| 113 | + |
| 114 | + * - :guilabel:`Data Source Name` |
| 115 | + - Human-readable label that identifies the data source in |
| 116 | + |service|. |
| 117 | + |
| 118 | + * - :guilabel:`Data Source Connection Status` |
| 119 | + - Label that indicates whether you connected the |
| 120 | + data source to |charts|. |
| 121 | + |
| 122 | + To learn more about the other information that displays on the |
| 123 | + data source's details page, see |
| 124 | + :ref:`manage-existing-data-sources`. |
| 125 | + |
| 126 | + .. step:: Check the connection status and connect the data source. |
| 127 | + |
| 128 | + If the data source connection status is :guilabel:`Connected`, |
| 129 | + you already connected this data source to |charts|. The |
| 130 | + :guilabel:`Data Access` section displays. |
| 131 | + |
| 132 | + If the data source connection status is :guilabel:`Disconnected`: |
| 133 | + |
| 134 | + a. Click the connect icon :icon-fa5:`link` next to the data |
| 135 | + source connection status. |
| 136 | + #. Click :guilabel:`Reconnect` on the modal that displays. |
| 137 | + |
| 138 | + The data source connects and the :guilabel:`Data Access` |
| 139 | + section displays. |
| 140 | + |
| 141 | + To learn more about the other information that displays in the |
| 142 | + data source's :guilabel:`Data Access` section, see |
| 143 | + :ref:`manage-existing-data-sources`. |
| 144 | + |
| 145 | +.. _disconnect-deployment: |
| 146 | + |
| 147 | +Disconnect a Deployment from |charts-short| |
| 148 | +------------------------------------------- |
| 149 | + |
| 150 | +Disconnect a deployment to disconnect all data sources within the |
| 151 | +deployment from |charts-short|. |
| 152 | + |
| 153 | +If you disconnect a deployment, you can :ref:`reconnect |
| 154 | +<connect-deployment>` it later to resume rendering charts that use the |
| 155 | +deployment's data sources. |
| 156 | + |
| 157 | +To disconnect a deployment: |
| 158 | + |
| 159 | +.. procedure:: |
| 160 | + :style: normal |
| 161 | + |
| 162 | + .. include:: /includes/steps-access-deployment.rst |
| 163 | + |
| 164 | + .. step:: Check the connection status and disconnect the deployment. |
| 165 | + |
| 166 | + If the deployment connection status is :guilabel:`Disconnected`, |
| 167 | + the deployment is already disconnected from |charts-short|. |
| 168 | + |
| 169 | + If the deployment connection status is :guilabel:`Connected`: |
| 170 | + |
| 171 | + a. Click the disconnect icon :icon-fa5:`unlink` next to the deployment connection |
| 172 | + status. The :guilabel:`Disconnect Deployment` modal appears. |
| 173 | + #. Click :guilabel:`Check for connected charts` to |
| 174 | + learn whether any charts use the deployment's collections as a |
| 175 | + data source. |
| 176 | + #. Click :guilabel:`Disconnect`. |
| 177 | + |
| 178 | + The deployment disconnects from |charts-short|. |
| 179 | + |
| 180 | +.. _disconnect-data-source: |
| 181 | + |
| 182 | +Disconnect a Data Source from |charts| |
| 183 | +-------------------------------------- |
| 184 | + |
| 185 | +Disconnect a data source from |charts-short| to remove its data from |
| 186 | +your charts. If you disconnect a data source: |
| 187 | + |
| 188 | +- Any charts you built that use the data source no longer |
| 189 | + render and display an error. |
| 190 | +- Any charts that use :pipeline:`$lookup` to access data in the data |
| 191 | + source no longer render and display an error. |
| 192 | +- You can't use the data source to build new charts. |
| 193 | + |
| 194 | +You can also :ref:`disconnect a deployment <disconnect-deployment>`. |
| 195 | + |
| 196 | +If you disconnect a data source, you can :ref:`reconnect |
| 197 | +<connect-data-source>` it later to resume rendering charts that |
| 198 | +use its data. |
| 199 | + |
| 200 | +.. note:: |
| 201 | + |
| 202 | + .. include:: /includes/sample-data-source-description.rst |
| 203 | + |
| 204 | +To disconnect a data source from |charts-short|: |
| 205 | + |
| 206 | +.. procedure:: |
| 207 | + :style: normal |
| 208 | + |
| 209 | + .. include:: /includes/steps-access-deployment.rst |
| 210 | + |
| 211 | + .. step:: In the :guilabel:`Data Access` section, select the database that contains the data source. |
| 212 | + |
| 213 | + Select the database that contains the data source you want to |
| 214 | + disconnect. The database's data sources display. |
| 215 | + |
| 216 | + .. step:: Click :guilabel:`Manage` next to the data source's information. |
| 217 | + |
| 218 | + The data source's details page displays. |
| 219 | + |
| 220 | + .. step:: Check the connection status and disconnect the data source. |
| 221 | + |
| 222 | + If the data source connection status is :guilabel:`Disconnected`, |
| 223 | + the data source is already disconnected from |charts|. |
| 224 | + |
| 225 | + If the data source connection status is :guilabel:`Connected`: |
| 226 | + |
| 227 | + a. Click the disconnect icon :icon-fa5:`unlink` next to the data |
| 228 | + source connection |
| 229 | + status. The :guilabel:`Disconnect Data Source` modal appears. |
| 230 | + #. Click :guilabel:`Check for connected charts` to |
| 231 | + learn whether any charts use the |
| 232 | + data source. |
| 233 | + #. Click :guilabel:`Disconnect`. |
| 234 | + |
| 235 | + The data source disconnects from |charts-short|. |
0 commit comments