Docs 菜单

Docs 主页 → Atlas App Services

Atlas Device Sync 配置文件

在此页面上

  • 同步配置

您可以在 sync目录中为应用程序配置Atlas Device Sync ：

app/
└── sync/
    └── config.json

同步配置

sync/config.json
{
  "type": "flexible",
  "development_mode_enabled": <Boolean>,
  "service_name": "<Data Source Name>",
  "database_name": "<Development Mode Database Name>",
  "state": <"enabled" | "disabled">,
  "client_max_offline_days": <Number>,
  "is_recovery_mode_disabled": <Boolean>,
  "queryable_fields_names": ["<Field Name>", ...],
  "indexed_queryable_fields_names": ["<Field Name>", ...],
  "collection_queryable_fields_names": {
    "<Collection Name>": ["<Field Name>", ...],
    ...
  }
}
字段
说明
type
string

同步模式。共有两种同步模式：Flexible Sync 和较旧的基于分区的同步。我们建议使用 Flexible Sync。有关基于分区的同步的更多信息，请参阅基于分区的同步。

Flexible Sync 配置的有效选项：

  • "flexible"

development_mode_enabled
boolean
如果为 true，则启用应用程序的开发模式。启用后，App Services 会自动将同步的对象存储在特定数据库（在 database_name 中指定），并镜像该数据库集合模式中的对象类型。
service_name
string
要同步的 Atlas 集群数据源的名称。您无法在无服务器实例中使用同步。
database_name
string
App Services 在开发模式下存储数据的同步集群中数据库的名称。App Services 自动为每个同步类型生成模式，并将每个对象类型映射到数据库内的集合。
state
string

应用程序同步协议的当前状态。

有效选项：

  • "enabled"

  • "disabled"

client_max_offline_days
number
在主动修剪某些客户端需要从旧版本的 Realm 同步的元数据之前，后端压缩过程等待的天数。
is_recovery_mode_disabled
boolean
如果为 false，则应用程序已启用恢复模式。启用后，支持此功能的 Realm SDK 会尝试在执行客户端重置时恢复未同步的更改。恢复模式默认启用。
queryable_fields_names
string[]
用作全局可查询字段的字段名称列表。
indexed_queryable_fields_names
string[]

用作索引可查询字段的字段名称列表。 虽然此属性是一个数组，但 Sync 目前仅支持一个单索引可查询字段。 因此，该数组最多可以包含一个元素。

索引可查询字段必须存在于模式中，并且在同步的每个collection中具有相同的符合条件的字段类型。索引可查询字段名称也必须出现在queryable_fields_names中，因为这是一个全局可查询字段。

collection_queryable_fields_names
{ [collectionName: string]: string[] }
从集合名称到每个集合的集合级可查询字段列表的映射。
last_disabled
number
上次暂停或禁用同步的日期和时间，表示为自 Unix 纪元（1970 年 1 月 1 日，00:00:00 UTC）以来的秒数。
asymmetric_tables
string[]
定义为与Data Ingest不对称的collection名称的数组，客户端可以写入但不能读取数据。
← 日志转发器配置文件
trigger配置文件 →

在此页面上