数据导入模板

详情

新建一个数据导入模板。

参数

param：字典，键的类型为字符串。包含以下键值对：

• name：必填，STRING，数据导入模板的名称。

• tags：选填，STRING，数据导入模板的标签，多个标签可以用逗号分隔。

• comment：选填，STRING，数据导入模板的备注。

返回值

一个字典，包含以下键值对：

• template_id：UUID，数据导入模板的唯一 ID。

例子

starfish::facplfBasic::facplf_create_new_data_import_template({
    "name": "apitest_dataImport",
    "tags": "",
    "comment": ""
})


/* output： 
template_id->"9e9fdb94-35ff-55a6-0db8-63a4315c25cb"
*/

详情

编辑数据导入模板。

参数

param：字典，键的类型为字符串。包含以下键值对：

• template_id：必填，STRING，数据导入模板的唯一 id。

• name：选填，STRING，要修改后的数据导入模板的名称。

• tags：选填，STRING，要修改后的数据导入模板的标签，多个标签可以用逗号分隔。

• comment：选填，STRING，要修改后的数据导入模板的备注。

• code：选填，STRING，要修改后的数据导入模板的代码。

返回值

一个整型标量，表示修改成功的数量。

例子

starfish::facplfBasic::facplf_edit_data_import_template({
    "template_id": "9e9fdb94-35ff-55a6-0db8-63a4315c25cb",
    "name": "apitest_dataImport",
    "tags": "loadCsv",
    "comment": "",
    "code": "
    def apitest_dataImport(dbName, tbName, csvFile){\r\n    pt = loadTable(dbName, tbName)\r\n    t = loadText(csvFile, schema=pt.schema().colDefs)\r\n    pt.append!(t)\r\n}"
})

// output：1

详情

查看数据导入模板列表。

参数

无

返回值

一个字典，包含以下键值对：

• total：整型，数据导入模板总数。

• items：表，数据导入模板列表。包含以下字段：

  字段名	类型	说明
  template_id	UUID	数据导入模板的唯一 ID
  name	STRING	数据导入模板的名称
  tags	STRING	数据导入模板的标签，多个标签之间用逗号分隔
  run_record_count	INT	数据导入模板的运行次数
  is_custom	STRING	是否为自定义模板
  create_time	TIMESTAMP	数据导入模板的创建时间
  update_time	TIMESTAMP	数据导入模板的创建时间
  creator	STRING	创建数据导入模板的用户名称
  comment	STRING	数据导入模板的备注
  source_code	BLOB	数据导入模板的实际代码

例子

starfish::facplfBasic::facplf_data_import_template_list()

/* output: 
total->1
items->
template_id	                         name	 tags	run_record_count is_custom	create_time	            update_time	            creator	  comment	             source_code
------------------------------------ ------- ------ ---------------- ---------- ----------------------- ----------------------- --------- ---------------------- -------------------------------------------------------------------------------
00000000-0000-0000-0005-000000000001 loadCSV		0	             true	    2024.10.21 00:00:00.000	2024.10.21 00:00:00.000	DolphinDB 内置CSV数据导入维度表方法 def loadCSV(dbName, tbName, path){ //该数据模板仅适用于较小数据量的CSV文件数…
*/

详情

查看数据导入模板详情。

参数

param：字典，键的类型为字符串。包含以下键值对：

• template_id：必填，字符串，表示数据导入模板的唯一 ID。

返回值

一个字典，包含以下键值对：

• template_id：UUID，数据导入模板的唯一 ID。

• name：STRING，数据导入模板的名称。

• tags：STRING，数据导入模板的标签，多个标签之间用逗号分隔。

• create_time：TIMESTAMP，数据导入模板的创建时间。

• update_time：TIMESTAMP，数据导入模板的创建时间。

• creator：STRING，创建数据导入模板的用户名称。

• comment：INT，数据导入模板的备注。

• is_custom：STRING，是否为自定义模板。

• source_code：BLOB，数据导入模板的代码。

• run_record_count：INT，数据导入模板的运行次数。

