Modèle de données Cloud Firestore

Cloud Firestore est une base de données NoSQL orientée documents. Contrairement à une base de données SQL, il n'y a ni tables, ni lignes. À la place, vous stockez les données dans des documents organisés en collections.

Chaque document contient un ensemble de paires clé/valeur. Cloud Firestore est optimisé pour le stockage de grandes collections composées de petits documents.

Tous les documents doivent être stockés dans des collections. Les documents peuvent contenir des sous-collections et des objets imbriqués qui peuvent tous deux être constitués de champs de données élémentaires, tels que des chaînes, ou d'objets complexes, tels que des listes.

Dans Cloud Firestore, les collections et les documents sont créés implicitement. Il vous suffit d'attribuer des données à un document au sein d'une collection. Si la collection ou le document n'existe pas, Cloud Firestore le crée.

Documents

Dans Cloud Firestore, l'unité de stockage est le document. Un document est un enregistrement de données allégé qui contient des champs correspondant à des valeurs. Chaque document est identifié par un nom.

Voici un exemple de document représentant un utilisateur alovelace :

• alovelace

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

Remarque :Cloud Firestore accepte plusieurs types de données en tant que valeurs : booléens, nombres, chaînes, points géographiques, blobs binaires et horodatage. Pour structurer les données d'un document, vous pouvez également utiliser des tableaux ou des objets imbriqués, appelés cartes.

Les objets complexes imbriqués dans un document sont appelés cartes. Ainsi, dans l'exemple ci-dessus, vous pouvez structurer le nom de l'utilisateur à l'aide d'une carte, comme ceci :

• alovelace

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

Vous remarquerez peut-être que les documents ressemblent beaucoup à du JSON. C'est parce qu'ils sont basés sur ce format. Même si des différences existent (par exemple, les documents acceptent davantage de types de données et leur taille est limitée à 1 Mo), vous pouvez généralement considérer que les documents sont des enregistrements JSON allégés.

Collections

Les documents se trouvent dans des collections, qui sont de simples conteneurs. Par exemple, vous pouvez créer une collection users pour accueillir vos différents utilisateurs, chacun représenté par un document :

• users

  • alovelace

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

  • aturing

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

Cloud Firestore est un système de bases de données sans schéma. Vous disposez ainsi d'une liberté totale quant aux champs que vous placez dans chaque document et aux types de données que vous stockez dans ces champs. Les documents d'une même collection peuvent tous contenir des champs différents ou stocker différents types de données dans ces champs. Toutefois, lorque vous créez plusieurs documents, il est conseillé d'utiliser des champs et types de données similaires afin de pouvoir plus facilement effectuer des requêtes sur l'ensemble.

Une collection ne contient rien d'autre que des documents. Elle ne peut pas contenir directement de champs bruts associés à des valeurs ni contenir d'autres collections. Pour plus d'informations sur la façon de structurer des données plus complexes dans Cloud Firestore, consultez la page Données hiérarchiques.

Les noms des documents d'une collection doivent être uniques. Vous pouvez fournir vos propres clés, telles que des identifiants d'utilisateur, ou laisser Cloud Firestore générer des identifiants aléatoires automatiquement.

Il n'est pas nécessaire de créer ou de supprimer des collections. Une collection existe dès lors qu'un premier document y est créé. Si vous supprimez tous les documents d'une collection, elle n'existe plus.

Références

Dans Cloud Firestore, chaque document est identifiable de manière unique en fonction de sa position dans la base de données. L'exemple précédent présentait un document alovelace placé dans la collection users. Pour mentionner cet emplacement dans votre code, vous pouvez lui associer une référence.

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

import { doc } from "firebase/firestore";

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

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

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

Swift

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Objective-C

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Kotlin+KTX

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

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

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Unity

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

C#

C#

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Ruby

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

Une référence est un objet léger qui pointe simplement vers un emplacement de votre base de données. Vous pouvez créer une référence même s'il n'existe aucune donnée. La création d'une référence n'exécute aucune opération réseau.

Vous pouvez également créer des références à des collections :

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

import { collection } from "firebase/firestore";

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

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

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

Swift

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Objective-C

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Kotlin+KTX

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

