Удалить поля

Описание

Удалите поля из документов, созданных на предыдущем этапе.

Сгенерированные документы будут содержать все поля из предыдущего этапа, за исключением полей, которые необходимо удалить.

Примеры

Node.js
const results = await db.pipeline()
  .collection("cities")
  .removeFields("population", "location.state")
  .execute();

Web

const results = await execute(db.pipeline()
  .collection("cities")
  .removeFields("population", "location.state"));
Быстрый
let results = try await db.pipeline()
  .collection("cities")
  .removeFields(["population", "location.state"])
  .execute()

Kotlin

val results = db.pipeline()
    .collection("cities")
    .removeFields("population", "location.state")
    .execute()

Java

Task<Pipeline.Snapshot> results = db.pipeline()
        .collection("cities")
        .removeFields("population", "location.state")
        .execute();
Python
results = (
    client.pipeline()
    .collection("cities")
    .remove_fields("population", "location.state")
    .execute()
)
Java
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .collection("cities")
        .removeFields("population", "location.state")
        .execute()
        .get();
Идти
snapshot := client.Pipeline().Collection("cities").
	RemoveFields(firestore.Fields("population", "location.state")).
	Execute(ctx)

Поведение

Удалить вложенные поля

Этап remove_fields(...) учитывает синтаксис вложенных полей и удаляет ключи из карты.

Например, чтобы удалить вложенное поле состояния из набора данных:

Node.js

await db.collection("cities").doc("SF").set({name: "San Francisco", location: {country: "USA", state: "California"}});
await db.collection("cities").doc("TO").set({name: "Toronto", location: {country: "Canada", province: "Ontario"}});

Можно использовать следующий конвейер обработки данных:

Node.js

const results = await db.pipeline()
  .collection("/cities")
  .removeFields("location.state")
  .execute();

В результате создаются следующие документы:

{ name: "San Francisco", location: { country: "USA" } }
{ name: "Toronto", location: { country: "Canada", province: "Ontario" } }

Удаление элементов внутри массива не поддерживается.

Удалить из несуществующих полей

Если вложенное или поле верхнего уровня, переданное функции remove_fields(...) , отсутствует в документе, то этот этап не будет редактировать документ для данного поля. Другие существующие поля всё равно будут удалены.