תחילת העבודה עם Firebase Data Connect באופן מקומי

במדריך למתחילים הזה תלמדו איך לפתח את Firebase Data Connect באפליקציה באופן מקומי, בלי להגדיר מכונה של SQL בסביבת הייצור.

• מוסיפים את Firebase Data Connect לפרויקט Firebase.
• הגדרת סביבת פיתוח שכוללת תוסף של Visual Studio Code לעבודה עם מכונה מקומית.
• לאחר מכן נסביר איך:
  • יצירת סכימה לאפליקציית סרט
  • מגדירים שאילתות ומוטציות שישמשו באפליקציה
  • בדיקת השאילתות והמוטציות באמצעות נתונים לדוגמה במהלך בדיקה במהדורת אימולטור מקומית
  • יצירת ערכות SDK עם סוגים מוגדרים ושימוש בהן באפליקציה
  • פורסים את הסכימה, השאילתות והנתונים הסופיים בענן (אופציונלי, נדרש מינוי ל-Blaze).

דרישות מוקדמות

כדי להשתמש במדריך למתחילים הזה, צריך את הדברים הבאים:

• Linux,‏ macOS או Windows
• Visual Studio Code
• מתקינים את Node.js באמצעות nvm-windows ל-Windows או nvm ל-macOS או ל-Linux.
• אם עדיין לא עשיתם זאת, יוצרים פרויקט Firebase במסוף Firebase.

הגדרת סביבת הפיתוח

תצטרכו את Visual Studio Code כדי לנהל את הסכימה ולהגדיר שאילתות שישמשו את האפליקציה. ערכת SDK עם סוגים מוגדרים תיווצר עבורכם באופן אוטומטי:

1. יוצרים ספרייה חדשה לפרויקט המקומי.
2. פותחים את VS Code בספרייה החדשה.
3. מתקינים את התוסף Firebase Data Connect מ-Visual Studio Code Marketplace.

הגדרת ספריית הפרויקט

כדי להגדיר את הפרויקט המקומי, צריך לאתחל את ספריית הפרויקט. בחלונית הימנית של VS Code, לוחצים על סמל Firebase כדי לפתוח את ממשק המשתמש של התוסף של Data Connect ל-VS Code:

1. לוחצים על הלחצן כניסה באמצעות חשבון Google.
2. לוחצים על הלחצן Connect a Firebase project ובוחרים את הפרויקט שיצרתם קודם במסוף.
3. לוחצים על הלחצן Run firebase init.

4. לוחצים על הלחצן הפעלת אמולטורים.

יצירת סכימה

בספריית הפרויקט ב-Firebase, בקובץ /dataconnect/schema/schema.gql, מתחילים להגדיר סכימה של GraphQL בנושא סרטים.

סרט

ב-Data Connect, שדות GraphQL ממופים לעמודות. הסרט כולל את id, title, imageUrl וגם genre. Data Connect מזהה סוגי נתונים בסיסיים: String ו-UUID.

מעתיקים את קטע הקוד הבא או מסירים את ההערות מהשורות המתאימות בקובץ.

# By default, a UUID id key will be created by default as primary key.
# If you want to specify a primary key, say title, which you can do through
# the @table(key: "title") directive
type Movie @table {
  id: UUID! @default(expr: "uuidV4()")
  title: String!
  imageUrl: String!
  genre: String
}

מטא-נתונים של סרט

מעתיקים את קטע הקוד הבא או מבטלים את הוספת ההערה לשורות המתאימות בקובץ.

# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
  # This time, we omit adding a primary key because
  # you can rely on Data Connect to manage it.

  # @unique indicates a 1-1 relationship
  movie: Movie! @unique
  # movieId: UUID <- this is created by the above reference
  rating: Float
  releaseYear: Int
  description: String
}

שימו לב שהשדה movie ממופה לסוג Movie. Data Connect מבינה שמדובר בקשר בין Movie לבין MovieMetadata, ותנהל את הקשר הזה בשבילך.

מידע נוסף על סכימות של Data Connect זמין במסמכי התיעוד

הוספת נתונים לטבלאות

בחלונית העריכה של VS Code יופיעו לחצני CodeLens מעל סוגי GraphQL בקטע /dataconnect/schema/schema.gql. אפשר להשתמש בלחצנים Add data (הוספת נתונים) ו-Run (Local) (הפעלה (מקומית)) כדי להוסיף נתונים למסד הנתונים המקומי.

כדי להוסיף רשומות לטבלאות Movie ו-MovieMetadata:

1. באזור schema.gql, לוחצים על הלחצן Add data שמעל להצהרת הסוג Movie.
   
2. בקובץ Movie_insert.gql שנוצר, מקודדים את הנתונים של שלושת השדות.
3. לוחצים על הלחצן הפעלה (מקומית).
   