例子

starfish::facplfBasic::facplf_data_import_template_detail({
  "template_id": "9e9fdb94-35ff-55a6-0db8-63a4315c25cb"
})

/* output: 
template_id->9e9fdb94-35ff-55a6-0db8-63a4315c25cb
name->'apitest_dataImport'
tags->'loadCsv'
create_time->2024.10.28 10:00:48.916
update_time->2024.10.28 16:11:47.848
creator->'admin'
comment->''
is_custom->true
source_code->def apitest_dataImport(dbName, tbName, csvFile){ pt = loadTable(dbName, tbName) t = load…
run_record_count->5
*/

详情

查看数据导入模板详情。

参数

param：字典，键的类型为字符串。包含以下键值对：

• template_id：必填，字符串，表示运行的数据导入模板的 ID。

• template_params：必填，字符串，表示数据导入模板的参数，每个 dict 包含以下键值对：。

  • name：字符串标量，表示数据导入模板的参数名称；

  • value：标量，类型由下一个参数 type 的取值决定，表示数据导入模板的参数值；

  • type：字符串标量，表示数据导入模板的参数类型，取值范围与因子模板的参数类型取值范围一致。

返回值

一个字典，包含以下键值对：

• import_job_id：STRING，数据导入模板的运行作业 ID。

• import_record_id：STRING，数据导入模板的运行记录 ID。

例子

use starfish::facplfRun
starfish::facplfRun::facplf_run_data_import({
    "template_id": "9e9fdb94-35ff-55a6-0db8-63a4315c25cb",
    "template_params": [
        {
            "name": "dbName",
            "type": "string",
            "value": "dfs://factor_test"
        },
        {
            "name": "tbName",
            "type": "string",
            "value": "data"
        },
        {
            "name": "csvFile",
            "type": "string",
            "value": "testImport.csv"
        }
    ]
})

/* output:
import_job_id->admin_apitest_dataImport_444f0d37_f128_5763_37f2_16177e899692"
import_record_id->"444f0d37-f128-5763-37f2-16177e899692"
*/

详情

查看数据导入模板运行结果。

参数

param：字典，键的类型为字符串。包含以下键值对：

• import_record_id：必填，字符串，表示数据导入模板的运行记录 ID。

返回值

一个字典，包含以下键值对：

• import_record_id：UUID，数据导入模板的运行记录 ID。

• template_id：UUID，数据导入模板 ID。

• template_name：STRING，数据导入模板名称。

• create_time：TIMESTAMP，任务创建时间。

• creator：STRING，任务创建者。

• db_name：STRING，导入目标数据库库名。

• tb_name：STRING，导入目标数据表表名。

• run_node：STRING，运行节点名。

• params：DICT[]，数据导入模板运行参数。

• jobId：STRING，数据导入任务 ID。

• status：INT，数据导入任务运行状态。

• result：DICT，数据导入结果。

例子

starfish::facplfBasic::facplf_get_data_import_record_detail({"import_record_id": "444f0d37-f128-5763-37f2-16177e899692"})

/* output: 
import_record_id->444f0d37-f128-5763-37f2-16177e899692
template_id->9e9fdb94-35ff-55a6-0db8-63a4315c25cb
template_name->'apitest_dataImport'
create_time->2024.10.28 16:13:46.868
creator->'admin'
db_name->'dfs://factor_test'
tb_name->'data'
run_node->'single7301'
params->[{"name": "dbName","type": "string","value": "dfs://factor_test"},{"name": "tbName","type": "string","value": "data"},{"name": "csvFile","type": "string","value": "testImport.csv"}]
jobId->'admin_apitest_dataImport_444f0d37_f128_5763_37f2_16177e899692'
status->1
result->
  cols->["tradetime","securityid","price","volume"]
  data->
  tradetime	              securityid price	           volume
  ----------------------- ---------- ----------------- -------
  2024.09.16 09:30:00.000 600100     0.872059161774814 392
  2024.09.16 09:30:01.000 600100     9.695313763804732 7,078
  ...
*/