Go

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

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

	_ = usersRef
}
retrieve_data_reference_collection.go

PHP

PHP

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Unity

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

C#

C#

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Ruby

collection_ref = firestore.col "users"
data_model.rb

Remarque : Les références aux collections et les références aux documents sont deux types de références distincts, qui vous permettent d'exécuter différentes opérations. Par exemple, une référence à une collection vous permet d'effectuer une requête sur les documents de la collection, tandis qu'une référence à un document vous permet de lire ou d'écrire dans un document individuel.

Pour des raisons pratiques, vous avez également la possibilité de créer des références en spécifiant le chemin d'accès d'un document ou d'une collection sous forme de chaîne dont les éléments sont séparés par une barre oblique (/). Par exemple, voici comment créer une référence au document alovelace :

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

import { doc } from "firebase/firestore"; 

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

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

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

Swift

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Objective-C

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Kotlin+KTX

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

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

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Unity

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

C#

C#

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Ruby

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

Données hiérarchiques

Pour comprendre le fonctionnement des structures de données hiérarchiques dans Cloud Firestore, prenons l'exemple d'une application de chat contenant des messages et des salons de discussion.

Vous pouvez créer une collection appelée rooms pour stocker différents salons de discussion :

• rooms

  • roomA

    name : "my chat room"
    

  • roomB

    ...
    

Maintenant que vous avez créé une collection de salons de discussion, choisissez comment stocker les messages. Il serait préférable de ne pas les stocker dans le document du salon de discussion, car dans Cloud Firestore, les documents doivent être légers. Or, un salon de discussion peut contenir un nombre important de messages. Toutefois, vous pouvez créer des collections supplémentaires dans le document de votre salon de discussion, sous la forme de sous-collections.

Sous-collections

Dans ce cas de figure, le meilleur moyen de stocker les messages consiste à utiliser des sous-collections. Une sous-collection est une collection associée à un document spécifique.

Remarque : Vous pouvez effectuer des requêtes sur plusieurs sous-collections avec le même identifiant de collection à l'aide des requêtes de groupe de collections.

Dans votre collection rooms, vous pouvez créer une sous-collection appelée messages pour chaque document de salon de discussion :

• rooms

  • roomA

    name : "my chat room"
    

    • messages

      • message1

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

      • message2

        ...
        

  • roomB

    ...
    

Dans cet exemple, une référence à un message de la sous-collection est créée à l'aide du code suivant :

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

import { doc } from "firebase/firestore"; 

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

Web

En savoir plus sur l'API Web modulaire pouvant être allégée par "tree shaking" et sur la mise à niveau depuis l'API avec espace de noms

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

Swift

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Objective-C

Remarque : Ce produit n'est pas disponible sur les cibles watchOS et App Clip.

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

Kotlin+KTX

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

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

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Unity

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

C#

C#

Pour en savoir plus sur l'installation et la création d'un client Cloud Firestore, consultez la page Bibliothèques clientes Cloud Firestore.

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

Ruby

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

Notez l'alternance des collections et des documents. Vos collections et vos documents doivent toujours respecter ce format. Vous ne pouvez pas référencer de collection dans une collection ou de document dans un document.

Les sous-collections vous permettent de structurer les données de manière hiérarchique pour les rendre plus accessibles. Pour obtenir tous les messages dans roomA, vous pouvez créer une référence à une sous-collection messages, puis interagir avec elle comme vous le feriez avec toute autre référence à une collection.

Les documents des sous-collections peuvent également contenir des sous-collections, ce qui vous permet d'imbriquer davantage de données. Vous pouvez imbriquer jusqu'à 100 niveaux de données.

Avertissement : La suppression d'un document n'entraîne pas la suppression de ses sous-collections.

Lorsque vous supprimez un document contenant des sous-collections, celles-ci ne sont pas supprimées. Par exemple, un document peut être situé à l'emplacement coll/doc/subcoll/subdoc même si le document coll/doc n'existe plus. Si vous souhaitez supprimer des documents dans des sous-collections lorsque vous supprimez un document parent, vous devez le faire manuellement, comme indiqué dans la page Supprimer les collections.