סכימות, שאילתות ומוטציות של Data Connect

באמצעות Firebase Data Connect אפשר ליצור מחברים למכונות PostgreSQL שמנוהלות באמצעות Google Cloud SQL. המחברים האלה הם שילובים של סכימה, שאילתות ומוטציות לשימוש בנתונים שלכם.

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

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

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

הסכימה של אפליקציה לביקורות על סרטים

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

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

טבלת סרטים

הסכימה של Movies מכילה הנחיות ליבה כמו:

  • @table(name) ו-@col(name) כדי להתאים אישית את שמות הטבלה והעמודה ב-SQL. אם לא מציינים שם, מערכת Data Connect יוצרת שמות מסוג snake_case.
  • @col(dataType) כדי להתאים אישית את סוגי העמודות ב-SQL.
  • @default כדי להגדיר ערכי ברירת מחדל של עמודות SQL במהלך ההוספה.

פרטים נוספים זמינים במסמכי העזרה של @table, @col ו-@default.

# Movies
type Movie @table(name: "movie", key: "id") {
  id: UUID! @col(name: "movie_id") @default(expr: "uuidV4()")
  title: String!
  releaseYear: Int
  genre: String @col(dataType: "varchar(20)")
  rating: Int
  description: String
}

מפתחות סקלריים וערכים של שרתים

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

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

באמצעות ערכי שרת, אפשר לאפשר לשרת לאכלס באופן דינמי שדות בטבלאות באמצעות ערכים שמאוחסנים או ניתנים לחישוב בקלות, בהתאם לביטויי CEL ספציפיים בצד השרת בארגומנט expr. לדוגמה, אפשר להגדיר שדה עם חותמת זמן שתחול כשניגשים לשדה באמצעות הזמן שנשמר בבקשת הפעולה, updatedAt: Timestamp! @default(expr: "request.time").

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

עכשיו נלמד לעקוב אחרי במאי סרטים, וגם להגדיר יחס אחד-ל-אחד עם Movie.

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

אפשר להשתמש בהנחיה @ref כדי להתאים אישית את האילוץ של מפתח זר.

  • @ref(fields) כדי לציין את שדות המפתח הזר.
  • @ref(references) כדי לציין את השדות שאליהם מתייחסים בטבלת היעד. ברירת המחדל של ההפניה הזו היא למפתח הראשי, אבל יש תמיכה גם בשדות עם @unique.

מידע נוסף זמין במאמרי העזרה של @ref.

# Movie Metadata
# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
  # @unique ensures that each Movie only has one MovieMetadata.
  movie: Movie! @unique
  # Since it references to another table type, it adds a foreign key constraint.
  #  movie: Movie! @unique @ref(fields: "movieId", references: "id")
  #  movieId: UUID! <- implicitly added foreign key field
  director: String
}

Actor ו-MovieActor

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

# Actors
# Suppose an actor can participate in multiple movies and movies can have multiple actors
# Movie - Actors (or vice versa) is a many to many relationship
type Actor @table {
  id: UUID! @default(expr: "uuidV4()")
  name: String! @col(dataType: "varchar(30)")
}
# Join table for many-to-many relationship for movies and actors
# The 'key' param signifies the primary keys of this table
# In this case, the keys are [movieId, actorId], the foreign key fields of the reference fields [movie, actor]
type MovieActor @table(key: ["movie", "actor"]) {
  movie: Movie!
  # movieId: UUID! <- implicitly added foreign key field
  actor: Actor!
  # actorId: UUID! <- implicitly added foreign key field
  role: String! # "main" or "supporting"
  # optional other fields
}

משתמש

לבסוף, משתמשים באפליקציה.

# Users
# Suppose a user can leave reviews for movies
type User @table {
  id: String! @default(expr: "auth.uid")
  username: String! @col(dataType: "varchar(50)")
}

סוגי הנתונים הנתמכים

Data Connect תומך בסוגי הנתונים הסקלריים הבאים, עם הקצאות לסוגים של PostgreSQL באמצעות @col(dataType:).

