本文为您介绍FTP Reader支持的数据类型、字段映射和数据源等参数及配置示例。

背景信息

FTP Reader为您提供读取远程FTP文件系统数据存储的功能。在底层实现上，FTP Reader获取远程FTP文件数据，并转换为数据同步传输协议传递给Writer。

本地文件内容存放的是一张逻辑意义上的二维表，例如CSV格式的文本信息。

FTP Reader实现了从远程FTP文件读取数据并转为数据同步协议的功能，远程FTP文件本身是无结构化数据存储。对于数据同步而言，目前FTP Reader支持的功能如下所示：
  • 支持且仅支持读取TXT的文件，并要求TXT中的schema为一张二维表。
  • 支持类CSV格式文件，自定义分隔符。
  • 支持多种类型数据读取（使用STRING表示）、支持列裁剪和列常量。
  • 支持递归读取、支持文件名过滤。
  • 支持文本压缩，现有压缩格式为gzip、bzip2、zip、lzo和lzo_deflate。
  • 多个File可以支持并发读取。
暂时不支持以下功能：
  • 单个File支持多线程并发读取，此处涉及到单个File内部切分算法。
  • 单个File在压缩情况下，从技术上无法支持多线程并发读取。

类型转换列表

远程FTP文件本身不提供数据类型，该类型是DataX FtpReader定义。
DataX内部类型远程FTP文件数据类型
LONGLONG
DOUBLEDOUBLE
STRINGSTRING
BOOLEANBOOLEAN
DATEDATE

参数说明

参数描述是否必选默认值
datasource数据源名称，脚本模式支持添加数据源，此配置项填写的内容必须要与添加的数据源名称保持一致。是无
path远程FTP文件系统的路径和文件名信息，需要填写包含路径和文件后缀的完整文件路径和文件名。这里可以支持填写多个路径。
  • 当指定单个远程FTP文件，FTP Reader暂时只能使用单线程进行数据抽取。后期会在非压缩文件情况下针对单个File进行多线程并发读取。
  • 当指定多个远程FTP文件，FTP Reader支持使用多线程进行数据抽取。线程并发数通过通道数指定。
  • 当指定通配符，FTP Reader尝试遍历出多个文件信息。例如，指定/代表读取/目录下所有的文件，指定/bazhen/代表读取bazhen目录下游所有的文件。FTP Reader目前仅支持星号（*）作为文件通配符，并支持使用调度参数配合调度，灵活配置文件名与文件路径。
说明
  • 通常不建议您使用星号（*），易导致任务运行报JVM内存溢出的错误。
  • 数据同步会将一个作业下同步的所有Text File视作同一张数据表。您必须自己保证所有的File能够适配同一套Schema信息。
  • 您必须保证读取文件为类CSV格式，并且提供给数据同步系统权限可读。
  • 如果Path指定的路径下没有符合匹配的文件抽取，同步任务将报错。
是无
column读取字段列表，type指定源数据的类型，index指定当前列来自于文本第几列（以0开始），value指定当前类型为常量，不从源头文件读取数据，而是根据value值自动生成对应的列。
默认情况下，您可以全部按照STRING类型读取数据，配置为"column":["*"]。您可以指定column字段信息，配置如下。 
{
    "type": "long",
    "index": 0    //从远程FTP文件文本第一列获取INT字段。
  },
  {
    "type": "string",
    "value": "alibaba"  //从FTP Reader内部生成alibaba的字符串字段作为当前字段。
  }

对于您指定的column信息，type必须填写，index和value必须选择其一。

是无
fieldDelimiter读取的字段分隔符。
说明 FTP Reader在读取数据时，需要指定字段分割符，如果不指定会默认为（,），界面配置也会默认填写（,）。
是,
skipHeader类CSV格式文件可能存在表头为标题情况，需要跳过。默认不跳过，压缩文件模式下不支持skipHeader。否false
encoding读取文件的编码配置。否utf-8
nullFormat 文本文件中无法使用标准字符串定义null（空指针），数据同步提供nullFormat定义哪些字符串可以表示为null。

例如，您配置nullFormat:"null"，如果源头数据是null，则数据同步视作null字段。

