מודל נתונים של Cloud Firestore

Cloud Firestore הוא מסד נתונים מסוג NoSQL שמתמקד במסמכים. בניגוד למסד נתונים של SQL, אין טבלאות או שורות. במקום זאת, הנתונים מאוחסנים במסמכים, שמאורגנים באוספים.

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

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

אוספים ומסמכים נוצרים באופן משתמע ב-Cloud Firestore. פשוט מקצים נתונים למסמך בתוך אוסף. אם האוסף או המסמך לא קיימים, Cloud Firestore יוצר אותם.

מסמכים

ב-Cloud Firestore, יחידת האחסון היא המסמך. מסמך הוא רשומה קלה שמכילה שדות שממופים לערכים. לכל מסמך יש שם.

מסמך שמייצג משתמש alovelace עשוי להיראות כך:

• class alovelace

  first : "Ada"
last : "Lovelace"
born : 1815
  

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

• class alovelace

  name :
    first : "Ada"
    last : "Lovelace"
born : 1815
  

יכול להיות שתבחינו שהמסמכים דומים מאוד ל-JSON. למעשה, הם בעצם כאלה. יש כמה הבדלים (לדוגמה, מסמכים תומכים בסוגי נתונים נוספים והם מוגבלים לגודל של 1MB), אבל באופן כללי אפשר להתייחס למסמכים כאל רשומות JSON קלילות.

אוספים

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

• collections_bookmark משתמשים

  • class alovelace

    first : "Ada"
last : "Lovelace"
born : 1815
    

  • class aturing

    first : "Alan"
last : "Turing"
born : 1912
    

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

אוסף מכיל מסמכים בלבד. הוא לא יכול להכיל שדות גולמיים עם ערכים באופן ישיר, והוא לא יכול להכיל אוספים אחרים. (במאמר נתונים היררכיים מוסבר איך ליצור מבנה לנתונים מורכבים יותר ב-Cloud Firestore).

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

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

קובצי עזר

כל מסמך ב-Cloud Firestore מזוהה באופן ייחודי לפי המיקום שלו במסד הנתונים. בדוגמה הקודמת מוצג המסמך alovelace באוסף users. כדי להפנות למיקום הזה בקוד, אפשר ליצור הפניה אליו.

import { doc } from "firebase/firestore";

const alovelaceDocumentRef = doc(db, 'users', 'alovelace');
doc_reference.js

var alovelaceDocumentRef = db.collection('users').doc('alovelace');
test.firestore.js

let alovelaceDocumentRef = db.collection("users").document("alovelace")
ViewController.swift

FIRDocumentReference *alovelaceDocumentRef =
    [[self.db collectionWithPath:@"users"] documentWithPath:@"alovelace"];
ViewController.m

val alovelaceDocumentRef = db.collection("users").document("alovelace")
DocSnippets.kt

DocumentReference alovelaceDocumentRef = db.collection("users").document("alovelace");
DocSnippets.java

final alovelaceDocumentRef = db.collection("users").doc("alovelace");
firestore.dart

// Reference to a document with id "alovelace" in the collection "users"
DocumentReference document = db.collection("users").document("alovelace");
References.java

a_lovelace_ref = db.collection("users").document("alovelace")
snippets.py

a_lovelace_ref = db.collection("users").document("alovelace")
snippets.py

DocumentReference alovelace_document_reference =
    db->Collection("users").Document("alovelace");
snippets.cpp

const alovelaceDocumentRef = db.collection('users').doc('alovelace');
index.js

import (
	"cloud.google.com/go/firestore"
)

func createDocReference(client *firestore.Client) {

	alovelaceRef := client.Collection("users").Doc("alovelace")

	_ = alovelaceRef
}
retrieve_data_reference_document.go

$document = $db->collection('samples/php/users')->document('alovelace');
data_reference_document.php

DocumentReference documentRef = db.Collection("users").Document("alovelace");

DocumentReference documentRef = db.Collection("users").Document("alovelace");
Program.cs

document_ref = firestore.col("users").doc("alovelace")
data_model.rb

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

אפשר גם ליצור הפניות לאוספים:

import { collection } from "firebase/firestore";

const usersCollectionRef = collection(db, 'users');
collection_reference.js

var usersCollectionRef = db.collection('users');
test.firestore.js

let usersCollectionRef = db.collection("users")
ViewController.swift

FIRCollectionReference *usersCollectionRef = [self.db collectionWithPath:@"users"];
ViewController.m

val usersCollectionRef = db.collection("users")
DocSnippets.kt

CollectionReference usersCollectionRef = db.collection("users");
DocSnippets.java

final usersCollectionRef = db.collection("users");
firestore.dart

// Reference to the collection "users"
CollectionReference collection = db.collection("users");
References.java

users_ref = db.collection("users")
snippets.py

users_ref = db.collection("users")
snippets.py

CollectionReference users_collection_reference = db->Collection("users");
snippets.cpp

const usersCollectionRef = db.collection('users');
index.js

import (
	"cloud.google.com/go/firestore"
)

func createCollectionReference(client *firestore.Client) {
	usersRef := client.Collection("users")

	_ = usersRef
}
retrieve_data_reference_collection.go

