Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateDescription<TSchema>

Type parameters

Hierarchy继承层级

  • UpdateDescription

Index索引

Properties属性

disambiguatedPaths?: Document

A document containing additional information about any ambiguous update paths from the update event. 包含有关更新事件中任何不明确更新路径的附加信息的文档。The document maps the full ambiguous update path to an array containing the actual resolved components of the path. 文档将完全不明确的更新路径映射到包含路径的实际解析组件的数组。For example, given a document shaped like { a: { '0': 0 } }, and an update of { $inc: 'a.0' }, disambiguated paths would look like the following:例如,给定形状为{ a: { '0': 0 } }的文档和{ $inc: 'a.0' }的更新,消除歧义的路径如下所示:

  {
'a.0': ['a', '0']
}

This field is only present when there are ambiguous paths that are updated as a part of the update event and showExpandedEvents is enabled for the change stream.只有当存在作为更新事件的一部分而更新的不明确路径并且为更改流启用了showExpandedEvents时,此字段才会出现。

sinceserverversion

6.1.0

removedFields?: string[]

An array of field names that were removed from the document.从文档中删除的字段名数组。

truncatedArrays?: { field: string; newSize: number }[]

An array of documents which record array truncations performed with pipeline-based updates using one or more of the following stages:一个文档数组,用于记录使用以下一个或多个阶段执行的基于管道的更新的数组截断:

  • $addFields
  • $set
  • $replaceRoot
  • $replaceWith
updatedFields?: Partial<TSchema>

A document containing key:value pairs of names of the fields that were changed, and the new value for those fields.包含已更改字段名称的键:值对以及这些字段的新值的文档。

Generated using TypeDoc