Skip to main content
Version: 2.1.1

Feishu Sheet

Description

Get data from Feishu sheet

tip

Engine Supported and plugin name

  • Spark: FeishuSheet
  • Flink

Options

nametyperequireddefault value
appIdstringyes-
appSecretstringyes-
sheetTokenstringyes-
rangestringnoall values in sheet
sheetNumintno1
titleLineNumintno1
ignoreTitleLineboolnotrue
  • appId and appSecret
    • These two parameters need to get from Feishu open platform.
    • And open the sheet permission in permission management tab.
  • sheetToken
  • range
    • The format is A1:D5 or A2:C4 and so on.
  • sheetNum
    • If you want import first sheet you can input 1 and the default value is 1.
    • If you want import second one you should input 2.
  • titleLineNum
    • The default title line the first line.
    • If you title line is not first, you can change number for it. Like 2, 3 or 5.
  • ignoreTitleLine
    • The title line it not save to data, if you want to save title line to data, you can set value as false.

common options [string]

Source plugin common parameters, please refer to Source Plugin for details

Example

    FeishuSheet {
result_table_name = "my_dataset"
appId = "cli_a2cbxxxxxx"
appSecret = "IvhtW7xxxxxxxxxxxxxxx"
sheetToken = "shtcn6K3DIixxxxxxxxxxxx"
# range = "A1:D4"
}