$collection = $db->collection('samples/php/users');
data_reference_collection.php

CollectionReference collectionRef = db.Collection("users");

CollectionReference collectionRef = db.Collection("users");
Program.cs

collection_ref = firestore.col "users"
data_model.rb

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

import { doc } from "firebase/firestore"; 

const alovelaceDocumentRef = doc(db, 'users/alovelace');
doc_reference_alternative.js

var alovelaceDocumentRef = db.doc('users/alovelace');
test.firestore.js

let aLovelaceDocumentReference = db.document("users/alovelace")
ViewController.swift

FIRDocumentReference *aLovelaceDocumentReference =
    [self.db documentWithPath:@"users/alovelace"];
ViewController.m

val alovelaceDocumentRef = db.document("users/alovelace")
DocSnippets.kt

DocumentReference alovelaceDocumentRef = db.document("users/alovelace");
DocSnippets.java

final aLovelaceDocRef = db.doc("users/alovelace");
firestore.dart

// Reference to a document with id "alovelace" in the collection "users"
DocumentReference document = db.document("users/alovelace");
References.java

a_lovelace_ref = db.document("users/alovelace")
snippets.py

a_lovelace_ref = db.document("users/alovelace")
snippets.py

DocumentReference alovelace_document = db->Document("users/alovelace");
snippets.cpp

const alovelaceDocumentRef = db.doc('users/alovelace');
index.js

import (
	"cloud.google.com/go/firestore"
)

func createDocReferenceFromString(client *firestore.Client) {
	// Reference to a document with id "alovelace" in the collection "users"
	alovelaceRef := client.Doc("users/alovelace")

	_ = alovelaceRef
}
retrieve_data_reference_document_path.go

$document = $db->document('users/alovelace');
data_reference_document_path.php

DocumentReference documentRef = db.Document("users/alovelace");

DocumentReference documentRef = db.Document("users/alovelace");
Program.cs

document_path_ref = firestore.doc "users/alovelace"
data_model.rb

נתונים היררכיים

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

אפשר ליצור אוסף בשם rooms כדי לאחסן בו חדרי צ'אט שונים:

• collections_bookmark חדרים

  • class roomA

    name : "my chat room"
    

  • class roomB

    ...
    

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

אוספי משנה

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

אפשר ליצור אוסף משנה בשם messages לכל מסמך של חדר באוסף rooms:

• collections_bookmark חדרים

  • class roomA

    name : "my chat room"
    

    • collections_bookmark הודעות

      • class message1

        from : "alex"
msg : "Hello World!"
        

      • class message2

        ...
        

  • class roomB

    ...
    

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

import { doc } from "firebase/firestore"; 

const messageRef = doc(db, "rooms", "roomA", "messages", "message1");
subcollection_reference.js

var messageRef = db.collection('rooms').doc('roomA')
                .collection('messages').doc('message1');
test.firestore.js

let messageRef = db
  .collection("rooms").document("roomA")
  .collection("messages").document("message1")
ViewController.swift

FIRDocumentReference *messageRef =
    [[[[self.db collectionWithPath:@"rooms"] documentWithPath:@"roomA"]
    collectionWithPath:@"messages"] documentWithPath:@"message1"];
ViewController.m

val messageRef = db
    .collection("rooms").document("roomA")
    .collection("messages").document("message1")
DocSnippets.kt

DocumentReference messageRef = db
        .collection("rooms").document("roomA")
        .collection("messages").document("message1");
DocSnippets.java

final messageRef = db
    .collection("rooms")
    .doc("roomA")
    .collection("messages")
    .doc("message1");
firestore.dart

// Reference to a document in subcollection "messages"
DocumentReference document =
    db.collection("rooms").document("roomA").collection("messages").document("message1");
References.java

room_a_ref = db.collection("rooms").document("roomA")
message_ref = room_a_ref.collection("messages").document("message1")
snippets.py

room_a_ref = db.collection("rooms").document("roomA")
message_ref = room_a_ref.collection("messages").document("message1")
snippets.py

DocumentReference message_reference = db->Collection("rooms")
    .Document("roomA")
    .Collection("messages")
    .Document("message1");
snippets.cpp

const messageRef = db.collection('rooms').doc('roomA')
  .collection('messages').doc('message1');
index.js

import (
	"cloud.google.com/go/firestore"
)

func createSubcollectionReference(client *firestore.Client) {
	messageRef := client.Collection("rooms").Doc("roomA").
		Collection("messages").Doc("message1")

	_ = messageRef
}
retrieve_data_reference_subcollection.go

$document = $db
    ->collection('rooms')
    ->document('roomA')
    ->collection('messages')
    ->document('message1');
data_reference_subcollection.php

DocumentReference documentRef = db
	.Collection("Rooms").Document("RoomA")
	.Collection("Messages").Document("Message1");

DocumentReference documentRef = db
    .Collection("Rooms").Document("RoomA")
    .Collection("Messages").Document("Message1");
Program.cs

message_ref = firestore.col("rooms").doc("roomA").col("messages").doc("message1")
data_model.rb

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

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

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