创建和使用数据分析扫描

借助 Dataplex Universal Catalog，您可以识别 BigQuery 表中列的常见统计特征（常见值、数据分布、null 计数）。此信息有助于您更有效地了解和分析数据。

如需详细了解 Dataplex Universal Catalog 数据分析扫描，请参阅数据分析简介。

准备工作

Enable the Dataplex API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

所需的角色

如需获得创建和管理数据分析扫描所需的权限，请让管理员向您授予资源（例如项目或表）的以下 IAM 角色：

• 创建、运行、更新和删除数据分析扫描： 包含数据扫描的项目的 Dataplex DataScan Editor (roles/dataplex.dataScanEditor) 角色。
• 如需允许 Dataplex Universal Catalog 针对 BigQuery 数据运行数据分析扫描，请为 Dataplex Universal Catalog 服务账号授予以下角色： 运行扫描的项目中的 BigQuery Job User (roles/bigquery.jobUser) 角色；被扫描的表中的 BigQuery Data Viewer (roles/bigquery.dataViewer) 角色。
• 如需针对使用 Cloud Storage 数据的 BigQuery 外部表运行数据分析扫描，请为 Dataplex Universal Catalog 服务账号授予 Cloud Storage 存储桶的 Storage Object Viewer (roles/storage.objectViewer) 和 Storage Legacy Bucket Reader (roles/storage.legacyBucketReader) 角色。
• 如需查看数据分析扫描结果、作业和历史记录： 针对包含数据扫描的项目，拥有 Dataplex DataScan Viewer (roles/dataplex.dataScanViewer) 角色。
• 如需将数据分析扫描结果导出到 BigQuery 表，您需要拥有该表的 BigQuery Data Editor (roles/bigquery.dataEditor) 角色。
• 如需将数据分析扫描结果发布到 Dataplex Universal Catalog，您需要具有 @bigquery 条目组的 Dataplex Catalog Editor (roles/dataplex.catalogEditor) 角色。
• 在数据分析标签页中查看 BigQuery 中已发布的数据分析文件扫描结果： 表的 BigQuery Data Viewer (roles/bigquery.dataViewer) 角色。

如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义角色或其他预定义角色来获取所需的权限。

如果某个表使用 BigQuery 行级安全性，则 Dataplex Universal Catalog 只能扫描对 Dataplex Universal Catalog 服务账号可见的行。如需允许 Dataplex Universal Catalog 扫描所有行，请将其服务账号添加到谓词为 TRUE 的行过滤条件中。

如果某个表使用 BigQuery 列级安全性，则 Dataplex Universal Catalog 需要有权扫描受保护的列。如需授予访问权限，请为 Dataplex Universal Catalog 服务账号授予表中所用所有政策标记的 Data Catalog Fine-Grained Reader (roles/datacatalog.fineGrainedReader) 角色。创建或更新数据扫描的用户也需要拥有这些受保护列的权限。

向 Dataplex Universal Catalog 服务账号授予角色

为了运行数据分析扫描，Dataplex Universal Catalog 使用的服务账号需要拥有运行 BigQuery 作业和读取 BigQuery 表数据的权限。如需授予所需的角色，请按以下步骤操作：

1. 获取 Dataplex Universal Catalog 服务账号的邮箱。如果您之前未在此项目中创建数据分析或数据质量扫描，请运行以下 gcloud 命令以生成服务身份：

   gcloud beta services identity create --service=dataplex.googleapis.com
   

   该命令会返回服务账号邮箱，其格式如下：service-PROJECT_NUMBER@gcp-sa-dataplex.iam.gserviceaccount.com。

   如果服务账号已存在，您可以在 Google Cloud 控制台的 IAM 页面上查看名称中包含 Dataplex 的主账号，找到该服务账号的邮箱。

2. 向服务账号授予您项目的 BigQuery Job User (roles/bigquery.jobUser) 角色。此角色可让服务账号运行 BigQuery 作业以进行扫描。

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member="serviceAccount:service-PROJECT_NUMBER@gcp-sa-dataplex.iam.gserviceaccount.com" \
       --role="roles/bigquery.jobUser"
   

   替换以下内容：

   • PROJECT_ID：您的 Google Cloud 项目 ID。
   • service-PROJECT_NUMBER@gcp-sa-dataplex.iam.gserviceaccount.com：Dataplex Universal Catalog 服务账号的邮箱。

