‎to_hb_results()‎ 方法

将 HCL 数据帧保存至 结果 表。

说明

使用 to_hb_results() 方法还需要在 HCL 脚本编辑器的变量窗口中创建一个名为 v_hb_token 的密码变量,并分配一个 HighBond API 令牌作为变量值。有关详细信息,请参阅

语法

数据帧名称.to_hb_results(table_id = 结果应用程序表 ID 编号, column_names = {"列名称":"结果应用程序显示名称", "...n":"...n"}|字典对象, overwrite = True|False)

参数

名称描述
table_id = 结果应用程序表 ID 编号结果 表中的数值 ID。
column_names = {"column_name" : "Results_display_name", "...n" : "...n"}

可选

数据帧中的列名与 结果 中相应字段的显示名称之间的映射。

使用标准 Python 字典为一个或多个列构建该映射。

您仅为目标 结果 表中的字段指定显示名称。结果应用程序中的基础字段名称保持不变。

column_names = 字典对象

可选

一个预先存在的字典对象,它将数据帧中的一个或多个列名映射到 结果 中相应字段的显示名称。

作为在 to_hb_results() 中创建列映射的替代解决方案,您可以在单独的字典中创建映射并仅在 to_hb_results() 中指定该字典名称。如果您需要为 结果 中的多个目标表创建同一组显示名称,则此方法效率更高。

您仅为目标 结果 表中的字段指定显示名称。结果应用程序中的基础字段名称保持不变。

overwrite = True | False
  • True保存的数据覆盖 结果 表中的任何现有数据。
  • False保存的数据被追加到 结果 表中的任何现有数据。

如果您省略该参数,则保存的数据被默认附加。

返回

如果成功,则为返回码 202。对于失败,返回一个错误消息。

示例

将数据帧保存至 结果

您将 customer_summary 数据帧保存至 ID 为 587293 的 结果 表。结果 表中的任何现有记录都会被覆盖。

customer_summary.to_hb_results(table_id = "587293", overwrite = True)

保存数据帧并在 结果 中创建字段显示名称

您将 customer_summary 数据帧保存至 ID 为 587293 的 结果 表。与此同时,为目标 结果 表中的字段创建三个显示名称。

结果 中:

  • No 字段使用 Customer Number 显示名称
  • First 字段使用 First Name 显示名称
  • Last 字段使用 Last Name 显示名称
customer_summary.to_hb_results(table_id = "587293", column_names = {"No":"Customer Number", "First":"First Name", "Last":"Last Name"}, overwrite = True)

使用预先存在的字典,保存多个数据帧并创建字段显示名称

使用单个字典对象 ( display_names ) 在三个 结果 表中创建相同的显示名称集。

display_names = {"No":"Customer Number", "First":"First Name", "Last":"Last Name"}
customer_summary_us.to_hb_results(table_id = "587293", column_names = display_names, overwrite = True)
customer_summary_eu.to_hb_results(table_id = "587294", column_names = display_names, overwrite = True)
customer_summary_ap.to_hb_results(table_id = "587295", column_names = display_names, overwrite = True)

备注

数据类型映射

当您将 HCL 数据帧保存到 结果 表时,数据帧中的列数据类型会自动映射到表中的字段数据类型:

HCL 数据帧中的列数据类型结果 表中的字段数据类型
对象字符
类别字符
int64数值
float64数值
datetime64[ns]日期时间
timedelta64[ns]数值
布尔逻辑

自动移除元数据和附加字段

如果数据分析工作流将数据在 结果机器人结果 之间往返,则 HCL 数据帧中的 metadataextras 字段将自动从保存回 结果 的数据中移除。无论您是将 HCL 数据帧保存回 结果 中的同一个表还是新表,这些字段都会被移除。

metadataextras 字段均为 结果 中系统生成的字段并受到保护。这些字段中的内容(如果可编辑)只能在 结果 中编辑。因此,系统会阻止您通过 机器人 覆盖或追加到这些字段。

说明

当您将往返数据保存回 结果 时,metadataextras 字段确实会出现在保存的数据中。然而,这些是由 结果 自动创建的新字段。而不是 机器人 中存在的字段。

如果 机器人 中存在以下 metadataextras 字段,则会自动从保存的数据中移除:

  • metadata.priority

  • metadata.status

  • metadata.publish_date

  • metadata.publisher

  • metadata.assignee

  • metadata.group

  • metadata.updated_at

  • metadata.closed_at

  • extras.record_id

  • extras.collection

  • extras.results_table