4. חוזרים על השלבים הקודמים כדי להוסיף רשומה לטבלה MovieMetadata, ומספקים את הערך של id של הסרט בשדה movieId, כפי שמופיע בהנחיה במונטיזציה (mutation) שנוצרה של MovieMetadata_insert.

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

1. חזרה ב-schema.gql, לוחצים על הלחצן Read data מעל להצהרת הטיפוס Movie.
2. בקובץ Movie_read.gql שנוצר, לוחצים על הלחצן Run (Local) כדי להריץ את השאילתה.

מידע נוסף על מוטציות של Data Connect זמין במסמכי התיעוד

הגדרת השאילתה

עכשיו מגיע החלק הכי כיף: נגדיר את השאילתות שתצטרכו באפליקציה. כמפתחים, אתם רגילים לכתוב שאילתות SQL ולא שאילתות GraphQL, ולכן יכול להיות שבהתחלה זה ייראה לכם קצת שונה. עם זאת, GraphQL הוא מצומצם הרבה יותר ומאובטח יותר מבחינת סוגים מ-SQL גולמי. ותוסף VS Code מקל על חוויית הפיתוח.

מתחילים לערוך את הקובץ /dataconnect/connector/queries.gql. כדי לקבל את כל הסרטים, צריך להשתמש בשאילתה כזו.

# File `/dataconnect/connector/queries.gql`

# @auth() directives control who can call each operation.
# Anyone should be able to list all movies, so the auth level is set to PUBLIC
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

מריצים את השאילתה באמצעות הלחצן של CodeLens שנמצא בקרבת מקום.

תכונה מעניינת מאוד היא היכולת להתייחס ליחסים של מסד הנתונים כגרף. מכיוון של-MovieMetadata יש שדה movie שמפנה לסרט, אפשר להטמיע את השדה ולקבל מידע על פרטי הסרט. אפשר לנסות להוסיף את הסוג שנוצר, movieMetadata_on_movie, לשאילתה ListMovies.

query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
    movieMetadata_on_movie {
        rating
    }
  }
}

מידע נוסף על שאילתות של Data Connect זמין במסמכי התיעוד

יצירת ערכות SDK ושימוש בהן באפליקציה

בחלונית הימנית של VS Code, לוחצים על סמל Firebase כדי לפתוח את ממשק המשתמש של התוסף של Data Connect ל-VS Code:

1. לוחצים על הלחצן Add SDK to app (הוספת SDK לאפליקציה).

2. בתיבת הדו-שיח שמופיעה, בוחרים ספרייה שמכילה את הקוד של האפליקציה. Data Connect. קוד ה-SDK ייוצר ויישמר שם.

3. בחרו את פלטפורמת האפליקציה ושימו לב שקוד ה-SDK נוצר מיד בספרייה שבחרתם.

איך משתמשים ב-SDK שנוצר כדי להפעיל שאילתות ומוטציות מאפליקציות לקוח (אינטרנט, Android,‏ iOS, ‏ Flutter).

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

אחרי שתסיימו את ההגדרה המקומית באפליקציה, תוכלו לפרוס את הסכימה, הנתונים והשאילתות בענן. כדי להגדיר מכונה של Cloud SQL, צריך מינוי Blaze.

1. עוברים לקטע Data Connect במסוף Firebase ויוצרים מכונה של Cloud SQL לתקופת ניסיון בחינם.

2. במסוף המובנה של VS Code, מריצים את הפקודה firebase init dataconnect ובוחרים את Region/Service ID שיצרתם זה עתה במסוף.

3. בוחרים באפשרות 'Y' כשמופיעה ההודעה 'File dataconnect/dataconnect.yaml already exists, Overwrite?'.

4. בממשק המשתמש של התוסף של Data Connect ל-VS Code, לוחצים על הלחצן פריסה בסביבת הייצור.

5. אחרי הפריסה, עוברים למסוף Firebase כדי לוודא שהסכימה, הפעולות והנתונים הועלאו לענן. אמורה להיות לכם אפשרות להציג את הסכימה ולהריץ את הפעולות במסוף. המכונה של Cloud SQL for PostgreSQL תתעדכן עם הסכימה והנתונים שנוצרו והופעלו.

השלבים הבאים

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

• במסוף Firebase ניתן להוסיף נתונים למסד הנתונים, לבדוק ולשנות את הסכימות, ולעקוב אחרי שירות Data Connect.

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

• מידע נוסף על פיתוח סכימה, שאילתות ומוטציה
• מידע נוסף על יצירת ערכות SDK ללקוח ועל קריאה לשאילתות ולמוטציות מקודק הלקוח ב-אינטרנט, ב-Android, ב-iOS וב-Flutter.