Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Modelo de dados do Cloud Firestore

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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 de valores-chave. 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. Basta atribuir 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 ser assim:

  • 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:

  • alovelace

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

Você pode notar que os documentos se parecem muito com JSON. Na verdade, eles basicamente são. Existem algumas diferenças (por exemplo, documentos oferecem suporte a 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:

  • usuários

    • alovelace

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

    • turing

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

O Cloud Firestore não tem esquema, então você tem total liberdade sobre quais campos você coloca em cada documento e quais tipos de dados você armazena nesses campos. Todos os documentos 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 consultar os documentos 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 de 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 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.

Web version 9

import { doc } from "firebase/firestore";

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

Web version 8

var alovelaceDocumentRef = db.collection('users').doc('alovelace');
Rápido
Observação: este produto não está disponível em destinos watchOS e App Clip.
let alovelaceDocumentRef = db.collection("users").document("alovelace")
Objetivo-C
Observação: este produto não está disponível em destinos watchOS e App Clip.
FIRDocumentReference *alovelaceDocumentRef =
    [[self.db collectionWithPath:@"users"] documentWithPath:@"alovelace"];

Java

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

Kotlin+KTX

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

Dart

final alovelaceDocumentRef = db.collection("users").doc("alovelace");
Java
// Reference to a document with id "alovelace" in the collection "users"
DocumentReference document = db.collection("users").document("alovelace");
Pitão
a_lovelace_ref = db.collection(u'users').document(u'alovelace')

Python

a_lovelace_ref = db.collection("users").document("alovelace")
C++
DocumentReference alovelace_document_reference =
    db->Collection("users").Document("alovelace");
Node.js
const alovelaceDocumentRef = db.collection('users').doc('alovelace');
Vai
alovelaceRef := client.Collection("users").Doc("alovelace")
PHP

PHP

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

$document = $db->collection('samples/php/users')->document('alovelace');
Unidade
DocumentReference documentRef = db.Collection("users").Document("alovelace");
C#

C#

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

DocumentReference documentRef = db.Collection("users").Document("alovelace");
Rubi
document_ref = firestore.col("users").doc("alovelace")

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 dados ou não, 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 :

Web version 9

import { collection } from "firebase/firestore";

const usersCollectionRef = collection(db, 'users');

Web version 8

var usersCollectionRef = db.collection('users');
Rápido
Observação: este produto não está disponível em destinos watchOS e App Clip.
let usersCollectionRef = db.collection("users")
Objetivo-C
Observação: este produto não está disponível em destinos watchOS e App Clip.
FIRCollectionReference *usersCollectionRef = [self.db collectionWithPath:@"users"];

Java

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

Kotlin+KTX

val usersCollectionRef = db.collection("users")

Dart

final usersCollectionRef = db.collection("users");
Java
// Reference to the collection "users"
CollectionReference collection = db.collection("users");
Pitão
users_ref = db.collection(u'users')

Python

users_ref = db.collection("users")
C++
CollectionReference users_collection_reference = db->Collection("users");
Node.js
const usersCollectionRef = db.collection('users');
Vai
usersRef := client.Collection("users")
PHP

PHP

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

$collection = $db->collection('samples/php/users');
Unidade
CollectionReference collectionRef = db.Collection("users");
C#

C#

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

CollectionReference collectionRef = db.Collection("users");
Rubi
collection_ref = firestore.col "users"

Por conveniência, você também pode criar referências especificando o caminho para um documento ou coleção como uma string, com componentes de caminho separados por uma barra ( / ). Por exemplo, para criar uma referência ao documento alovelace :

Web version 9

import { doc } from "firebase/firestore"; 

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

Web version 8

var alovelaceDocumentRef = db.doc('users/alovelace');
Rápido
Observação: este produto não está disponível em destinos watchOS e App Clip.
let aLovelaceDocumentReference = db.document("users/alovelace")
Objetivo-C
Observação: este produto não está disponível em destinos watchOS e App Clip.
FIRDocumentReference *aLovelaceDocumentReference =
    [self.db documentWithPath:@"users/alovelace"];

Java

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

Kotlin+KTX

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

Dart

final aLovelaceDocRef = db.doc("users/alovelace");
Java
// Reference to a document with id "alovelace" in the collection "users"
DocumentReference document = db.document("users/alovelace");
Pitão
a_lovelace_ref = db.document(u'users/alovelace')

Python

a_lovelace_ref = db.document("users/alovelace")
C++
DocumentReference alovelace_document = db->Document("users/alovelace");
Node.js
const alovelaceDocumentRef = db.doc('users/alovelace');
Vai
// Reference to a document with id "alovelace" in the collection "users"
alovelaceRef := client.Doc("users/alovelace")
PHP

PHP

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

$document = $db->document('users/alovelace');
Unidade
DocumentReference documentRef = db.Document("users/alovelace");
C#

C#

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

DocumentReference documentRef = db.Document("users/alovelace");
Rubi
document_path_ref = firestore.doc "users/alovelace"

Dados hierárquicos

Para entender como as estruturas de dados hierárquicas funcionam no Cloud Firestore, considere um exemplo de aplicativo de bate-papo com mensagens e salas de bate-papo.

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

  • quartos

    • A

      name : "my chat room"

    • sala de B

      ...

Agora que você tem salas de bate-papo, decida como armazenar suas mensagens. Talvez você não queira armazená-los no documento da sala de bate-papo. Os documentos no Cloud Firestore devem ser leves e uma sala de bate-papo pode conter um grande número de mensagens. No entanto, você pode criar coleções adicionais no documento da 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 sala em sua coleção de rooms :

  • quartos

    • A

      name : "my chat room"

      • mensagens

        • mensagem aula1

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

        • mensagem aula2

          ...

    • sala de B

      ...

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

Web version 9

import { doc } from "firebase/firestore"; 

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

Web version 8

var messageRef = db.collection('rooms').doc('roomA')
                .collection('messages').doc('message1');
Rápido
Observação: este produto não está disponível em destinos watchOS e App Clip.
let messageRef = db
    .collection("rooms").document("roomA")
    .collection("messages").document("message1")
Objetivo-C
Observação: este produto não está disponível em destinos watchOS e App Clip.
FIRDocumentReference *messageRef =
    [[[[self.db collectionWithPath:@"rooms"] documentWithPath:@"roomA"]
    collectionWithPath:@"messages"] documentWithPath:@"message1"];

Java

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

Kotlin+KTX

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

Dart

final messageRef = db
    .collection("rooms")
    .doc("roomA")
    .collection("messages")
    .doc("message1");
Java
// Reference to a document in subcollection "messages"
DocumentReference document =
    db.collection("rooms").document("roomA").collection("messages").document("message1");
Pitão
room_a_ref = db.collection(u'rooms').document(u'roomA')
message_ref = room_a_ref.collection(u'messages').document(u'message1')

Python

room_a_ref = db.collection("rooms").document("roomA")
message_ref = room_a_ref.collection("messages").document("message1")
C++
DocumentReference message_reference = db->Collection("rooms")
    .Document("roomA")
    .Collection("messages")
    .Document("message1");
Node.js
const messageRef = db.collection('rooms').doc('roomA')
  .collection('messages').doc('message1');
Vai
messageRef := client.Collection("rooms").Doc("roomA").
	Collection("messages").Doc("message1")
PHP

PHP

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

$document = $db
    ->collection('rooms')
    ->document('roomA')
    ->collection('messages')
    ->document('message1');
Unidade
DocumentReference documentRef = db
	.Collection("Rooms").Document("RoomA")
	.Collection("Messages").Document("Message1");
C#

C#

Para saber mais sobre como instalar e criar um cliente do Cloud Firestore, consulte Bibliotecas de cliente do Cloud Firestore .

DocumentReference documentRef = db
    .Collection("Rooms").Document("RoomA")
    .Collection("Messages").Document("Message1");
Rubi
message_ref = firestore.col("rooms").doc("roomA").col("messages").doc("message1")

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 fazer referência a uma coleção em uma coleção ou a um documento em um documento.

As subcoleções permitem estruturar 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 aninhar ainda mais os dados. Você pode aninhar dados em até 100 níveis de profundidade.