Data Connect type סוג מובנה של GraphQL או
סוג Data Connect בהתאמה אישית 		סוג ברירת המחדל של PostgreSQL סוגי PostgreSQL נתמכים
(כינוי בסוגריים)
String GraphQL טקסט text
bit(n), varbit(n)
char(n), varchar(n)
Int GraphQL int Int2‏ (smallint, ‏ smallserial), ‏
int4‏ (integer, ‏ int, ‏ serial)
Float GraphQL float8 float4 (מספר ממשי)
float8 (דיוק כפול)
numeric (עשרוני)
בוליאני GraphQL בוליאני בוליאני
מזהה ייחודי אוניברסלי (UUID) בהתאמה אישית uuid uuid
Int64 בהתאמה אישית bigint int8‏ (bigint, ‏ bigserial)
numeric (decimal)
תאריך בהתאמה אישית date תאריך
חותמת זמן בהתאמה אישית timestamptz

timestamptz

הערה: פרטי אזור הזמן המקומי לא נשמרים.
PostgreSQL ממירה ומאחסנת חותמות זמן כאלה כ-UTC.
Vector בהתאמה אישית vector

וקטור

ביצוע חיפוש דמיון וקטורי באמצעות Vertex AI
  • List ב-GraphQL ממופה למערך דו-מימדי.
    • לדוגמה, [Int] ממופה אל int5[], ו-[Any] ממופה אל jsonb[].
    • אין תמיכה במערכים בתצוגת עץ ב-Data Connect.

שימוש בשדות שנוצרו כדי ליצור שאילתות ומוטציות

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

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

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

שמות שדות שנוצרים באופן אוטומטי

Data Connect מסיק שמות מתאימים לשדות שנוצרים באופן אוטומטי על סמך ההצהרות של סוגי הסכימות. לדוגמה, אם עובדים עם מקור של PostgreSQL ומגדירים טבלה בשם Movie, השרת ייצור:

  • שדות לקריאת נתונים בתרחישי שימוש עם טבלה אחת, עם השמות הידידותיים movie (יחיד, לאחזור תוצאות בודדות עם העברת ארגומנטים כמו eq) ו-movies (רבים, לאחזור רשימות תוצאות עם העברת ארגומנטים כמו gt ופעולות כמו orderby). Data Connect יוצר גם שדות לפעולות יחסיות עם כמה טבלאות, עם שמות מפורשים כמו actors_on_movies או actors_via_actormovie.
  • שדות לכתיבה של נתונים עם שם מוכר כמו movie_insert,‏ movie_upsert…

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

הנחיות לשאילתות ולמוטציות

בנוסף להנחיות שבהן משתמשים להגדרת סוגים וטבלאות, ב-Data Connect יש את ההנחיות @auth, ‏ @check, ‏ @redact ו-@transaction להרחבת ההתנהגות של שאילתות ומוטציות.

דירקטיבה רלוונטי ל: תיאור
@auth שאילתות ומוטציות הגדרת מדיניות האימות לשאילתה או למוטציה. המדריך לאימות והרשאה
@check שאילתות לחיפוש נתוני הרשאה בדיקה שהשדות שצוינו נמצאים בתוצאות השאילתה. ביטוי של Common Expression Language ‏ (CEL) משמש לבדיקת ערכי השדות. המדריך לאימות והרשאה
@redact שאילתות מחיקה של חלק מהתשובה מהלקוח. המדריך לאימות והרשאה
@transaction מוטציות אכיפה של כך שטרנספורמציה תמיד תרוץ בטרנזקציה של מסד נתונים. דוגמאות למוטציות של אפליקציות סרטים

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

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

במדריך למתחילים, השאילתה לדוגמה listEmails לא כללה פרמטרים. כמובן, במקרים רבים הנתונים שיועברו לשדות השאילתה יהיו דינמיים. אפשר להשתמש בתחביר $variableName כדי לעבוד עם משתנים כאחד מהרכיבים של הגדרת השאילתה.

