Modelo de datos

Modelo de datos

Firestore es una base de datos NoSQL orientada a documentos. A diferencia de una base de datos SQL, no hay tablas ni filas. En su lugar, los datos se almacenan en documentos, que se organizan en colecciones.

Cada documento contiene un conjunto de pares clave-valor. Firestore está optimizado para almacenar grandes colecciones de documentos pequeños.

Todos los documentos deben almacenarse en colecciones. Los documentos pueden contener subcolecciones y objetos anidados, que pueden incluir campos primitivos, como cadenas, u objetos complejos, como listas.

Las colecciones y los documentos se crean de forma implícita en Firestore. Solo tienes que asignar datos a un documento de una colección. Si no existe la colección o el documento, Firestore los crea.

Redactar documentos

En Firestore, la unidad de almacenamiento es el documento. Un documento es un registro ligero que contiene campos, que se asignan a valores. Cada documento se identifica por un nombre.

Un documento que representa a un usuario alovelace podría tener este aspecto:

• alovelace

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

Nota: Firestore admite varios tipos de datos para los valores: boolean, number, string, geo point, binary blob y timestamp. También puedes usar arrays u objetos anidados, llamados mapas, para estructurar los datos de un documento.

Los objetos complejos y anidados de un documento se denominan mapas. Por ejemplo, puedes estructurar el nombre del usuario del ejemplo anterior con un mapa, de la siguiente manera:

• alovelace

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

Puede que observes que los documentos se parecen mucho a JSON. De hecho, lo son. Hay algunas diferencias (por ejemplo, los documentos admiten tipos de datos adicionales y tienen un tamaño máximo de 1 MB), pero, en general, puedes tratar los documentos como registros JSON ligeros.

Colecciones

Los documentos se encuentran en colecciones, que son simplemente contenedores de documentos. Por ejemplo, puedes tener una colección users para incluir a tus distintos usuarios, cada uno de ellos representado por un documento:

• usuarios

  • alovelace

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

  • aturing

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

Firestore no utiliza esquemas, por lo que tienes total libertad para elegir los campos que quieres incluir en cada documento y los tipos de datos que quieres almacenar en esos campos. Los documentos de una misma colección pueden contener campos diferentes o almacenar distintos tipos de datos en esos campos. Sin embargo, es recomendable usar los mismos campos y tipos de datos en varios documentos para poder consultar los documentos más fácilmente.

Una colección contiene documentos y nada más. No puede contener directamente campos sin formato con valores ni otras colecciones. Consulta Datos jerárquicos para obtener una explicación sobre cómo estructurar datos más complejos en Firestore.

Los nombres de los documentos de una colección son únicos. Puedes proporcionar tus propias claves, como IDs de usuario, o dejar que Firestore cree IDs aleatorios automáticamente.

No es necesario que crees ni elimines colecciones. Una vez que hayas creado el primer documento de una colección, la colección ya existirá. Si eliminas todos los documentos de una colección, esta dejará de existir.

Referencias

Cada documento de Firestore se identifica de forma única por su ubicación en la base de datos. En el ejemplo anterior se ha mostrado un documento alovelace dentro de la colección users. Para hacer referencia a esta ubicación en tu código, puedes crear una referencia a ella.

Versión web 9

import { doc } from "firebase/firestore";

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

Versión web 8

Consulta más información sobre la API web modular de eliminación de código muerto y sus ventajas con respecto a la API con espacio de nombres.

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

Swift

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Objective‑C

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Kotlin
Android

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

Java
Android

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
(Async)

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

Go

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

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

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

Unity

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

C#

C#

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

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

Ruby

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

Una referencia es un objeto ligero que solo apunta a una ubicación de tu base de datos. Puedes crear una referencia independientemente de si hay datos o no, y crear una referencia no realiza ninguna operación de red.

También puedes crear referencias a colecciones:

Versión web 9

import { collection } from "firebase/firestore";

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

Versión web 8

Consulta más información sobre la API web modular de eliminación de código muerto y sus ventajas con respecto a la API con espacio de nombres.

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

Swift

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Objective‑C

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Kotlin
Android

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

Java
Android

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
(Async)

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

Go

import (
	"cloud.google.com/go/firestore"
)

func createCollectionReference(client *firestore.Client) {
	usersRef := client.Collection("users")

	_ = usersRef
}
retrieve_data_reference_collection.go

