תחילת העבודה עם תוסף Looker ל-VS Code

התוסף Looker ל-VS Code מאפשר לפתח LookML ישירות בסביבת שולחן העבודה המקומית. הוא מספק הדגשה עשירה של תחביר, סנכרון קבצים דו-כיווני עם מופע Looker ושילוב עם סוכני AI לתכנות לצורך 'תכנות בשיטת Vibe coding'.

התוסף מבוסס על מסגרת Visual Studio Code (VS Code), והוא תומך בסביבות פיתוח משולבות (IDE) שמבוססות על VS Code IDE, כמו סביבות הפיתוח המשולבות וכלי התכנות הבאים:

  • Claude Code
  • Codex
  • סמן
  • Kiro
  • VS Code
  • גלישת רוח
  • Zed

סביבות פיתוח משולבות (IDE) שהן לא הסתעפויות של VS Code, כמו IntelliJ ו-Eclipse, לא נתמכות על ידי תוסף Looker ל-VS Code.

במדריך הזה מוסבר איך להגדיר את התוסף ולאמת אותו.

תהליך עבודה מבוסס-AI

התוסף Looker ל-VS Code הוא חלק מתהליך עבודה של פיתוח מבוסס-AI אקטיבי לעריכה וליצירה של קובצי LookML. כדי להפעיל את תהליך העבודה הזה, צריך להגדיר את הכלים הבאים:

  • התוסף של Looker ל-VS Code.
  • סביבת פיתוח משולבת (IDE) מקומית שמבוססת על VS Code. סביבת הפיתוח המשולבת צריכה להכיל סוכן AI מובנה (לדוגמה, Cursor), או, אם סביבת הפיתוח המשולבת לא מכילה סוכן AI מובנה (כמו VS Code בסיסי), היא צריכה להיות משולבת עם כלי AI עצמאי (כמו Gemini CLI או Claude Code). הוראות לחיבור סביבת הפיתוח המשולבת (IDE) לסוכן מופיעות במסמכי התיעוד של סביבת הפיתוח המשולבת המקומית.
  • שרת MCP, כמו MCP Toolbox for Databases.

מידע נוסף על תהליך העבודה מבוסס-AI זמין במאמר פיתוח בעזרת AI (תכנות בשיטת Vibe coding) ב-Looker.

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

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

  • חיבור לכלים מבוססי-AI: אם אתם מתכננים להשתמש בפיתוח בעזרת AI, אתם צריכים לחבר את סביבת הפיתוח המשולבת (IDE) ואת סוכן ה-AI ל-MCP Toolbox for Databases. לדוגמה, הגדרת דוגמה לחיבור של MCP Toolbox ל-Gemini CLI מופיעה במסמך שימוש ב-Looker עם MCP,‏ Gemini CLI וסוכנים אחרים. פרטים נוספים מופיעים במאמרי העזרה של הכלים.
  • הרשאות ב-Looker: כדי לערוך מודלים, צריכה להיות לכם הרשאת develop ב-Looker.
  • מכונה של Looker: במכונה צריכה לפעול גרסה Looker 26.6 ואילך.
  • התקנת Git: כדי לשכפל את מאגר LookML ולנהל אותו, צריך להתקין את Git במחשב המקומי.
  • הגדרת הפרויקט: צריך להגדיר את פרויקט LookML ל-Git.
  • מזהה לקוח ב-OAuth: אם אתם משתמשים באימות OAuth (מומלץ), אתם צריכים לקבל מזהה לקוח ב-OAuth מהאדמין של Looker.

הגדרות אדמין

אם הארגון שלכם משתמש ב-OAuth לאימות, אדמין ב-Looker צריך לרשום את תוסף Looker ל-VS Code כלקוח OAuth בממשק המשתמש של Looker Admin.

משתמשים ב-API Explorer של Looker כדי להגדיר שילוב של OAuth. אפשר לגשת אל API Explorer באחת מהדרכים הבאות:

  • אם API Explorer כבר מותקן במכונה של Looker, אפשר לגשת אליו באמצעות פורמט כתובת ה-URL הבא:

    https://LOOKER_INSTANCE_URL/extensions/marketplace_extension_api_explorer::api-explorer/

  • אם אין לכם את API Explorer במכונה של Looker, אתם יכולים להתקין אותו מ-Looker Marketplace. מידע נוסף מופיע בדף שימוש ב-API Explorer.

