Cette page explique comment créer une analyse de la qualité des données Dataplex.
Pour en savoir plus sur les analyses de la qualité des données, consultez À propos de la qualité des données automatique
Avant de commencer
Activez l'API Dataplex.
Facultatif: Si vous souhaitez que Dataplex génère des recommandations pour des règles de qualité des données basées sur les résultats d'une analyse de profilage des données, Créer et exécuter l'analyse de profilage des données
Autorisations
Pour exécuter une analyse de qualité des données sur une table BigQuery, vous devez disposer de l'autorisation de lire la table BigQuery et de créer un job BigQuery dans le projet utilisé pour analyser la table.
Si la table BigQuery et l'analyse de qualité des données se trouvent dans des projets différents, vous devez attribuer au compte de service Dataplex du projet contenant l'analyse de qualité des données l'autorisation de lecture pour la table BigQuery correspondante.
Si les règles de qualité des données font référence à des tables supplémentaires, le compte de service doit disposer d'autorisations de lecture sur les mêmes tables.
Pour obtenir les autorisations nécessaires pour exporter les résultats de l'analyse table BigQuery, demandez à votre administrateur d'accorder le compte de service Dataplex pour le compte Rôle IAM d'éditeur de données (
roles/bigquery.dataEditor
) sur le l'ensemble de données et la table de résultats. Fournit les autorisations suivantes:bigquery.datasets.get
bigquery.tables.create
bigquery.tables.get
bigquery.tables.getData
bigquery.tables.update
bigquery.tables.updateData
Si les données BigQuery sont organisées dans un Dataplex accordez au compte de service Dataplex le rôle Rôles
roles/dataplex.metadataReader
etroles/dataplex.viewer
. Vous devez également disposer de toutes les autorisations suivantes :dataplex.lakes.list
dataplex.lakes.get
dataplex.zones.list
dataplex.zones.get
dataplex.entities.list
dataplex.entities.get
dataplex.operations.get
Si vous analysez une table externe BigQuery à partir de Cloud Storage, attribuez au compte de service Dataplex le rôle Cloud Storage
roles/storage.objectViewer
pour le bucket. Vous pouvez également attribuer au compte de service Dataplex les autorisations suivantes:storage.buckets.get
storage.objects.get
Si vous souhaitez publier les résultats de l'analyse de la qualité des données dans le les pages BigQuery et Data Catalog de la console Google Cloud pour les tables sources, vous devez disposer l'éditeur de données BigQuery (
roles/bigquery.dataEditor
) ; rôle IAM ou l'autorisationbigquery.tables.update
pour la table.Si vous devez accéder à des colonnes protégées par les règles d'accès BigQuery au niveau des colonnes, accordez des autorisations au compte de service Dataplex pour ces colonnes. L'utilisateur qui crée ou met à jour une analyse de données doit également disposer d'autorisations pour les colonnes.
Si des règles d'accès BigQuery au niveau des lignes sont activées pour une table, vous ne pouvez analyser que les lignes visibles par le compte de service Dataplex. Notez que les droits d'accès de l'utilisateur individuel ne sont pas évalués pour les règles au niveau des lignes.
Autorisations et rôles d'analyse des données
Pour utiliser la qualité automatique des données, vous devez disposer des autorisations nécessaires pour exécuter des analyses de données. un rôle disposant d'autorisations prédéfinies pour exécuter des analyses de données.
Le tableau suivant répertorie les autorisations DataScan
:
Nom de l'autorisation | Accorde l'autorisation d'effectuer les opérations suivantes : |
---|---|
dataplex.datascans.create |
Créer un objet DataScan |
dataplex.datascans.delete |
Supprimer un objet DataScan |
dataplex.datascans.get |
Afficher les métadonnées opérationnelles telles que l'ID ou la programmation, mais pas les résultats ni les règles |
dataplex.datascans.getData |
Afficher les détails de DataScan , y compris les règles et les résultats |
dataplex.datascans.list |
Lister les DataScan |
dataplex.datascans.run |
Exécuter un DataScan |
dataplex.datascans.update |
Mettre à jour la description d'un DataScan |
dataplex.datascans.getIamPolicy |
Afficher les autorisations IAM actuelles de l'analyse |
dataplex.datascans.setIamPolicy |
Définir des autorisations IAM sur l'analyse |
Attribuez aux utilisateurs un ou plusieurs des rôles suivants:
roles/dataplex.dataScanAdmin
: accès complet aux ressourcesDataScan
.roles/dataplex.dataScanEditor
: accès en écriture aux ressourcesDataScan
.roles/dataplex.dataScanViewer
: accès en lecture aux ressourcesDataScan
, à l'exception des règles et des résultats.roles/dataplex.dataScanDataViewer
: accès en lecture aux ressourcesDataScan
, y compris aux règles et aux résultats.
Définir des règles de qualité des données
Vous pouvez définir des règles de qualité des données à l'aide de règles intégrées ou de contrôles SQL personnalisés. Si vous utilisez la Google Cloud CLI, vous pouvez définir ces règles dans un fichier JSON ou YAML.
Les exemples des sections suivantes montrent comment définir différents critères de qualité des données des règles de pare-feu. Les règles valident un exemple de table contenant des données sur les transactions des clients. Supposons que la table présente le schéma suivant :
Nom de colonne | Type de colonne | Description de la colonne |
---|---|---|
transaction_timestamp | Horodatage | Code temporel de la transaction. La table est partitionnée en fonction de ce champ. |
customer_id | Chaîne | Numéro client au format 8 lettres suivies de 16 chiffres. |
transaction_id | Chaîne | L'ID de transaction doit être unique dans la table. |
currency_id | Chaîne | L'une des devises acceptées. Le type de devise doit correspondre à l'une des devises disponibles dans la table de dimension dim_currency .
|
amount | float | Montant de la transaction. |
discount_pct | float | Pourcentage de remise. Cette valeur doit être comprise entre 0 et 100. |
Définir des règles de qualité des données à l'aide des types de règles intégrés
Les exemples de règles suivants sont basés sur des types de règles intégrés. Vous pouvez créer des règles basées sur des types de règles intégrés à l'aide de la console Google Cloud ou de l'API. Dataplex peut vous recommander certaines de ces règles.
Nom de la colonne | Type de règle | Dimension suggérée | Paramètres de la règle |
---|---|---|---|
transaction_id |
Vérification de l'originalité | Unicité | "Threshold" (Seuil) : Not Applicable |
amount |
Vérification des valeurs nulles | Exhaustivité | "Threshold" (Seuil) : 100% |
customer_id |
Vérification de l'expression régulière | Validité | Expression régulière : ^[0-9]{8}[a-zA-Z]{16}$ Seuil : 100%
|
currency_id |
Vérification de la définition de valeurs | Validité | Ensemble de : USD,JPY,INR,GBP,CAN Seuil : 100%
|
Définir des règles de qualité des données à l'aide de règles SQL personnalisées
Pour créer des règles SQL personnalisées, utilisez le framework suivant :
Lorsque vous créez une règle qui évalue une ligne à la fois, créez une expression qui génère le nombre de lignes réussies lorsque Dataplex évalue la requête
SELECT COUNTIF(CUSTOM_SQL_EXPRESSION) FROM TABLE
. Dataplex compare le nombre de lignes réussies au seuil.Lorsque vous créez une règle qui évalue les lignes ou utilise une condition de table, créez une expression qui renvoie un résultat de succès ou d'échec lorsque Dataplex évalue la requête
SELECT IF(CUSTOM_SQL_EXPRESSION) FROM TABLE
.Lorsque vous créez une règle qui évalue l'état non valide d'un ensemble de données, fournissez une instruction qui renvoie des lignes non valides. Si des lignes sont renvoyées, la règle est défaillant. Omettez le point-virgule de fin de l'instruction SQL.
Vous pouvez faire référence à une table de source de données et à tous ses filtres de précondition en utilisant le paramètre de référence de données
${data()}
dans une règle, au lieu de mentionner explicitement la table source et ses filtres. Exemples de Les filtres de condition préalable incluent les filtres de lignes, les pourcentages d'échantillonnage et les filtres des filtres. Le paramètre${data()}
est sensible à la casse.
Les exemples de règles suivants sont basés sur des règles SQL personnalisées.
Type de règle | Description de la règle | Expression SQL |
---|---|---|
État de la ligne | Vérifie si la valeur de discount_pct
est compris entre 0 et 100.
|
0 < discount_pct ET discount_pct < 100
|
État de la ligne | Vérification de référence pour vérifier que currency_id est l'une des devises acceptées.
|
currency_id in (select id from my_project_id.dim_dataset.dim_currency)
|
Condition de table | Expression SQL d'agrégation qui vérifie si la discount_pct moyenne est comprise entre 30% et 50 %
|
30<avg(discount) AND avg(discount) <50
|
Condition de ligne | Vérifie si une date n'est pas dans le futur. | TIMESTAMP(transaction_timestamp) < CURRENT_TIMESTAMP()
|
État de la table |
Fonction définie par l'utilisateur dans BigQuery (UDF, user-defined function)
pour vérifier que le montant moyen des transactions est inférieur à une valeur
par pays. Créez la UDF (JavaScript) en exécutant la commande suivante:
CREATE OR REPLACE FUNCTION myProject.myDataset.average_by_country ( country STRING, average FLOAT64) RETURNS BOOL LANGUAGE js AS R""" if (country = "CAN" && average < 5000){ return 1 } else if (country = "IND" && average < 1000){ return 1 } else { return 0 } """; |
Exemple de règle pour vérifier le montant moyen des transactions pour country=CAN .
myProject.myDataset.average_by_country( "CAN", (SELECT avg(amount) FROM myProject.myDataset.transactions_table WHERE currency_id = 'CAN' )) |
Condition de table | BigQuery ML
"predict" pour identifier les anomalies dans discount_pct . Vérifications
si une remise doit être appliquée en fonction de customer ,
currency et transaction . La règle vérifie si la prédiction correspond à la valeur réelle, au moins 99 % du temps. Hypothèse: le
le modèle de ML est créé avant d'utiliser la règle. Créer le modèle de ML à l'aide de la
la commande suivante:
CREATE MODEL model-project-id.dataset-id.model-name OPTIONS(model_type='logistic_reg') AS SELECT IF(discount_pct IS NULL, 0, 1) AS label, IFNULL(customer_id, "") AS customer, IFNULL(currency_id, "") AS currency, IFNULL(amount, 0.0) AS amount FROM `data-project-id.dataset-id.table-names` WHERE transaction_timestamp < '2022-01-01'; |
La règle suivante vérifie si la précision de la prédiction est supérieure à 99 %.
SELECT accuracy > 0.99 FROM ML.EVALUATE (MODEL model-project-id.dataset-id.model-name, ( SELECT customer_id, currency_id, amount, discount_pct FROM data-project-id.dataset-id.table-names WHERE transaction_timestamp > '2022-01-01'; ) ) |
Condition de ligne | Une fonction de prédiction BigQuery ML pour identifier les anomalies dans discount_pct . La fonction
vérifie si une remise doit être appliquée en fonction de customer ,
currency et transaction .
La règle identifie toutes les occurrences où la prédiction ne correspond pas.
Hypothèse : Le modèle de ML est créé avant d'utiliser la règle. Créez le modèle ML à l'aide de la commande suivante :
CREATE MODEL model-project-id.dataset-id.model-name OPTIONS(model_type='logistic_reg') AS SELECT IF(discount_pct IS NULL, 0, 1) AS label, IFNULL(customer_id, "") AS customer, IFNULL(currency_id, "") AS currency, IFNULL(amount, 0.0) AS amount FROM `data-project-id.dataset-id.table-names` WHERE transaction_timestamp < '2022-01-01'; |
La règle suivante vérifie si la prévision de remise correspond à la remise réelle pour chaque ligne.
IF(discount_pct > 0, 1, 0) =(SELECT predicted_label FROM ML.PREDICT( MODEL model-project-id.dataset-id.model-name, ( SELECT customer_id, currency_id, amount, discount_pct FROM data-project-id.dataset-id.table-names AS t WHERE t.transaction_timestamp = transaction_timestamp LIMIT 1 ) ) ) |
Assertion SQL | Vérifie si discount_pct est supérieur à 30% pour aujourd'hui
en vérifiant s'il existe des lignes avec un pourcentage de remise inférieur à
égal à 30. |
SELECT * FROM my_project_id.dim_dataset.dim_currency WHERE discount_pct <= 30 AND transaction_timestamp >= current_date() |
Assertion SQL (avec paramètre de référence de données) | Vérifie si Le filtre de date Le paramètre de référence de données |
SELECT * FROM ${data()} WHERE discount_pct > 30 |
Définir des règles de qualité des données à l'aide de la CLI gcloud
L'exemple de fichier YAML suivant utilise certaines des mêmes règles que les exemples de règles utilisant des types intégrés et les exemples de règles SQL personnalisées. Vous pouvez utiliser ce fichier YAML comme entrée pour la commande de gcloud CLI.
rules:
- uniquenessExpectation: {}
column: transaction_id
dimension: UNIQUENESS
- nonNullExpectation: {}
column: amount
dimension: COMPLETENESS
threshold: 1
- regexExpectation:
regex: '^[0-9]{8}[a-zA-Z]{16}$'
column : customer_id
ignoreNull : true
dimension : VALIDITY
threshold : 1
- setExpectation :
values :
- 'USD'
- 'JPY'
- 'INR'
- 'GBP'
- 'CAN'
column : currency_id
ignoreNull : true
dimension : VALIDITY
threshold : 1
- rangeExpectation:
minValue : '0'
maxValue : '100'
column : discount_pct
ignoreNull : true
dimension : VALIDITY
threshold : 1
- rowConditionExpectation:
sqlExpression : 0 < `discount_pct` AND `discount_pct` < 100
column: discount_pct
dimension: VALIDITY
threshold: 1
- rowConditionExpectation:
sqlExpression : currency_id in (select id from `my_project_id.dim_dataset.dim_currency`)
column: currency_id
dimension: VALIDITY
threshold: 1
- tableConditionExpectation:
sqlExpression : 30 < avg(discount_pct) AND avg(discount_pct) < 50
dimension: VALIDITY
- rowConditionExpectation:
sqlExpression : TIMESTAMP(transaction_timestamp) < CURRENT_TIMESTAMP()
column: transaction_timestamp
dimension: VALIDITY
threshold: 1
- sqlAssertion:
sqlStatement : SELECT * FROM `my_project_id.dim_dataset.dim_currency` WHERE discount_pct > 100
dimension: VALIDITY
Créer une analyse de qualité des données
Console
Dans la console Google Cloud, accédez à la page Qualité des données.
Cliquez sur Créer une analyse de la qualité des données.
Dans la fenêtre Define scan (Définir une analyse), renseignez les champs suivants:
Saisissez un nom dans le champ Nom à afficher.
L'ID de l'analyse est généré automatiquement si vous ne fournissez pas le vôtre. Consultez la convention d'attribution de noms des ressources.
Facultatif : saisissez une Description.
Dans le champ Tableau, cliquez sur Parcourir, choisissez votre table, puis cliquez sur Sélectionner. Dataplex n'est compatible qu'avec les tables BigQuery standards.
Pour les tables des ensembles de données multirégionaux, choisissez une région dans laquelle créer l'analyse de données.
Pour parcourir les tables organisées dans le lac Dataplex, cliquez sur Parcourir les lacs Dataplex.
Dans le champ Champ d'application, sélectionnez Incrémentiel ou Intégralité des données.
- Si vous choisissez Incrémentiel : dans le champ Colonne Horodatage :
sélectionnez une colonne de type
DATE
ouTIMESTAMP
dans votre table BigQuery qui augmente de façon linéaire et peut être utilisé pour identifier de nouveaux enregistrements. Il peut s'agir d'une colonne qui partitionne la table.
- Si vous choisissez Incrémentiel : dans le champ Colonne Horodatage :
sélectionnez une colonne de type
(Facultatif) Ajoutez des libellés. Les étiquettes sont des paires
key:value
qui vous permettent de regrouper associés ou à d'autres ressources Google Cloud.Pour filtrer vos données, cliquez sur Filtres. Cochez la case Filtrer les lignes. La valeur d'entrée pour le filtre de ligne doit être un code SQL valide qui peut être utilisée dans une clause
WHERE
dans Syntaxe SQL standard BigQuery. Par exemple,col1 >= 0
. Le filtre peut être une combinaison de plusieurs conditions de colonne. Par exemple,col1 >= 0 AND col2 < 10
.Pour échantillonner vos données, dans la liste Taille d'échantillonnage, sélectionnez un pourcentage d'échantillonnage. Choisissez une valeur comprise entre 0,0 % et 100,0 %, avec trois chiffres après la virgule au maximum. Pour les ensembles de données plus volumineux, choisissez un pourcentage d'échantillonnage inférieur. Par exemple, pour une table d'environ 1 PB, si vous saisissez une valeur comprise entre 0,1 % et 1 %, Dataplex échantillonne entre 1 et 10 To de données. Pour les analyses de données incrémentielles, Dataplex applique l'échantillonnage au dernier incrément.
Pour publier les résultats de l'analyse de qualité des données sur les pages BigQuery et Data Catalog de la console Google Cloud pour la table source, cochez la case Publier les résultats dans les interfaces utilisateur de BigQuery et de Dataplex Catalog. Vous pouvez consulter les derniers résultats de l'analyse dans l'onglet Qualité des données des pages BigQuery et Data Catalog pour la table source. Pour permettre aux utilisateurs d'accéder aux résultats d'analyse publiés, consultez la section Partager les résultats publiés. L'option de publication peut ne pas être disponible dans les cas suivants :
- Vous ne disposez pas des autorisations nécessaires pour la table.
- Une autre analyse de qualité des données est configurée pour publier les résultats.
Pour en savoir plus sur les autorisations requises pour afficher les résultats publiés, consultez la section Autorisations.
Cliquez sur Continuer.
Dans la fenêtre Planifier, choisissez l'une des options suivantes :
Répéter : exécutez la tâche d'analyse de la qualité des données selon un calendrier. hebdomadaire, mensuelle ou personnalisée. Spécifiez la fréquence d'exécution de l'analyse et l'heure. Si vous choisissez "Personnalisé", utilisez cron. pour spécifier le calendrier.
À la demande: exécutez votre job d'analyse de la qualité des données à la demande.
Cliquez sur Continuer.
Dans la fenêtre Règles de qualité des données, définissez les règles à configurer pour cette analyse de la qualité des données. Cliquez sur Ajouter des règles, puis sélectionnez l'une des options suivantes :
Recommandations basées sur les profils : créez des règles à partir des recommandations basées sur une analyse de profil de données existante.
Sélectionner des colonnes: sélectionnez les colonnes pour lesquelles vous souhaitez obtenir des règles recommandées.
Analyser un projet : recommandations basées sur une analyse de profilage des données existante. Par défaut, Dataplex sélectionne les analyses de profilage du même projet que celui dans lequel vous créez l'analyse de qualité des données. Si vous avez créé l'analyse dans un autre projet, doit spécifier le projet à partir duquel extraire les analyses de profil.
Choisir les résultats de profil : en fonction des colonnes et du projet que vous sélectionnez, plusieurs résultats de profil s'affichent.
Sélectionnez un ou plusieurs résultats de profil, puis cliquez sur OK. Une liste de règles s'affiche.
Cochez les cases correspondant aux règles que vous souhaitez modifier, puis cliquez sur Sélectionner. Une fois sélectionnées, les règles sont ajoutées à votre règle actuelle liste. Vous pouvez ensuite modifier les règles.
Types de règles intégrés: créez des règles à partir de règles prédéfinies. Consultez la liste des règles prédéfinies.
Choisir des colonnes : sélectionnez les colonnes pour lesquelles vous souhaitez définir des règles.
Choisir des types de règles : en fonction des colonnes que vous sélectionnez, plusieurs types de règles s'affichent.
Sélectionnez un ou plusieurs types de règles, puis cliquez sur OK. Une liste de règles s'affiche.
Sélectionnez les règles à modifier en cochant les cases et en cliquant sur Sélectionner. Une fois sélectionnées, les règles sont ajoutées à votre liste de règles actuelle. Vous pouvez ensuite modifier les règles.
Règle de vérification des lignes SQL : créez une règle SQL personnalisée à appliquer à chaque ligne (règle de vérification des lignes SQL personnalisée).
Dans Dimension, choisissez une dimension.
Dans Seuil de réussite, choisissez le pourcentage d'enregistrements passer le contrôle.
Dans Nom de la colonne, choisissez une colonne.
Dans le champ Fournir une expression SQL, saisissez une expression SQL qui renvoie la valeur booléenne
true
(PASS) oufalse
(ÉCHEC). Pour en savoir plus, consultez la section Types de règles SQL personnalisées compatibles et les exemples de la section Définir des règles de qualité des données de ce document.Cliquez sur Ajouter.
Règle de vérification des agrégations SQL: créer une requête SQL personnalisée et une règle de condition de table.
Dans Dimension, choisissez une dimension.
Dans Nom de la colonne, choisissez une colonne.
Dans le champ Fournir une expression SQL, saisissez une expression SQL qui renvoie la valeur booléenne
true
(PASS) oufalse
(ÉCHEC). Pour en savoir plus, consultez la section Types de règles SQL personnalisées compatibles et les exemples de la section Définir des règles de qualité des données de ce document.Cliquez sur Ajouter.
Règle d'assertion SQL : créez une règle d'assertion SQL personnalisée pour vérifier l'état non valide des données.
Dans Dimension, choisissez une dimension.
Facultatif : dans Nom de la colonne, sélectionnez une colonne.
Dans le champ Fournir une instruction SQL, saisissez une instruction SQL qui renvoie les lignes correspondant à l'état non valide. Si des lignes sont renvoyées, cette règle échoue. Omettez le point-virgule de fin de la requête SQL . Pour en savoir plus, consultez Types de règles SQL personnalisées compatibles et les exemples dans la section Définir des règles de qualité des données de ce document.
Cliquez sur Ajouter.
Dataplex autorise les noms personnalisés pour les règles de qualité des données pour la surveillance et les alertes. Pour chaque règle de qualité des données, vous pouvez vous pouvez éventuellement attribuer un nom et une description à la règle personnalisée. Pour ce faire, modifiez une règle et spécifiez les informations suivantes:
- Nom de la règle: saisissez un nom de règle personnalisée comportant jusqu'à 63 caractères. Le nom de la règle peut inclure des lettres (a-z, A-Z), des chiffres (0-9) et des traits d'union (-), et doit commencer par une lettre et se terminer par un chiffre ou une lettre.
- Description : saisissez une description de la règle d'une longueur maximale de 1 024 caractères.
Cliquez sur Continuer.
Facultatif : exportez les résultats de l'analyse vers une table standard BigQuery. Cliquez sur Parcourir pour sélectionner un ensemble de données BigQuery existant dans lequel stocker les résultats de l'analyse de la qualité des données.
Si la table spécifiée n'existe pas, Dataplex la crée pour vous. Si vous utilisez une table existante, assurez-vous qu'elle est compatible avec le schéma de la table d'exportation.
Cliquez sur Créer.
Une fois l'analyse créée, vous pouvez l'exécuter à tout moment en cliquant sur Run now (Exécuter maintenant).
gcloud
Pour créer une analyse de qualité des données, utilisez la commande gcloud dataplex datascans create data-quality
.
Si les données sources sont organisées dans un lac Dataplex, incluez le
L'indicateur --data-source-entity
:
gcloud dataplex datascans create data-quality DATASCAN \
--location=LOCATION \
--data-quality-spec-file=DATA_QUALITY_SPEC_FILE \
--data-source-entity=DATA_SOURCE_ENTITY
Si les données sources ne sont pas organisées dans un lac Dataplex, incluez l'indicateur --data-source-resource
:
gcloud dataplex datascans create data-quality DATASCAN \
--location=LOCATION \
--data-quality-spec-file=DATA_QUALITY_SPEC_FILE \
--data-source-resource=DATA_SOURCE_RESOURCE
Remplacez les variables suivantes :
DATASCAN
: nom de l'analyse de la qualité des données.LOCATION
: région Google Cloud dans laquelle créer l'analyse de la qualité des données.DATA_QUALITY_SPEC_FILE
: chemin d'accès au fichier JSON ou YAML contenant les spécifications de l'analyse de la qualité des données. Il peut s'agir d'un fichier local ou d'un chemin d'accès Cloud Storage avec le préfixegs://
. Utilisez ce fichier pour spécifier les règles de qualité des données pour l'analyse. Vous pouvez également spécifiez des détails supplémentaires dans ce fichier, tels que des filtres, un pourcentage d'échantillonnage et des actions post-analyse, comme l'exportation vers BigQuery ou l'envoi des notifications par e-mail. Consultez le documentation sur la représentation JSON.DATA_SOURCE_ENTITY
: entité Dataplex contenant les données pour l'analyse de la qualité des données. Exemple :projects/test-project/locations/test-location/lakes/test-lake/zones/test-zone/entities/test-entity
.DATA_SOURCE_RESOURCE
: nom de la ressource contenant les données pour l'analyse de la qualité des données. Exemple ://bigquery.googleapis.com/projects/test-project/datasets/test-dataset/tables/test-table
.
REST
Utilisez l'explorateur d'API pour créer une analyse de la qualité des données.
Si vous souhaitez créer des règles pour l'analyse de qualité des données à l'aide de recommandations de règles basées sur les résultats d'une analyse de profilage des données, obtenez les recommandations en appelant la méthode dataScans.jobs.generateDataQualityRules
sur l'analyse de profilage des données.
Exporter le schéma de la table
Exporter les résultats de l'analyse de la qualité des données vers un fichier BigQuery existant assurez-vous qu'elle est compatible avec le schéma de table suivant:
Nom de la colonne | Type de données de la colonne | Nom du sous-champ (le cas échéant) |
Type de données du sous-champ | Mode | Exemple |
---|---|---|---|---|---|
data_quality_scan | struct/record |
resource_name |
string |
nullable | //dataplex.googleapis.com/projects/test-project/locations/europe-west2/datascans/test-datascan |
project_id |
string |
pouvant avoir une valeur nulle | dataplex-back-end-dev-project |
||
location |
string |
pouvant avoir une valeur nulle | us-central1 |
||
data_scan_id |
string |
nullable | test-datascan |
||
data_source | struct/record |
resource_name |
string |
pouvant avoir une valeur nulle | Cas de l'entité ://dataplex.googleapis.com/projects/dataplex-back-end-dev-project/locations/europe-west2/lakes/a0-datascan-test-lake/zones/a0-datascan-test-zone/entities/table1 Cas de la table : //bigquery.googleapis.com/projects/test-project/datasets/test-dataset/tables/test-table
|
dataplex_entity_project_id |
string |
nullable | dataplex-back-end-dev-project |
||
dataplex_entity_project_number |
integer |
pouvant avoir une valeur nulle | 123456789 |
||
dataplex_lake_id |
string |
nullable | (Valable uniquement si la source est une entité)test-lake
|
||
dataplex_zone_id |
string |
nullable | (Valide uniquement si la source est une entité)test-zone |
||
dataplex_entity_id |
string |
pouvant avoir une valeur nulle | (Valable uniquement si la source est une entité)test-entity |
||
table_project_id |
string |
nullable | test-project |
||
table_project_number |
integer |
pouvant avoir une valeur nulle | 987654321 |
||
dataset_id |
string |
nullable | (Valide uniquement si la source est un tableau)test-dataset |
||
table_id |
string |
pouvant avoir une valeur nulle | (Valide uniquement si la source est un tableau)test-table |
||
data_quality_job_id | string |
pouvant avoir une valeur nulle | caeba234-cfde-4fca-9e5b-fe02a9812e38 |
||
data_quality_job_configuration | json |
trigger |
string |
pouvant avoir une valeur nulle | ondemand /schedule |
incremental |
boolean |
nullable | true /false |
||
sampling_percent |
float |
pouvant avoir une valeur nulle | (0-100)20.0 (indique 20 %) |
||
row_filter |
string |
nullable | col1 >= 0 AND col2 < 10 |
||
job_labels | json |
nullable | {"key1":value1} |
||
job_start_time | timestamp |
nullable | 2023-01-01 00:00:00 UTC |
||
job_end_time | timestamp |
pouvant avoir une valeur nulle | 2023-01-01 00:00:00 UTC |
||
job_rows_scanned | integer |
nullable | 7500 |
||
rule_name | string |
nullable | test-rule |
||
rule_type | string |
nullable | Range Check |
||
rule_evaluation_type | string |
nullable | Per row |
||
colonne_règle | string |
nullable | Rule only attached to a certain column |
||
rule_dimension | string |
pouvant avoir une valeur nulle | UNIQUENESS |
||
job_quality_result | struct/record |
passed |
boolean |
nullable | true /false |
score |
float |
pouvant avoir une valeur nulle | 90.8 |
||
job_dimension_result | json |
nullable | {"ACCURACY":{"passed":true,"score":100},"CONSISTENCY":{"passed":false,"score":60}}
|
||
rule_threshold_percent | float |
pouvant avoir une valeur nulle | (0,0-100,0)Rule-threshold-pct in API * 100 |
||
rule_parameters | json |
pouvant avoir une valeur nulle | {min: 24, max:5345} |
||
rule_pass | boolean |
pouvant avoir une valeur nulle | True |
||
rule_rows_evaluated | integer |
pouvant avoir une valeur nulle | 7400 |
||
rule_rows_passed | integer |
pouvant avoir une valeur nulle | 3 |
||
rule_rows_null | integer |
pouvant avoir une valeur nulle | 4 |
||
rule_failed_records_query | string |
nullable | "SELECT * FROM `test-project.test-dataset.test-table` WHERE (NOT((`cTime` >= '15:31:38.776361' and `cTime` <= '19:23:53.754823') IS TRUE));" |
Lorsque vous configurez BigQueryExport pour une tâche d'analyse de la qualité des données, suivez ces consignes :
- Pour le champ
resultsTable
, utilisez le format suivant://bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id}/tables/{table-id}
- Utilisez une table standard BigQuery.
- Si la table n'existe pas au moment de la création ou de la mise à jour de l'analyse, Dataplex la crée pour vous.
- Par défaut, la table est partitionnée tous les jours en fonction de la colonne
job_start_time
. - Si vous souhaitez que la table soit partitionnée dans d'autres configurations ou si vous ne souhaitez pas de partitionnement, recréez la table avec le schéma et les configurations requis, puis fournissez la table précréée comme table de résultats.
- Assurez-vous que la table des résultats se trouve au même emplacement que la table source.
- Si VPC-SC est configuré sur le projet, le tableau des résultats doit se trouver dans le même périmètre VPC-SC que le tableau source.
- Si la table est modifiée pendant la phase d'exécution de l'analyse, la valeur exporte le job en cours d'exécution vers la table de résultats précédente, et la table change prend effet à partir de la tâche d'analyse suivante.
- Ne modifiez pas le schéma de la table. Si vous avez besoin de colonnes personnalisées, créez une vue sur le tableau.
- Pour réduire les coûts, définissez une date d'expiration sur la partition en fonction de votre cas d'utilisation. Pour en savoir plus, consultez la section Définir le délai d'expiration de la partition.
Exécuter une analyse de la qualité des données
Console
Dans la console Google Cloud, accédez à la page Qualité des données.
Cliquez sur l'analyse de la qualité des données à exécuter.
Cliquez sur Exécuter maintenant.
gcloud
Pour effectuer une analyse de la qualité des données, utilisez le
Commande gcloud dataplex datascans run
:
gcloud dataplex datascans run DATASCAN \ --location=LOCATION \
Remplacez les variables suivantes :
LOCATION
: région Google Cloud dans laquelle l'analyse de la qualité des données a été créée.DATASCAN
: nom de l'analyse de la qualité des données.
REST
Utilisez APIs Explorer pour exécuter une analyse de la qualité des données.
Afficher les résultats de l'analyse de qualité des données
Console
Dans la console Google Cloud, accédez à la page Qualité des données.
Pour afficher les résultats détaillés d'une analyse, cliquez sur son nom.
La section Vue d'ensemble affiche des informations sur les sept dernières tâches, y compris la date et l'heure de l'exécution de l'analyse, le nombre d'enregistrements analysés dans chaque tâche, si toutes les vérifications de qualité des données ont réussi, s'il y a eu des échecs, le nombre d'échecs de vérification de la qualité des données et les dimensions concernées.
La section Configuration de l'analyse de la qualité des données affiche les détails analyse.
Pour afficher les scores de qualité des données qui indiquent le pourcentage de règles respectées, cliquez sur l'onglet Historique des tâches. Cliquez ensuite sur un ID de tâche.
gcloud
Pour afficher les résultats d'une tâche d'analyse de qualité des données, utilisez la commande gcloud dataplex datascans jobs describe
:
gcloud dataplex datascans jobs describe JOB \ --location=LOCATION \ --datascan=DATASCAN \ --view=FULL
Remplacez les variables suivantes :
JOB
: ID de la tâche d'analyse de la qualité des données.LOCATION
: région Google Cloud dans laquelle les données l'analyse de la qualité a été créée.DATASCAN
: nom de l'analyse de qualité des données à laquelle la tâche appartient.--view=FULL
: pour afficher le résultat de la tâche d'analyse, spécifiezFULL
.
REST
Utilisez APIs Explorer pour afficher les résultats d'une analyse de la qualité des données.
Afficher l'historique des résultats d'analyse
Dataplex enregistre l'historique des analyses de la qualité des données des 300 dernières tâches ou de l'année précédente, selon la première éventualité.
Console
Dans la console Google Cloud, accédez à la page Qualité des données.
Cliquez sur le nom d'une analyse.
Cliquez sur l'onglet Historique des jobs.
L'onglet Jobs history (Historique des jobs) fournit des informations sur les jobs précédents. Elle répertorie toutes tâches, le nombre d'enregistrements analysés dans chaque tâche, l'état de la tâche, l'heure l'exécution du job, la réussite ou l'échec de chaque règle, etc.
Pour afficher des informations détaillées sur une tâche, cliquez sur l'une des tâches de la colonne ID de tâche.
gcloud
Pour afficher toutes les tâches d'une analyse de qualité des données, exécutez la commande gcloud dataplex datascans jobs list
:
gcloud dataplex datascans jobs list \ --location=LOCATION \ --datascan=DATASCAN \
Remplacez les variables suivantes :
LOCATION
: région Google Cloud dans laquelle l'analyse de la qualité des données a été créée.DATASCAN
: nom de l'analyse de la qualité des données à afficher tous les emplois.
REST
Utilisez APIs Explorer pour afficher toutes les tâches d'analyse.
Partager les résultats publiés
Lorsque vous créez une analyse de qualité des données, si vous avez choisi de publier les résultats de l'analyse sur les pages BigQuery et Data Catalog de la console Google Cloud, les derniers résultats de l'analyse seront disponibles dans l'onglet Qualité des données de ces pages.
Vous pouvez autoriser les utilisateurs de votre organisation à accéder à l'analyse publiée résultats. Pour accorder l'accès aux résultats de l'analyse, procédez comme suit:
Dans la console Google Cloud, accédez à la page Qualité des données.
Cliquez sur l'analyse de la qualité des données dont vous souhaitez partager les résultats.
Accédez à l'onglet Autorisations.
Cliquez sur Accorder l'accès.
Dans le champ Nouveaux comptes principaux, ajoutez le compte principal auquel vous souhaitez accorder l'accès.
Dans le champ Sélectionnez un rôle, choisissez Lecteur de données Dataplex DataScan.
Cliquez sur Enregistrer.
Pour supprimer l'accès aux résultats d'analyse publiés pour un compte principal, procédez comme suit :
Dans la console Google Cloud, accédez à la page Qualité des données.
Cliquez sur l'analyse de qualité des données dont vous souhaitez partager les résultats.
Accédez à l'onglet Autorisations.
Sélectionnez le compte principal pour lequel vous souhaitez supprimer le lecteur de données Dataplex DataScan. rôle de ressource.
Cliquez sur Supprimer l'accès.
Cliquez sur Confirmer.
Définir des alertes dans Cloud Logging
Pour définir des alertes en cas de défaillances de qualité des données à l'aide des journaux de Cloud Logging, procédez comme suit :
Console
Dans la console Google Cloud, accédez à Cloud Logging Explorateur de journaux :
Dans la fenêtre Requête, saisissez votre requête. Consultez des exemples de requêtes.
Cliquez sur Exécuter la requête (Run Query).
Cliquez sur Créer une alerte. Un panneau latéral s'ouvre.
Saisissez le nom de votre règle d'alerte, puis cliquez sur Suivant.
Examinez la requête.
Cliquez sur le bouton Prévisualiser les journaux pour tester votre requête. Cela permet d'afficher les journaux avec des conditions de correspondance.
Cliquez sur Suivant.
Définissez le délai entre les notifications, puis cliquez sur Suivant.
Définissez les personnes à avertir, puis cliquez sur Enregistrer pour la créer. la règle d'alerte.
Vous pouvez également configurer et modifier vos alertes en accédant aux Accédez à Monitoring > Alertes dans la console Google Cloud.
gcloud
Non compatible
REST
Utilisez APIs Explorer pour définir des alertes dans Cloud Logging.
Exemples de requêtes pour définir des alertes au niveau de la tâche ou de la dimension
Exemple de requête pour définir des alertes sur les échecs globaux de qualité des données pour une analyse de qualité des données :
resource.type="dataplex.googleapis.com/DataScan" AND labels."dataplex.googleapis.com/data_scan_state"="SUCCEEDED" AND resource.labels.resource_container="projects/112233445566" AND resource.labels.datascan_id="a0-test-dec6-dq-3" AND NOT jsonPayload.dataQuality.passed=true
Exemple de requête pour définir des alertes en cas d'échec de la qualité des données pour une dimension (par exemple, l'unicité) d'une analyse de la qualité des données donnée :
resource.type="dataplex.googleapis.com/DataScan" AND labels."dataplex.googleapis.com/data_scan_state"="SUCCEEDED" AND resource.labels.resource_container="projects/112233445566" AND resource.labels.datascan_id="a0-test-dec6-dq-3" AND jsonPayload.dataQuality.dimensionPassed.UNIQUENESS=false
Exemple de requête permettant de définir des alertes sur les échecs liés à la qualité des données d'une table.
Définir des alertes sur les échecs de qualité des données pour une table BigQuery ne sont pas organisées dans un lac Dataplex:
resource.type="dataplex.googleapis.com/DataScan" AND jsonPayload.dataSource="//bigquery.googleapis.com/projects/test-project/datasets/testdataset/table/chicago_taxi_trips" AND labels."dataplex.googleapis.com/data_scan_state"="SUCCEEDED" AND resource.labels.resource_container="projects/112233445566" AND NOT jsonPayload.dataQuality.passed=true
Définissez des alertes en cas d'échec de la qualité des données pour une table BigQuery organisée dans un lac Dataplex :
resource.type="dataplex.googleapis.com/DataScan" AND jsonPayload.dataSource="projects/test-project/datasets/testdataset/table/chicago_taxi_trips" AND labels."dataplex.googleapis.com/data_scan_state"="SUCCEEDED" AND resource.labels.resource_container="projects/112233445566" AND NOT jsonPayload.dataQuality.passed=true
Exemples de requêtes à définir pour des alertes de règle
Exemple de requête permettant de définir des alertes pour toutes les règles de qualité des données en échec avec la spécifié pour une analyse de la qualité des données:
resource.type="dataplex.googleapis.com/DataScan" AND jsonPayload.ruleName="custom-name" AND jsonPayload.result="FAILED"
Exemple de requête pour définir des alertes sur toutes les règles de qualité des données non respectées d'un type d'évaluation spécifique pour une analyse de la qualité des données :
resource.type="dataplex.googleapis.com/DataScan" AND jsonPayload.evalutionType="PER_ROW" AND jsonPayload.result="FAILED"
Exemple de requête pour définir des alertes sur toutes les règles de qualité des données non respectées pour une colonne de la table utilisée pour une analyse de qualité des données :
resource.type="dataplex.googleapis.com/DataScan" AND jsonPayload.column="CInteger" AND jsonPayload.result="FAILED"
Résoudre un problème de qualité des données
Pour chaque tâche comportant des règles au niveau des lignes qui échouent, Dataplex fournit une requête pour obtenir les enregistrements ayant échoué. Exécutez cette requête pour afficher les enregistrements ne correspondent pas à votre règle.
Console
Dans la console Google Cloud, accédez à la page Qualité des données.
Cliquez sur le nom de l'analyse dont vous souhaitez résoudre les enregistrements.
Cliquez sur l'onglet Historique des tâches.
Cliquez sur l'ID de la tâche qui a identifié des échecs de qualité des données.
Dans la fenêtre des résultats de la tâche qui s'ouvre, dans la section Règles, recherchez la colonne Requête pour obtenir les enregistrements ayant échoué. Cliquez sur Copier la requête dans le presse-papiers à côté de ayant échoué.
Exécutez la requête dans BigQuery pour afficher les enregistrements à l'origine de l'échec de la tâche.
gcloud
Non compatible
REST
Utilisez APIs Explorer pour afficher la requête permettant d'obtenir les enregistrements en échec pour les jobs qui échec du test.
Mettre à jour une analyse de qualité des données
Console
Dans la console Google Cloud, accédez à la page Qualité des données.
Sur la ligne de la capture à modifier, cliquez sur les trois points verticaux > Modifier.
Modifiez les valeurs.
Cliquez sur Enregistrer.
gcloud
Pour modifier la description d'une analyse de qualité des données, utilisez la commande gcloud dataplex datascans update data-quality
:
gcloud dataplex datascans update data-quality DATASCAN \ --location=LOCATION \ --description=DESCRIPTION
Remplacez les éléments suivants :
DATASCAN
: nom de l'analyse de la qualité des données à mise à jour.LOCATION
: région Google Cloud dans laquelle l'analyse de la qualité des données a été créée.DESCRIPTION
: nouvelle description de l'analyse de la qualité des données.
REST
Utilisez l'explorateur d'API pour modifier votre analyse de la qualité des données.
Supprimer une analyse de la qualité des données
Console
Dans la console Google Cloud, accédez à la page Qualité des données.
Cliquez sur l'analyse que vous souhaitez supprimer.
Cliquez sur Supprimer.
gcloud
Pour supprimer une analyse de la qualité des données, utilisez la commande gcloud dataplex datascans delete
:
gcloud dataplex datascans delete DATASCAN \ --location=LOCATION \ --async
Remplacez les variables suivantes :
DATASCAN
: nom de l'analyse de qualité des données à supprimer.LOCATION
: région Google Cloud dans laquelle l'analyse de la qualité des données a été créée.
REST
Utilisez APIs Explorer pour supprimer l'analyse de la qualité des données.
Étape suivante
- Découvrez le profilage de données.
- Découvrez comment utiliser le profilage de données.
- Suivez un tutoriel pour : gérer les règles de qualité des données sous forme de code avec Terraform.