איסוף

תיאור

מחזירה את כל המסמכים מאוסף נתון. אפשר להוסיף אוספים בתוך אוספים.

תחביר

Node.js

const results = await db.pipeline()
  .collection('/cities/SF/departments')
  .execute();

דוגמאות ללקוחות

Web

const results = await execute(db.pipeline()
  .collection("users/bob/games")
  .sort(field("name").ascending())
  );
test.firestore.js
Swift
let results = try await db.pipeline()
  .collection("users/bob/games")
  .sort([Field("name").ascending()])
  .execute()
PipelineSnippets.swift

Kotlin

val results = db.pipeline()
    .collection("users/bob/games")
    .sort(field("name").ascending())
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> results = db.pipeline()
    .collection("users/bob/games")
    .sort(field("name").ascending())
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

results = (
    client.pipeline()
    .collection("users/bob/games")
    .sort(Field.of("name").ascending())
    .execute()
)
firestore_pipelines.py
Java
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .collection("users/bob/games")
        .sort(ascending(field("name")))
        .execute()
        .get();
PipelineSnippets.java

התנהגות

כדי להשתמש בשלב collection, הוא צריך להופיע כשלב הראשון בצינור.

סדר המסמכים שמוחזרים משלב collection לא יציב, ולכן לא מומלץ להסתמך עליו. אפשר להשתמש בשלב מיון נוסף כדי לקבל סדר דטרמיניסטי.

לדוגמה, עבור המסמכים הבאים:

Node.js

await db.collection('cities').doc('SF').set({name: 'San Francsico', state: 'California'});
await db.collection('cities').doc('NYC').set({name: 'New York City', state: 'New York'});
await db.collection('cities').doc('CHI').set({name: 'Chicago', state: 'Illinois'});
await db.collection('states').doc('CA').set({name: 'California'});

אפשר להשתמש בשלב collection כדי לאחזר את כל הערים באוסף cities ואז למיין אותן בסדר עולה לפי שם.

Node.js

const results = await db.pipeline()
  .collection('/cities')
  .sort(field('name').ascending())
  .execute();

השאילתה הזו יוצרת את המסמכים הבאים:

  {name: 'Chicago', state: 'Illinois'}
  {name: 'New York City', state: 'New York'}
  {name: 'San Francisco', state: 'California'}

אוספי משנה

אפשר להשתמש בשלב collection גם כדי לטרגט אוספים תחת הורה ספציפי על ידי ציון הנתיב המלא לשלב.

לדוגמה, עבור המסמכים הבאים:

Node.js

await db.collection('cities/SF/departments').doc('building').set({name: 'SF Building Deparment', employees: 750});
await db.collection('cities/NY/departments').doc('building').set({name: 'NY Building Deparment', employees: 1000});
await db.collection('cities/CHI/departments').doc('building').set({name: 'CHI Building Deparment', employees: 900});
await db.collection('cities/NY/departments').doc('finance').set({name: 'NY Finance Deparment', employees: 1200});

בדוגמה הזו, אנחנו רוצים רק את המחלקות של העיר ניו יורק.

Node.js

const results = await db.pipeline()
  .collection('/cities/NY/departments')
  .sort(field('employees').ascending())
  .execute();

הפעולה הזו תחזיר את כל המחלקות בנתיב המלא cities/NY/departments.

  {name: 'NY Building Deparment', employees: 1000}
  {name: 'NY Finance Deparment', employees: 1200}