במאמר הזה מוסבר איך לחפש נכסי נתונים ב-Knowledge Catalog.
לפני שמתחילים
לפני שמבצעים חיפוש, צריך לוודא שהוקצו לכם התפקידים הנדרשים ושהפעלתם את ה-API הדרוש.
התפקידים הנדרשים
כדי לקבל את ההרשאות שדרושות בשביל לחפש רשומות ולגשת לתוצאות החיפוש ב-Knowledge Catalog, אתם צריכים לבקש מהאדמין לתת לכם את התפקידים הבאים ב-IAM:
-
חיפוש ערכים:
- אדמין של Dataplex Catalog (
roles/dataplex.catalogAdmin) בפרויקט שמשמש לחיפוש - Dataplex Catalog Editor (
roles/dataplex.catalogEditor) בפרויקט שמשמש לחיפוש - Dataplex Catalog Viewer (
roles/dataplex.catalogViewer) בפרויקט שמשמש לחיפוש
- אדמין של Dataplex Catalog (
-
חיפוש מטא-נתונים של מערכי נתונים וטבלאות ב-BigQuery:
BigQuery Metadata Viewer (צפייה במטא-נתונים של BigQuery) (
roles/bigquery.metadataViewer) במערך הנתונים או בטבלה -
חיפוש ערכים בהתאמה אישית:
Dataplex Catalog Viewer (
roles/dataplex.catalogViewer) בפרויקט שמשמש לחיפוש
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
הרשאות ברמת הנכס
תוצאות החיפוש מוגבלות לרמת הגישה שלכם, ללא קשר לפרויקט שנבחר. כדי למצוא נכס ב-Knowledge Catalog, צריכות להיות לכם הרשאות קריאה מתאימות למשאב במערכת המקור הבסיסית שלו.
לדוגמה, כדי למצוא טבלה ב-BigQuery צריך את התפקיד roles/bigquery.metadataViewer, וכדי למצוא מופע של Cloud SQL צריך את המקבילה שלו, הרשאות Cloud SQL. פרטים נוספים זמינים במאמר בנושא היקף החיפוש.
הפעלת ה-API
מפעילים את Dataplex API.
תפקידים שנדרשים להפעלת ממשקי API
כדי להפעיל ממשקי API, נדרשת ההרשאה serviceusage.services.enable. אם יצרתם את הפרויקט, סביר להניח שכבר יש לכם את ההרשאה הזו דרך התפקיד 'בעלים' (roles/owner). אחרת, תוכלו לקבל את ההרשאה הזו דרך התפקיד 'אדמין של Service Usage' (roles/serviceusage.serviceUsageAdmin). כך מקצים תפקידים.
חיפוש מקורות מידע
המסוף
כדי לחפש משאבים, פועלים לפי השלבים הבאים:
נכנסים לדף Search בקטלוג הידע במסוף Google Cloud .
אם מופיעה ההנחיה רוצה לנסות חיפוש בשפה טבעית?, לוחצים עליה. כברירת מחדל, האפשרות 'חיפוש בשפה טבעית' מסומנת.
בשדה חיפוש משאבים בכל הפרויקטים באמצעות שפה טבעית, מזינים את השאילתה ולוחצים על Enter.
כדי לצמצם את החיפוש, לוחצים על מסננים.
- מסננים בכמה קטעים מוערכים באמצעות האופרטור הלוגי
AND. - כדי להוסיף כמה מסננים לאותו קטע, משתמשים באופרטור הלוגי
OR.
אלה המסננים שזמינים:
- Scope: חיפוש בכל הארגון (ברירת מחדל), בפרויקט הנוכחי או רק במשאבים המסומנים בכוכב. מידע נוסף זמין במאמר בנושא היקף החיפוש.
- Systems: Google Cloud השירות שאליו משתייך המשאב, כמו BigQuery. מערכת Knowledge Catalog מכילה קבוצות של רשומות.
- Projects: הפרויקטים שבהם יתבצע החיפוש.
- סוג: סוג המשאב, כמו חיבור ל-BigQuery, קטגוריה של Cloud Storage או מסד נתונים. בהתאם לסוג המשאב, אפשר גם לסנן לפי סוג משנה, כמו סוג החיבור או ניב SQL.
- בחירת מיקומים: המיקומים שבהם יתבצע החיפוש.
- בחירת מערכי נתונים: תוצאות החיפוש מוגבלות למשאבי BigQuery ששייכים למערכי הנתונים שנבחרו ב-BigQuery. בשדה Type to filter (הקלדה לסינון), מזינים את השם של מערך הנתונים.
- סוגי היבטים: סוגי ההיבטים ב-Knowledge Catalog שמשויכים למשאב שאתם מחפשים. כדי לסנן לפי ערכי מאפיינים, לוחצים על סינון לפי ערכי סוג מאפיין ואז בוחרים את הערכים.
- מסננים בכמה קטעים מוערכים באמצעות האופרטור הלוגי
כדי לראות מידע נוסף על המשאב שחיפשתם, לוחצים על שם המשאב בתוצאות החיפוש כדי לפתוח את דף פרטי הרשומה.
Google Cloud CLI
כדי לחפש משאבים, משתמשים בפקודה gcloud dataplex entries search:
gcloud dataplex entries search 'foo' \ --project=PROJECT_ID \ --semantic-search
מחליפים את PROJECT_ID במזהה Google Cloud הפרויקט.
C#
C#
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי C#ההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog C# API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
המשך
Go
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Goההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Go API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Java
Java
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Javaההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Java API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Node.js
Node.js
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Node.jsההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Node.js API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
PHP
PHP
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי PHPההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog PHP API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Python
Python
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Pythonההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Python API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Ruby
Ruby
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Rubyההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Ruby API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
REST
כדי לחפש משאבים, משתמשים ב-method searchEntries כשפרמטר SemanticSearch מוגדר ל-true.
POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchEntries?query=foo&semanticSearch=true
מחליפים את מה שכתוב בשדות הבאים:
- PROJECT_ID: מזהה הפרויקט ב- Google Cloud
- LOCATION: האזור שבו הפרויקט קיים (לדוגמה,
us-central1)
הצגת פרטים של נכס שהוחזר על ידי חיפוש
המסוף
משתמשים בחיפוש ב-Knowledge Catalog כדי לראות את הפרטים של נכס.
חיפוש נכס ב-Knowledge Catalog.
בתוצאות החיפוש, לוחצים על הנכס שרוצים לראות את הפרטים שלו.
ייפתח דף הפרטים של הרשומה. הדף כולל את הקטעים הבאים:
- פרטי הרשומה: כוללים מידע כמו סוג הרשומה, המערכת, הפלטפורמה, השם המוגדר במלואו, זמן היצירה, זמן השינוי האחרון, התיאור והאחראים.
- סקירה כללית: סקירה כללית של הערך, אם היא זמינה.
- מאפיינים: המאפיינים הנדרשים והאופציונליים שהוגדרו לרשומה. מידע נוסף זמין במאמר בנושא קטגוריות של היבטים.
gcloud
פקודת gcloud dataplex entries lookup:
gcloud dataplex entries lookup ENTRY_ID \ --entry-group=ENTRY_GROUP_ID \ --location=LOCATION \ --project=PROJECT_ID
מחליפים את מה שכתוב בשדות הבאים:
-
ENTRY_ID: המזהה של הרשומה -
ENTRY_GROUP_ID: המזהה של קבוצת הרשומות -
LOCATION: האזור שבו הפרויקט קיים -
PROJECT_ID: המזהה של Google Cloud הפרויקט
C#
C#
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי C#ההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog C# API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
המשך
Go
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Goההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Go API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Java
Java
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Javaההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Java API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Node.js
Node.js
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Node.jsההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Node.js API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
PHP
PHP
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי PHPההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog PHP API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Python
Python
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Pythonההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Python API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
Ruby
Ruby
לפני שמנסים את הדוגמה הזו, צריך לפעול לפי Rubyההוראות להגדרה במאמר מדריך למתחילים לעבודה עם Knowledge Catalog באמצעות ספריות לקוח. מידע נוסף מופיע במאמרי העזרה של Knowledge Catalog Ruby API.
כדי לבצע אימות לקטלוג הידע, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.
REST
כדי לראות את פרטי הנכס, משתמשים בשיטה lookupEntry.
מגבלות
אלו המגבלות שחלות על חיפוש:
- משאבים ציבוריים לא נכללים בחיפוש בשפה טבעית.
- היבטים שמצורפים לקישורי כניסה לא נכללים בחיפוש בשפה טבעית.
המאמרים הבאים
- הסבר על תחביר החיפוש ב-Knowledge Catalog
- מידע נוסף על ניהול מטא-נתונים ב-Knowledge Catalog
- איך מעשירים רשומות וקישורים לרשומות במטא-נתונים באמצעות היבטים
- איך מנהלים רשומות ומייבאים מקורות בהתאמה אישית
- אפשר לנסות תרחישי שימוש ב-Knowledge Catalog.
- אפשר להשתמש בסוכן הגילוי של Knowledge Catalog כדי לקבל תשובות לשאילתות מורכבות בשפה טבעית.