כך נראית השאילתה הבאה:

  • הגדרת סוג query
  • שם של פעולה (שאילתה) ב-ListMoviesByGenre
  • ארגומנט פעולה של משתנה יחיד $genre
  • הוראה יחידה, @auth.
query ListMoviesByGenre($genre: String!) @auth(level: USER)

לכל ארגומנט של שאילתה נדרשת הצהרת סוג, סוג מובנה כמו String או סוג מותאם אישית שמוגדר בסכימה כמו Movie.

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

מפתחות סקלר בשאילתות

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

Data Connect מגדיר סוג מיוחד למשתני מפתח סקלריים, שמזוהים באמצעות _Key. לדוגמה, הסוג של מפתח סקלרי בטבלה Movie הוא Movie_Key.

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

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

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

query GetMovie($myKey: Movie_Key!) {
  movie(key: $myKey) { title }
}

אפשר לספק אותם בבקשה בפורמט JSON כך (או בפורמטים אחרים של שרשור):

{
  # …
  "variables": {
    "myKey": {"foo": "some-string-value", "bar": 42}
  }
}

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

שימוש בכינויים בשאילתות

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

זוהי שאילתה שבה ביטוי משתמש בכינוי mostPopular.

query ReviewTopPopularity($genre: String) {
  mostPopular: review(first: {
    where: {genre: {eq: $genre}},
    orderBy: {popularity: DESC}
  }) { … }
}

שאילתות פשוטות עם מסננים

שאילתות Data Connect ממפות לכל המסננים והפעולות הנפוצות של SQL.

אופרטורים where ו-orderBy (שאילתות יחיד, שאילתות רבים)

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

query MovieByTopRating($genre: String) {
  mostPopular: movies(
     where: { genre: { eq: $genre } }, orderBy: { rating: DESC }
  ) {
    # graphql: list the fields from the results to return
    id
    title
    genre
    description
  }
}

query MoviesByReleaseYear($min: Int, $max: Int) {
  movies(where: {releaseYear: {le: $max, ge: $min}}, orderBy: [{releaseYear: ASC}]) { … }
}

אופרטורים limit ו-offset (שאילתות יחיד, שאילתות רבים)

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

query MoviesTop10 {
  movies(orderBy: [{ rating: DESC }], limit: 10) {
    # graphql: list the fields from the results to return
    title
  }
}

כולל בשדות מערך

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

# Filter using arrays and embedded fields.
query ListMoviesByTag($tag: String!) {
  movies(where: { tags: { includes: $tag }}) {
    # graphql: list the fields from the results to return
    id
    title
  }
}

פעולות על מחרוזות וביטויים רגולריים

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

query MoviesTitleSearch($prefix: String, $suffix: String, $contained: String, $regex: String) {
  prefixed: movies(where: {title: {startsWith: $prefix}}) {...}
  suffixed: movies(where: {title: {endsWith: $suffix}}) {...}
  contained: movies(where: {title: {contains: $contained}}) {...}
  matchRegex: movies(where: {title: {pattern: {regex: $regex}}}) {...}
}

or ו-and למסננים מורכבים

משתמשים ב-or וב-and ללוגיקה מורכבת יותר.

query ListMoviesByGenreAndGenre($minRating: Int!, $genre: String) {
  movies(
    where: { _or: [{ rating: { ge: $minRating } }, { genre: { eq: $genre } }] }
  ) {
    # graphql: list the fields from the results to return
    title
  }
}

שאילתות מורכבות

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

בשאילתות כאלה נעשה שימוש בתחביר הקסם Data Connect _on_ ו-_via בשדות הקריאה שנוצרו.

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

רבים לאחד

נוסיף ביקורות לאפליקציה באמצעות טבלה מסוג Review ושינוי ב-User.

