שימוש בחבילות JavaScript

במאמר הזה מוסבר איך:

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

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

    מעבר אל Dataform

  2. מבצעים אחת מהפעולות הבאות או את שתיהן:

    1. כדי להתקין חבילה במאגר או לאמת חבילת NPM פרטית כדי לאפשר את ההתקנה שלה, פועלים לפי השלבים הבאים:
      1. בוחרים מאגר או יוצרים מאגר.
      2. בוחרים או יוצרים סביבת עבודה לפיתוח.
      3. אופציונלי: כדי להתקין חבילה פרטית, מאמתים את החבילה הפרטית.
      4. אם המאגר לא מכיל קובץ package.json, צריך ליצור קובץ package.json ולהעביר אליו את חבילת הליבה של Dataform.
    2. כדי ליצור חבילה, פועלים לפי השלבים הבאים:
      1. יוצרים מאגר Dataform שמוקדש לחבילה. שם המאגר צריך להיות זהה לשם החבילה.
      2. מקשרים את המאגר למאגר Git של צד שלישי שיארח את החבילה.
      3. יוצרים ומפעילים סביבת עבודה במאגר Dataform.

  3. חשוב לוודא שיש לכם את ההרשאות הנדרשות כדי לבצע את המשימות שמתוארות במסמך הזה.

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

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

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

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

התקנת חבילה

בקטע הזה מוסבר איך להתקין חבילת JavaScript ולייבא אותה לקובץ JavaScript ולקובץ SQLX, כדי שתוכלו להשתמש בחבילה כדי לפתח תהליכי עבודה ב-Dataform.

כדי להשתמש בחבילה ב-Dataform, צריך להתקין אותה במאגר.

אפשר להתקין את סוגי החבילות הבאים ב-Dataform:

לאחר מכן, כדי להשתמש בחבילה בקובץ JavaScript או SQLX, צריך לייבא את התוכן הרצוי מהחבילה לקובץ. אפשר גם לייבא חבילה שלמה לקובץ JavaScript או SQLX במקום התוכן שנבחר.

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

  • מציינים במפורש את גרסת החבילה ב-package.json, לדוגמה, 3.0.0. אל תשתמשו באפשרויות אחרות של dependencies package.json, למשל >version.

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

הוספת חבילה כתלות

כדי להתקין חבילה במאגר Dataform, צריך להוסיף אותה כהסתמכות בקובץ package.json:

  1. בסביבת העבודה, בחלונית Files (קבצים), לוחצים על package.json.

  2. מוסיפים את החבילה לבלוק dependencies:

    1. מוסיפים חבילת NPM ציבורית שפורסמה בפורמט הבא:

      "PACKAGE-NAME": "PACKAGE-VERSION"

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

      • ‫PACKAGE-NAME בשם החבילה.
      • ‫PACKAGE-VERSION עם הגרסה האחרונה של חבילת ה-NPM הציבורית שפורסמה. כדי למנוע בעיות בהתקנת החבילה, צריך לציין במפורש את הגרסה, לדוגמה, 3.0.0.

    2. מוסיפים חבילת NPM ציבורית שלא פורסמה בפורמט הבא:

      "PACKAGE-NAME": "PACKAGE-URL"

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

      • ‫PACKAGE-NAME בשם החבילה.
      • ‫PACKAGE-URL בכתובת ה-URL של מאגר החבילות של הצד השלישי tar.gz, לדוגמה https://github.com/user/sample-package-repository/archive/master.tar.gz.

    3. מוסיפים חבילת NPM פרטית מאומתת בפורמט הבא:

      "REGISTRY-SCOPE/PACKAGE-NAME": "PACKAGE-URL"

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

      • ‫REGISTRY-SCOPE בשם החבילה. REGISTRY-SCOPE צריך להיות זהה להיקף הרישום שמוגדר בקובץ .npmrc במאגר.
      • ‫PACKAGE-NAME בשם החבילה.
      • ‫PACKAGE-URL בכתובת ה-URL של מאגר החבילות tar.gz, לדוגמה https://github.com/user/sample-package-repository/archive/master.tar.gz.

  3. לוחצים על Install packages (התקנת חבילות).

  4. שומרים ודוחפים את השינויים.

בדוגמה הבאה של קוד אפשר לראות את חבילת המאפיינים הציבורית בקוד פתוח Slowly changing dimensions שנוספה לקובץ .package.json:

 ```json
 {
   "name": "repository-name",
   "dependencies": {
     "@dataform/core": "2.0.3",
     "dataform-scd": "https://github.com/dataform-co/dataform-scd/archive/0.3.tar.gz"
   }
 }
 ```

ייבוא של פונקציה או קבוע של חבילה לקובץ JavaScript ב-Dataform

כדי להשתמש בפונקציה או בקבוע מחבילה בתוך קובץ JavaScript ב-Dataform, קודם צריך לייבא אותם לקובץ.

כדי לייבא פונקציה או קבוע מחבילה לקובץ JavaScript, פועלים לפי השלבים הבאים:

  1. בסביבת העבודה, בחלונית Files (קבצים), בוחרים קובץ .js שבו רוצים להשתמש בחבילה.

  2. בקובץ, מייבאים פונקציה או קבוע בפורמט הבא:

    const {