Модель данных Cloud Firestore

Cloud Firestore — это документально-ориентированная база данных NoSQL. В отличие от базы данных SQL, здесь нет таблиц и строк. Вместо этого вы храните данные в документах , которые организованы в коллекции .

Каждый документ содержит набор пар ключ-значение. Cloud Firestore оптимизирован для хранения больших коллекций небольших документов.

Все документы должны храниться в фондах. Документы могут содержать подколлекции и вложенные объекты, оба из которых могут включать примитивные поля, такие как строки, или сложные объекты, такие как списки.

Коллекции и документы создаются неявно в Cloud Firestore. Просто назначьте данные документу в коллекции. Если коллекция или документ не существует, Cloud Firestore создаст их.

Документы

В Cloud Firestore единицей хранения является документ. Документ — это упрощенная запись, содержащая поля, которые сопоставляются со значениями. Каждый документ идентифицируется именем.

Документ, представляющий пользователя alovelace , может выглядеть так:

• class ловеласа

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

Сложные вложенные объекты в документе называются картами. Например, вы можете структурировать имя пользователя из приведенного выше примера с помощью карты, например:

• class ловеласа

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

Вы можете заметить, что документы очень похожи на JSON. На самом деле, они в основном таковы. Есть некоторые различия (например, документы поддерживают дополнительные типы данных и имеют ограничение по размеру до 1 МБ), но в целом документы можно рассматривать как облегченные записи JSON.

Коллекции

Документы живут в коллекциях, которые представляют собой просто контейнеры для документов. Например, у вас может быть коллекция users , содержащая различных пользователей, каждый из которых представлен документом:

• пользователи collections_bookmark

  • class ловеласа

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

  • обучение в class

    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 комнатаА

    name : "my chat room"
    

  • class комнатаБ

    ...
    

Теперь, когда у вас есть чаты, решите, как хранить ваши сообщения. Возможно, вы не захотите хранить их в документе комнаты чата. Документы в Cloud Firestore должны быть легкими, а чат может содержать большое количество сообщений. Однако вы можете создавать дополнительные коллекции в документе комнаты чата в виде подколлекций.

Подколлекции

Лучший способ хранения сообщений в этом сценарии — использование подколлекций. Подколлекция — это коллекция, связанная с определенным документом.

Вы можете создать подколлекцию под названием messages для каждого документа комнаты в вашей коллекции rooms :

• collections_bookmark комнаты

  • class комнатаА

    name : "my chat room"
    

    • сообщения collections_bookmark

      • сообщение class

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

      • сообщение class

        ...
        

  • class комнатаБ

    ...
    

В этом примере вы создадите ссылку на сообщение в подколлекции с помощью следующего кода:

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 уровней.