Cloud Firestore 數據模型

Cloud Firestore 是一個 NoSQL、面向文檔的數據庫。與 SQL 數據庫不同，它沒有表或行。相反，您將數據存儲在文檔中，這些文檔被組織成集合。

每個文檔都包含一組鍵值對。 Cloud Firestore 針對存儲大量小型文檔進行了優化。

所有文檔都必須存儲在集合中。文檔可以包含子集合和嵌套對象，這兩者都可以包含原始字段（如字符串）或複雜對象（如列表）。

集合和文檔是在 Cloud Firestore 中隱式創建的。只需將數據分配給集合中的文檔即可。如果集合或文檔不存在，Cloud Firestore 會創建它。

文件

在 Cloud Firestore 中，存儲單位是文檔。文檔是一種輕量級記錄，其中包含映射到值的字段。每個文檔都由一個名稱標識。

表示用戶alovelace的文檔可能如下所示：

• 情人

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

注意： Cloud Firestore 支持多種數據類型的值：布爾值、數字、字符串、地理點、二進制 blob 和時間戳。您還可以使用數組或嵌套對象（稱為映射）來構建文檔中的數據。

文檔中復雜的嵌套對象稱為映射。例如，您可以使用映射從上面的示例構建用戶名，如下所示：

• 情人

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

您可能會注意到文檔看起來很像 JSON。事實上，他們基本上是。存在一些差異（例如，文檔支持額外的數據類型並且大小限制為 1 MB），但通常，您可以將文檔視為輕量級 JSON 記錄。

收藏品

文檔存在於集合中，集合只是文檔的容器。例如，您可以有一個users集合來包含您的各種用戶，每個用戶都由一個文檔表示：

• 用戶

  • 情人

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

  • 教育

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

Cloud Firestore 是無架構的，因此您可以完全自由地決定在每個文檔中放置哪些字段以及在這些字段中存儲哪些數據類型。同一集合中的文檔都可以包含不同的字段或在這些字段中存儲不同類型的數據。但是，最好在多個文檔中使用相同的字段和數據類型，這樣您可以更輕鬆地查詢文檔。

集合只包含文檔，沒有其他內容。它不能直接包含帶值的原始字段，也不能包含其他集合。 （有關如何在 Cloud Firestore 中構建更複雜數據的說明，請參閱分層數據。）

集合中文檔的名稱是唯一的。您可以提供自己的密鑰，例如用戶 ID，也可以讓 Cloud Firestore 自動為您創建隨機 ID。

您不需要“創建”或“刪除”集合。在集合中創建第一個文檔後，集合就存在了。如果您刪除集合中的所有文檔，則該集合將不復存在。

參考

Cloud Firestore 中的每個文檔都由其在數據庫中的位置唯一標識。前面的示例顯示了集合users中的文檔alovelace 。要在您的代碼中引用此位置，您可以創建對它的引用。

Web version 9

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

import { doc } from "firebase/firestore";

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

Web version 8

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

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

迅速

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

目標-C

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

Kotlin+KTX

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

Java

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

Dart

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

Python

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

Python

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

C++

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

節點.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

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

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

統一

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

C＃

C＃

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

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

紅寶石

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

引用是一個輕量級對象，它只指向數據庫中的一個位置。無論數據是否存在，您都可以創建引用，並且創建引用不會執行任何網絡操作。

您還可以創建對集合的引用：

Web version 9

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

import { collection } from "firebase/firestore";

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

Web version 8

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

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

迅速

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

目標-C

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

Kotlin+KTX

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

Java

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

Dart

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

爪哇

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

Python

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

Python

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

C++

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

節點.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

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

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

統一

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

C＃

C＃

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

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

紅寶石

collection_ref = firestore.col "users"
data_model.rb

注意：集合引用和文檔引用是兩種不同類型的引用，可讓您執行不同的操作。例如，您可以使用集合引用來查詢集合中的文檔，也可以使用文檔引用來讀取或寫入單個文檔。

為方便起見，您還可以通過將文檔或集合的路徑指定為字符串來創建引用，路徑組件由正斜杠 ( / ) 分隔。例如，要創建對alovelace文檔的引用：

Web version 9

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

import { doc } from "firebase/firestore"; 

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

Web version 8

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

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

迅速

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

目標-C

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

Kotlin+KTX

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

Java

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

Dart

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

Python

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

Python

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

C++

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

節點.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

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

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

統一

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

C＃

C＃

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

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

紅寶石

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

分層數據

要了解分層數據結構在 Cloud Firestore 中的工作原理，請考慮一個包含消息和聊天室的示例聊天應用。

您可以創建一個名為rooms的集合來存儲不同的聊天室：

• 房間

  • A

    name : "my chat room"
    

  • B

    ...
    

現在您有了聊天室，決定如何存儲您的消息。您可能不想將它們存儲在聊天室的文檔中。 Cloud Firestore 中的文檔應該是輕量級的，而聊天室可能包含大量消息。但是，您可以在聊天室的文檔中創建其他集合，作為子集合。

子集

在這種情況下存儲消息的最佳方式是使用子集合。子集合是與特定文檔關聯的集合。

注意：您可以使用Collection Group Queries跨具有相同集合 ID 的子集合進行查詢。

您可以為rooms集合中的每個房間文檔創建一個名為messages的子集合：

• 房間

  • A

    name : "my chat room"
    

    • 消息

      • 留言1

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

      • 留言2

        ...
        

  • B

    ...
    

在此示例中，您將使用以下代碼創建對子集合中消息的引用：

Web version 9

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

import { doc } from "firebase/firestore"; 

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

Web version 8

詳細了解 tree-shakeable Web v9 模塊化 SDK 並從版本 8升級。

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

迅速

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

目標-C

注意：此產品不適用於 watchOS 和 App Clip 目標。

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

Kotlin+KTX

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

Java

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

爪哇

// 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

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

節點.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

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

$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");

C＃

C＃

有關安裝和創建 Cloud Firestore 客戶端的更多信息，請參閱Cloud Firestore 客戶端庫。

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 層深度的數據。

警告：刪除文檔不會刪除其子集合！

當您刪除包含子集合的文檔時，不會刪除這些子集合。例如，可能有一個文檔位於coll/doc/subcoll/subdoc ，即使文檔coll/doc不再存在。如果要在刪除父文檔時刪除子集合中的文檔，則必須手動執行，如刪除集合所示。