כדי לרשום את התוסף, פועלים לפי השלבים הבאים:

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

  2. כדי למלא את השדה client_guid:

    • צריך להשתמש במזהה ייחודי גלובלי.
    • צריך להיות מוכנים להפיץ את המזהה לכל מפתחי LookML שרוצים להשתמש בתוסף.

  3. בשביל redirect_uri, משתמשים ב:

    vscode://google.vscode-looker-official/oauth_callback

  4. ממלאים את הפרטים בטופס display_name ובטופס description כמו שמתואר במסמך רישום אפליקציית לקוח OAuth.

אחרי שהאפליקציה נרשמת, API Explorer מחזיר תגובה עם סיכום של הרישום. אתם יכולים להשתמש בנקודת הקצה Get OAuth Client App עם client_guid כדי לבדוק את פרטי הרישום.

מעבירים את client_guid שנוצר למפתחים, והם ישתמשו בו להגדרת התוסף.

התקנת התוסף

כדי להתקין את התוסף:

  1. מתקינים את התוסף של Looker ל-VS Code מ-Visual Studio Marketplace.
  2. פותחים את סביבת הפיתוח המשולבת (IDE), כמו VS Code או Cursor.
  3. לוחצים על סמל התוספים בסרגל הפעילות.
  4. מחפשים את התוסף של Looker ל-VS Code ולוחצים על Install (התקנה).
  5. אחרי התקנת התוסף, הסמל של Looker מופיע בסרגל הפעילות.

הגדרת התוסף

צריך להגדיר את התוסף עם פרטי מופע Looker בקובץ settings.json של סביבת העבודה.

  1. פותחים את חלון הפקודות (Command-Shift-P ב-Mac או Ctrl+Shift+P ב-Windows/Linux) כשסביבת העבודה פתוחה.
  2. מחפשים את האפשרות העדפות: פתיחת הגדרות Workspace‏ (JSON) ובוחרים בה.
  3. מוסיפים את משתני ההגדרה להגדרות. משתני ההגדרה משתנים בהתאם לשיטת האימות: OAuth או פרטי כניסה ל-API.

תהליך האימות המומלץ הוא OAuth 2.1. מדביקים את ההגדרות האלה בקובץ settings.json של סביבת העבודה.

{
  "looker.instanceUrl": "https://YOUR_INSTANCE_URL",
  "looker.oauthClientId": "YOUR_OAUTH_CLIENT_ID",
  "looker.projectId": "YOUR_PROJECT_ID"
}

מחליפים את מה שכתוב בשדות הבאים:

  • ‫https://YOUR_INSTANCE_URL: כתובת ה-URL של מופע Looker.
  • ‫YOUR_OAUTH_CLIENT_ID: מזהה הלקוח ב-OAuth ‏ (client_guid) שקיבלתם מאדמין Looker.
  • ‫YOUR_PROJECT_ID: שם הפרויקט שרוצים לערוך. כדי למצוא אותו, פותחים את דף הפרויקטים של LookML במופע Looker. מזהה הפרויקט מופיע בעמודה Project.

אימות באמצעות פרטי כניסה ל-API

אם אתם מעדיפים להשתמש במפתחות API של Looker, תוכלו לעיין בתיעוד כדי ליצור פרטי כניסה ל-API. צריך גם לספק את מזהה הפרויקט.

{
  "looker.instanceUrl": "https://YOUR_INSTANCE_URL",
  "looker.clientId": "YOUR_CLIENT_ID",
  "looker.clientSecret": "YOUR_CLIENT_SECRET",
  "looker.projectId": "YOUR_PROJECT_ID"
}

מחליפים את מה שכתוב בשדות הבאים:

  • ‫https://YOUR_INSTANCE_URL: כתובת ה-URL של מופע Looker.
  • ‫YOUR_CLIENT_ID ו-YOUR_CLIENT_SECRET: מזהה הלקוח וסוד הלקוח של פרטי הכניסה ל-API שבהם אתם משתמשים לאימות. כדי למצוא את פרטי הכניסה האלה, פותחים את דף החשבון במופע Looker, ואז בקטע מפתחות API לוחצים על הלחצן ניהול. ייפתח הדף API Keys שבו אפשר לראות את מזהי הלקוחות והסודות.
  • ‫YOUR_PROJECT_ID: שם הפרויקט שרוצים לערוך. כדי למצוא את שם הפרויקט, פותחים את הדף LookML Projects במופע Looker. מזהה הפרויקט מופיע בעמודה Project.