3. 向服务账号授予您要分析的每个表的 BigQuery Data Viewer (roles/bigquery.dataViewer) 角色。此角色可授予对表的只读权限。

   gcloud bigquery tables add-iam-policy-binding DATASET_ID.TABLE_ID \
       --member="serviceAccount:service-PROJECT_NUMBER@gcp-sa-dataplex.iam.gserviceaccount.com" \
       --role="roles/bigquery.dataViewer"
   

   替换以下内容：

   • DATASET_ID：包含相应表的数据集的 ID。
   • TABLE_ID：要分析的表的 ID。
   • service-PROJECT_NUMBER@gcp-sa-dataplex.iam.gserviceaccount.com：Dataplex Universal Catalog 服务账号的邮箱。

     创建数据分析扫描

     控制台

     1. 在 Google Cloud 控制台中，前往 Dataplex Universal Catalog 数据分析和质量评估页面。

        前往“数据分析和质量评估”

     2. 点击创建数据分析扫描。

     3. 可选：输入显示名称。

     4. 输入 ID。请参阅资源命名惯例。

     5. （可选）输入说明。

     6. 在表字段中，点击浏览。选择要扫描的表，然后点击选择。

        对于多区域数据集中的表，请选择要在其中创建数据扫描的区域。

        如需浏览在 Dataplex Universal Catalog 数据湖中整理的表，请点击在 Dataplex 数据湖中浏览。

     7. 在范围字段中，选择增量或所有数据。

        • 如果您选择增量数据，请在时间戳列字段中，从 BigQuery 表中选择类型为 DATE 或 TIMESTAMP 且可随新记录的添加而递增的列，该列可用于识别新记录。对于按 DATE 或 TIMESTAMP 类型的列进行分区的表，我们建议将分区列用作时间戳字段。

     8. 可选：如需过滤数据，请执行以下任一操作：

        • 如需按行过滤，请点击选中过滤行复选框。 输入一个有效的 SQL 表达式，该表达式可用于 GoogleSQL 语法中的 WHERE 子句。例如：col1 >= 0。

          过滤条件可以是多个列的 SQL 条件的组合。例如：col1 >= 0 AND col2 < 10。

        • 如需按列过滤，请选中过滤列复选框。

          • 如需在数据分析扫描中包含列，请在包含列字段中点击浏览。选择要添加的列，然后点击选择。

          • 如需从数据分析扫描中排除列，请在排除列字段中点击浏览。选择要排除的列，然后点击选择。

     9. 如需对数据分析扫描应用采样，请在采样规模列表中选择采样百分比。选择一个范围介于 0.0% 到 100.0% 之间的百分比值，最多精确到小数点后 3 位。

        • 对于较大的数据集，请选择一个较低的采样百分比。例如，对于一个 1 PB 的表，如果您输入的值介于 0.1% 到 1.0% 之间，则数据分析会采样 1-10 TB 的数据。

        • 采样数据中必须至少有 100 条记录才能返回结果。

        • 对于增量数据扫描，数据分析扫描会对最新增量应用采样。

     10. 可选：在Google Cloud 控制台中源表的 BigQuery 和 Dataplex Universal Catalog 页面中发布数据分析扫描结果。选中将结果发布到 BigQuery 和 Dataplex Catalog 复选框。

         您可以在源表的 BigQuery 和 Dataplex Universal Catalog 页面中的数据分析标签页上查看最新扫描结果。如需使用户能够访问已发布的扫描结果，请参阅本文档的授予对数据分析扫描结果的访问权限部分。

         在以下情况下，发布选项可能不可用：

         • 您没有相应表的所需权限。
         • 另一数据质量扫描已设置为发布结果。

     11. 在时间表部分中，选择以下选项之一：

         • 重复：按时间表（每小时、每天、每周、每月或自定义）运行数据分析扫描。指定扫描的运行频率和时间。如果您选择自定义，请使用 cron 格式指定时间表。

         • 按需：按需运行数据分析扫描。

     12. 点击继续。

     13. 可选：将扫描结果导出到 BigQuery 标准表。在将扫描结果导出到 BigQuery 表部分中，执行以下操作：

         1. 在选择 BigQuery 数据集字段中，点击浏览。选择一个 BigQuery 数据集，用于存储数据分析扫描结果。

         2. 在 BigQuery 表字段中，指定用于存储数据分析扫描结果的表。如果您使用的是现有表，请确保该表与导出表架构兼容。如果指定的表不存在，Dataplex Universal Catalog 会为您创建该表。

     14. 可选：添加标签。标签是键值对，可用于将相关对象组合在一起或者与其他 Google Cloud 资源组合在一起。

     15. 如需创建扫描，请点击创建。

         如果您将时间表设置为“按需”，还可以点击运行扫描立即运行扫描。

     gcloud

     如需创建数据分析扫描，请使用 gcloud dataplex datascans create data-profile 命令。

     如果源数据在 Dataplex Universal Catalog 数据湖中整理，请添加 --data-source-entity 标志：

     gcloud dataplex datascans create data-profile DATASCAN \
     --location=LOCATION \
     --data-source-entity=DATA_SOURCE_ENTITY
     

     如果源数据未在 Dataplex Universal Catalog 数据湖中整理，请添加 --data-source-resource 标志：

     gcloud dataplex datascans create data-profile DATASCAN \
     --location=LOCATION \
     --data-source-resource=DATA_SOURCE_RESOURCE
     

     执行以下变量替换操作：

     • DATASCAN：数据分析扫描的名称。
     • LOCATION：要在其中创建数据分析扫描的 Google Cloud 区域。
     • DATA_SOURCE_ENTITY：包含数据分析扫描所用数据的 Dataplex Universal Catalog 实体。例如 projects/test-project/locations/test-location/lakes/test-lake/zones/test-zone/entities/test-entity。
     • DATA_SOURCE_RESOURCE：包含数据分析扫描所用数据的资源的名称。例如 //bigquery.googleapis.com/projects/test-project/datasets/test-dataset/tables/test-table。

     C#

     C#

     在尝试此示例之前，请按照 Dataplex Universal Catalog 快速入门：使用客户端库中的 C# 设置说明进行操作。如需了解详情，请参阅 Dataplex Universal Catalog C# API 参考文档。

     如需向 Dataplex Universal Catalog 进行身份验证，请设置应用默认凭证。如需了解详情，请参阅为本地开发环境设置身份验证。

     using Google.Api.Gax.ResourceNames;
     using Google.Cloud.Dataplex.V1;
     using Google.LongRunning;
     
     public sealed partial class GeneratedDataScanServiceClientSnippets
     {
         /// <summary>Snippet for CreateDataScan</summary>
         /// <remarks>
         /// This snippet has been automatically generated and should be regarded as a code template only.
         /// It will require modifications to work:
         /// - It may require correct/in-range values for request initialization.
         /// - It may require specifying regional endpoints when creating the service client as shown in
         ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
         /// </remarks>
         public void CreateDataScanRequestObject()
         {
             // Create client
             DataScanServiceClient dataScanServiceClient = DataScanServiceClient.Create();
             // Initialize request argument(s)
             CreateDataScanRequest request = new CreateDataScanRequest
             {
                 ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
                 DataScan = new DataScan(),
                 DataScanId = "",
                 ValidateOnly = false,
             };
             // Make the request
             Operation<DataScan, OperationMetadata> response = dataScanServiceClient.CreateDataScan(request);
     
             // Poll until the returned long-running operation is complete
             Operation<DataScan, OperationMetadata> completedResponse = response.PollUntilCompleted();
             // Retrieve the operation result
             DataScan result = completedResponse.Result;
     
             // Or get the name of the operation
             string operationName = response.Name;
             // This name can be stored, then the long-running operation retrieved later by name
             Operation<DataScan, OperationMetadata> retrievedResponse = dataScanServiceClient.PollOnceCreateDataScan(operationName);
             // Check if the retrieved long-running operation has completed
             if (retrievedResponse.IsCompleted)
             {
                 // If it has completed, then access the result
                 DataScan retrievedResult = retrievedResponse.Result;
             }
         }
     }

     Go

     Go

     在尝试此示例之前，请按照 Dataplex Universal Catalog 快速入门：使用客户端库中的 Go 设置说明进行操作。如需了解详情，请参阅 Dataplex Universal Catalog Go API 参考文档。

     如需向 Dataplex Universal Catalog 进行身份验证，请设置应用默认凭证。如需了解详情，请参阅为本地开发环境设置身份验证。

     
     package main
     
     import (
     	"context"
     
     	dataplex "cloud.google.com/go/dataplex/apiv1"
     	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
     )
     
     func main() {
     	ctx := context.Background()
     	// This snippet has been automatically generated and should be regarded as a code template only.
     	// It will require modifications to work:
     	// - It may require correct/in-range values for request initialization.
     	// - It may require specifying regional endpoints when creating the service client as shown in:
     	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
     	c, err := dataplex.NewDataScanClient(ctx)
     	if err != nil {
     		// TODO: Handle error.
     	}
     	defer c.Close()
     
     	req := &dataplexpb.CreateDataScanRequest{
     		// TODO: Fill request struct fields.
     		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateDataScanRequest.
     	}
     	op, err := c.CreateDataScan(ctx, req)
     	if err != nil {
     		// TODO: Handle error.
     	}
     
     	resp, err := op.Wait(ctx)
     	if err != nil {
     		// TODO: Handle error.
     	}
     	// TODO: Use resp.
     	_ =