Skip to content

Commit e7666fd

Browse files
authored
remove mentions of Edge Server (#3382)
## Pull Request Info - SDK Docs Consolidation Jira ticket: https://jira.mongodb.org/browse/DOCSP-43675 ### Staging Links <!-- start insert-links --> <li><a href=https://deploy-preview-3382--device-sdk.netlify.app/index>index</a></li><li><a href=https://deploy-preview-3382--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-3382--device-sdk.netlify.app/sdk/flutter/app-services/connect-to-app>sdk/flutter/app-services/connect-to-app</a></li><li><a href=https://deploy-preview-3382--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-3382--device-sdk.netlify.app/sdk/kotlin/realm-database/crud/read>sdk/kotlin/realm-database/crud/read</a></li><li><a href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/kotlin/realm-database/open-and-close-a-realm>sdk/kotlin/realm-database/open-and-close-a-realm</a></li><li><a href=https://deploy-preview-3382--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-3382--device-sdk.netlify.app/sdk/node/model-data/data-types/counters>sdk/node/model-data/data-types/counters</a></li><li><a href=https://deploy-preview-3382--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-3382--device-sdk.netlify.app/sdk/swift/app-services/connect-to-app-services-backend>sdk/swift/app-services/connect-to-app-services-backend</a></li><li><a href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/swift/realm-files>sdk/swift/realm-files</a></li><li><a href=https://deploy-preview-3382--device-sdk.netlify.app/studio/view-atlas-data-sync>studio/view-atlas-data-sync</a></li> <!-- end insert-links -->
1 parent 24df3e6 commit e7666fd

File tree

14 files changed

+24
-40
lines changed

14 files changed

+24
-40
lines changed

examples/dart/test/app_services_test.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ void main() {
4747
test('Change BaseUrl', () async {
4848
// :snippet-start: change-base-url
4949
// Specify a custom baseUrl to connect to.
50-
// In this case, an Edge Server instance running on the device.
51-
final appConfig = AppConfiguration(edgeServerAppId,
50+
// In this case, a custom server instance running on the device.
51+
final appConfig = AppConfiguration(customServerAppId,
5252
baseUrl: Uri.parse('http://localhost:80'));
5353

5454
var app = App(appConfig);

source/examples/generated/flutter/app_services_test.snippet.change-base-url.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Specify a custom baseUrl to connect to.
2-
// In this case, an Edge Server instance running on the device.
3-
final appConfig = AppConfiguration(edgeServerAppId,
2+
// In this case, a custom server instance running on the device.
3+
final appConfig = AppConfiguration(customServerAppId,
44
baseUrl: Uri.parse('http://localhost:80'));
55

66
var app = App(appConfig);

source/index.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Welcome to the Atlas Device SDK Docs
3535
.. introduction::
3636

3737
Atlas Device SDK is a suite of app development tools optimized for
38-
data access and persistence on mobile and edge devices. Use the SDKs to
39-
build data-driven mobile, edge, web, desktop, and IoT apps.
38+
data access and persistence on mobile devices. Use the SDKs to
39+
build data-driven mobile, web, desktop, and IoT apps.
4040

4141
.. button:: Get started with a tutorial
4242
:uri: https://mongodb.com/docs/atlas/app-services/get-started/

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ connect to a different server:
6262

6363
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
6464
you want to connect directly to a local ``baseURL`` in your region.
65-
- You want to connect to an :ref:`Edge Server instance <edge-server-connect-from-client>`.
6665

6766
You can specify a ``baseURL`` in the
6867
:dotnet-sdk:`AppConfiguration <reference/Realms.Sync.AppConfiguration.html#Realms_Sync_AppConfiguration_BaseUri>`.
@@ -76,8 +75,7 @@ Connect to a Different Server During Runtime
7675
.. versionadded:: 12.1.0
7776

7877
In some cases, you might want to change the ``baseURL`` while the app is
79-
running. For example, you might want to roam between Edge Servers, or
80-
move from an App Services connection to an Edge Server connection. To change
78+
running. To change
8179
the ``baseURL`` during runtime, call the
8280
:dotnet-sdk:`app.UpdateBaseUriAsync() <reference/Realms.Sync.App.html#Realms_Sync_App_UpdateBaseUriAsync_System_Uri_>`
8381
method:

source/sdk/flutter/app-services/connect-to-app.txt

+3-5
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,8 @@ By default, Atlas Device SDK connects to Atlas using the global ``baseUrl``
127127
of ``https://services.cloud.mongodb.com``. In some cases, you may want to
128128
connect to a different server:
129129

130-
- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region. For more information, refer to the :ref:`<local-deployment>` App Services documentation.
131-
- You want to connect to an Edge Server instance. For more information, refer to
132-
the :ref:`edge-server-connect-from-client` App Services documentation.
130+
- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region.
131+
For more information, refer to the :ref:`<local-deployment>` App Services documentation.
133132

134133
You can specify a ``baseUrl`` in the
135134
:flutter-sdk:`AppConfiguration <realm/AppConfiguration-class.html>`:
@@ -145,8 +144,7 @@ Connect to a Different Server During Runtime
145144
``updateBaseUrl`` accepts ``null`` value
146145

147146
In some cases, you might want to change the ``baseUrl`` while the app is
148-
running. For example, you might want to roam between Edge Servers or
149-
move from an App Services connection to an Edge Server connection.
147+
running.
150148

151149
To change the ``baseUrl`` during runtime, call the experimental
152150
:flutter-sdk:`app.updateBaseUrl <realm/App/updateBaseUrl.html>` method. You can

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

+3-12
Original file line numberDiff line numberDiff line change
@@ -270,9 +270,8 @@ By default, Atlas Device SDK connects to Atlas using the global ``baseUrl``
270270
of ``https://services.cloud.mongodb.com``. In some cases, you may want to
271271
connect to a different server:
272272

273-
- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region. For more information, refer to the :ref:`<local-deployment>` App Services documentation.
274-
- You want to connect to an Edge Server instance. For more information, refer to
275-
the :ref:`edge-server-connect-from-client` App Services documentation.
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.
276275

277276
You can specify a ``baseUrl`` in the
278277
`AppConfiguration <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb/-app-configuration/index.html>`__:
@@ -286,8 +285,7 @@ Connect to a Different Server During Runtime
286285
.. versionadded:: 1.16.0
287286

288287
In some cases, you might want to change the ``baseUrl`` while the app is
289-
running. For example, you might want to roam between Edge Servers or
290-
move from an App Services connection to an Edge Server connection.
288+
running.
291289

292290
To change the ``baseUrl`` during runtime, call the experimental
293291
`app.updateBaseUrl <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb/-app/index.html#2007791704%2FFunctions%2F380376748>`__ method. You can
@@ -296,13 +294,6 @@ pass ``null`` to reset the ``baseUrl`` to the default value.
296294
.. literalinclude:: /examples/generated/kotlin/AppClientTest.snippet.change-base-url.kt
297295
:language: kotlin
298296

299-
This API is experimental and requires the `@ExperimentalEdgeServerApi
300-
<{+kotlin-sync-prefix+}io.realm.kotlin.mongodb.annotations/-experimental-edge-server-api/index.html>`__
301-
annotation:
302-
303-
.. literalinclude:: /examples/generated/kotlin/AppClientTest.snippet.experimental-opt-in.kt
304-
:language: kotlin
305-
306297
If you change the ``baseUrl`` *after* you have logged in a user and
307298
have opened a synced database, the app must perform a client reset. For more
308299
information, refer to :ref:`kotlin-client-reset`.

source/sdk/kotlin/realm-database/crud/read.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,8 @@ notation.
279279
To filter by property, you can pass Realm Query Language (RQL) filters and
280280
operators, use Kotlin's built-in extension methods or the SDK's convenience
281281
methods, or use a combination. For information on all currently supported RQL
282-
operators and syntax, refer to the :ref:`<rql>` reference documentation.
282+
operators and syntax, refer to the :ref:`Realm Query Language <rql>` reference
283+
documentation.
283284

284285
In the following example, we query a ``Frog`` object type and filter by the
285286
``name`` property:

source/sdk/kotlin/realm-database/open-and-close-a-realm.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ path, which you can define when you open the realm.
4646

4747
.. tip:: Work with Realm Files in Realm Studio
4848

49-
You can open, view, and edit the contents of realm files with :ref:`realm-studio`.
49+
You can open, view, and edit the contents of realm files with
50+
:ref:`Realm Studio <realm-studio>`.
5051

5152
If you don't want to create a ``.realm`` file or its associated auxiliary
5253
files, you can open an in-memory realm.

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,6 @@ connect to a different server:
149149

150150
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
151151
you want to connect directly to a local ``baseURL`` in your region.
152-
- You want to connect to an :ref:`Edge Server instance <edge-server-connect-from-client>`.
153152

154153
You can specify a ``baseURL`` in the
155154
:js-sdk:`AppConfiguration <types/Realm.AppConfiguration.html>`:
@@ -176,8 +175,7 @@ Connect to a Different Server During Runtime
176175
.. versionadded:: 12.8.0
177176

178177
In some cases, you might want to change the ``baseURL`` while the app is
179-
running. For example, you might want to roam between Edge Servers, or
180-
move from an App Services connection to an Edge Server connection.
178+
running.
181179

182180
To change the ``baseURL`` during runtime, call the ``app.updateBaseUrl()``
183181
method. Note that the string value can't end in a trailing slash.

source/sdk/node/model-data/data-types/counters.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,5 @@ counter value greater than or equal to that of the specified counter.
130130

131131
.. include:: /examples/generated/node/v12/formatted/data-types.test.snippet.filtering-with-counter.ts.rst
132132

133-
For more information on querying with the SDK, refer to :ref:`realm-query-language`.
133+
For more information on querying with the SDK, refer to
134+
:ref:`Realm Query Language <realm-query-language>`.

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ connect to a different server:
106106

107107
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
108108
you want to connect directly to a local ``baseURL`` in your region.
109-
- You want to connect to an :ref:`Edge Server instance <edge-server-connect-from-client>`.
110109

111110
You can specify a ``baseURL`` as a prop for :ref:`AppProvider <react-native-app-provider>`.
112111
All :js-sdk:`AppConfiguration <types/Realm.AppConfiguration.html>` keys can be
@@ -118,8 +117,7 @@ Connect to a Different Server During Runtime
118117
.. versionchanged:: ``[email protected]``
119118

120119
In some cases, you might want to change the ``baseURL`` while the app is
121-
running. For example, you might want to roam between Edge Servers, or
122-
move from an App Services connection to an Edge Server connection.
120+
running.
123121

124122
Currently, this feature is implemented as an experimental module that requires
125123
specific TypeScript configuration. The required configuration can be difficult

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,6 @@ connect to a different server:
115115

116116
- Your App Services App uses :ref:`local deployment <local-deployment>`, and
117117
you want to connect directly to a local ``baseURL`` in your region.
118-
- You want to connect to an :ref:`Edge Server instance <edge-server-connect-from-client>`.
119118

120119
You can specify a ``baseURL`` in the
121120
:swift-sdk:`AppConfiguration <Extensions/AppConfiguration.html>`:
@@ -129,8 +128,7 @@ Connect to a Different Server During Runtime
129128
.. versionadded:: 10.50.0
130129

131130
In some cases, you might want to change the ``baseURL`` while the app is
132-
running. For example, you might want to roam between Edge Servers, or
133-
move from an App Services connection to an Edge Server connection. To change
131+
running. To change
134132
the ``baseURL`` during runtime, call the ``app.updateBaseUrl(to: )`` method:
135133

136134
.. literalinclude:: /examples/generated/code/start/RealmApp.snippet.change-base-url.swift

source/sdk/swift/realm-files.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Realm stores a binary encoded version of every object and type in a
3838
realm in a single ``.realm`` file. The file is located at :ref:`a specific
3939
path <ios-default-and-file-url-realm>` that you can define when you open the
4040
realm. You can open, view, and edit the contents of these files with
41-
:ref:`realm-studio`.
41+
:ref:`Realm Studio <realm-studio>`.
4242

4343
.. _ios-in-memory-realm:
4444

source/studio/view-atlas-data-sync.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Add a Subscription
142142
:ref:`queryable-fields` in the App Services documentation.
143143

144144
For information about available query operators, refer to the
145-
:ref:`realm-query-language` reference.
145+
:ref:`Realm Query Language <realm-query-language>` reference.
146146

147147
Device Sync supports using a subset of RQL operators in Sync subscription
148148
queries. For information on these limitations, refer to

0 commit comments

Comments
 (0)