# User table is keyed by Firebase Auth UID.
type User @table {
  # `@default(expr: "auth.uid")` sets it to Firebase Auth UID during insert and upsert.
  id: String! @default(expr: "auth.uid")
  username: String! @col(dataType: "varchar(50)")
  # The `user: User!` field in the Review table generates the following one-to-many query field.
  #  reviews_on_user: [Review!]!
  # The `Review` join table the following many-to-many query field.
  #  movies_via_Review: [Movie!]!
}

# Reviews is a join table tween User and Movie.
# It has a composite primary keys `userUid` and `movieId`.
# A user can leave reviews for many movies. A movie can have reviews from many users.
# User  <-> Review is a one-to-many relationship
# Movie <-> Review is a one-to-many relationship
# Movie <-> User is a many-to-many relationship
type Review @table(name: "Reviews", key: ["movie", "user"]) {
  user: User!
  # The user field adds the following foreign key field. Feel free to uncomment and customize it.
  #  userUid: String!
  movie: Movie!
  # The movie field adds the following foreign key field. Feel free to uncomment and customize it.
  #  movieId: UUID!
  rating: Int
  reviewText: String
  reviewDate: Date! @default(expr: "request.time")
}

שאילתות מסוג 'רבים לאחד'

עכשיו נבחן שאילתה עם כינוי כדי להמחיש את תחביר _via_.

query UserMoviePreferences($username: String!) @auth(level: USER) {
  users(where: { username: { eq: $username } }) {
    likedMovies: movies_via_Review(where: { rating: { ge: 4 } }) {
      title
      genre
    }
    dislikedMovies: movies_via_Review(where: { rating: { le: 2 } }) {
      title
      genre
    }
  }
}

אחד על אחד

אפשר לראות את התבנית. בהמשך, הסכימה שונתה לצורך המחשה.

# Movies
type Movie
  @table(name: "Movies", singular: "movie", plural: "movies", key: ["id"]) {
  id: UUID! @col(name: "movie_id") @default(expr: "uuidV4()")
  title: String!
  releaseYear: Int @col(name: "release_year")
  genre: String
  rating: Int @col(name: "rating")
  description: String @col(name: "description")
  tags: [String] @col(name: "tags")
}
# Movie Metadata
# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata
  @table(
    name: "MovieMetadata"
  ) {
  # @ref creates a field in the current table (MovieMetadata) that holds the primary key of the referenced type
  # In this case, @ref(fields: "id") is implied
  movie: Movie! @ref
  # movieId: UUID <- this is created by the above @ref
  director: String @col(name: "director")
}


extend type MovieMetadata {
  movieId: UUID! # matches primary key of referenced type
...
}

extend type Movie {
  movieMetadata: MovieMetadata # can only be non-nullable on ref side
  # conflict-free name, always generated
  movieMetadatas_on_movie: MovieMetadata
}

שאילתות של אחד לאחד

אפשר לשלוח שאילתות באמצעות תחביר _on_.

# One to one
query GetMovieMetadata($id: UUID!) @auth(level: PUBLIC) {
  movie(id: $id) {
    movieMetadatas_on_movie {
      director
    }
  }
}

רבים לרבים

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

# MovieActors Join Table Definition
type MovieActors @table(
  key: ["movie", "actor"] # join key triggers many-to-many generation
) {
  movie: Movie!
  actor: Actor!
}

# generated extensions for the MovieActors join table
extend type MovieActors {
  movieId: UUID!
  actorId: UUID!
}

# Extensions for Actor and Movie to handle many-to-many relationships
extend type Movie {
  movieActors: [MovieActors!]! # standard many-to-one relation to join table
  actors: [Actor!]! # many-to-many via join table

  movieActors_on_actor: [MovieActors!]!
  # since MovieActors joins distinct types, type name alone is sufficiently precise
  actors_via_MovieActors: [Actor!]!
}

extend type Actor {
  movieActors: [MovieActors!]! # standard many-to-one relation to join table
  movies: [Movie!]! # many-to-many via join table

  movieActors_on_movie: [MovieActors!]!
  movies_via_MovieActors: [Movie!]!
}

