SimpleCsvFileLookupService

文档中心 › 组件索引 › SimpleCsvFileLookupService

SimpleCsvFileLookupService Controller Service

类型全限定名:cn.org.acal.lynxus.lookup.SimpleCsvFileLookupService

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

描述

可重新加载的基于 CSV 文件的查找服务。 csv 文件的第一行被视为标题。

标签

lookupcacheenrichjoincsvreloadablekeyvalue

属性

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

名称默认值可选值描述
CSV File可以在其中查找Key-Value对的 CSV 文件的路径。
支持表达式语言:是(仅使用环境/系统变量求值)
CSV 格式default
  • 自定义格式 — CSV 的格式是通过使用此Controller Service的属性来配置的,例如值分隔符
  • RFC 4180 — CSV 数据遵循 https://tools.ietf.org/html/rfc4180 中定义的 RFC 4180 规范
  • Microsoft Excel — CSV 数据遵循 Microsoft Excel 使用的格式
  • 制表符分隔 — CSV 数据是制表符分隔而不是逗号分隔
  • MySQL 格式 — CSV 数据遵循 MySQL 使用的格式
  • Informix Unload — Informix 在执行 UNLOAD TO file_name 命令时使用的格式
  • Informix Unload 禁用转义 — Informix 在执行 UNLOAD TO file_name 命令时使用的格式,且禁用转义
  • 默认格式 — 与自定义格式相同。出于兼容性原因而可用。
  • RFC4180 — 与 RFC 4180 相同。出于兼容性原因而可用。
指定 CSV 数据使用的 "格式",或指定是否应使用自定义格式。
Character SetUTF-8用于解码 CSV 文件的字符编码。
支持表达式语言:是(仅使用环境/系统变量求值)
Lookup Key ColumnCSV 文件中用作查找键的字段。此字段将与查找处理器中指定的属性进行匹配。
支持表达式语言:是(仅使用环境/系统变量求值)
Ignore Duplicatestrue
  • true
  • false
忽略 CSV 文件中记录的重复键。
Value Separator,用于在 CSV 记录中分隔值/字段的字符。如果通过 Expression Language 指定了此属性,但在运行时求值为无效的值分隔符,则将跳过该值并使用默认的值分隔符。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Quote Character"用于引用值的引号字符,这样就不必使用转义字符。如果通过 Expression Language 指定了此属性,但在运行时求值为无效的引号字符,则将跳过该值并使用默认的引号字符。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Quote ModeMINIMAL
  • 引用所有值 — 所有值都将使用配置的引号字符进行引用。
  • 最小引用 — 仅在值包含特殊字符(如换行符或字段分隔符)时才引用。
  • 引用非数值 — 除数值类型外,其他值都将被引用。
  • 不引用值 — 值不会被引用。相反,所有特殊字符都将使用配置的转义字符进行转义。
指定写入字段时应如何引用字段
Comment Marker用于表示注释开始的字符。 任何以此注释开头的行都将被忽略。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Escape Character\用于转义在 CSV 解析器中具有特殊含义的字符的转义字符。如果通过 Expression Language 指定了此属性,但在运行时求值为无效的转义字符,则将跳过该值并使用默认的转义字符。设置为空字符串表示不使用转义字符。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Trim Fieldstrue
  • true
  • false
是否应删除字段开头和结尾的空格
Lookup Value Column查找值列。
支持表达式语言:是(仅使用环境/系统变量求值)

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

提供的 Service API

  • LookupService (cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8)
  • StringLookupService (cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8)