יצירת פרופיל של הנתונים

סריקות של פרופיל נתונים עוזרות לכם להבין טוב יותר את הנתונים שלכם על ידי ניתוח המאפיינים הסטטיסטיים שלהם, כמו ערכים ממוצעים, ייחודיים ומקסימליים. הסריקות האלה, שמבוססות על Knowledge Catalog, מאפשרות לכם לקבל תובנות מעמיקות לגבי מערכי הנתונים שלכם ולהמליץ במהירות על כללים לבדיקות של איכות הנתונים.

מידע נוסף על יצירת פרופילים של נתונים זמין במאמר מידע על יצירת פרופילים של נתונים.

לפני שמתחילים

מפעילים את Dataplex API, אם הוא עדיין לא מופעל.

התפקידים שנדרשים כדי להפעיל ממשקי API

כדי להפעיל ממשקי API, צריך את ההרשאה serviceusage.services.enable. אם יצרתם את הפרויקט, סביר להניח שכבר יש לכם את ההרשאה הזו דרך התפקיד "בעלים" (roles/owner). אחרת, תוכלו לקבל את ההרשאה הזו דרך התפקיד "אדמין בממשק 'שימוש בשירות'" (roles/serviceusage.serviceUsageAdmin). איך מקצים תפקידים

להפעלת ה-API

התפקידים הנדרשים

בקטע הזה מוסבר אילו תפקידים והרשאות ב-IAM נדרשים כדי להשתמש בסריקות של פרופילי נתונים ב-Knowledge Catalog.

תפקידים והרשאות של משתמשים

כדי לקבל את ההרשאות שדרושות ליצירה ולניהול של סריקות פרופיל נתונים, בקשו מהאדמין להקצות לכם את התפקידים הבאים ב-IAM:

  • יצירה, הפעלה, עדכון ומחיקה של סריקות פרופיל נתונים: עריכת Dataplex DataScan (roles/dataplex.dataScanEditor) בפרויקט שמכיל את סריקת הנתונים
  • צפייה בתוצאות, במשימות ובהיסטוריה של סריקת פרופיל הנתונים: Dataplex DataScan Viewer (roles/dataplex.dataScanViewer) בפרויקט שמכיל את סריקת הנתונים
  • פרסום תוצאות של סריקת פרופיל נתונים ב-Knowledge Catalog: עריכת קטלוג Dataplex (roles/dataplex.catalogEditor) בקבוצת הרשומות @bigquery
  • צפייה בתוצאות של סריקת פרופיל הנתונים שפורסמו ב-BigQuery בכרטיסייה Data profile: BigQuery Data Viewer (roles/bigquery.dataViewer) בטבלה
  • מריצים סריקות של פרופיל נתונים:
    • ‫BigQuery Job User ‏ (roles/bigquery.jobUser) בפרויקט שבו מתבצעת הסריקה (כל סוגי הטבלאות)
    • BigQuery Data Viewer ‏ (roles/bigquery.dataViewer) בטבלאות של BigQuery שנסרקות
  • מריצים סריקות של פרופיל נתונים בטבלאות חיצוניות של BigQuery שמשתמשות בנתונים מ-Cloud Storage:
  • כדי להריץ סריקות פרופיל נתונים בטבלאות של קטלוג REST של Iceberg, ‏SAP BDC Delta Lake ו-Apache Hive ב- Google Cloud Lakehouse: BigLake Viewer (roles/biglake.viewer) בטבלאות שנסרקות
  • ייצוא תוצאות של סריקת פרופיל נתונים לטבלה ב-BigQuery: BigQuery Data Editor (roles/bigquery.dataEditor) בטבלה

להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

התפקידים המוגדרים מראש האלה כוללים את ההרשאות שנדרשות כדי ליצור ולנהל סריקות של פרופילי נתונים. כדי לראות בדיוק אילו הרשאות נדרשות, אפשר להרחיב את הקטע ההרשאות הנדרשות:

ההרשאות הנדרשות

כדי ליצור ולנהל סריקות של פרופילי נתונים, צריך את ההרשאות הבאות:

  • ליצור, להריץ, לעדכן ולמחוק סריקות של פרופילי נתונים:
    • dataplex.datascans.create בפרויקט
    • dataplex.datascans.update בסריקת נתונים
    • dataplex.datascans.delete בסריקת נתונים
    • dataplex.datascans.run בסריקת נתונים
    • dataplex.datascans.get בסריקת נתונים
    • dataplex.datascans.list בפרויקט
    • dataplex.dataScanJobs.get במשימת סריקת נתונים
    • dataplex.dataScanJobs.list בסריקת נתונים
  • הצגת תוצאות, משימות והיסטוריה של סריקות פרופיל נתונים:
    • dataplex.datascans.getData בסריקת נתונים
    • dataplex.datascans.list בפרויקט
    • dataplex.dataScanJobs.get במשימת סריקת נתונים
    • dataplex.dataScanJobs.list בסריקת נתונים
  • פרסום תוצאות של סריקת פרופיל נתונים ב-Knowledge Catalog:
    • dataplex.entryGroups.useDataProfileAspect בקבוצת הרשומות
    • bigquery.tables.update בטבלה
    • ‫dataplex.entries.update בכניסה
  • צפייה בתוצאות של פרופיל נתונים שפורסם בטבלה ב-BigQuery או ב-Knowledge Catalog:
    • bigquery.tables.get בטבלה
    • bigquery.tables.getData בטבלה

יכול להיות שתקבלו את ההרשאות האלה באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש אחרים.

תפקידים והרשאות של חשבון שירות ב-Knowledge Catalog

לא משנה באיזו זהות להרצה תבחרו (סוכן השירות של Knowledge Catalog שמוגדר כברירת מחדל, חשבון שירות בהתאמה אישית או פרטי כניסה של משתמש קצה), הזהות הזו צריכה את התפקידים וההרשאות הבאים כדי להריץ את משימות הסריקה של פרופיל הנתונים בקצה העורפי ולייצא את התוצאות.

כדי לוודא שלזהות ההרצה יש את ההרשאות הנדרשות להרצת סריקות של פרופילי נתונים ולייצוא התוצאות, צריך לבקש מהאדמין להקצות לזהות ההרצה את תפקידי ה-IAM הבאים:

  • מריצים סריקות של פרופיל נתונים:
    • ‫BigQuery Job User ‏ (roles/bigquery.jobUser) בפרויקט שבו מתבצעת הסריקה (כל סוגי הטבלאות)
    • BigQuery Data Viewer ‏ (roles/bigquery.dataViewer) בטבלאות של BigQuery שנסרקות
  • מריצים סריקות של פרופיל נתונים בטבלאות חיצוניות של BigQuery שמשתמשות בנתונים מ-Cloud Storage:
  • הפעלת סריקות של פרופיל נתונים בטבלאות של קטלוג REST של Iceberg, ‏SAP BDC Delta Lake ו-Apache Hive ב- Google Cloud Lakehouse: BigLake Viewer (roles/biglake.viewer) בטבלאות שנסרקות
  • ייצוא תוצאות של סריקת פרופיל נתונים לטבלה ב-BigQuery: BigQuery Data Editor (roles/bigquery.dataEditor) בטבלה

להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

התפקידים המוגדרים מראש האלה כוללים את ההרשאות שנדרשות כדי להריץ סריקות פרופיל נתונים ולייצא את התוצאות. כדי לראות בדיוק אילו הרשאות נדרשות, אפשר להרחיב את הקטע ההרשאות הנדרשות:

ההרשאות הנדרשות

כדי להריץ סריקות של פרופיל נתונים ולייצא את התוצאות, נדרשות ההרשאות הבאות:

  • הרצת סריקות פרופיל נתונים על נתונים ב-BigQuery:
    • bigquery.jobs.create בפרויקט
    • bigquery.tables.get בטבלה
    • bigquery.tables.getData בטבלה
  • מריצים סריקות של פרופיל נתונים בטבלאות חיצוניות של BigQuery שמשתמשות בנתונים מ-Cloud Storage:
    • ‫storage.buckets.get בקטגוריה
    • storage.objects.get באובייקט
  • ייצוא של תוצאות סריקת פרופיל הנתונים לטבלה ב-BigQuery:
    • bigquery.tables.create במערך הנתונים
    • bigquery.tables.updateData בטבלה

יכול להיות שהאדמין יוכל גם להעניק לזהות המבצעת את ההרשאות האלה באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש אחרים.

אם בטבלה מוגדרת אבטחה ברמת השורה ב-BigQuery, ‏Knowledge Catalog יכול לסרוק רק שורות שגלויות לחשבון השירות של Knowledge Catalog. כדי לאפשר ל-Knowledge Catalog לסרוק את כל השורות, צריך להוסיף את חשבון השירות שלו למסנן שורות שבו הפרדיקט הוא TRUE.

אם בטבלה מוגדרת אבטחה ברמת העמודה ב-BigQuery, צריך לתת ל-Knowledge Catalog גישה כדי לסרוק עמודות מוגנות. כדי לתת גישה, מקצים לחשבון השירות של Knowledge Catalog את התפקיד קורא עם הרשאות מפורטות ב-Data Catalog‏ (roles/datacatalog.fineGrainedReader) בכל תגי המדיניות שבהם משתמשים בטבלה. המשתמש שיוצר או מעדכן סריקת נתונים צריך גם הרשאות לעמודות המוגנות.

הקצאת תפקידים לחשבון השירות של Knowledge Catalog

כדי להריץ סריקות של פרופילי נתונים, ב-Knowledge Catalog נעשה שימוש בחשבון שירות שצריך הרשאות להרצת משימות ב-BigQuery ולקריאת נתונים מטבלאות ב-BigQuery. כדי להקצות את התפקידים הנדרשים:

  1. משיגים את כתובת האימייל של חשבון השירות של Knowledge Catalog. אם לא יצרתם פרופיל נתונים או סריקה של איכות הנתונים בפרויקט הזה בעבר, הריצו את הפקודה הבאה של gcloud כדי ליצור את זהות השירות:

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

    הפקודה מחזירה את כתובת האימייל של חשבון השירות, בפורמט הבא: service-PROJECT_ID@gcp-sa-dataplex.iam.gserviceaccount.com.

    אם חשבון השירות כבר קיים, אפשר למצוא את כתובת האימייל שלו על ידי הצגת חשבונות משתמשים עם השם Dataplex בדף IAM במסוףGoogle Cloud .

  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 .
    • ‫service-PROJECT_NUMBER@gcp-sa-dataplex.iam.gserviceaccount.com: כתובת האימייל של חשבון השירות של Knowledge 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: המזהה של קבוצת הנתונים שמכילה את הטבלה.
    • ‫TABLE_ID: מזהה הטבלה שרוצים ליצור לה פרופיל.
    • ‫service-PROJECT_NUMBER@gcp-sa-dataplex.iam.gserviceaccount.com: כתובת האימייל של חשבון השירות של Knowledge Catalog.

יצירת סריקה של פרופיל נתונים