שאילתות ליחס 'רבים לרבים'

נבחן שאילתה עם כינוי כדי להמחיש את התחביר של _via_.

query GetMovieCast($movieId: UUID!, $actorId: UUID!) @auth(level: PUBLIC) {
  movie(id: $movieId) {
    mainActors: actors_via_MovieActor(where: { role: { eq: "main" } }) {
      name
    }
    supportingActors: actors_via_MovieActor(
      where: { role: { eq: "supporting" } }
    ) {
      name
    }
  }
  actor(id: $actorId) {
    mainRoles: movies_via_MovieActor(where: { role: { eq: "main" } }) {
      title
    }
    supportingRoles: movies_via_MovieActor(
      where: { role: { eq: "supporting" } }
    ) {
      title
    }
  }
}

שאילתות צבירת נתונים

מהם נתונים מצטברים ולמה כדאי להשתמש בהם?

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

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

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

  • ביצועים מהירים יותר של האפליקציה (כי אין צורך לבצע חישובים בצד הלקוח)
  • הפחתת עלויות תעבורת הנתונים היוצאת (כי שולחים רק את התוצאות המצטברות במקום את כל הקלט)
  • אבטחה משופרת (כי אפשר לתת ללקוחות גישה לנתונים מצטברים במקום לכל קבוצת הנתונים)

דוגמה לסכימה של צבירה

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

  type Product @table {
    name: String!
    manufacturer: String!
    quantityInStock: Int!
    price: Float!
    expirationDate: Date
  }

צבירה פשוטה

_count לכל השדות

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

שאילתה תגובה 
one
 
query CountProducts {
  products {
    _count
  }
}

לדוגמה, אם יש לכם 5 מוצרים במסד הנתונים, התוצאה תהיה:

{
  "products": [
    {
    "_count": 5
    }
  ]
}

לכל השדות יש שדה <field>_count, שסופר את מספר השורות שיש להן ערך שאינו null בשדה הזה.

שאילתה תגובה
field_count
 
query CountProductsWithExpirationDate {
  products {
    expirationDate_count
  }
}

לדוגמה, אם יש לכם 3 מוצרים עם תאריך תפוגה, התוצאה תהיה:

{
  "products": [
    {
    "expirationDate_count": 3
    }
  ]
}
_min,‏ _max,‏ _sum ו-_avg לשדות מספריים

גם לשדות מספריים (int,‏ float,‏ int64) יש את הערכים <field>_min,‏ <field>_max,‏ <field>_sum ו-<field>_avg.

שאילתה תגובה
_min _max _sum _avg
 
query NumericAggregates {
  products {
  quantityInStock_max
  price_min
  price_avg
  quantityInStock_sum
  }
}

לדוגמה, אם יש לכם את המוצרים הבאים:

  • מוצר א': quantityInStock: 10, ‏ price: 2.99
  • מוצר ב': quantityInStock: 5, ‏ price: 5.99
  • מוצר ג': quantityInStock: 20, ‏ price: 1.99

התוצאה תהיה:

{
  "products": [
    {
    "quantityInStock_max": 20,
    "price_min": 1.99,
    "price_avg": 3.6566666666666666,
    "quantityInStock_sum": 35
    }
  ]
}
_min ו-_max לתאריכים ולחותמות זמן

בשדות התאריך וחותמת הזמן מופיעים הערכים <field>_min ו-<field>_max.

שאילתה תגובה
_min _maxdatetime
 
query DateAndTimeAggregates {
  products {
  expirationDate_max
  expirationDate_min
  }
}

לדוגמה, אם תאריכי התפוגה הם:

  • מוצר א': 2024-01-01
  • מוצר ב': 2024-03-01
  • מוצר ג': 2024-02-01

התוצאה תהיה:

{
  "products": [
    {
    "expirationDate_max": "2024-03-01",
    "expirationDate_min": "2024-01-01"
    }
  ]
}

ייחודי

