定义和实施模式

导航至 Schema（模式）屏幕

在左侧导航菜单中，单击Schema Data Access下方的 ，打开模式编辑器。集合配置屏幕显示在Collections标签页中。 Atlas App Services会扫描关联集群以查找现有集合，并将它们列在模式编辑器的左侧。

从菜单中查找并选择您的集合，以在模式编辑器的右侧显示集合配置。

点击放大

从现有数据生成模式（可选）

如果集合中已有数据， App Services可以对集合中的文档子集进行示例，并根据示例生成模式。 如果您已有模式或更愿意手动定义模式，请跳至下一步。

您可以配置要抽样的文档数量，并使用 MongoDB 查询语言将样本限制为特定文档。默认情况下，App Services 从整个集合中随机抽样最多 500 个文档。

要从现有数据生成模式，请执行以下步骤：

1. 从模式编辑器右侧的集合配置中，单击Generate Schema打开示例配置屏幕。

2. 指定样本大小，最多为 50,000 个文档。

3. （可选）单击 Advanced 并指定查询、投影和/或排序，以便优化样本查询。使用查询和排序筛选器对特定的文档子集进行抽样，并使用投影筛选器对每个文档的特定字段子集进行抽样。

4. 单击 Generate 以运行样本查询并生成模式。该过程可能最多需要一分钟，具体取决于抽样文档的数量和内容。

点击放大

定义或修改模式

您可以手动定义模式，也可以通过添加字段级模式定义来修改现有模式。

您可以为每个集合定义一个BSON模式。 每个集合模式的根级类型是 object模式，表示集合中的文档。 您可以在根模式的properties字段中为文档字段定义其他模式。

JSON 模式对象中可用的字段取决于模式定义的值类型。有关支持的类型列表以及如何配置这些类型的详细信息，请参阅模式类型。

{
  "name": "Jane Doe",
  "age": 42,
  "favoriteColors": [
    { "rank": 1, "name": "RebeccaPurple", "hexCode": "#663399" },
    { "rank": 2, "name": "DodgerBlue", "hexCode": "#1E90FF" },
    { "rank": 3, "name": "SeaGreen", "hexCode": "#2E8B57" },
  ]
}

{
  "bsonType": "object",
  "required": ["name", "age", "favoriteColors"],
  "properties": {
    "name": {
      "bsonType": "string"
    },
    "age": {
      "bsonType": "int",
      "minimum": 13,
      "exclusiveMinimum": false
    },
    "favoriteColors": {
      "bsonType": "array",
      "uniqueItems": true,
      "items": {
        "bsonType": "object",
        "properties": {
          "rank": { "bsonType": "int" },
          "name": { "bsonType": "string" },
          "hexCode": {
            "bsonType": "string",
            "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
          }
        }
      }
    }
  }
}

添加更改验证表达式（可选）

除了配置每个字段的内容外，还可以通过在模式的 validate 字段中定义验证表达式来验证对文档的更改。验证表达式可以使用 %%prev 和 %%prevRoot 扩展来在插入或更新操作发生之前访问字段或文档的值。

"owner_id": {
  "validate": {
    "%or": [
      { "%%prev": { "%exists": false } },
      { "%%prev": "%%this" }
    ]
  }
}

"owner_id": {
  "validate": {
    "%or": [
      { "%%prevRoot.owner_id": { "%exists": false } },
      { "%%prevRoot.owner_id": "%%root.owner_id" }
    ]
  }
}

保存模式

配置模式后，单击 Save。保存后，App Services 立即开始为所有未来查询实施该模式。

根据模式验证文档

保存集合模式后，您可以验证集合中的现有文档是否符合该模式。

App Services 使用抽样文档进行验证，就像自动生成模式一样。

要验证集合中的数据，请执行以下步骤：

1. 单击 Run Validation 按钮打开验证配置窗口。

2. 指定样本大小，最多为 50,000 个文档。

3. （可选）单击 Advanced 并指定查询和/或排序，以便将验证细化为特定的文档子集。

4. 单击 Run Validation 对集合中的文档进行抽样，并根据模式验证每个文档。

验证完成后，App Services 会在 JSON Validation Errors 表中列出样本中的所有验证错误。该表的每一行均代表特定字段的特定类型的验证错误，并指明未能以此方式通过验证的文档数量。

对于每个验证错误，您可以使用 Actions 菜单下载失败的原始文档，或复制查找失败文档的 MongoDB 查询。

点击放大

登录MongoDB Cloud

要使用 AppServices 配置您的应用，您必须使用 API密钥登录MongoDB Cloud，该密钥的范围为包含该应用的组织或项目。

appservices login --api-key="<MongoDB Cloud Public API Key>" --private-api-key="<MongoDB Cloud Private API Key>"

拉取最新版本的应用程序

要使用appservices定义文档模式，您需要应用程序配置文件的本地副本。

要提取最新版本应用的本地副本，请运行以下命令：

appservices pull --remote="<Your App ID>"

定义模式

要定义或修改集合的模式，请打开集合配置目录中的schema.json配置文件。

# Create the collection's configuration directory
mkdir -p data_sources/<service>/<db>/<collection>
# Create the collection's schema file
echo '{}' >> data_sources/<service>/<db>/<collection>/schema.json

每个文档的根级模式必须为object类型。 您可以使用其他模式来配置properties大量中的特定字段。 该模式至少应如下所示：

{
  "bsonType": "object",
  "properties": {
    "<Field Name>": <Schema Document>,
    ...
  }
}

定义变更验证（可选）

您可以通过在模式的validate字段中定义验证表达式来验证对文档的更改。 在插入或更新操作发生 之前%%prevRoot ，验证表达式可以使用%%prev 和 扩展来访问权限字段或文档的值。

"owner_id": {
  "validate": {
    "%or": [
      { "%%prev": { "%exists": false } },
      { "%%prev": "%%this" }
    ]
  }
}

"owner_id": {
  "validate": {
    "%or": [
      { "%%prevRoot.owner_id": { "%exists": false } },
      { "%%prevRoot.owner_id": "%%root.owner_id" }
    ]
  }
}

部署更新的模式

定义并保存schema.json后，您可以将更新的配置推送到远程应用。 App Services CLI在推送时立即部署新模式。

appservices push --remote="<Your App ID>"