Modelo de dados do Cloud Firestore

O Cloud Firestore é um banco de dados NoSQL orientado a documentos. Ao contrário de um banco de dados SQL, não há tabelas ou linhas. Em vez disso, você armazena dados em documentos , que são organizados em coleções .

Cada documento contém um conjunto de pares chave-valor. O Cloud Firestore é otimizado para armazenar grandes coleções de pequenos documentos.

Todos os documentos devem ser armazenados em coleções. Os documentos podem conter subcoleções e objetos aninhados, os quais podem incluir campos primitivos como strings ou objetos complexos como listas.

Coleções e documentos são criados implicitamente no Cloud Firestore. Simplesmente atribua dados a um documento dentro de uma coleção. Se a coleção ou o documento não existir, o Cloud Firestore o criará.

Documentos

No Cloud Firestore, a unidade de armazenamento é o documento. Um documento é um registro leve que contém campos, que são mapeados para valores. Cada documento é identificado por um nome.

Um documento representando um usuário alovelace pode se parecer com isto:

• class alovelace

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

Objetos complexos e aninhados em um documento são chamados de mapas. Por exemplo, você pode estruturar o nome do usuário do exemplo acima com um mapa, assim:

• class alovelace

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

Você pode perceber que os documentos se parecem muito com JSON. Na verdade, eles basicamente são. Existem algumas diferenças (por exemplo, documentos suportam tipos de dados extras e são limitados em tamanho a 1 MB), mas, em geral, você pode tratar documentos como registros JSON leves.

Coleções

Os documentos vivem em coleções, que são simplesmente recipientes para documentos. Por exemplo, você pode ter uma coleção de users para conter seus vários usuários, cada um representado por um documento:

• collections_bookmark usuários

  • class alovelace

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

  • class aturing

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

O Cloud Firestore não tem esquema, então você tem total liberdade sobre quais campos colocar em cada documento e quais tipos de dados armazenar nesses campos. Todos os documentos dentro da mesma coleção podem conter campos diferentes ou armazenar diferentes tipos de dados nesses campos. No entanto, é uma boa ideia usar os mesmos campos e tipos de dados em vários documentos, para que você possa consultá-los com mais facilidade.

Uma coleção contém documentos e nada mais. Ele não pode conter diretamente campos brutos com valores e não pode conter outras coleções. (Consulte Dados hierárquicos para obter uma explicação sobre como estruturar dados mais complexos no Cloud Firestore.)

Os nomes dos documentos em uma coleção são exclusivos. Você pode fornecer suas próprias chaves, como IDs de usuário, ou pode permitir que o Cloud Firestore crie IDs aleatórios para você automaticamente.

Você não precisa "criar" ou "excluir" coleções. Depois de criar o primeiro documento em uma coleção, a coleção existe. Se você excluir todos os documentos de uma coleção, ela não existirá mais.

Referências

Cada documento no Cloud Firestore é identificado exclusivamente por sua localização no banco de dados. O exemplo anterior mostrou um documento alovelace dentro da coleção users . Para fazer referência a esse local em seu código, você pode criar uma referência a ele.

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(u'users').document(u'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

alovelaceRef := client.Collection("users").Doc("alovelace")
retrieve.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

Uma referência é um objeto leve que apenas aponta para um local em seu banco de dados. Você pode criar uma referência independentemente de existirem ou não dados nela, e a criação de uma referência não executa nenhuma operação de rede.

Você também pode criar referências a coleções :

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(u'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

usersRef := client.Collection("users")
retrieve.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

Por conveniência, você também pode criar referências especificando o caminho para um documento ou coleção como uma string, com os componentes do caminho separados por uma barra ( / ). Por exemplo, para criar uma referência ao documento 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(u'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

// Reference to a document with id "alovelace" in the collection "users"
alovelaceRef := client.Doc("users/alovelace")
retrieve.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

Dados Hierárquicos

Para entender como as estruturas de dados hierárquicos funcionam no Cloud Firestore, considere um aplicativo de chat de exemplo com mensagens e salas de chat.

Você pode criar uma coleção chamada rooms para armazenar diferentes salas de chat:

• collections_bookmark quartos

  • class A

    name : "my chat room"
    

  • class aulaB

    ...
    

Agora que você tem salas de bate-papo, decida como armazenar suas mensagens. Você pode não querer armazená-los no documento da sala de bate-papo. Os documentos no Cloud Firestore devem ser leves e uma sala de chat pode conter um grande número de mensagens. No entanto, você pode criar coleções adicionais no documento de sua sala de bate-papo, como subcoleções.

Subcoleções

A melhor maneira de armazenar mensagens nesse cenário é usando subcoleções. Uma subcoleção é uma coleção associada a um documento específico.

Você pode criar uma subcoleção chamada messages para cada documento de quarto em sua coleção de rooms :

• collections_bookmark quartos

  • class A

    name : "my chat room"
    

    • collections_bookmark mensagens

      • class message1

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

      • mensagem class classe2

        ...
        

  • class aulaB

    ...
    

Neste exemplo, você criaria uma referência a uma mensagem na subcoleção com o seguinte código:

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(u'rooms').document(u'roomA')
message_ref = room_a_ref.collection(u'messages').document(u'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

messageRef := client.Collection("rooms").Doc("roomA").
	Collection("messages").Doc("message1")
retrieve.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

Observe o padrão alternado de coleções e documentos. Suas coleções e documentos devem sempre seguir esse padrão. Você não pode referenciar uma coleção em uma coleção ou um documento em um documento.

As subcoleções permitem que você estruture os dados hierarquicamente, facilitando o acesso aos dados. Para obter todas as mensagens em roomA , você pode criar uma referência de coleção para as messages da subcoleção e interagir com ela como faria com qualquer outra referência de coleção.

Documentos em subcoleções também podem conter subcoleções, permitindo que você aninhe mais dados. Você pode aninhar dados em até 100 níveis de profundidade.