Método to_hb_results()

Salva um dataframe do HCL em uma tabela do Resultados.

Observação

Para usar o método to_hb_results(), você também precisa criar uma variável de senha chamada v_hb_token na janela Variáveis do editor de scripts do HCL e atribuir um token de API do HighBond como valor da variável. Para obter mais informações, consulte Use a janela Variáveis para definir uma variável HCL.

Sintaxe

nome_dataframe.to_hb_results(table_id = número_de_ID_da_tabela_do_Resultados, column_names = {"nome_coluna":"nome_de_exibição_no_Resultados", "...n":"...n"}|objeto_de_dicionário, overwrite = True|False)

Parâmetros

Nome Descrição
table_id = número_de_ID_da_tabela_do_Resultados O ID numérico da tabela Resultados.
column_names = {"column_name" : "Results_display_name", "...n" : "...n"}

opcional

Mapeamento entre um nome de coluna no dataframe e um nome de exibição para o campo correspondente no Resultados.

Crie o mapeamento para uma ou mais colunas usando um dicionário padrão do Python.

Você está especificando um nome de exibição apenas para o campo na tabela do Resultados de destino. O nome do campo subjacente no Resultados permanece inalterado.

column_names = dictionary_object

opcional

Um objeto de dicionário preexistente que mapeia um ou mais nomes de colunas no dataframe para exibir nomes para os campos correspondentes no Resultados.

Como alternativa à criação do mapeamento de coluna em to_hb_results(), você pode criá-lo em um dicionário separado e especificar apenas o nome do dicionário em to_hb_results(). Se você precisa criar o mesmo conjunto de nomes de exibição para várias tabelas de destino no Resultados, essa abordagem é mais eficiente.

Você está especificando um nome de exibição apenas para o campo na tabela do Resultados de destino. O nome do campo subjacente no Resultados permanece inalterado.

overwrite = True | False
  • True Os dados salvos sobrescrevem qualquer dado existente na tabela do Resultados.
  • False Os dados salvos são anexados aos dados existentes na tabela do Resultados.

Se o parâmetro for omitido, os dados serão anexados por padrão.

Retorna

Para uma execução bem-sucedida, o código de retorno é 202. Em caso de falha, uma mensagem de erro.

Exemplos

Salvar um dataframe em uma tabela do Resultados

Você salva o dataframe customer_summary na tabela do Resultados como ID 587293. Todos os registros existentes na tabela Resultados são sobrescritos.

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

Salvar um dataframe e criar nomes de exibição de campo no Resultados

Você salva o dataframe customer_summary na tabela do Resultados como ID 587293. Ao mesmo tempo, você cria três nomes de exibição para campos na tabela do Resultados de destino.

No Resultados:

  • O campo No usa o nome de exibição Customer Number
  • O campo First usa o nome de exibição First Name
  • O campo Last usa o nome de exibição Last Name
customer_summary.to_hb_results(table_id = "587293", column_names = {"No":"Customer Number", "First":"First Name", "Last":"Last Name"}, overwrite = True)

Salvar vários dataframes e criar nomes de exibição de campo usando um dicionário preexistente

Você usa um objeto de dicionário único ( display_names ) para criar o mesmo conjunto de nomes de exibição em três tabelas do Resultados.

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)

Observações

Mapeamento de tipo de dados

Quando você salva um dataframe do HCL em uma tabela no Resultados, os tipos de dados de coluna no dataframe são mapeados automaticamente para tipos de dados de campo na tabela:

Tipo de dados de coluna no dataframe do HCL Tipo de dados de campo na tabela do Resultados
objeto caractere
categoria caractere
int64 numérico
float64 numérico
datetime64[ns] datahora
timedelta64[ns] numérico
booleano lógico

Remoção automática dos campos metadata e extras

Se um fluxo de trabalho de análise de dados enviar dados do Resultados para o Robôs e de volta para o Resultados, os campos metadata e extras em um dataframe do HCL serão removidos automaticamente dos dados salvos no Resultados. Os campos serão removidos se você salvar o dataframe do HCL na mesma tabela no Resultados ou em uma tabela nova.

Os campos metadata e extras são campos gerados pelo sistema no Resultados e ficam protegidos. Se for editável, o conteúdo nesses campos poderá ser editado apenas no Resultados. Por esse motivo, você está evitando a ação de substituir ou anexar a esses campos no Robôs.

Observação

Quando você salva dados de ida e volta no Resultados, os campos metadata e extras aparecem com os dados salvos. No entanto, são campos novos criados automaticamente pelo Resultados. Não são os mesmos campos que existem no Robôs.

Os campos metadata e extras a seguir, se existirem no Robôs, serão removidos automaticamente dos dados salvos:

  • 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