TOS資料來源讀取能力 - DataWorks

TOS資料來源為您提供讀取TOS檔案的能力，您可以使用本資料來源，擷取TOS中儲存的檔案，解析並同步至任意目標資料來源。本文為您介紹DataWorks的TOS資料同步的能力支援情況。

使用限制

TOS資料來源支援以下欄位類型在DataWorks中使用。

資料類型	說明
STRING	文本類型。
LONG	整型。
BYTES	位元組數組，將讀取到的常值內容轉為`UTF-8`編碼的位元組數組。
BOOL	布爾型。
DOUBLE	浮點型。
DATE	日期時間類型，支援以下日期時間格式： `YYYY-MM-dd HH:mm:ss` `yyyy-MM-dd` `HH:mm:ss`

建立TOS資料來源

在進行資料同步任務開發時，您需要在DataWorks上建立一個對應的資料來源，操作流程請參見資料來源管理，詳細的配置參數解釋可在配置介面查看對應參數的文案提示。

資料同步任務開發

TOS資料來源僅支援在單表離線同步任務中作為資料來源。以下為資料同步任務的配置入口及通用配置流程。

操作流程請參見嚮導模式配置、指令碼模式配置。
指令碼模式配置的全量參數和指令碼Demo，請參見下文附錄：指令碼Demo與參數說明。

附錄：指令碼Demo與參數說明

離線任務指令碼配置方式

如果您配置離線任務時使用指令碼模式的方式進行配置，您需要按照統一的指令碼格式要求，在任務指令碼中編寫相應的參數，詳情請參見指令碼模式配置，以下為您介紹指令碼模式下資料來源的參數配置詳情。

Reader指令碼Demo

{
  "type": "job",
  "version": "2.0",
  "steps": [
    {
      "stepType": "tos",
      "parameter": {
        "datasource": "",
        "object": ["f/z/1.csv"],
        "fileFormat": "csv",
        "encoding": "utf8/gbk/...",
        "fieldDelimiter": ",",
        "useMultiCharDelimiter": true,
        "skipHeader": true,
        "compress": "zip/gzip",
        "column": [
          {
            "index": 0,
            "type": "long"
          },
          {
            "index": 1,
            "type": "boolean"
          },
          {
            "index": 2,
            "type": "double"
          },
          {
            "index": 3,
            "type": "string"
          },
          {
            "index": 4,
            "type": "date"
          }
        ]
      },
      "name": "Reader",
      "category": "reader"
    },
    {
      "stepType": "stream",
      "parameter": {},
      "name": "Writer",
      "category": "writer"
    }
  ],
  "setting": {
    "errorLimit": {
      "record": "0"
    },
    "speed": {
      "concurrent": 1
    }
  },
  "order": {
    "hops": [
      {
        "from": "Reader",
        "to": "Writer"
      }
    ]
  }
}

Reader指令碼參數

參數	描述	是否必選	預設值
datasource	資料來源名稱，指令碼模式支援添加資料來源，該配置項填寫的內容必須和添加的資料來源名稱保持一致。	是	無
fileFormat	源標頭檔類型。支援`csv`、`text`、`parquet`、`orc`。	是	無
object	檔案路徑，此參數支援萬用字元，支援配置為數組。例如：您需要同步a/b/1.csv和a/b/2.csv兩個檔案，可以配置為a/b/.csv。	是	無
column	讀取欄位列表，type指定來源資料的類型，index指定當前列來自於文本第幾列（以0開始），value指定當前類型為常量，不是從源標頭檔讀取資料，而是根據value值自動產生對應的列。預設情況下，您可以全部按照String類型讀取資料，配置如下。 `column": [""]` 您可以指定column欄位資訊，配置如下。 `"column": { "type": "long", "index": 0 //從TOS文本第一列擷取int欄位。 }, { "type": "string", "value": "alibaba" //從TOS內部產生alibaba的字串欄位作為當前欄位。 }` 說明對於您指定的column*資訊，type必須填寫，index和value必須選擇其一。	是	全部按照`STRING`類型讀取。
fieldDelimiter	讀取的欄位分隔符號。說明 TOS Reader在讀取資料時，需要指定欄位分隔符號，如果不指定，預設為（,），介面配置中也會預設填寫為（,）。如果分隔字元不可見，請填寫Unicode編碼。例如：`\u001b`、`\u007c`。	是	`,`
lineDelimiter	讀取的行分隔字元。說明當fileFormat取值為text時，本參數有效。	否	無
compress	文本壓縮類型，預設不填寫（即不壓縮）。支援壓縮類型為`gzip`、`bzip2`和`zip`。	否	`不壓縮`
encoding	讀取檔案的編碼配置。	否	`utf-8`
nullFormat	文字檔中無法使用標準字串定義null（null 指標），資料同步系統提供nullFormat定義哪些字串可以表示為null。例如：配置`nullFormat:"null"`，等同於“可見字元”，如果源頭資料是null，則資料同步視作null欄位。配置`nullFormat:"\u0001"`，等同於“不可見字元”，如果源頭資料是字串"\u0001"，則資料同步視作null欄位。不寫`"nullFormat"`這個參數，等同於“未配置”，代表來源是什麼資料就直接按照什麼資料寫入目標端，不做任何轉換。	否	無
skipHeader	CSV格式檔案通過skipHeader配置是否讀取表頭內容。 True：同步資料來源的時候讀取表頭內容。 False：同步資料來源的時候不讀取表頭內容。說明壓縮檔模式下不支援skipHeader。	否	`false`
parquetSchema	以Parquet檔案格式讀取TOS時配置，若且唯若fileFormat為parquet時生效，具體表示parquet儲存的類型說明。您需要確保填寫parquetSchema後，整體配置符合JSON文法。 `message MessageType名 { 是否必填, 資料類型, 列名; ......................; }` parquetSchema的配置格式說明如下： MessageType名：填寫名稱。是否必填：required表示非空，optional表示可為空白。推薦全部填寫optional。資料類型：Parquet檔案支援BOOLEAN、Int32、Int64、Int96、FLOAT、DOUBLE、BINARY（如果是字串類型，請填BINARY）和fixed_len_byte_array類型。每行列設定必須以分號結尾，最後一行也要寫上分號。配置樣本如下所示： `"parquetSchema": "message m { optional int32 minute_id; optional int32 dsp_id; optional int32 adx_pid; optional int64 req; optional int64 res; optional int64 suc; optional int64 imp; optional double revenue; }"`	否	無
csvReaderConfig	讀取CSV類型檔案參數配置為Map類型。讀取CSV類型檔案使用的csvReader進行讀取，不配置則使用預設值。	否	無