הארגומנט distinct מאפשר לקבל את כל הערכים הייחודיים של שדה (או שילוב של שדות). לדוגמה:

שאילתה תגובה
distinct
query ListDistinctManufacturers {
  products(distinct: true) {
    manufacturer
  }
}

לדוגמה, אם יש לכם את היצרנים הבאים:

  • מוצר א': manufacturer: "Acme"
  • מוצר ב': manufacturer: "Beta"
  • מוצר ג': manufacturer: "Acme"

התוצאה תהיה:

{
  "products": [
    { "manufacturer": "Acme" },
    { "manufacturer": "Beta" }
  ]
}

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

שאילתה תגובה
distinctonaggregate
 
query CountDistinctManufacturers {
  products {
    manufacturer_count(distinct: true)
  }
}

לדוגמה, אם יש לכם את היצרנים הבאים:

  • מוצר א': manufacturer: "Acme"
  • מוצר ב': manufacturer: "Beta"
  • מוצר ג': manufacturer: "Acme"

התוצאה תהיה:

{
  "products": [
    {
    "manufacturer_count": 2
    }
  ]
}

צבירה של נתונים מקובצים

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

שאילתה תגובה
groupedaggregates
 
query MostExpensiveProductByManufacturer {
  products {
  manufacturer
  price_max
  }
}

לדוגמה, אם יש לכם את המוצרים הבאים:

  • מוצר א': manufacturer: "Acme", ‏ price: 2.99
  • מוצר ב': manufacturer: "Beta", ‏ price: 5.99
  • מוצר ג': manufacturer: "Acme", ‏ price: 1.99

התוצאה תהיה:

{
  "products": [
    { "manufacturer": "Acme", "price_max": 2.99 },
    { "manufacturer": "Beta", "price_max": 5.99 }
  ]
}
having ו-where עם צבירה מקובצת

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

  • having מאפשר לסנן קבוצות לפי שדות המצטברים שלהן

  • where מאפשר לסנן את השורות על סמך שדות לא מצטברים.

שאילתה תגובה
havingwhere
query FilteredMostExpensiveProductByManufacturer {
  products(having: {price_max: {ge: 2.99}}) {
  manufacturer
  price_max
  }
}

לדוגמה, אם יש לכם את המוצרים הבאים:

  • מוצר א': manufacturer: "Acme", ‏ price: 2.99
  • מוצר ב': manufacturer: "Beta", ‏ price: 5.99
  • מוצר ג': manufacturer: "Acme", ‏ price: 1.99

התוצאה תהיה:

{
  "products": [
    { "manufacturer": "Acme", "price_max": 2.99 },
    { "manufacturer": "Beta", "price_max": 5.99 }
  ]
}

צבירה בין טבלאות

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

  type Product @table {
    name: String!
    manufacturer: Manufacturer!
    quantityInStock: Int!
    price: Float!
    expirationDate: Date
  }

  type Manufacturer @table {
    name: String!
    headquartersCountry: String!
  }

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

שאילתה תגובה 
aggregatesacrosstables
 
query GetProductCount($id: UUID) {
  manufacturers {
    name
    products_on_manufacturer {
      _count
    }
  }
}

לדוגמה, אם יש לכם את היצרנים הבאים:

  • יצרן א': name: "Acme", products_on_manufacturer: 2
  • יצרן ב': name: "Beta", ‏ products_on_manufacturer: 1

התוצאה תהיה:

{
  "manufacturers": [
    { "name": "Acme", "products_on_manufacturer": { "_count": 2 } },
    { "name": "Beta", "products_on_manufacturer": { "_count": 1 } }
  ]
}

מוטציות למסד הנתונים של ביקורות על סרטים

כפי שצוין, כשמגדירים טבלה בסכימה, Data Connect יוצר מוטציות סמויות בסיסיות לכל טבלה.

type Movie @table { ... }

