Modificare i dati con le operazioni della pipeline Firestore

Utilizza le fasi del linguaggio di manipolazione dei dati (DML) update(...) e delete(...) per creare pipeline di dati in grado di eseguire query sui documenti e quindi eliminare o modificare i dati.

Requisiti della versione

Le operazioni descritte in questa pagina richiedono la versione Enterprise di Firestore.

Prima di iniziare

Dovresti sapere come eseguire query su un database con le operazioni della pipeline.

Aggiornare i documenti

Utilizza la fase DML update(...) per creare pipeline di dati in grado di eseguire query sui documenti e quindi aggiungere o modificare i dati.

Tutte le fasi DML devono essere alla fine della pipeline. I documenti che entrano in questa fase devono includere il campo __name__ per identificare i documenti da aggiornare. L'operazione non riesce se uno dei documenti che tenti di aggiornare non esiste.

Ad esempio, la seguente operazione esegue il backfill di una modifica del modello di dati in tutti i documenti di un gruppo di raccolte. La pipeline aggiunge un campo preferences.color a tutti i documenti del gruppo di raccolte users in cui manca questo campo.

const snapshot = await db.pipeline()
   .collectionGroup("users")
   .where(not(exists(field("preferences.color"))))
   .addFields(constant(null).as("preferences.color"))
   .removeFields("color")
   .update()
   .execute();
test.firestore.js

from google.cloud.firestore_v1.pipeline_expressions import Constant, Field, Not

snapshot = (
    client.pipeline()
    .collection_group("users")
    .where(Not(Field.of("preferences.color").exists()))
    .add_fields(Constant.of(None).as_("preferences.color"))
    .remove_fields("color")
    .update()
    .execute()
)
firestore_pipelines.py

Pipeline.Snapshot snapshot = firestore.pipeline()
   .collectionGroup("users")
   .where(not(exists(field("preferences.color"))))
   .addFields(constant((String) null).as("preferences.color"))
   .removeFields("color")
   .update()
   .execute().get();
PipelineSnippets.java

Eliminare i documenti

Utilizza le fasi DML delete(...) stage per creare pipeline di dati in grado di eseguire query sui documenti e quindi eliminare i dati. Per evitare eliminazioni collettive accidentali, le pipeline che terminano con delete(...) devono includere almeno una fase where(...). Tutte le fasi DML devono essere alla fine della pipeline.

Ad esempio, la seguente pipeline elimina tutti i users documenti con address.users impostato su USA e con __create_time__ inferiore a 10 giorni:

const pipeline = db.pipeline()
  .collectionGroup("users")
  .where(field("address.country").equal("USA"))
  .where(field("__create_time__").timestampAdd("day", 10).lessThan(currentTimestamp()))
  .delete();
await pipeline.execute();
test.firestore.js

from google.cloud.firestore_v1.pipeline_expressions import CurrentTimestamp, Field

snapshot = (
    client.pipeline()
    .collection_group("users")
    .where(Field.of("address.country").equal("USA"))
    .where(
        Field.of("__create_time__")
        .timestamp_add("day", 10)
        .less_than(CurrentTimestamp())
    )
    .delete()
    .execute()
)
firestore_pipelines.py

Pipeline.Snapshot deleteResults = firestore.pipeline()
  .collectionGroup("users")
  .where(field("address.country").equal("USA"))
  .where(field("__create_time__").add(constant(10)).lessThan(currentTimestamp()))
  .delete()
  .execute().get();
PipelineSnippets.java

Coerenza

Le operazioni della pipeline con le fasi update(...) e delete() non sono supportate all'interno di una transazione. Le fasi DML vengono eseguite al di fuori di una transazione con il seguente comportamento:

• Ogni documento viene aggiornato in modo indipendente. Ciò significa che le operazioni non sono atomiche tra i documenti. L'operazione non riesce al primo errore ed è possibile un successo parziale.
• Sono supportate le seguenti fasi:
  • collection(...)
  • collection_group(...)
  • where(...)
  • select(...)
  • add_fields(...)
  • remove_fields(...)
  • let(...)
  • sort(...)
  • limit(...)
  • offset(...)
• Le seguenti fasi non sono supportate:
  • aggregate(...)
  • distinct(...)
  • unnest(...)
  • find_nearest(...)
  • Le fasi di query multiple come union(...), join e sottoquery non sono consentite prima di una fase DML.

Limitazioni

Tieni presenti le seguenti limitazioni per le fasi DML:

• Le fasi DML devono essere le ultime fasi in una definizione di pipeline prima di chiamare .execute().
• Le operazioni della pipeline con le fasi update(...) e delete() non sono supportate all'interno di una transazione.
• Se la fase precedente alla fase DML produce più documenti con lo stesso __name__, ogni istanza viene elaborata. Per update(...), ciò significa che lo stesso documento di destinazione potrebbe essere modificato più volte. Per delete(...), i tentativi successivi al primo non avranno effetto.