מודל נתונים

מודל נתונים

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

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

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

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

מסמכים

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

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

• alovelace

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

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

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

• alovelace

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

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

אוספים

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

• משתמשים

  • alovelace

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

  • aturing

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

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

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

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

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

קובצי עזר

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

גרסה 9 לאינטרנט

import { doc } from "firebase/firestore";

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

גרסה 8 לאינטרנט

מידע נוסף על Web API מודולרי עם tree-shaking ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

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

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

‫Kotlin
Android

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

‫Java
Android

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

Dart

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

Java

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

Python

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

Python
(Async)

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

C++‎

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

Node.js

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

PHP

PHP

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Unity

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

C#‎

C#

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Ruby

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

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

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

גרסה 9 לאינטרנט

import { collection } from "firebase/firestore";

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

גרסה 8 לאינטרנט

מידע נוסף על Web API מודולרי עם tree-shaking ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

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

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

‫Kotlin
Android

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

‫Java
Android

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

Dart

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

Java

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

Python

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

Python
(Async)

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

C++‎

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

Node.js

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

PHP

PHP

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Unity

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

C#‎

C#

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Ruby

collection_ref = firestore.col "users"
data_model.rb

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

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

גרסה 9 לאינטרנט

import { doc } from "firebase/firestore"; 

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

גרסה 8 לאינטרנט

מידע נוסף על Web API מודולרי עם tree-shaking ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

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

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

‫Kotlin
Android

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

‫Java
Android

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

Dart

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

Java

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

Python

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

Python
(Async)

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

C++‎

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

Node.js

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

PHP

PHP

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Unity

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

C#‎

C#

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Ruby

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

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

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

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

• חדרים

  • roomA

    name : "my chat room"
    

  • roomB

    ...
    

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

אוספי משנה

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

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

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

• חדרים

  • roomA

    name : "my chat room"
    

    • הודעות

      • message1

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

      • message2

        ...
        

  • roomB

    ...
    

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

גרסה 9 לאינטרנט

import { doc } from "firebase/firestore"; 

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

גרסה 8 לאינטרנט

מידע נוסף על Web API מודולרי עם tree-shaking ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

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

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

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

‫Kotlin
Android

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

‫Java
Android

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

Dart

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

Java

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

Python

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

Python
(Async)

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

C++‎

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

Node.js

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

PHP

PHP

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Unity

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

C#‎

C#

כדי לבצע אימות ב-Firestore, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

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

Ruby

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

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

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

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

אזהרה: מחיקת מסמך לא מוחקת את אוספי המשנה שלו!

כשמוחקים מסמך שיש לו אוספי משנה, אוספי המשנה האלה לא נמחקים. לדוגמה, יכול להיות שיש מסמך בכתובת coll/doc/subcoll/subdoc גם אם המסמך coll/doc כבר לא קיים. אם רוצים למחוק מסמכים באוספי משנה כשמוחקים מסמך אב, צריך לעשות זאת באופן ידני, כמו שמוסבר במאמר מחיקת אוספים.