DeleteMongo

文档中心 › 组件索引 › DeleteMongo

DeleteMongo Processor

类型全限定名:cn.org.acal.lynxus.processors.mongodb.DeleteMongo

所属 Bundle:cn.org.acal.lynxus:lynxus-mongodb-nar:2.11.8

描述

对 MongoDB 集合执行删除查询。 该查询在 FlowFile 的正文中提供,用户可以选择是否删除一个或多个与其匹配的文档。

标签

deletemongomongodb

属性

下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。

名称默认值可选值描述
Client Service控制器服务 API:
MongoDBClientService
cn.org.acal.lynxus-lynxus-mongodb-client-service-api-nar-2.11.8
如果配置,此属性将使用分配的客户端服务进行连接池。
Mongo Database Name要使用的数据库的名称
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Mongo Collection Name要使用的集合的名称
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Delete Modeone
  • 删除单个 — 仅删除与查询匹配的第一个文档。
  • 删除多个 — 删除与查询匹配的每个文档。
  • 使用 'mongodb.delete.mode' 属性 — 读取 'mongodb.delete.mode' 属性并使用该模式。可接受的值为 'many' 和 'one'。
选择通过查询删除一个文档或通过查询删除多个文档。
Fail When Nothing Is Deletedtrue
  • 是 — 当没有删除任何文档时失败。
  • 否 — 当没有删除任何内容时不要失败。
确定如果没有成功删除任何内容,是否将FlowFile发送到成功或失败关系。

关系 (Relationships)

名称描述自动终止
failure所有无法写入 MongoDB 的 FlowFile 都会路由到此关系否
success所有写入 MongoDB 的 FlowFile 都会路由到此关系否

读取的 FlowFile 属性

名称描述
mongodb.delete.mode用于在每个 FlowFile 基础上控制删除模式的可配置参数。必须将进程配置为使用此选项。可接受的值为 'one' 和 'many'。

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件要求有传入连接。

详细说明

DeleteMongo

说明

该 Processor 使用用户在 FlowFile 正文中提供的查询从 Mongo 中删除数据。 它必须是合法的 JSON 文档。用户可以选择删除单个文档,或删除所有匹配 条件的文档。该行为可以通过相应的配置属性设置。此外,该 Processor 可以配置为把"未删除任何文档"视为错误事件,此时带查询的 FlowFile 会被发送到 failure Relationship。

查询示例

{
  "username": "john.smith",
  "recipient": "jane.doe"
}