extend type Mutation {
  # Insert a row into the movie table.
  movie_insert(...): Movie_Key!
  # Upsert a row into movie."
  movie_upsert(...): Movie_Key!
  # Update a row in Movie. Returns null if a row with the specified id/key does not exist
  movie_update(...): Movie_Key
  # Update rows based on a filter in Movie.
  movie_updateMany(...): Int!
  # Delete a single row in Movie. Returns null if a row with the specified id/key does not exist
  movie_delete(...): Movie_Key
  # Delete rows based on a filter in Movie.
  movie_deleteMany(...): Int!
}

בעזרתם תוכלו להטמיע מקרים מורכבים יותר ויותר של פעולות CRUD. צריך לומר את זה חמש פעמים מהר!

ההנחיה @transaction

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

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

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

יצירה

נתחיל ביצירה בסיסית.

# Create a movie based on user input
mutation CreateMovie($title: String!, $releaseYear: Int!, $genre: String!, $rating: Int!) {
  movie_insert(data: {
    title: $title
    releaseYear: $releaseYear
    genre: $genre
    rating: $rating
  })
}

# Create a movie with default values
mutation CreateMovie2 {
  movie_insert(data: {
    title: "Sherlock Holmes"
    releaseYear: 2009
    genre: "Mystery"
    rating: 5
  })
}

או הוספה ועדכון (upsert).

# Movie upsert using combination of variables and literals
mutation UpsertMovie($title: String!) {
  movie_upsert(data: {
    title: $title
    releaseYear: 2009
    genre: "Mystery"
    rating: 5
    genre: "Mystery/Thriller"
  })
}

ביצוע עדכונים

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

השדה movie_update מכיל ארגומנט id צפוי לזיהוי רשומה, ושדה data שבו אפשר להשתמש כדי להגדיר ערכים בעדכון הזה.

mutation UpdateMovie(
  $id: UUID!,
  $genre: String!,
  $rating: Int!,
  $description: String!
) {
  movie_update(id: $id,
    data: {
      genre: $genre
      rating: $rating
      description: $description
    })
}

כדי לבצע כמה עדכונים, משתמשים בשדה movie_updateMany.

# Multiple updates (increase all ratings of a genre)
mutation IncreaseRatingForGenre($genre: String!, $rating: Int!) {
  movie_updateMany(
    where: { genre: { eq: $genre } },
    data:
      {
        rating: $rating
      })
}

שימוש בפעולות הוספה, הפחתה, צירוף והוספה בתחילת שורה באמצעות _update

בעוד שבמוטציות _update ו-_updateMany אפשר להגדיר ערכים ב-data: באופן מפורש, בדרך כלל עדיף להחיל אופרטור כמו increment כדי לעדכן ערכים.

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

mutation UpdateMovie(
  $id: UUID!,
  $ratingIncrement: Int!
) {
  movie_update(id: $id, data: {
    rating_update: {
      inc: $ratingIncrement
    }
  })
}

Data Connect תומך באופרטורים הבאים לעדכוני שדות:

  • inc כדי להגדיל את סוגי הנתונים Int, ‏ Int64 ו-Float
  • dec כדי להקטין את סוגי הנתונים Int, ‏ Int64 ו-Float
  • append כדי לצרף לסוגי רשימות, מלבד רשימות Vector
  • prepend כדי להוסיף קידומת לסוגים של רשימות, מלבד רשימות וקטורים

ביצוע מחיקה

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

# Delete by key
mutation DeleteMovie($id: UUID!) {
  movie_delete(id: $id)
}

כאן אפשר להשתמש ב-_deleteMany.

# Multiple deletes
mutation DeleteUnpopularMovies($minRating: Int!) {
  movie_deleteMany(where: { rating: { le: $minRating } })
}

כתיבת מוטציות ביחסים

איך משתמשים בטרנספורמציה המשתמעת _upsert ביחס?

# Create or update a one to one relation
mutation MovieMetadataUpsert($movieId: UUID!, $director: String!) {
  movieMetadata_upsert(
    data: { movie: { id: $movieId }, director: $director }
  )
}

לאפשר ל-Data Connect לספק ערכים באמצעות תחביר field_expr

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

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

