הסרת שדות

תיאור

הסרת שדות מהמסמכים שנוצרו בשלב הקודם.

המסמכים שייווצרו יכללו את כל השדות מהשלב הקודם, למעט השדות שצוינו להסרה.

דוגמאות

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"));
Swift
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();

התנהגות

הסרת שדות מקוננים

בשלב 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(...) לא קיים במסמך, השלב לא יערוך את המסמך בשביל השדה הזה. שדות קיימים אחרים יוסרו.