Méthode to_hb_results()

Enregistre un cadre de données HCL dans une table Résultats.

Remarque

L'utilisation de la méthode to_hb_results() exige que vous créiez également une variable de mot de passe appelée v_hb_token dans la fenêtre Variables dans l'éditeur de script HCL et que vous affectiez un jeton d'API HighBond comme valeur de variable. Pour plus d'informations, consultez la rubrique Utiliser la fenêtre Variables pour définir une variable HCL.

Syntaxe

nom_cadrededonnées.to_hb_results(id_table = numéro_ID_table_Résultats, column_names = {"nom_colonne":"nom_affichage_Résultats", "...n":"...n"}|objet_dictionnaire, remplacer = True|False)

Paramètres

Nom Description
table_id = numéro_ID_table_Résultats ID numérique de la table Résultats.
column_names = {"nom_colonne" : "nom_affichage_Résultats", "...n" : "...n"}

facultatif

Un mappage entre un nom de colonne dans le cadre de données et un nom d'affichage pour le champ correspondant dans Résultats.

Construisez le mappage pour une ou plusieurs colonnes à l'aide d'un dictionnaire Python standard.

Vous spécifiez un nom d'affichage uniquement pour le champ dans la table Résultats de destination. Le nom du champ sous-jacent dans Résultats reste inchangé.

noms_colonnes = objet_dictionnaire

facultatif

Un objet de dictionnaire pré-existant qui mappe un ou plusieurs noms de colonnes dans le cadre de données pour afficher les noms pour les champs correspondants dans Résultats.

Plutôt que de créer le mappage de la colonne à l'intérieur de to_hb_results(), vous pouvez créer le mappage dans un dictionnaire distinct et spécifier uniquement le nom du dictionnaire dans to_hb_results(). Si vous devez créer le même jeu de noms d'affichage pour plusieurs tables de destination dans Résultats, cette approche est plus efficace.

Vous spécifiez un nom d'affichage uniquement pour le champ dans la table Résultats de destination. Le nom du champ sous-jacent dans Résultats reste inchangé.

overwrite = True | False
  • True Les données sauvegardées écrasent toutes les données existantes dans la table Résultats.
  • False Les données enregistrées sont concaténées aux données existantes dans la table Résultats.

Si vous omettez le paramètre, les données enregistrées sont concaténées par défaut.

Renvoie

En cas de succès, le code de retour 202. En cas d'échec, un message d'erreur.

Exemples

Enregistrer un cadre de données dans une table Résultats

Vous enregistrez le cadre de données customer_summary dans la table Résultats portant l'ID 587293. Les enregistrements existants dans la table Résultats sont écrasés.

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

Enregistrer un cadre de données et créer des noms d'affichage de champs dans Résultats

Vous enregistrez le cadre de données customer_summary dans la table Résultats portant l'ID 587293. Simultanément, vous pouvez créer trois noms d'affichage pour les champs de la table Résultats de destination.

Dans Résultats :

  • Le champ No utilise le nom d'affichage Customer Number
  • Le champ First utilise le nom d'affichage First Name
  • Le champ Last utilise le nom d'affichage Last Name
customer_summary.to_hb_results(table_id = "587293", column_names = {"No":"Customer Number", "First":"First Name", "Last":"Last Name"}, overwrite = True)

Enregistrer des cadres de données multiples et créer des noms d'affichage de champs à l'aide d'un dictionnaire pré-existant

Vous utilisez un objet de dictionnaire unique (display_names) pour créer le même jeu de noms d'affichage dans trois tables Résultats.

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)

Remarques

Mappage des types de données

Lorsque vous enregistrez un cadre de données HCL vers une table dans Résultats, les types de données de colonne dans le cadre de données sont automatiquement mappées aux types de données de champ dans la table :

Type de données de colonne dans un cadre de données HCL Type de données de champ dans la table Résultats
objet caractère
catégorie caractère
int64 numérique
float64 numérique
dateheure64[ns] DateHeure
deltaheure64[ns] numérique
bool logique

Retrait automatique des métadonnées et des champs supplémentaires

Si un flux de travail d'analyse de données procède à un aller-retour sur les données (de Résultats à Robots, puis de Robots à Résultats), les champs de metadata et les champs extras dans un cadre de données HCL sont automatiquement supprimés des données enregistrées vers Résultats. Les champs sont supprimés lorsque vous réenregistrez le cadre de données HCL vers la même table dans Résultats, ou dans une nouvelle table.

Les champs metadata et extras sont des champs générés par le système dans Résultats qui sont protégés. Le contenu de ces champs, s'ils sont éditables, peut uniquement être modifié dans Résultats. Pour cette raison, vous n'avez pas le droit d'écraser ou de concaténer ces champs depuis Robots.

Remarque

Lorsque vous réenregistrez les données d'aller-retour dans Résultats, les champs metadata et extras affichent les données enregistrées. Toutefois, ces nouveaux champs sont créés automatiquement par Résultats. Il ne s'agit pas des champs tels qu'ils existent dans Robots.

Les champs metadata et extras suivants, s'ils existent dans Robots, sont automatiquement supprimés des données enregistrées :

  • 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