Skip to content

Commit 956552b

Browse files
authored
Remove edge server mentions (#3388)
## Pull Request Info - SDK Docs Consolidation Jira ticket: DOCSP-46788 ### Staging Links <!-- start insert-links --> <li><a href=https://deploy-preview-3388--device-sdk.netlify.app/sdk/dotnet/app-services/connect-to-app-services-backend>sdk/dotnet/app-services/connect-to-app-services-backend</a></li><li><a href=https://deploy-preview-3388--device-sdk.netlify.app/sdk/kotlin/app-services/connect-to-app-services-backend>sdk/kotlin/app-services/connect-to-app-services-backend</a></li><li><a href=https://deploy-preview-3388--device-sdk.netlify.app/sdk/node/app-services/connect-to-app-services-backend>sdk/node/app-services/connect-to-app-services-backend</a></li><li><a href=https://deploy-preview-3388--device-sdk.netlify.app/sdk/react-native/app-services/connect-to-app-services-app>sdk/react-native/app-services/connect-to-app-services-app</a></li><li><a href=https://deploy-preview-3388--device-sdk.netlify.app/sdk/swift/app-services/connect-to-app-services-backend>sdk/swift/app-services/connect-to-app-services-backend</a></li> <!-- end insert-links --> *Page Source* Add links to every SDK's pages where you got the SDK-specific information: - [PAGE_NAME](https://www.mongodb.com/docs/atlas/device-sdks/LIVE-DOCS-LINK) ### Release Notes <!-- - **Define Data Access Permissions** - Data Access Role Examples: Update CRUD Permissions example screenshots and copyable JSON --> ### PR Author Checklist Before requesting a review for your PR, please check these items: - [ ] Open the PR against the `feature-consolidated-sdk-docs` branch instead of `master` - [ ] Tag the consolidated page for: - genre - meta.keywords - meta.description #### Naming - [ ] Update Realm naming and the language around persistence layer/local/device per [this document](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing) - [ ] Include `.rst` files comply with [the naming guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9) #### Links and Refs - [ ] Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections - [ ] Remove or update any SDK-specific refs to use the new consolidated SDK ref targets - [ ] [Update any Kotlin API links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new Kotlin SDK roles #### Content - [ ] Shared code boxes have snippets or placeholders for all 9 languages - [ ] API description sections have API details or a generic placeholder for all 9 languages - [ ] Check related pages for relevant content to include - [ ] Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic ### Reviewer Checklist As a reviewer, please check these items: - [ ] Shared code example boxes contain language-specific snippets or placeholders for every language - [ ] API reference details contain working API reference links or generic content - [ ] Realm naming/language has been updated - [ ] All relevant content from individual SDK pages is present on the consolidated page
1 parent 289e256 commit 956552b

File tree

5 files changed

+0
-284
lines changed

5 files changed

+0
-284
lines changed

source/sdk/dotnet/app-services/connect-to-app-services-backend.txt

-65
Original file line numberDiff line numberDiff line change
@@ -50,68 +50,3 @@ method. The following example sets the LogLevel and the request timeout:
5050
You can create multiple App client instances to connect to multiple
5151
Apps. All App client instances that share the same App ID use the same
5252
underlying connection.
53-
54-
.. _dotnet-connect-to-specific-server:
55-
56-
Connect to a Specific Server
57-
----------------------------
58-
59-
By default, Atlas Device SDK connects to Atlas using the global ``baseURL``
60-
of ``https://services.cloud.mongodb.com``. In some cases, you may want to
61-
connect to a different server:
62-
63-
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
64-
you want to connect directly to a local ``baseURL`` in your region.
65-
66-
You can specify a ``baseURL`` in the
67-
:dotnet-sdk:`AppConfiguration <reference/Realms.Sync.AppConfiguration.html#Realms_Sync_AppConfiguration_BaseUri>`.
68-
69-
.. literalinclude:: /examples/generated/dotnet/BaseURLChange.snippet.custom-base-url.cs
70-
:language: csharp
71-
72-
Connect to a Different Server During Runtime
73-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74-
75-
.. versionadded:: 12.1.0
76-
77-
In some cases, you might want to change the ``baseURL`` while the app is
78-
running. To change
79-
the ``baseURL`` during runtime, call the
80-
:dotnet-sdk:`app.UpdateBaseUriAsync() <reference/Realms.Sync.App.html#Realms_Sync_App_UpdateBaseUriAsync_System_Uri_>`
81-
method:
82-
83-
.. literalinclude:: /examples/generated/dotnet/BaseURLChange.snippet.update-base-url.cs
84-
:language: csharp
85-
86-
This API is experimental. As seen above, you must use ``#pragma warning disable Rlm001``
87-
and ``#pragma warning restore Rlm001`` to suppress the experimental errors,
88-
where ``Rlm001`` is the experimental attributes's ``diagnosticId``.
89-
90-
If you want to change the ``baseURL`` after you have logged in a user and
91-
have opened a synced database, the app must perform a
92-
:ref:`client reset <dotnet-client-resets>`. Perform these steps in your code:
93-
94-
1. :ref:`Pause the Sync session <dotnet-suspend-resume-sync>`.
95-
2. Update the ``baseURL`` by calling the ``app.updateBaseUrl(to: )`` method.
96-
3. Authenticate and log the user in again with the new ``baseURL``.
97-
4. Open a synced database pulling data from the new server.
98-
99-
Both the server and the client must be online for the user to authenticate and
100-
connect to the new server. If the server is not online or the client does not
101-
have a network connection, the user cannot authenticate and open the database.
102-
103-
.. important:: Changing an App Config After Initializing the App
104-
105-
.. versionchanged:: v11.7.0
106-
``BaseUri`` is not cached in the App configuration
107-
108-
When you initialize the App client, the configuration is cached internally.
109-
Attempting to close and then re-open an App with a changed configuration
110-
within the same process has no effect. The client continues to use the
111-
cached configuration.
112-
113-
In .NET SDK version 11.7.0 and later, the :dotnet-sdk:`BaseUri <reference/Realms.Sync.AppConfiguration.html#Realms_Sync_AppConfiguration_BaseUri>`
114-
is *no longer* cached in the App configuration. This means that you can change the
115-
``BaseUri``, and the App client will use the updated configuration. In
116-
earlier SDK versions, changes to the ``BaseUri`` in a cached App
117-
configuration have no effect.

source/sdk/kotlin/app-services/connect-to-app-services-backend.txt

-48
Original file line numberDiff line numberDiff line change
@@ -261,54 +261,6 @@ method, which accepts a Boolean value.
261261
This feature is currently only available on Android and Java Virtual
262262
Machine (JVM) platforms.
263263

264-
.. _kotlin-connect-to-specific-server:
265-
266-
Connect to a Specific Server
267-
----------------------------
268-
269-
By default, Atlas Device SDK connects to Atlas using the global ``baseUrl``
270-
of ``https://services.cloud.mongodb.com``. In some cases, you may want to
271-
connect to a different server:
272-
273-
- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region.
274-
For more information, refer to the :ref:`<local-deployment>` App Services documentation.
275-
276-
You can specify a ``baseUrl`` in the
277-
`AppConfiguration <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb/-app-configuration/index.html>`__:
278-
279-
.. literalinclude:: /examples/generated/kotlin/AppClientTest.snippet.custom-base-url.kt
280-
:language: kotlin
281-
282-
Connect to a Different Server During Runtime
283-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
284-
285-
.. versionadded:: 1.16.0
286-
287-
In some cases, you might want to change the ``baseUrl`` while the app is
288-
running.
289-
290-
To change the ``baseUrl`` during runtime, call the experimental
291-
`app.updateBaseUrl <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb/-app/index.html#2007791704%2FFunctions%2F380376748>`__ method. You can
292-
pass ``null`` to reset the ``baseUrl`` to the default value.
293-
294-
.. literalinclude:: /examples/generated/kotlin/AppClientTest.snippet.change-base-url.kt
295-
:language: kotlin
296-
297-
If you change the ``baseUrl`` *after* you have logged in a user and
298-
have opened a synced database, the app must perform a client reset. For more
299-
information, refer to :ref:`kotlin-client-reset`.
300-
301-
Perform the following in your code:
302-
303-
1. :ref:`Pause the Sync session <kotlin-pause-resume-sync>`
304-
2. Update the ``baseUrl`` using the ``app.updateBaseUrl`` method
305-
3. Re-authenticate the user to log in using the new ``baseUrl``
306-
4. Open a synced database pulling data from the new server
307-
308-
Both the server and the client *must* be online for the user to authenticate and
309-
connect to the new server. If the server is not online or the client does not
310-
have a network connection, the user cannot authenticate and open the database.
311-
312264
Close the App Client
313265
--------------------
314266

source/sdk/node/app-services/connect-to-app-services-backend.txt

-95
Original file line numberDiff line numberDiff line change
@@ -139,98 +139,3 @@ To encrypt App metadata:
139139
:tabid: javascript
140140

141141
.. include:: /examples/generated/node/v12/formatted/metadata.test.snippet.encrypt-metadata.js.rst
142-
143-
Connect to a Specific Server
144-
----------------------------
145-
146-
By default, Atlas Device SDK connects to Atlas using the global ``baseURL``
147-
of ``https://services.cloud.mongodb.com``. In some cases, you may want to
148-
connect to a different server:
149-
150-
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
151-
you want to connect directly to a local ``baseURL`` in your region.
152-
153-
You can specify a ``baseURL`` in the
154-
:js-sdk:`AppConfiguration <types/Realm.AppConfiguration.html>`:
155-
156-
.. tabs-realm-languages::
157-
158-
.. tab::
159-
:tabid: typescript
160-
161-
.. literalinclude:: /examples/generated/node/v12/formatted/app-services.test.snippet.custom-base-url.ts.rst
162-
:language: typescript
163-
164-
.. tab::
165-
:tabid: javascript
166-
167-
.. literalinclude:: /examples/generated/node/v12/formatted/app-services.test.snippet.custom-base-url.js.rst
168-
:language: javascript
169-
170-
.. _node-change-server-during-runtime:
171-
172-
Connect to a Different Server During Runtime
173-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174-
175-
.. versionadded:: 12.8.0
176-
177-
In some cases, you might want to change the ``baseURL`` while the app is
178-
running.
179-
180-
To change the ``baseURL`` during runtime, call the ``app.updateBaseUrl()``
181-
method. Note that the string value can't end in a trailing slash.
182-
183-
.. tabs-realm-languages::
184-
185-
.. tab::
186-
:tabid: typescript
187-
188-
.. include:: /examples/generated/node/v12/formatted/app-services.test.snippet.change-base-url.ts.rst
189-
190-
.. tab::
191-
:tabid: javascript
192-
193-
.. include:: /examples/generated/node/v12/formatted/app-services.test.snippet.change-base-url.js.rst
194-
195-
This API is experimental, so you must use the experimental import in the file
196-
where you want to use this API:
197-
198-
.. include:: /examples/generated/node/v12/formatted/app-services.test.snippet.import-experimental-baseurl.ts.rst
199-
200-
.. _node-change-server-typescript:
201-
202-
TypeScript Config for Experimental API
203-
``````````````````````````````````````
204-
205-
The ``app.updateBaseUrl()`` method is in an experimental module that you must
206-
import separately. To get the proper types from this module, you need to set the
207-
following fields in your ``tsconfig.json`` file:
208-
209-
.. code-block:: json
210-
:copyable: true
211-
212-
{
213-
"target": "es2022",
214-
"module": "node16",
215-
"moduleResolution": "node16",
216-
// ...
217-
}
218-
219-
220-
Change Server with Logged-in User
221-
`````````````````````````````````
222-
223-
If you want to change the ``baseURL`` after you have logged in a user and
224-
have opened a synced database, the app must perform a
225-
:ref:`client reset <node-perform-a-client-reset>`. Perform these steps in your
226-
code:
227-
228-
1. :ref:`Pause the Sync session <node-pause-or-resume-a-sync-session>`.
229-
2. Update the ``baseURL`` by calling the ``app.updateBaseUrl()`` method.
230-
3. Go through the authentication flow again to log in the user through the
231-
new ``baseURL``.
232-
4. Open a synced database pulling data from the new server.
233-
234-
Both the server and the client must be online for the user to authenticate and
235-
connect to the new server. If the server is not online or the client does not
236-
have a network connection, the user cannot authenticate and open the database.

source/sdk/react-native/app-services/connect-to-app-services-app.txt

-27
Original file line numberDiff line numberDiff line change
@@ -96,30 +96,3 @@ To encrypt App metadata:
9696
#. Pass the App configuration object to ``new Realm.App()``.
9797

9898
.. include:: /examples/generated/react-native/v12/EncryptMetadata.snippet.encrypt-metadata.tsx.rst
99-
100-
Connect to a Specific Server
101-
----------------------------
102-
103-
By default, Atlas Device SDK connects to Atlas using the global ``baseURL``
104-
of ``https://services.cloud.mongodb.com``. In some cases, you may want to
105-
connect to a different server:
106-
107-
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
108-
you want to connect directly to a local ``baseURL`` in your region.
109-
110-
You can specify a ``baseURL`` as a prop for :ref:`AppProvider <react-native-app-provider>`.
111-
All :js-sdk:`AppConfiguration <types/Realm.AppConfiguration.html>` keys can be
112-
passed as props to ``AppProvider``.
113-
114-
Connect to a Different Server During Runtime
115-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116-
117-
.. versionchanged:: ``[email protected]``
118-
119-
In some cases, you might want to change the ``baseURL`` while the app is
120-
running.
121-
122-
Currently, this feature is implemented as an experimental module that requires
123-
specific TypeScript configuration. The required configuration can be difficult
124-
to make work with a React Native app. For more information on implementation, refer to :ref:`documentation for the
125-
Node.js SDK <node-change-server-typescript>`.

source/sdk/swift/app-services/connect-to-app-services-backend.txt

-49
Original file line numberDiff line numberDiff line change
@@ -104,55 +104,6 @@ refer to :objc-sdk:`RLMSyncTimeoutOptions <Classes/RLMSyncTimeoutOptions.html>`.
104104
.. literalinclude:: /examples/generated/code/start/RealmApp.snippet.app-config-sync-timeout.swift
105105
:language: swift
106106

107-
.. _swift-connect-to-specific-server:
108-
109-
Connect to a Specific Server
110-
----------------------------
111-
112-
By default, Atlas Device SDK connects to Atlas using the global ``baseURL``
113-
of ``https://services.cloud.mongodb.com``. In some cases, you may want to
114-
connect to a different server:
115-
116-
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
117-
you want to connect directly to a local ``baseURL`` in your region.
118-
119-
You can specify a ``baseURL`` in the
120-
:swift-sdk:`AppConfiguration <Extensions/AppConfiguration.html>`:
121-
122-
.. literalinclude:: /examples/generated/code/start/RealmApp.snippet.custom-base-url.swift
123-
:language: swift
124-
125-
Connect to a Different Server During Runtime
126-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127-
128-
.. versionadded:: 10.50.0
129-
130-
In some cases, you might want to change the ``baseURL`` while the app is
131-
running. To change
132-
the ``baseURL`` during runtime, call the ``app.updateBaseUrl(to: )`` method:
133-
134-
.. literalinclude:: /examples/generated/code/start/RealmApp.snippet.change-base-url.swift
135-
:language: swift
136-
137-
This API is experimental, so you must use the experimental import in the file
138-
where you want to use this API:
139-
140-
.. literalinclude:: /examples/generated/code/start/RealmApp.snippet.import-experimental.swift
141-
:language: swift
142-
143-
If you want to change the ``baseURL`` after you have logged in a user and
144-
have opened a synced database, the app must perform a
145-
:ref:`client reset <ios-client-reset>`. Perform these steps in your code:
146-
147-
1. :ref:`Pause the Sync session <swift-suspend-sync-session>`.
148-
2. Update the ``baseURL`` by calling the ``app.updateBaseUrl(to: )`` method.
149-
3. Authenticate and log the user in again with the new ``baseURL``.
150-
4. Open a synced database pulling data from the new server.
151-
152-
Both the server and the client must be online for the user to authenticate and
153-
connect to the new server. If the server is not online or the client does not
154-
have a network connection, the user cannot authenticate and open the database.
155-
156107
Supported Operating Systems
157108
---------------------------
158109

0 commit comments

Comments
 (0)