המסוף

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על יצירת סריקת פרופיל נתונים.

  3. אופציונלי: מזינים שם לתצוגה.

  4. מזינים מזהה. מוסכמות למתן שמות למשאבים

  5. אופציונלי: מזינים תיאור.

  6. בשדה Table, לוחצים על Browse. בוחרים את הטבלה שרוצים לסרוק ולוחצים על Select. יש תמיכה רק בטבלאות BigQuery רגילות, ב-Iceberg REST Catalog, ב-SAP BDC Delta Lake וב-Apache Hive ב- Google CloudLakehouse.

    בטבלאות של מערכי נתונים במספר אזורים, בוחרים את האזור שבו רוצים ליצור את סריקת הנתונים.

    כדי לעיין בטבלאות שמאורגנות ב-Knowledge Catalog, לוחצים על Browse within Knowledge Catalog Lakes.

  7. בקטע מצב, בוחרים אחת מהאפשרויות הבאות:

    • ‫Standard: יצירת פרופיל של הנתונים באמצעות הגדרות סריקה שניתנות להתאמה אישית. זהו מצב ברירת המחדל.

    • קל משקל: מספק תובנות מהירות באמצעות סריקה עם זמן אחזור קצר ורמת דיוק נמוכה.

  8. אם בחרתם במצב רגיל, מגדירים את האפשרויות הבאות. האפשרויות האלה לא מופיעות כשבוחרים במצב Lightweight.

    1. בשדה היקף, בוחרים באפשרות מצטבר או כל הנתונים.

      אם בוחרים באפשרות נתונים מצטברים, בשדה עמודת חותמת זמן בוחרים עמודה מסוג DATE או TIMESTAMP מהטבלה ב-BigQuery. העמודה הזו משמשת את Knowledge Catalog כדי לזהות רשומות חדשות כשהן מתווספות. בטבלאות שמחולקות לפי עמודה מסוג DATE או TIMESTAMP, מומלץ להשתמש בעמודה הזו כעמודת החלוקה למחיצות.

    2. אופציונלי: כדי לסנן את הנתונים, מבצעים את אחת מהפעולות הבאות:

      • כדי לסנן לפי שורות, מסמנים את התיבה סינון שורות. מזינים ביטוי SQL תקין שאפשר להשתמש בו בסעיף WHERE בתחביר של GoogleSQL. לדוגמה: col1 >= 0.

        המסנן יכול להיות שילוב של תנאי SQL בכמה עמודות. לדוגמה: col1 >= 0 AND col2 < 10.

      • כדי לסנן לפי עמודות, מסמנים את התיבה סינון עמודות.

      • כדי לכלול עמודות בסריקת הפרופיל, בשדה Include columns לוחצים על Browse. בוחרים את העמודות שרוצים לכלול ולוחצים על בחירה.

      • כדי להחריג עמודות מסריקת הפרופיל, בשדה Exclude columns לוחצים על Browse. בוחרים את העמודות שרוצים להחריג ולוחצים על Select.

    3. כדי להחיל דגימה על סריקת פרופיל הנתונים, בוחרים אחוז דגימה ברשימה Sampling size. בוחרים ערך באחוזים בטווח שבין 0.0% ל-100.0% עם עד 3 ספרות אחרי הנקודה העשרונית.

      • בקבוצות נתונים גדולות יותר, כדאי לבחור אחוז דגימה נמוך יותר. לדוגמה, בטבלה של 1 PB, אם תזינו ערך בין 0.1% ל-1.0%, פרופיל הנתונים ידגום בין 1 TB ל-10 TB של נתונים.

      • כדי לקבל תוצאה, צריכות להיות לפחות 100 רשומות בנתונים שנדגמו.

      • בסריקות נתונים מצטברות, סריקת פרופיל הנתונים מחילה דגימה על המצטבר האחרון.

  9. אופציונלי: פרסום התוצאות של סריקת פרופיל הנתונים בדפים BigQuery ו-Knowledge Catalog במסוףGoogle Cloud של טבלת המקור. מסמנים את התיבה Publish results to Knowledge Catalog.

    אתם יכולים לראות את תוצאות הסריקה האחרונות בכרטיסייה Data profile בדפים BigQuery ו-Knowledge Catalog של טבלת המקור. כדי לאפשר למשתמשים לגשת לתוצאות הסריקה שפורסמו, עיינו בקטע מתן גישה לתוצאות של סריקת פרופיל נתונים במאמר הזה.

    יכול להיות שאפשרות הפרסום לא תהיה זמינה במקרים הבאים:

    • אין לכם את ההרשאות הנדרשות בטבלה.
    • סריקת פרופיל נתונים נוספת מוגדרת לפרסום תוצאות.
  10. בקטע תזמון, בוחרים אחת מהאפשרויות הבאות:

    • ‫Repeat: הפעלת סריקת פרופיל הנתונים לפי לוח זמנים: מדי שעה, מדי יום, מדי שבוע, מדי חודש או בהתאמה אישית. מציינים באיזו תדירות ובאיזו שעה הסריקה צריכה לפעול. אם בוחרים באפשרות Custom, צריך להשתמש בפורמט cron כדי לציין את לוח הזמנים.

    • לפי דרישה: הפעלת סריקת פרופיל הנתונים לפי דרישה.

    • ‫One-time run: הפעלה של סריקת פרופיל הנתונים פעם אחת עכשיו, והסרה של הסריקה אחרי זמן המחיקה האוטומטית. התכונה הזו נמצאת בגרסת טרום-השקה (Preview).

      • הגדרת מחיקה אוטומטית של תוצאות אחרי סריקה: זמן המחיקה האוטומטית מגדיר את משך הזמן שבו סריקת פרופיל הנתונים נשארת פעילה אחרי ההפעלה. סריקת פרופיל נתונים בלי זמן מוגדר למחיקה אוטומטית מוסרת באופן אוטומטי אחרי 24 שעות. זמן המחיקה האוטומטית יכול לנוע בין 0 שניות (מחיקה מיידית) ל-365 ימים.
  11. לוחצים על Continue.

  12. אופציונלי: ייצוא של תוצאות הסריקה לטבלה רגילה ב-BigQuery. בקטע Export scan results to BigQuery table, מבצעים את הפעולות הבאות:

    1. בשדה Select BigQuery dataset, לוחצים על Browse. בוחרים מערך נתונים ב-BigQuery שבו יישמרו תוצאות הסריקה של פרופיל הנתונים.

    2. בשדה BigQuery table, מציינים את הטבלה ב-BigQuery שבה רוצים לשמור את תוצאות הסריקה של פרופיל הנתונים. אם אתם משתמשים בטבלה קיימת, ודאו שהיא תואמת לסכימת טבלת הייצוא. אם הטבלה שציינתם לא קיימת, היא תיווצר על ידי Knowledge Catalog.

  13. אופציונלי: מוסיפים תוויות. תוויות הן צמדי מפתח/ערך שמאפשרים לקשר בין אובייקטים או ביניהם לבין משאבים אחרים של Google Cloud .

  14. כדי ליצור את הסריקה, לוחצים על Create.

    אם הגדרתם את התזמון לפי דרישה, אתם יכולים גם להריץ את הסריקה עכשיו בלחיצה על Run scan.

gcloud

כדי ליצור סריקת פרופיל נתונים, משתמשים בפקודה gcloud dataplex datascans create data-profile.

אם נתוני המקור מאורגנים ב-Knowledge Catalog, צריך לכלול את הדגל --data-source-entity:

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

אם נתוני המקור לא מאורגנים ב-Knowledge Catalog lake, צריך לכלול את הדגל --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: הישות ב-Knowledge 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#

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של C# במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery C# API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

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 במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Go API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.


//go:build examples

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.
	_ = resp
}

Java

Java

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Java במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Java API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

import com.google.cloud.dataplex.v1.CreateDataScanRequest;
import com.google.cloud.dataplex.v1.DataScan;
import com.google.cloud.dataplex.v1.DataScanServiceClient;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateDataScan {

  public static void main(String[] args) throws Exception {
    syncCreateDataScan();
  }

  public static void syncCreateDataScan() throws Exception {
    // 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/java/docs/setup#configure_endpoints_for_the_client_library
    try (DataScanServiceClient dataScanServiceClient = DataScanServiceClient.create()) {
      CreateDataScanRequest request =
          CreateDataScanRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setDataScan(DataScan.newBuilder().build())
              .setDataScanId("dataScanId1260787906")
              .setValidateOnly(true)
              .build();
      DataScan response = dataScanServiceClient.createDataScanAsync(request).get();
    }
  }
}

Python

Python

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Python במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Python API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import google.api_core.exceptions
from google.cloud import dataplex_v1