否无
markDoneFileName标档文件名，数据同步前检查标档文件。如果标档文件不存在，等待一段时间重新检查标档文件，如果检查到标档文件开始执行同步任务。否无
maxRetryTime表示检查标档文件重试次数，默认重试60次，每一次重试间隔为1分钟，共60分钟。否60
csvReaderConfig读取CSV类型文件参数配置，Map类型。读取CSV类型文件使用的CsvReader进行读取，会有很多配置，不配置则使用默认值。否无
fileFormat读取的文件类型，默认情况下文件作为csv格式文件进行读取，内容被解析为逻辑上的二维表结构处理。如果您配置为binary，则表示按照纯粹二进制格式进行复制传输。

通常在FTP、OSS等存储之间进行目录结构对等复制时使用，通常无需配置该项。

否无

向导开发介绍

  1. 选择数据源。
    配置同步任务的数据来源和数据去向。选择数据来源
    参数描述
    数据源即上述参数说明中的datasource，通常填写您配置的数据源名称。
    文件路径即上述参数说明中的path，需要填写包含路径和文件后缀的完整文件路径和文件名。您可以与调度参数结合实现每日读取指定文件数据。当同步任务运行时，任务中配置的参数都会被替换为调度参数表达式所表达的实际值，然后再执行数据同步。详情请参见调度参数的典型应用场景、数据集成使用调度参数的相关说明。
    说明 如果要实现同步动态文件名中的数据，部分插件需要转脚本模式进行配置。同时，在使用变量的情况下，一般不支持数据预览功能。
    文本类型读取的文件类型，默认情况下文件作为csv格式文件进行读取。
    列分隔符即上述参数说明中的fieldDelimiter，默认值为（,）。
    编码格式即上述参数说明中的encoding，默认值为utf-8。
    null值即上述参数说明中的nullFormat，定义表示null值的字符串。
    压缩格式文本压缩类型，默认值为不压缩。
    是否包含表头即上述参数说明中的skipHeader，默认值为No。
  2. 字段映射，即上述参数说明中的column。
    左侧的源头表字段和右侧的目标表字段为一一对应的关系。单击添加一行可以增加单个字段，将鼠标放至需要删除的字段上，即可单击删除按钮进行删除。字段映射
    参数描述
    同名映射单击同名映射，可以根据名称建立相应的映射关系，请注意匹配数据类型。
    同行映射单击同行映射，可以在同行建立相应的映射关系，请注意匹配数据类型。
    取消映射单击取消映射，可以取消建立的映射关系。
  3. 通道控制。通道配置
    参数描述
    任务期望最大并发数数据同步任务内，可以从源并行读取或并行写入数据存储端的最大线程数。向导模式通过界面化配置并发数，指定任务所使用的并行度。
    同步速率设置同步速率可以保护读取端数据库，以避免抽取速度过大，给源库造成太大的压力。同步速率建议限流，结合源库的配置，请合理配置抽取速率。
    错误记录数错误记录数，表示脏数据的最大容忍条数。
    分布式处理能力

    数据同步时，可以将任务切片分散到多台执行节点上并发执行，提高同步速率。该模式下，配置较大任务并发数会增加数据存储访问压力，如需使用该功能，请提前评估数据存储的访问负载。该功能仅支持在独享数据集成资源组配置，详情请参见独享数据集成资源组和新增和使用独享数据集成资源组。

脚本开发介绍

配置一个从FTP数据库同步抽取数据作业，使用脚本开发的详情请参见通过脚本模式配置离线同步任务。 
{
    "type":"job",
    "version":"2.0",//版本号。
    "steps":[
        {
            "stepType":"ftp",//插件名。
            "parameter":{
                "path":[],//文件路径。
                "nullFormat":"",//null值。
                "compress":"",//压缩格式。
                "datasource":"",//数据源。
                "column":[//字段。
                    {
                        "index":0,//序列号。
                        "type":""//字段类型。
                    }
                ],
                "skipHeader":"",//是否包含表头。
                "fieldDelimiter":",",//列分隔符。
                "encoding":"UTF-8",//编码格式。
                "fileFormat":"csv"//文本类型。
            },
            "name":"Reader",
            "category":"reader"
        },
        {
            "stepType":"stream",
            "parameter":{},
            "name":"Writer",
            "category":"writer"
        }
    ],
    "setting":{
        "errorLimit":{
            "record":"0"//错误记录数。
        },
        "speed":{
        "throttle":true,//当throttle值为false时，mbps参数不生效，表示不限流；当throttle值为true时,表示限流。
            "concurrent":1 //作业并发数。
            "mbps":"12",//限流
        }
    },
    "order":{
        "hops":[
            {
                "from":"Reader",
                "to":"Writer"
            }
        ]
    }
}