Remplacer par (étape de transformation)

Remplacer par (étape de transformation)

Description

Remplace les champs du document existant par les champs d'une expression donnée.

L'expression peut être une carte littérale ou une expression qui renvoie à une carte. Si une expression donnée ne renvoie pas à une carte, cette étape renvoie une erreur.

Trois modes sont compatibles :

• full_replace: remplace l'intégralité du document par le résultat de l'expression donnée, en omettant les champs qui n'y figurent pas.
• merge_overwrite_existing: fusionne l'expression avec le document existant, en remplaçant les valeurs de champ du document par les valeurs de l'expression.
• merge_keep_existing: fusionne l'expression avec le document existant, en n'ajoutant des valeurs de champ que lorsqu'il n'en existe pas dans le document.

Exemples

Créez une collection cities avec les documents suivants :

Node.js

await db.collection("cities").doc("SF").set({name: "San Francisco", population: 800000, location: {country: "USA", state: "California"}});
await db.collection("cities").doc("TO").set({name: "Toronto", population:  3000000, province: "ON", location: {country: "Canada", province: "Ontario"}});
await db.collection("cities").doc("NY").set({name: "New York", location: {country: "USA", state: "New York"}});
await db.collection("cities").cov("AT").set({name: "Atlantis", population: null});

Utiliser le mode full_replace pour obtenir une version modifiée du document

Extrayez le champ location imbriqué, en ignorant toutes les autres données :

Node.js

  const names = await db.pipeline()
    .collection("/cities")
    .replace_with(Field.of("location"), "full_replace")
    .execute();
    

Java

Pipeline.Snapshot names =
    firestore.pipeline().collection("cities").replaceWith(field("location")).execute().get();
PipelineSnippets.java

Go

snapshot := client.Pipeline().
	Collection("cities").
	ReplaceWith(firestore.FieldOf("location")).
	Execute(ctx)
pipeline_snippets_general.go

Résultat :

{ country: "USA", state: "California" },
{ country: "Canada", province: "Ontario" },
{ country: "USA", state: "New York" },
{ }

Utiliser le mode merge_overwrite_existing pour définir des champs

Définissez le champ population de tous les documents sur 0, en remplaçant les valeurs existantes :

Node.js

  const censoredResults = await db.pipeline()
    .collection("/cities")
    .replace_with(map("population", 0), "merge_overwrite_existing")
    .execute();
    

Résultat :

{name: "San Francisco", population: 0, location: {country: "USA", state: "California"}},
{name: "Toronto", population: 0, province: "ON", location: {country: "Canada", province: "Ontario"}},
{name: "New York", population: 0, location: {country: "USA", state: "New York"}},
{name: "Atlantis", population: 0}

Utiliser le mode merge_keep_existing pour ajouter une valeur par défaut

Définir une valeur par défaut pour location lorsqu'il n'apparaît pas dans un document :

Node.js

  const defaultedResults = await db.pipeline()
    .collection("/cities")
    .replace_with(map("location", "unknown"), "merge_keep_existing")
    .execute();
    

Résultat :

{ name: "San Francisco", population: 800000, location: { country: "USA", state: "California" } },
{ name: "Toronto", province: "ON", population: 3000000, location: { country: "Canada", province: "Ontario" } },
{ name: "New York", location: { country: "USA", state: "New York" } },
{ name: "Atlantis", population: null, location: "unknown" }