def create_data_profile_scan_global(
    project_id: str,
    dataset_id: str,
    table_id: str,
    location: str,
) -> None:
    """Creates a Dataplex Data Profile Scan using global API endpoint routing.

    Args:
        project_id (str): Google Cloud project ID where the scan is created.
        dataset_id (str): Target BigQuery dataset ID.
        table_id (str): Target BigQuery table ID to scan.
        location (str): Google Cloud region where serverless compute runs.
    """
    client = dataplex_v1.DataScanServiceClient()

    parent = client.common_location_path(project=project_id, location=location)

    bigquery_table = (
        f"//bigquery.googleapis.com/projects/{project_id}"
        f"/datasets/{dataset_id}/tables/{table_id}"
    )

    data_profile_spec = dataplex_v1.DataProfileSpec(sampling_percent=100.0)

    data_scan = dataplex_v1.DataScan(
        display_name="Global Data Profile Scan",
        description="Regional data profile scan generating automated table statistics.",
        data=dataplex_v1.DataSource(resource=bigquery_table),
        data_profile_spec=data_profile_spec,
    )

    request = dataplex_v1.CreateDataScanRequest(
        parent=parent,
        data_scan=data_scan,
    )

    try:
        operation = client.create_data_scan(request=request)
        print(operation.result())

    except google.api_core.exceptions.AlreadyExists:
        print("A scan with this ID already exists.")
    except google.api_core.exceptions.InvalidArgument as e:
        print(f"Your scan configuration is invalid: {e}")
    except google.api_core.exceptions.GoogleAPIError as e:
        print(f"Unexpected exception: {e}")


Ruby

Ruby

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Ruby במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Ruby API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

require "google/cloud/dataplex/v1"

##
# Snippet for the create_data_scan call in the DataScanService service
#
# 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/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::DataScanService::Client#create_data_scan.
#
def create_data_scan
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::DataScanService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::CreateDataScanRequest.new

  # Call the create_data_scan method.
  result = client.create_data_scan request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

כדי ליצור סריקת פרופיל נתונים, משתמשים ב-method‏ dataScans.create.

יצירת כמה סריקות של פרופילי נתונים

אתם יכולים להגדיר סריקות של פרופילי נתונים לכמה טבלאות במערך נתונים ב-BigQuery בו-זמנית באמצעות מסוף Google Cloud .

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על יצירת סריקת פרופיל נתונים.

  3. בוחרים באפשרות סריקות פרופיל נתונים מרובות.

  4. מזינים קידומת למזהה. ב-Knowledge Catalog נוצרים באופן אוטומטי מזהי סריקה באמצעות הקידומת שצוינה וסיומות ייחודיות.

  5. מזינים תיאור לכל סריקות פרופיל הנתונים.

  6. בשדה Dataset, לוחצים על Browse. בוחרים מערך נתונים כדי לבחור טבלאות מתוכו. לוחצים על Select.

  7. אם מערך הנתונים הוא בכמה אזורים, בוחרים אזור שבו רוצים ליצור את סריקות פרופיל הנתונים.

  8. בקטע מצב, בוחרים אחת מהאפשרויות הבאות:

    • ‫Standard: יצירת פרופיל של הנתונים באמצעות הגדרות סריקה שניתנות להתאמה אישית. זהו מצב ברירת המחדל.

    • קל: מספק תובנות מהירות באמצעות סריקה עם זמן אחזור קצר ורמת דיוק נמוכה. התכונה הזו נמצאת בגרסת טרום-השקה (Preview).

  9. אם בחרתם במצב Standard, קבעו את ההגדרות הבאות לסריקות. ההגדרות האלה לא מופיעות כשבוחרים במצב קל.

    1. בשדה היקף, בוחרים באפשרות מצטבר או כל הנתונים.

      אם בוחרים בנתונים מצטברים, אפשר לבחור רק טבלאות שמחולקות לפי עמודה מסוג DATE או TIMESTAMP.

    2. כדי להחיל דגימה על סריקות פרופיל הנתונים, בוחרים אחוז דגימה ברשימה Sampling size.

      בוחרים ערך באחוזים בין 0.0% ל-100.0% עם עד 3 ספרות אחרי הנקודה העשרונית.

  10. אופציונלי: פרסום התוצאות של סריקת פרופיל הנתונים בדפים BigQuery ו-Knowledge Catalog במסוףGoogle Cloud של טבלת המקור. מסמנים את התיבה Publish results to Knowledge Catalog.

    אתם יכולים לראות את תוצאות הסריקה האחרונות בכרטיסייה Data profile בדפים BigQuery ו-Knowledge Catalog של טבלת המקור. כדי לאפשר למשתמשים לגשת לתוצאות הסריקה שפורסמו, עיינו בקטע מתן גישה לתוצאות של סריקת פרופיל נתונים במאמר הזה.

  11. בקטע תזמון, בוחרים אחת מהאפשרויות הבאות:

    • חזרה: הפעלת סריקות פרופיל נתונים לפי לוח זמנים: מדי שעה, מדי יום, מדי שבוע, מדי חודש או בהתאמה אישית. מציינים באיזו תדירות הסריקות צריכות לפעול ובאיזו שעה. אם בוחרים באפשרות Custom, צריך להשתמש בפורמט cron כדי לציין את לוח הזמנים.

    • על פי דרישה: הפעלת סריקות של פרופיל הנתונים על פי דרישה.

      • הפעלה חד-פעמית: מריצים את סריקת פרופיל הנתונים פעם אחת עכשיו, ומסירים את הסריקה אחרי זמן המחיקה האוטומטית. התכונה הזו נמצאת בגרסת טרום-השקה (Preview).

        • הגדרת מחיקה אוטומטית של תוצאות אחרי הסריקה: זמן המחיקה האוטומטית מגדיר את משך הזמן שבו סריקת פרופיל הנתונים נשארת פעילה אחרי ההפעלה. סריקת פרופיל נתונים שלא צוין בה זמן מחיקה אוטומטית תוסר באופן אוטומטי אחרי 24 שעות. זמן המחיקה האוטומטית יכול לנוע בין 0 שניות (מחיקה מיידית) ל-365 ימים.
  12. לוחצים על Continue.

  13. בשדה Choose tables, לוחצים על Browse. בוחרים טבלה אחת או יותר לסריקה ולוחצים על Select.

  14. לוחצים על Continue.

  15. אופציונלי: ייצוא של תוצאות הסריקה לטבלה רגילה ב-BigQuery. בקטע Export scan results to BigQuery table, מבצעים את הפעולות הבאות:

    1. בשדה Select BigQuery dataset, לוחצים על Browse. בוחרים מערך נתונים ב-BigQuery שבו יישמרו תוצאות הסריקה של פרופיל הנתונים.

    2. בשדה BigQuery table, מציינים את הטבלה ב-BigQuery שבה רוצים לשמור את תוצאות הסריקה של פרופיל הנתונים. אם אתם משתמשים בטבלה קיימת, ודאו שהיא תואמת לסכימת טבלת הייצוא. אם הטבלה שצוינה לא קיימת, Knowledge Catalog יוצר אותה בשבילכם.

      ב-Knowledge Catalog, כל סריקות פרופיל הנתונים משתמשות באותה טבלת תוצאות.

  16. אופציונלי: מוסיפים תוויות. תוויות הן צמדי מפתח/ערך שמאפשרים לקשר בין אובייקטים או ביניהם לבין משאבים אחרים של Google Cloud .

  17. כדי ליצור את הסריקות, לוחצים על Create.

    אם הגדרתם את התזמון לפי דרישה, אתם יכולים גם להריץ את הסריקות עכשיו בלחיצה על Run scan.

