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. Au lieu de cela, vous stockez les données dans des documents , qui sont organisés en collections .

Chaque document contient un ensemble de paires clé-valeur. Cloud Firestore est optimisé pour stocker de grandes collections 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 inclure des champs primitifs comme des chaînes ou des objets complexes comme des listes.

Les collections et les documents sont créés implicitement dans Cloud Firestore. Attribuez simplement 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 léger qui contient des champs, qui correspondent à des valeurs. Chaque document est identifié par un nom.

Un document représentant un utilisateur alovelace pourrait ressembler à ceci :

• class alovelace

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

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

• class alovelace

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

Vous remarquerez peut-être que les documents ressemblent beaucoup à JSON. En fait, ils le sont essentiellement. Il existe quelques différences (par exemple, les documents prennent en charge des types de données supplémentaires et leur taille est limitée à 1 Mo), mais en général, vous pouvez traiter les documents comme des enregistrements JSON légers.

Collections

Les documents vivent dans des collections, qui sont simplement des conteneurs de documents. Par exemple, vous pourriez avoir une collection users pour contenir vos différents utilisateurs, chacun représenté par un document :

• utilisateurs collections_bookmark

  • class alovelace

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

  • maturation class

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

Cloud Firestore est sans schéma, vous avez donc une totale liberté sur les champs que vous placez dans chaque document et sur les 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. Cependant, il est conseillé d'utiliser les mêmes champs et types de données dans plusieurs documents, afin de pouvoir interroger les documents plus facilement.

Une collection contient des documents et rien d'autre. Il ne peut pas contenir directement des champs bruts avec des valeurs et il ne peut pas contenir d'autres collections. (Voir Données hiérarchiques pour une explication sur la façon de structurer des données plus complexes dans Cloud Firestore.)

Les noms des documents d'une collection sont uniques. Vous pouvez fournir vos propres clés, telles que des ID utilisateur, ou vous pouvez laisser Cloud Firestore créer automatiquement des ID aléatoires pour vous.

Vous n'avez pas besoin de "créer" ou de "supprimer" des collections. Une fois que vous avez créé le premier document d'une collection, la collection existe. Si vous supprimez tous les documents d'une collection, celle-ci n'existe plus.

Les références

Chaque document dans Cloud Firestore est identifié de manière unique par son emplacement dans la base de données. L'exemple précédent montrait un document alovelace au sein de la collection users . Pour faire référence à cet emplacement dans votre code, vous pouvez créer une référence à celui-ci.

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

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

func createDocReference(client *firestore.Client) {

	alovelaceRef := client.Collection("users").Doc("alovelace")

	_ = alovelaceRef
}
retrieve_data_reference_document.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

Une référence est un objet léger qui pointe simplement vers un emplacement dans votre base de données. Vous pouvez créer une référence, que des données y soient présentes ou non, et la création d'une référence n'effectue aucune opération réseau.

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

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

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

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

	_ = usersRef
}
retrieve_data_reference_collection.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

Pour plus de commodité, vous pouvez également créer des références en spécifiant le chemin d'accès à un document ou à une collection sous forme de chaîne, avec des composants de chemin séparés par une barre oblique ( / ). Par exemple, pour créer une référence au document 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('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

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

$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

Données hiérarchiques

Pour comprendre le fonctionnement des structures de données hiérarchiques dans Cloud Firestore, considérons un exemple d'application de chat avec des messages et des salles de chat.

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

• collections_bookmark salles

  • salle class

    name : "my chat room"
    

  • salle class

    ...
    

Maintenant que vous avez des salons de discussion, décidez comment stocker vos messages. Vous ne voudrez peut-être pas les stocker dans le document de la salle de discussion. Les documents dans Cloud Firestore doivent être légers et une salle de discussion peut contenir un grand nombre de messages. Cependant, vous pouvez créer des collections supplémentaires dans le document de votre salle de discussion, en tant que sous-collections.

Sous-collections

La meilleure façon de stocker des messages dans ce scénario consiste à utiliser des sous-collections. Une sous-collection est une collection associée à un document spécifique.

Vous pouvez créer une sous-collection appelée messages pour chaque document de salle de votre collection rooms :

• collections_bookmark salles

  • salle class

    name : "my chat room"
    

    • messages collections_bookmark

      • message class

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

      • message class

        ...
        

  • salle class

    ...
    

Dans cet exemple, vous créeriez une référence à un message dans la sous-collection avec le code suivant :

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

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

$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

Remarquez l'alternance des collections et des documents. Vos collections et documents doivent toujours suivre ce modèle. Vous ne pouvez pas référencer une collection dans une collection ou un document dans un document.

Les sous-collections vous permettent de structurer les données de manière hiérarchique, ce qui facilite l'accès aux données. Pour obtenir tous les messages dans roomA , vous pouvez créer une référence de collection aux messages de la sous-collection et interagir avec elle comme vous le feriez avec n'importe quelle autre référence de collection.

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