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

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

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

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

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

Документы

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

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

• аловелайс

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

Примечание: Cloud Firestore поддерживает различные типы данных для значений: логические значения, числа, строки, географические точки, двоичные объекты и метки времени. Вы также можете использовать массивы или вложенные объекты, называемые картами, для структурирования данных внутри документа.

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

• аловелайс

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

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

Коллекции

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

• users

  • аловелайс

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

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

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

Коллекция содержит только документы и ничего больше. Она не может напрямую содержать поля со значениями и не может содержать другие коллекции. (См. раздел «Иерархические данные» для объяснения того, как структурировать более сложные данные в Cloud Firestore .)

Названия документов в коллекции уникальны. Вы можете указать собственные ключи, например, идентификаторы пользователей, или позволить Cloud Firestore автоматически создавать для вас случайные идентификаторы.

Нет необходимости «создавать» или «удалять» коллекции. После создания первого документа в коллекции она продолжает существовать. Если удалить все документы в коллекции, она перестанет существовать.

Ссылки

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

Web

import { doc } from "firebase/firestore";

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

Web

Узнайте больше о модульном веб-API, допускающем оптимизацию кода (tree-shakeable), и его преимуществах перед API с использованием пространств имен.

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

Быстрый

Примечание: Этот продукт недоступен для watchOS и приложений App Clip.

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

Objective-C

Примечание: Этот продукт недоступен для watchOS и приложений App Clip.

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

Kotlin

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

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

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

Для получения дополнительной информации об установке и создании клиента 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

import { collection } from "firebase/firestore";

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

Web

Узнайте больше о модульном веб-API, допускающем оптимизацию кода (tree-shakeable), и его преимуществах перед API с использованием пространств имен.

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

Быстрый

Примечание: Этот продукт недоступен для watchOS и приложений App Clip.

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

Objective-C

Примечание: Этот продукт недоступен для watchOS и приложений App Clip.

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

Kotlin

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

Java

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

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

Для получения дополнительной информации об установке и создании клиента 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

import { doc } from "firebase/firestore"; 

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

Web

Узнайте больше о модульном веб-API, допускающем оптимизацию кода (tree-shakeable), и его преимуществах перед API с использованием пространств имен.

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

Быстрый

Примечание: Этот продукт недоступен для watchOS и приложений App Clip.

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

Objective-C

Примечание: Этот продукт недоступен для watchOS и приложений App Clip.

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

Kotlin

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

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

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

Для получения дополнительной информации об установке и создании клиента 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 для хранения различных чатов:

• комнаты

  • комнатаА

    name : "my chat room"
    

  • комнатаB

    ...
    

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

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

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

Примечание: Вы можете выполнять запросы к подколлекциям с одинаковым идентификатором коллекции, используя запросы к группам коллекций .

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

• комнаты

  • комнатаА

    name : "my chat room"
    

    • сообщения

      • сообщение1

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

      • сообщение2

        ...
        

  • комнатаB

    ...
    

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

Web

import { doc } from "firebase/firestore"; 

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

Web

Узнайте больше о модульном веб-API, допускающем оптимизацию кода (tree-shakeable), и его преимуществах перед API с использованием пространств имен.

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

Objective-C

Примечание: Этот продукт недоступен для watchOS и приложений App Clip.

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

Kotlin

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

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

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

Для получения дополнительной информации об установке и создании клиента 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 больше не существует. Если вы хотите удалить документы в подколлекциях при удалении родительского документа, это необходимо сделать вручную, как показано в разделе «Удаление коллекций» .