הרצת סריקת פרופיל נתונים

המסוף

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על סריקת פרופיל הנתונים שרוצים להריץ.
  3. לוחצים על הפעלה מיידית.

gcloud

כדי להריץ סריקה של פרופיל נתונים, משתמשים בפקודה gcloud dataplex datascans run:

gcloud dataplex datascans run DATASCAN \
--location=LOCATION

מחליפים את המשתנים הבאים:

  • ‫DATASCAN: השם של סריקת פרופיל הנתונים.
  • ‫LOCATION: האזור ב- Google Cloud שבו נוצרה סריקת פרופיל הנתונים.

C#‎

C#

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של C# במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery C# API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedDataScanServiceClientSnippets
{
    /// <summary>Snippet for RunDataScan</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 RunDataScanRequestObject()
    {
        // Create client
        DataScanServiceClient dataScanServiceClient = DataScanServiceClient.Create();
        // Initialize request argument(s)
        RunDataScanRequest request = new RunDataScanRequest
        {
            DataScanName = DataScanName.FromProjectLocationDataScan("[PROJECT]", "[LOCATION]", "[DATASCAN]"),
        };
        // Make the request
        RunDataScanResponse response = dataScanServiceClient.RunDataScan(request);
    }
}

המשך

Go

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Go במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Go API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.