הגדרות

אפשר להגדיר את ההגדרות הבאות של MCP בסביבת העבודה של ה-IDE.

הגדרה תיאור ברירת מחדל
looker.instanceURL כתובת ה-URL הבסיסית של המופע ב-Looker (לדוגמה, https://mycompany.looker.com). -
looker.authURL כתובת ה-URL לשימוש באימות OAuth. ההגדרה הזו נדרשת רק אם היא שונה מכתובת ה-URL של המופע. looker.instanceURL
looker.sdkURL כתובת ה-URL שמשמשת לבקשות API. הגדרה נדרשת רק אם היא שונה מכתובת ה-URL של המופע. looker.instanceURL
looker.oauthClientId מזהה לקוח ב-OAuth של Looker. נדרש עבור OAuth. -
looker.clientId מזהה הלקוח ב-Looker API. נדרש לאימות מפתח API. -
looker.clientSecret ‫Looker API Client Secret. נדרש לאימות מפתח API. -
looker.projectId מזהה הפרויקט ב-Looker. -
looker.mcpServerUrl כתובת ה-URL של שרת ה-MCP החיצוני ל-Proxy (לדוגמה, http://localhost:5000/mcp). -
looker.acceptSelfSignedCertificates התעלמות משגיאות באישור SSL (לדוגמה, באישורים בחתימה עצמית). אזהרה: לא מומלץ להפעיל את האפשרות הזו. false
looker.askBeforeOverwritingRemote לשאול תמיד לפני החלפת קבצים מרוחקים כשיש התנגשות. false

אימות דרך Looker

אם אתם משתמשים באימות OAuth, אתם צריכים להיכנס לחשבון Looker כדי לקשר את סביבת הפיתוח המשולבת המקומית לחשבון Looker.

  1. פותחים את לוח הפקודות.
  2. מריצים את הפקודה: Looker: Sign In (OAuth).
  3. מאשרים את ההנחיה לפתוח את הדפדפן.
  4. בדפדפן, מאשרים לתוסף לגשת לחשבון Looker.
  5. אחרי האישור, הדפדפן מפנה בחזרה ל-IDE. אמורה להופיע הודעה שאומרת התחברת בהצלחה ל-Looker!

שכפול פרויקט של LookML

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

  1. ב-VS Code, פותחים חלון חדש.
  2. פותחים את לוח הפקודות ובוחרים באפשרות Git: Clone (‏Git: שיבוט).
  3. מזינים את כתובת ה-URL של מאגר Git מרוחק (לדוגמה, מ-GitHub או מ-GitLab) ובוחרים תיקייה מקומית.
  4. פותחים את התיקייה המשוכפלת בסביבת הפיתוח המשולבת.

התוסף מזהה אוטומטית את קובצי ה-LookML ומתחיל לסנכרן עם הענף שהוצאתם ב-Development Mode (מצב פיתוח) במכונת Looker שלכם.

פתרון בעיות

אפשר לראות את יומני התוספים בחלונית Output של סביבת הפיתוח המשולבת (IDE). בוחרים בערוץ Looker כדי לראות את היומנים. כדי לראות יומנים מפורטים יותר, פותחים את לוח הפקודות, מריצים את הפקודה Developer: Set Log Level ובוחרים באפשרות Debug או Trace.

  • שגיאות אימות: מוודאים שהפרטים של looker.instanceUrl ושל looker.oauthClientId נכונים. צריך לוודא שמזהה ה-URI להפניה אוטומטית ב-Looker זהה בדיוק.
  • בעיות בסנכרון: כדאי לבדוק את יומני התוסף כדי לפתור בעיות בסנכרון. כדי להציג את היומנים, פותחים את החלונית Output ובוחרים באפשרות Looker מהתפריט הנפתח.
  • תגובה של בקשה שגויה במהלך OAuth: מוודאים שאפשר לגשת למופע Looker מהרשת המקומית ושיש חיבור אינטרנט תקין.

אם נתקלים בבעיות בתוסף, אפשר להריץ את הפקודה Developer: Reload Window מלוח הפקודות כדי לפתור אותן.

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