PHP

PHP

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

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

Unity

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

C#

C#

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

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

Ruby

collection_ref = firestore.col "users"
data_model.rb

Nota: Las referencias de colecciones y las referencias de documentos son dos tipos de referencias distintos que te permiten realizar operaciones diferentes. Por ejemplo, puedes usar una referencia de colección para consultar los documentos de la colección y una referencia de documento para leer o escribir un documento concreto.

Para mayor comodidad, también puedes crear referencias especificando la ruta a un documento o una colección como una cadena, con los componentes de la ruta separados por una barra diagonal (/). Por ejemplo, para crear una referencia al documento alovelace:

Versión web 9

import { doc } from "firebase/firestore"; 

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

Versión web 8

Consulta más información sobre la API web modular de eliminación de código muerto y sus ventajas con respecto a la API con espacio de nombres.

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

Swift

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Objective‑C

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Kotlin
Android

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

Java
Android

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
(Async)

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

Go

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

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

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

Unity

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

C#

C#

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

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

Ruby

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

Datos jerárquicos

Para entender cómo funcionan las estructuras de datos jerárquicas en Firestore, vamos a ver un ejemplo de una aplicación de chat con mensajes y salas de chat.

Puedes crear una colección llamada rooms para almacenar diferentes salas de chat:

• salas

  • roomA

    name : "my chat room"
    

  • roomB

    ...
    

Ahora que tienes salas de chat, decide cómo almacenar los mensajes. Puede que no quieras almacenarlos en el documento de la sala de chat. Los documentos de Firestore deben ser ligeros y una sala de chat puede contener un gran número de mensajes. Sin embargo, puedes crear colecciones adicionales en el documento de tu sala de chat como subcolecciones.

Subcolecciones

La mejor forma de almacenar mensajes en este caso es usar subcolecciones. Una subcolección es una colección asociada a un documento específico.

Nota: Puedes consultar subcolecciones con el mismo ID de colección mediante consultas de grupo de colecciones.

Puedes crear una subcolección llamada messages para cada documento de sala de tu colección rooms:

• salas

  • roomA

    name : "my chat room"
    

    • mensajes

      • message1

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

      • message2

        ...
        

  • roomB

    ...
    

En este ejemplo, crearías una referencia a un mensaje de la subcolección con el siguiente código:

Versión web 9

import { doc } from "firebase/firestore"; 

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

Versión web 8

Consulta más información sobre la API web modular de eliminación de código muerto y sus ventajas con respecto a la API con espacio de nombres.

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

Swift

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Objective‑C

Nota: Este producto no está disponible en los destinos de watchOS y App Clip.

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

Kotlin
Android

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

Java
Android

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
(Async)

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

Go

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

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

$document = $db
    ->collection('rooms')
    ->document('roomA')
    ->collection('messages')
    ->document('message1');

Unity

DocumentReference documentRef = db
	.Collection("Rooms").Document("RoomA")
	.Collection("Messages").Document("Message1");

C#

C#

Para autenticarte en Firestore, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

DocumentReference documentRef = db
    .Collection("Rooms").Document("RoomA")
    .Collection("Messages").Document("Message1");

Ruby

message_ref = firestore.col("rooms").doc("roomA").col("messages").doc("message1")
data_model.rb

Observa el patrón alterno de colecciones y documentos. Tus colecciones y documentos siempre deben seguir este patrón. No puedes hacer referencia a una colección en una colección ni a un documento en un documento.

Las subcolecciones te permiten estructurar los datos de forma jerárquica, lo que facilita el acceso a ellos. Para obtener todos los mensajes de roomA, puedes crear una referencia de colección a la subcolección messages e interactuar con ella como lo harías con cualquier otra referencia de colección.

Los documentos de las subcolecciones también pueden contener subcolecciones, lo que te permite anidar datos aún más. Puedes anidar datos hasta 100 niveles.

Advertencia: Al eliminar un documento, no se eliminan sus subcolecciones.

Cuando eliminas un documento que tiene subcolecciones, estas no se eliminan. Por ejemplo, puede haber un documento en coll/doc/subcoll/subdoc aunque el documento coll/doc ya no exista. Si quieres eliminar documentos de subcolecciones al eliminar un documento principal, debes hacerlo manualmente, como se indica en el artículo Eliminar colecciones.