Docs 菜单
Docs 主页
/ /
Atlas Device SDKs
/

使用 Device Sync 查看 Atlas 数据

在此页面上

  • 先决条件
  • 从Realm Studio连接到Atlas
  • 选择 Connect via Atlas Device Sync
  • 提供请求的元数据
  • 连接
  • 指定要同步的数据
  • 添加订阅
  • 删除订阅
  • 实时查看同步的更改

您可以使用Realm Studio通过Device Sync连接到MongoDB Atlas 。 Realm Studio用作同步客户端,类似于使用Device Sync的应用程序。 您可以:

  • 在焦点对象模式上添加和删除订阅。

  • 直接通过 Realm Studio 与 Atlas 数据交互。

使用Realm Studio查看您在运行开发中的应用时对数据所做的更改,或试验权限和订阅更改。

最低 Realm Studio 版本: 14.1.2 。

由于Device Sync 通过Realm Studio Atlas App ServicesAtlas App ServicesApp 将 连接到 后端,因此您需要先执行以下操作才能开始:

  1. 启用身份验证的Atlas App Services App。 要学习;了解如何操作,请参阅App Services文档中的创建App Services App程序。

  2. App Services App ID。 要学习;了解如何查找应用程序ID,请参阅查找您的应用程序ID。

Realm Studio 可以使用以下任何身份验证提供程序类型通过 Device Sync 进行连接:

  • 匿名

  • 电子邮件和密码

  • API 密钥

  • JSON web token

如果您的应用程序使用电子邮件和密码、 API密钥或 JSON web token 身份验证,则必须创建适当类型的档案,以便在从Realm Studio连接时使用。 有关创建档案的更多信息,请参阅Atlas App Services文档:

1

打开 Realm Studio,然后单击 Connect via Atlas Device Sync

2
  1. 提供 App ID。

  2. 如果您的App Services App使用自定义URL,请指定该URL。

  3. 选择您的应用使用的身份验证形式。 如果选择需要凭据的身份验证形式,请提供凭据。

3

单击 Connect(连接)。

成功连接后,Realm Studio 会在应用程序窗口的菜单栏中显示应用 ID。 您可以同时打开与多个Atlas App Services应用程序的连接。 如果要实时查看更改,还可以打开与同一 App Services App 的多个连接。

连接到Atlas后, Realm Studio会显示与您的App Services App模式匹配的对象类型列表。

Atlas App Services有关 模式的更多信息,请参阅 Atlas App Services文档中的 模式 。

Realm Studio 将这些模式映射到 Realm 对象。 有关如何使用 将这些模式映射到Realm Device Sync对象的信息,请参阅 Atlas App Services文档中的 数据模型映射 。

在为每种对象类型添加订阅之前,您看不到对象类型的任何数据。 订阅以及您为应用定义的权限决定了同步哪些数据。

要开始查看特定对象类型的数据,请添加订阅。 要更改您看到的数据,您可以:

  • 添加更多订阅以应用额外的筛选。

  • 删除订阅。

您无法更改已添加到Realm Studio的订阅。 要更改订阅,请将其删除并添加新订阅。

1

如果您的 App Services App 中有多种对象类型的模式,则可以在 Realm Studio 窗口的左窗格中将其视为对象类型名称列表。

单击对象类型名称可选择该对象类型。

2

选择对象类型后,带有+按钮的Subscriptions标签会显示在 Realm Studio 窗口左窗格的底部。

单击标签旁边的+打开 Add subscription on Object模态。

3

使用RQL ( RQL ) 为要与Realm Studio同步的对象创建查询。 只有与您的查询匹配的对象才会出现在Realm Studio中。 在开发应用程序时,您可以使用它来快速验证查询。

您的订阅查询必须至少包含一个可查询字段。 有关可查询字段的更多信息,请参阅Atlas Atlas App Services文档中的可查询字段。

有关可用查询运算符的信息,请参阅RQL参考。

Device Sync支持在 Sync订阅查询中使用RQL操作符子集。 有关这些限制的信息,请参阅Flexible Sync RQL限制。

例子

如果使用模板应用启动Device Sync ,则模板应用使用的订阅为:

`owner_id == "${user?.id}"`

要在Realm Studio中查看适用数据,请将此查询与特定用户的ID结合使用:

owner_id == "67ee25f483c29fa14cfd7295"

要查看您提供给凭证 Realm Studio的档案具有适当权限的所有数据,请使用以下查询:

TRUEPREDICATE
4

单击Add subscription以完成添加订阅的进程。 这会触发与Device Sync的初始同步:

  • 所选对象类型的项目。

  • 与您提供的订阅查询相匹配。

  • 您用于日志Realm Studio的凭证是否有权查看该项目。

片刻之后,您会看到对象数量从0变为反映满足此条件的对象数量。

5

您的App Services App可能具有针对多种对象类型的模式。 您必须为要在Realm Studio中查看的每种对象类型单独添加订阅。

如果您的对象包含指向其他对象的链接,例如在一对一或对多关系中,则在您为链接对象类型添加适当的订阅之前,链接对象不会显示在 Realm Studio 中。

1

单击Realm Studio窗口左窗格中的对象类型名称以选择该对象类型。

2

单击删除订阅。 如果没有看到该图标,请拖动以展开左窗格。 长时间订阅可能会将图标推出可视区域。

删除订阅后,与订阅匹配的数据将从Realm Studio中消失。

添加订阅后,如果您的凭证根据应用程序的规则允许,则可以创建、更新和删除对象。 当您在使用Device Sync连接时对对象进行更改时,这些更改会自动与Atlas和其他设备同步。 您可以看到实时反映的更改。

有关如何在Realm Studio中创建、修改和删除对象的信息,请参阅修改Realm文件中的对象。 在使用Device Sync连接时,您无需执行任何操作即可保存所做的更改。 这些更改会自动与服务器同步并保留在Atlas中。

如果您尝试修改或添加与您的订阅不匹配或您没有写入权限的对象,则 Device Sync 会返回补偿写入错误。 Realm Studio 会还原这些更改,并且它们不会与 Atlas 或其他设备同步。 有关更多信息,请参阅ErrorCompensatingWrite Flexible SyncAtlas App Services文档的 错误 部分中的 。

后退

Realm Studio