//go:build examples

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.RunDataScanRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#RunDataScanRequest.
	}
	resp, err := c.RunDataScan(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Java

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Java במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Java API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

import com.google.cloud.dataplex.v1.DataScanName;
import com.google.cloud.dataplex.v1.DataScanServiceClient;
import com.google.cloud.dataplex.v1.RunDataScanRequest;
import com.google.cloud.dataplex.v1.RunDataScanResponse;

public class SyncRunDataScan {

  public static void main(String[] args) throws Exception {
    syncRunDataScan();
  }

  public static void syncRunDataScan() throws Exception {
    // 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/java/docs/setup#configure_endpoints_for_the_client_library
    try (DataScanServiceClient dataScanServiceClient = DataScanServiceClient.create()) {
      RunDataScanRequest request =
          RunDataScanRequest.newBuilder()
              .setName(DataScanName.of("[PROJECT]", "[LOCATION]", "[DATASCAN]").toString())
              .build();
      RunDataScanResponse response = dataScanServiceClient.runDataScan(request);
    }
  }
}

Python

Python

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Python במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Python API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_run_data_scan():
    # Create a client
    client = dataplex_v1.DataScanServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.RunDataScanRequest(
        name="name_value",
    )

    # Make the request
    response = client.run_data_scan(request=request)

    # Handle the response
    print(response)

Ruby

Ruby

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Ruby במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Ruby API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

require "google/cloud/dataplex/v1"

##
# Snippet for the run_data_scan call in the DataScanService service
#
# 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/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::DataScanService::Client#run_data_scan.
#
def run_data_scan
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::DataScanService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::RunDataScanRequest.new

  # Call the run_data_scan method.
  result = client.run_data_scan request

  # The returned object is of type Google::Cloud::Dataplex::V1::RunDataScanResponse.
  p result
end

REST

כדי להריץ סריקת פרופיל נתונים, משתמשים ב-method‏ dataScans.run.

Airflow

כדי להריץ סריקת פרופיל נתונים באמצעות גרף אציקלי מכוון (DAG) ב-Managed Service for Apache Airflow (Cloud Composer), משתמשים ב-DataplexRunDataProfileScanOperator:

from datetime import datetime
from airflow import DAG
from airflow.providers.google.cloud.operators.dataplex import DataplexRunDataProfileScanOperator

with DAG(
  "dataplex_data_profile_scan",
  start_date=datetime(2026, 1, 1),
  schedule_interval="@daily",
  catchup=False,
) as dag:

  run_profile_scan = DataplexRunDataProfileScanOperator(
      task_id="run_dataplex_profile_scan",
      project_id="PROJECT_ID",
      region="REGION",
      data_scan_id="DATASCAN_ID",
  )

מחליפים את המשתנים הבאים:

  • ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud .
  • ‫REGION: האזור ( Google Cloud ) שבו נוצרה סריקת פרופיל הנתונים.
  • ‫DATASCAN_ID: המזהה של סריקת פרופיל הנתונים.

צפייה בתוצאות של סריקת פרופיל נתונים

המסוף

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על השם של סריקת פרופיל הנתונים.

    • בקטע Overview מוצג מידע על המשימות האחרונות, כולל מתי הסריקה בוצעה, מספר הרשומות בטבלה שנסרקו וסטטוס המשימה.

    • בקטע Data profile scan configuration מוצגים פרטים על הסריקה.

  3. כדי לראות מידע מפורט על משימה, כמו העמודות בטבלה שנסרקה, נתונים סטטיסטיים על העמודות שנמצאו בסריקה ויומני המשימות, לוחצים על הכרטיסייה Jobs history. לאחר מכן לוחצים על מזהה משימה.

gcloud

כדי לראות את התוצאות של משימת סריקת פרופיל נתונים, משתמשים בפקודה gcloud dataplex datascans jobs describe:

gcloud dataplex datascans jobs describe JOB \
--location=LOCATION \
--datascan=DATASCAN \
--view=FULL

מחליפים את המשתנים הבאים:

  • ‫JOB: מזהה המשימה של סריקת פרופיל הנתונים.
  • ‫LOCATION: האזור ב- Google Cloud שבו נוצרה סריקת פרופיל הנתונים.
  • ‫DATASCAN: השם של סריקת פרופיל הנתונים שהמשימה שייכת אליה.
  • ‫--view=FULL: כדי לראות את התוצאה של משימת הסריקה, מציינים את FULL.

C#‎

C#

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של C# במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery C# API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedDataScanServiceClientSnippets
{
    /// <summary>Snippet for GetDataScan</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 GetDataScanRequestObject()
    {
        // Create client
        DataScanServiceClient dataScanServiceClient = DataScanServiceClient.Create();
        // Initialize request argument(s)
        GetDataScanRequest request = new GetDataScanRequest
        {
            DataScanName = DataScanName.FromProjectLocationDataScan("[PROJECT]", "[LOCATION]", "[DATASCAN]"),
            View = GetDataScanRequest.Types.DataScanView.Unspecified,
        };
        // Make the request
        DataScan response = dataScanServiceClient.GetDataScan(request);
    }
}

המשך

Go

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Go במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Go API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.


//go:build examples

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.GetDataScanRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetDataScanRequest.
	}
	resp, err := c.GetDataScan(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Java

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Java במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Java API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

import com.google.cloud.dataplex.v1.DataScan;
import com.google.cloud.dataplex.v1.DataScanName;
import com.google.cloud.dataplex.v1.DataScanServiceClient;
import com.google.cloud.dataplex.v1.GetDataScanRequest;

public class SyncGetDataScan {

  public static void main(String[] args) throws Exception {
    syncGetDataScan();
  }

  public static void syncGetDataScan() throws Exception {
    // 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/java/docs/setup#configure_endpoints_for_the_client_library
    try (DataScanServiceClient dataScanServiceClient = DataScanServiceClient.create()) {
      GetDataScanRequest request =
          GetDataScanRequest.newBuilder()
              .setName(DataScanName.of("[PROJECT]", "[LOCATION]", "[DATASCAN]").toString())
              .build();
      DataScan response = dataScanServiceClient.getDataScan(request);
    }
  }
}

Python

Python

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Python במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Python API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_get_data_scan():
    # Create a client
    client = dataplex_v1.DataScanServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.GetDataScanRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_scan(request=request)

    # Handle the response
    print(response)

Ruby

Ruby

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Ruby במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Ruby API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

require "google/cloud/dataplex/v1"

##
# Snippet for the get_data_scan call in the DataScanService service
#
# 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/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::DataScanService::Client#get_data_scan.
#
def get_data_scan
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::DataScanService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::GetDataScanRequest.new

  # Call the get_data_scan method.
  result = client.get_data_scan request

  # The returned object is of type Google::Cloud::Dataplex::V1::DataScan.
  p result
end

REST

כדי לראות את התוצאות של סריקת פרופיל נתונים, משתמשים בשיטה dataScans.get.

הצגת התוצאות שפורסמו

אם תוצאות סריקת פרופיל הנתונים מתפרסמות בדפים של BigQuery ו-Knowledge Catalog במסוף Google Cloud , תוכלו לראות את תוצאות הסריקה האחרונות בכרטיסייה Data profile של טבלת המקור.

  1. נכנסים לדף BigQuery במסוף Google Cloud .

    כניסה ל-BigQuery

  2. בחלונית השמאלית, לוחצים על Explorer:

    כפתור מודגש לחלונית Explorer.

    אם החלונית הימנית לא מוצגת, לוחצים על הרחבת החלונית הימנית כדי לפתוח אותה.

  3. בחלונית Explorer, לוחצים על Datasets ואז על מערך הנתונים.

  4. לוחצים על Overview > Tables ובוחרים את הטבלה שרוצים לראות את תוצאות סריקת פרופיל הנתונים שלה.

  5. לוחצים על הכרטיסייה פרופיל נתונים.

    התוצאות האחרונות שפורסמו מוצגות.

צפייה במשימה האחרונה של סריקת פרופיל נתונים

המסוף

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על השם של סריקת פרופיל הנתונים.

  3. לוחצים על הכרטיסייה תוצאות המשימה האחרונה.

    בכרטיסייה Latest job results, אם יש לפחות הרצה אחת שהסתיימה בהצלחה, מוצג מידע על המשימה האחרונה. הוא מפרט את העמודות של הטבלה שנסרקה ונתונים סטטיסטיים על העמודות שנמצאו בסריקה.

gcloud

כדי לראות את הסריקה האחרונה של פרופיל הנתונים שהסתיימה בהצלחה, משתמשים בפקודה gcloud dataplex datascans describe:

gcloud dataplex datascans describe DATASCAN \
--location=LOCATION \
--view=FULL

מחליפים את המשתנים הבאים:

  • ‫DATASCAN: השם של סריקת פרופיל הנתונים שרוצים לראות את המשימה האחרונה שלה.
  • ‫LOCATION: האזור Google Cloud שבו נוצרה סריקת פרופיל הנתונים.
  • ‫--view=FULL: כדי לראות את התוצאה של משימת הסריקה, מציינים את FULL.

REST

כדי לראות את משימת הסריקה האחרונה, משתמשים ב-method dataScans.get.

צפייה בתוצאות של סריקות קודמות

ב-Knowledge Catalog נשמרת היסטוריית סריקות פרופיל הנתונים של 300 המשימות האחרונות או של השנה האחרונה, המוקדם מביניהם.

המסוף

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על השם של סריקת פרופיל הנתונים.

  3. לוחצים על הכרטיסייה Jobs history.

    בכרטיסייה Jobs history מוצג מידע על משימות קודמות, כמו מספר הרשומות שנסרקו בכל משימה, סטטוס המשימה והזמן שבו המשימה הופעלה.

  4. כדי לראות מידע מפורט על משימה, לוחצים על אחת מהמשימות בעמודה Job ID.

gcloud

כדי לראות את המשימות ההיסטוריות של סריקת פרופיל הנתונים, משתמשים בפקודה gcloud dataplex datascans jobs list:

gcloud dataplex datascans jobs list \
--location=LOCATION \
--datascan=DATASCAN

מחליפים את המשתנים הבאים:

  • ‫LOCATION: האזור Google Cloud שבו נוצרה סריקת פרופיל הנתונים.
  • ‫DATASCAN: השם של סריקת פרופיל הנתונים שרוצים לראות את המשימות שלה.

C#‎

C#

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של C# במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery C# API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

using Google.Api.Gax;
using Google.Cloud.Dataplex.V1;
using System;

public sealed partial class GeneratedDataScanServiceClientSnippets
{
    /// <summary>Snippet for ListDataScanJobs</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 ListDataScanJobsRequestObject()
    {
        // Create client
        DataScanServiceClient dataScanServiceClient = DataScanServiceClient.Create();
        // Initialize request argument(s)
        ListDataScanJobsRequest request = new ListDataScanJobsRequest
        {
            ParentAsDataScanName = DataScanName.FromProjectLocationDataScan("[PROJECT]", "[LOCATION]", "[DATASCAN]"),
            Filter = "",
        };
        // Make the request
        PagedEnumerable<ListDataScanJobsResponse, DataScanJob> response = dataScanServiceClient.ListDataScanJobs(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (DataScanJob item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (ListDataScanJobsResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (DataScanJob item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<DataScanJob> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (DataScanJob item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

המשך

Go

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Go במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Go API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
	"google.golang.org/api/iterator"
)

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.ListDataScanJobsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListDataScanJobsRequest.
	}
	it := c.ListDataScanJobs(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataplexpb.ListDataScanJobsResponse)
	}
}

Java

Java

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Java במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Java API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

import com.google.cloud.dataplex.v1.DataScanJob;
import com.google.cloud.dataplex.v1.DataScanName;
import com.google.cloud.dataplex.v1.DataScanServiceClient;
import com.google.cloud.dataplex.v1.ListDataScanJobsRequest;

public class SyncListDataScanJobs {

  public static void main(String[] args) throws Exception {
    syncListDataScanJobs();
  }

  public static void syncListDataScanJobs() throws Exception {
    // 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/java/docs/setup#configure_endpoints_for_the_client_library
    try (DataScanServiceClient dataScanServiceClient = DataScanServiceClient.create()) {
      ListDataScanJobsRequest request =
          ListDataScanJobsRequest.newBuilder()
              .setParent(DataScanName.of("[PROJECT]", "[LOCATION]", "[DATASCAN]").toString())
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setFilter("filter-1274492040")
              .build();
      for (DataScanJob element : dataScanServiceClient.listDataScanJobs(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Python

Python

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Python במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Python API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_list_data_scan_jobs():
    # Create a client
    client = dataplex_v1.DataScanServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.ListDataScanJobsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_data_scan_jobs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Ruby

Ruby

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Ruby במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Ruby API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

require "google/cloud/dataplex/v1"

##
# Snippet for the list_data_scan_jobs call in the DataScanService service
#
# 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/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::DataScanService::Client#list_data_scan_jobs.
#
def list_data_scan_jobs
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::DataScanService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::ListDataScanJobsRequest.new

  # Call the list_data_scan_jobs method.
  result = client.list_data_scan_jobs request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::Dataplex::V1::DataScanJob.
    p item
  end
end

REST

כדי לראות משימות היסטוריות של סריקת פרופיל נתונים, משתמשים ב-method‏ dataScans.jobs.list.

סטטוסים של משימות

אלה הסטטוסים האפשריים של משימות סריקת נתונים:

  • ‫PENDING: המשימה נוצרה אבל עדיין לא התחילה לפעול. במצב הזה, הסריקה מגדירה באופן פעיל תשתית או רוכשת משבצות. השלב הזה יכול להימשך בין 10 ל-20 שניות או יותר, בהתאם למורכבות הסכימה ולתחרות על המשאבים.

  • ‫RUNNING: המשימה פועלת.

  • ‫CANCELING: המשימה בתהליך ביטול.

  • ‫CANCELLED: המשימה בוטלה.

  • ‫SUCCEEDED: המשימה הושלמה בהצלחה. סטטוס ההשלמה עשוי להופיע באיחור של עד 60 שניות מההשלמה בפועל של השאילתה, בגלל שלבים של עיבוד לאחר השאילתה, כמו צבירה וסנכרון מטא-נתונים.

  • ‫FAILED: המשימה נכשלה בגלל שגיאה. סטטוס ההשלמה עשוי להופיע באיחור של עד 60 שניות מההשלמה בפועל של השאילתה, בגלל שלבים של עיבוד לאחר השאילתה, כמו צבירה וסנכרון מטא-נתונים.

  • ‫SUCCEEDED_WITH_ERRORS: המשימה הושלמה, אבל היו כמה שגיאות במהלך הביצוע.

שיטות מומלצות למעקב

כשאתם עוקבים אחרי משימות סריקת הנתונים, חשוב לזכור את השיטות המומלצות הבאות:

  • הימנעו מסקרים אגרסיביים: הימנעו מסקרים אגרסיביים (לדוגמה, קריאה ל-GetJob או לפונקציה מקבילה כל 1 עד 5 שניות). דגימה אגרסיבית מבזבזת את מכסת ה-API ולא מאיצה את מעברי המצבים.

  • שימוש בהשהיה מעריכית לפני ניסיון חוזר (exponential backoff): אם אי אפשר להימנע מדגימה חוזרת, צריך להשתמש בהשהיה מעריכית לפני ניסיון חוזר (exponential backoff) שמתחילה ב-10 עד 15 שניות.

  • שימוש בהפרדה אסינכרונית מבוססת-אירועים (מומלץ): במקום דגימת API סינכרונית, משתמשים בטריגרים של Eventarc שמאזינים ליומני הביקורת של Cloud (cloudaudit.googleapis.com). אפשר להשתמש בטריגרים האלה כדי להתחיל תהליכי עבודה במורד הזרם מיד אחרי אירועי השלמת המשימות של DataScan. הגישה הזו עוקפת את מגבלות הסקרים של ה-API, חוסכת במכסות ומפחיתה את זמן האחזור.

צפייה בסריקות של פרופיל הנתונים של טבלה

כדי לראות את סריקות פרופיל הנתונים שחלות על טבלה ספציפית:

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לסנן את הרשימה לפי שם הטבלה וסוג הסריקה.

מתן גישה לתוצאות של סריקת פרופיל נתונים

כדי לאפשר למשתמשים בארגון לראות את תוצאות הסריקה, מבצעים את הפעולות הבאות:

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על סריקת פרופיל הנתונים שרוצים לשתף את התוצאות שלה.

  3. לוחצים על הכרטיסייה Permissions.

  4. מבצעים את הפעולות הבאות:

    • כדי לתת גישה לחשבון משתמש, לוחצים על Grant access. מקצים את התפקיד Dataplex DataScan DataViewer לחשבון המשתמש המשויך.
    • כדי להסיר את הגישה מחשבון משתמש, בוחרים את החשבון שרוצים להסיר ממנו את התפקיד Dataplex DataScan DataViewer. לוחצים על הסרת הגישה ומאשרים את הפעולה.

ניהול סריקות של פרופיל נתונים בטבלה ספציפית

במאמר הזה מוסבר איך לנהל את סריקות פרופיל הנתונים בפרויקט באמצעות הדף Metadata curation > Data profiling & quality של BigQuery במסוףGoogle Cloud .

אתם יכולים גם ליצור ולנהל סריקות של פרופילי נתונים כשאתם עובדים עם טבלה ספציפית. במסוף Google Cloud , בדף BigQuery של הטבלה, משתמשים בכרטיסייה Data profile. מבצעים את הפעולות הבאות:

  1. נכנסים לדף BigQuery במסוף Google Cloud .

    כניסה לדף BigQuery

    בחלונית Explorer, לוחצים על Datasets ואז על מערך הנתונים. לוחצים על Overview > Tables ובוחרים את הטבלה שרוצים לראות את תוצאות סריקת פרופיל הנתונים שלה.

  2. לוחצים על הכרטיסייה פרופיל נתונים.

  3. בהתאם לשאלה אם לטבלה יש סריקת פרופיל נתונים שהתוצאות שלה פורסמו, אתם יכולים לעבוד עם סריקות פרופיל הנתונים של הטבלה בדרכים הבאות:

    • תוצאות סריקת פרופיל הנתונים מתפרסמות: תוצאות הסריקה האחרונות שפורסמו מוצגות בדף.

      כדי לנהל את סריקות פרופיל הנתונים של הטבלה, לוחצים על Data profile scan ובוחרים אחת מהאפשרויות הבאות:

    • תוצאות סריקת פרופיל הנתונים לא מתפרסמות: לוחצים על התפריט לצד פרופיל נתונים מהיר ובוחרים אחת מהאפשרויות הבאות:

      • התאמה אישית של פרופיל הנתונים: יצירת סריקה חדשה של פרופיל הנתונים. מידע נוסף זמין בקטע יצירת סריקה של פרופיל נתונים במסמך הזה. כשיוצרים סריקה מדף הפרטים של הטבלה, הטבלה נבחרת מראש.

      • ‫View previous profiles: הצגת רשימה של סריקות פרופיל הנתונים שחלות על הטבלה הזו.

עדכון של סריקת פרופיל נתונים

המסוף

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על השם של סריקת פרופיל נתונים.

  3. לוחצים על עריכה ומשנים את הערכים.

  4. לוחצים על Save.

gcloud

כדי לעדכן סריקת פרופיל נתונים, משתמשים בפקודה gcloud dataplex datascans update data-profile:

gcloud dataplex datascans update data-profile DATASCAN \
--location=LOCATION \
--description=DESCRIPTION

מחליפים את המשתנים הבאים:

  • ‫DATASCAN: השם של סריקת פרופיל הנתונים שרוצים לעדכן.
  • ‫LOCATION: האזור Google Cloud שבו נוצרה סריקת פרופיל הנתונים.
  • ‫DESCRIPTION: התיאור החדש של סריקת פרופיל הנתונים.

C#‎

C#

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של C# במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery C# API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

using Google.Cloud.Dataplex.V1;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedDataScanServiceClientSnippets
{
    /// <summary>Snippet for UpdateDataScan</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 UpdateDataScanRequestObject()
    {
        // Create client
        DataScanServiceClient dataScanServiceClient = DataScanServiceClient.Create();
        // Initialize request argument(s)
        UpdateDataScanRequest request = new UpdateDataScanRequest
        {
            DataScan = new DataScan(),
            UpdateMask = new FieldMask(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<DataScan, OperationMetadata> response = dataScanServiceClient.UpdateDataScan(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.PollOnceUpdateDataScan(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 במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Go API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.


//go:build examples

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.UpdateDataScanRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateDataScanRequest.
	}
	op, err := c.UpdateDataScan(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Java

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Java במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Java API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

import com.google.cloud.dataplex.v1.DataScan;
import com.google.cloud.dataplex.v1.DataScanServiceClient;
import com.google.cloud.dataplex.v1.UpdateDataScanRequest;
import com.google.protobuf.FieldMask;

public class SyncUpdateDataScan {

  public static void main(String[] args) throws Exception {
    syncUpdateDataScan();
  }

  public static void syncUpdateDataScan() throws Exception {
    // 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/java/docs/setup#configure_endpoints_for_the_client_library
    try (DataScanServiceClient dataScanServiceClient = DataScanServiceClient.create()) {
      UpdateDataScanRequest request =
          UpdateDataScanRequest.newBuilder()
              .setDataScan(DataScan.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setValidateOnly(true)
              .build();
      DataScan response = dataScanServiceClient.updateDataScanAsync(request).get();
    }
  }
}

Python

Python

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Python במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Python API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_data_scan():
    # Create a client
    client = dataplex_v1.DataScanServiceClient()

    # Initialize request argument(s)
    data_scan = dataplex_v1.DataScan()
    data_scan.data.entity = "entity_value"

    request = dataplex_v1.UpdateDataScanRequest(
        data_scan=data_scan,
    )

    # Make the request
    operation = client.update_data_scan(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Ruby במדריך למתחילים של BigQuery באמצעות ספריות לקוח. למידע נוסף, קראו את מאמרי העזרה של BigQuery Ruby API.

כדי לבצע אימות ב-BigQuery, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

require "google/cloud/dataplex/v1"

##
# Snippet for the update_data_scan call in the DataScanService service
#
# 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/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::DataScanService::Client#update_data_scan.
#
def update_data_scan
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::DataScanService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateDataScanRequest.new

  # Call the update_data_scan method.
  result = client.update_data_scan request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

כדי לערוך סריקת פרופיל נתונים, משתמשים ב-method‏ dataScans.patch.

מחיקת סריקת פרופיל נתונים

המסוף

  1. במסוף Google Cloud , בדף Metadata curation של BigQuery, נכנסים לכרטיסייה Data profiling & quality.

    מעבר אל "יצירת פרופילים של נתונים ואיכות"

  2. לוחצים על הסריקה שרוצים למחוק.

  3. לוחצים על מחיקה ומאשרים את הפעולה כשמוצגת בקשה.

gcloud

כדי למחוק סריקת פרופיל נתונים, משתמשים בפקודה gcloud dataplex datascans delete:

gcloud dataplex datascans delete DATASCAN \
--location=LOCATION --async

מחליפים את המשתנים הבאים:

  • ‫DATASCAN: השם של סריקת פרופיל הנתונים שרוצים למחוק.
  • ‫LOCATION: האזור Google Cloud שבו נוצרה סריקת פרופיל הנתונים.

REST

כדי למחוק סריקת פרופיל נתונים, משתמשים בשיטה dataScans.delete.

המאמרים הבאים