כשמטמיעים מוטציות, משתמשים בתחביר field_expr כדי להפעיל עדכונים שנוצרים על ידי השרת או לגשת לנתונים מהבקשות. לדוגמה, כדי להעביר את ההרשאה uid ששמורה בבקשה לפעולה _upsert, מעבירים את "auth.uid" בשדה userId_expr.

# Add a movie to the user's favorites list
mutation AddFavoritedMovie($movieId: UUID!) @auth(level: USER) {
  favorite_movie_upsert(data: { userId_expr: "auth.uid", movieId: $movieId })
}

# Remove a movie from the user's favorites list
mutation DeleteFavoritedMovie($movieId: UUID!) @auth(level: USER) {
  favorite_movie_delete(key: { userId_expr: "auth.uid", movieId: $movieId })
}

לחלופין, באפליקציה מוכרת של רשימת משימות, כשיוצרים רשימת משימות חדשה, אפשר להעביר את הערך id_expr כדי להורות לשרת ליצור UUID באופן אוטומטי עבור הרשימה.

mutation CreateTodoListWithFirstItem(
  $listName: String!
) @transaction {
  # Step 1
  todoList_insert(data: {
    id_expr: "uuidV4()", # <-- auto-generated. Or a column-level @default on `type TodoList` will also work
    name: $listName,
  })
}

מידע נוסף זמין במאמר בנושא סקאלרים של _Expr בחומר העזר בנושא סקאלרים.

שאילתות לחיפוש נתוני הרשאה

כדי לאשר מוטציות של Data Connect, קודם שולחים שאילתה למסד הנתונים ומאמתים את תוצאות השאילתה באמצעות ביטויים של CEL. זה שימושי, למשל, כשכותבים לטבלה וצריכים לבדוק את התוכן של שורה בטבלה אחרת.

התכונה הזו תומכת באפשרויות הבאות:

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

התכונות האלה שימושיות בתהליכי הרשאה.

סכימה מקבילת של SQL

-- Movies Table
CREATE TABLE Movies (
    movie_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    title VARCHAR(255) NOT NULL,
    release_year INT,
    genre VARCHAR(30),
    rating INT,
    description TEXT,
    tags TEXT[]
);
-- Movie Metadata Table
CREATE TABLE MovieMetadata (
    movie_id UUID REFERENCES Movies(movie_id) UNIQUE,
    director VARCHAR(255) NOT NULL,
    PRIMARY KEY (movie_id)
);
-- Actors Table
CREATE TABLE Actors (
    actor_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    name VARCHAR(30) NOT NULL
);
-- MovieActor Join Table for Many-to-Many Relationship
CREATE TABLE MovieActor (
    movie_id UUID REFERENCES Movies(movie_id),
    actor_id UUID REFERENCES Actors(actor_id),
    role VARCHAR(50) NOT NULL, # "main" or "supporting"
    PRIMARY KEY (movie_id, actor_id),
    FOREIGN KEY (movie_id) REFERENCES Movies(movie_id),
    FOREIGN KEY (actor_id) REFERENCES Actors(actor_id)
);
-- Users Table
CREATE TABLE Users (
    user_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    user_auth VARCHAR(255) NOT NULL
    username VARCHAR(30) NOT NULL
);
-- Reviews Table
CREATE TABLE Reviews (
    review_id UUID DEFAULT uuid_generate_v4() PRIMARY KEY,
    user_id UUID REFERENCES Users(user_id),
    movie_id UUID REFERENCES Movies(movie_id),
    rating INT,
    review_text TEXT,
    review_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    UNIQUE (movie_id, user_id)
    FOREIGN KEY (user_id) REFERENCES Users(user_id),
    FOREIGN KEY (movie_id) REFERENCES Movies(movie_id)
);
-- Self Join Example for Movie Sequel Relationship
ALTER TABLE Movies
ADD COLUMN sequel_to UUID REFERENCES Movies(movie_id);

מה השלב הבא?