FetchGridFS

文档中心 › 组件索引 › FetchGridFS

FetchGridFS Processor

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

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

描述

按文件名或用户定义的查询从 GridFS 存储桶检索一个或多个文件。

标签

fetchgridfsmongo

属性

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

名称默认值可选值描述
Client Service控制器服务 API:
MongoDBClientService
cn.org.acal.lynxus-lynxus-mongodb-client-service-api-nar-2.11.8
用于数据库连接的 MongoDB 客户端服务。
Mongo Database Name要使用的数据库的名称
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Bucket Name文件将存储到的 GridFS 存储桶。如果留空,将使用 MongoDB 客户端驱动程序使用的默认值 'fs'。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
File Name存储桶中作为该处理器目标的文件的名称。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Query用于从 GridFS 获取一个或多个文件的有效 MongoDB 查询。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Query Output Attribute如果设置,查询将被写入输出 FlowFiles 上的指定属性。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Operation Modeall-at-once
  • 完整查询获取 — 获取整个查询结果,然后使其对下游处理器可用。
  • 流式查询结果 — 查询开始发送结果后,定期将结果发送到下游处理器。
此选项控制何时将结果提供给下游处理器。如果启用流式查询结果,当接收到输入 FlowFile 并启动查询时,不会相对于输入 FlowFile 跟踪来源。在流式查询结果模式下,错误将通过发送一个新的 FlowFile(包含输入 FlowFile 的原始内容和属性)到 failure 关系来处理。流式处理仅应在 MongoDB 和 Lynxus 之间存在可靠连接时使用。

关系 (Relationships)

名称描述自动终止
failure当处理 FlowFile 失败时,就会转到此关系。否
original如果查询没有导致错误,原始输入FlowFile会转到这个关系否
success当操作成功时,FlowFile将被发送到该关系。否

写入的 FlowFile 属性

名称描述
gridfs.file.metadata与文件一起存储的自定义元数据将附加到此属性(如果存在)。

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件要求有传入连接。

详细说明

FetchGridFS

说明

该 Processor 从 GridFS 获取一个或多个文件。查询可以通过以下三种 方式之一提供:

  • Query 配置参数。
  • 通过配置 filename 参数自动构建。(注意:这只是文件名,该字段 中不能嵌入 Mongo 查询)。
  • 从 FlowFile 内容中获取查询。

该 Processor 还可以配置为只在获取操作结束时提交一次,或在每获取 一个文件后提交。只有当按总数据量(而非文件数量)衡量从 GridFS 获取的数据量很大时,才有必要多次提交,以确保不会让 Lynxus 使用的 磁盘过载。