הזמנה והגבלה של נתונים באמצעות Cloud Firestore

‫Cloud Firestore מספקת פונקציונליות עוצמתית של שאילתות, שמאפשרת לציין אילו מסמכים רוצים לאחזר מאוסף. אפשר להשתמש בשאילתות האלה גם עם get() או עם addSnapshotListener(), כמו שמתואר במאמר קבלת נתונים.

הערה: דוגמאות הקוד כוללות כמה שפות, אבל הטקסט שמסביר את הדוגמאות מתייחס לשמות של שיטות אינטרנט.

הזמנה והגבלה של נתונים

כברירת מחדל, שאילתה מאחזרת את כל המסמכים שתואמים לשאילתה בסדר עולה לפי מזהה המסמך. אפשר לציין את סדר המיון של הנתונים באמצעות orderBy(), ולהגביל את מספר המסמכים שאוחזרו באמצעות limit(). אם מציינים limit(), הערך חייב להיות גדול מאפס או שווה לו.

הערה: פסוקית orderBy() גם מסננת את קיום השדה הנתון. קבוצת התוצאות לא תכלול מסמכים שלא מכילים את השדה שצוין.

לדוגמה, אפשר לשאול מהן 3 הערים הראשונות לפי סדר אלפביתי באמצעות השאילתה:

Web

import { query, orderBy, limit } from "firebase/firestore";  

const q = query(citiesRef, orderBy("name"), limit(3));
order_and_limit.js

Web

מידע נוסף על Web API מודולרי שאפשר להשתמש בו בטכניקת Tree Shaking, ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

citiesRef.orderBy("name").limit(3);
test.firestore.js

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

citiesRef.order(by: "name").limit(to: 3)
ViewController.swift

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

[[citiesRef queryOrderedByField:@"name"] queryLimitedTo:3];
ViewController.m

Kotlin

citiesRef.orderBy("name").limit(3)
DocSnippets.kt

Java

citiesRef.orderBy("name").limit(3);
DocSnippets.java

Dart

final citiesRef = db.collection("cities");
citiesRef.orderBy("name").limit(3);
firestore.dart

Java

Query query = cities.orderBy("name").limit(3);
Query query = cities.orderBy("name").limitToLast(3);
QueryDataSnippets.java

Python

cities_ref = db.collection("cities")
query = cities_ref.order_by("name").limit_to_last(2)
results = query.get()
snippets.py

Python

cities_ref = db.collection("cities")
query = cities_ref.order_by("name").limit_to_last(2)
results = await query.get()
snippets.py

C++‎

cities_ref.OrderBy("name").Limit(3);
snippets.cpp

Node.js

const firstThreeRes = await citiesRef.orderBy('name').limit(3).get();
index.js

Go

query := cities.OrderBy("name", firestore.Asc).Limit(3)
query := cities.OrderBy("name", firestore.Asc).LimitToLast(3)
query.go

PHP

PHP

מידע נוסף על התקנה ויצירה של לקוח Cloud Firestore זמין במאמר ספריות לקוח של Cloud Firestore.

$query = $citiesRef->orderBy('name')->limit(3);
query_order_limit.php

Unity

Query query = citiesRef.OrderBy("Name").Limit(3);

C#‎

Query query = citiesRef.OrderBy("Name").Limit(3);
Program.cs

Ruby

query = cities_ref.order("name").limit(3)
order_limit_data.rb

אפשר גם למיין בסדר יורד כדי לקבל את 3 הערים האחרונות:

Web

import { query, orderBy, limit } from "firebase/firestore";  

const q = query(citiesRef, orderBy("name", "desc"), limit(3));
order_and_limit_desc.js

Web

מידע נוסף על Web API מודולרי שאפשר להשתמש בו בטכניקת Tree Shaking, ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

citiesRef.orderBy("name", "desc").limit(3);
test.firestore.js

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

citiesRef.order(by: "name", descending: true).limit(to: 3)
ViewController.swift

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

[[citiesRef queryOrderedByField:@"name" descending:YES] queryLimitedTo:3];
ViewController.m

Kotlin

citiesRef.orderBy("name", Query.Direction.DESCENDING).limit(3)
DocSnippets.kt

Java

citiesRef.orderBy("name", Direction.DESCENDING).limit(3);
DocSnippets.java

Dart

final citiesRef = db.collection("cities");
citiesRef.orderBy("name", descending: true).limit(3);
firestore.dart

Java

Query query = cities.orderBy("name", Direction.DESCENDING).limit(3);
QueryDataSnippets.java

Python

cities_ref = db.collection("cities")
query = cities_ref.order_by("name", direction=firestore.Query.DESCENDING).limit(3)
results = query.stream()
snippets.py

Python

cities_ref = db.collection("cities")
query = cities_ref.order_by("name", direction=firestore.Query.DESCENDING).limit(3)
results = query.stream()
snippets.py

C++‎

cities_ref.OrderBy("name", Query::Direction::kDescending).Limit(3);
snippets.cpp

Node.js

const lastThreeRes = await citiesRef.orderBy('name', 'desc').limit(3).get();
index.js

Go

query := cities.OrderBy("name", firestore.Desc).Limit(3)
query.go

PHP

PHP

מידע נוסף על התקנה ויצירה של לקוח Cloud Firestore זמין במאמר ספריות לקוח של Cloud Firestore.

$query = $citiesRef->orderBy('name', 'DESC')->limit(3);
query_order_desc_limit.php

Unity

Query query = citiesRef.OrderByDescending("Name").Limit(3);

C#‎

Query query = citiesRef.OrderByDescending("Name").Limit(3);
Program.cs

Ruby

query = cities_ref.order("name", "desc").limit(3)
order_limit_data.rb

אפשר גם למיין לפי כמה שדות. לדוגמה, אם רוצים למיין לפי מדינה, ובכל מדינה למיין לפי אוכלוסייה בסדר יורד:

Web

import { query, orderBy } from "firebase/firestore";  

const q = query(citiesRef, orderBy("state"), orderBy("population", "desc"));
order_multiple.js

Web

מידע נוסף על Web API מודולרי שאפשר להשתמש בו בטכניקת Tree Shaking, ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

citiesRef.orderBy("state").orderBy("population", "desc");
test.firestore.js

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

citiesRef
  .order(by: "state")
  .order(by: "population", descending: true)
ViewController.swift

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

[[citiesRef queryOrderedByField:@"state"] queryOrderedByField:@"population" descending:YES];
ViewController.m

Kotlin

citiesRef.orderBy("state").orderBy("population", Query.Direction.DESCENDING)
DocSnippets.kt

Java

citiesRef.orderBy("state").orderBy("population", Direction.DESCENDING);
DocSnippets.java

Dart

final citiesRef = db.collection("cities");
citiesRef.orderBy("state").orderBy("population", descending: true);
firestore.dart

Java

Query query = cities.orderBy("state").orderBy("population", Direction.DESCENDING);
QueryDataSnippets.java

Python

cities_ref = db.collection("cities")
ordered_city_ref = cities_ref.order_by("state").order_by(
    "population", direction=firestore.Query.DESCENDING
)
snippets.py

Python

cities_ref = db.collection("cities")
cities_ref.order_by("state").order_by(
    "population", direction=firestore.Query.DESCENDING
)
snippets.py

C++‎

cities_ref.OrderBy("state").OrderBy("name", Query::Direction::kDescending);
snippets.cpp

Node.js

const byStateByPopRes = await citiesRef.orderBy('state').orderBy('population', 'desc').get();
index.js

Go

query := client.Collection("cities").OrderBy("state", firestore.Asc).OrderBy("population", firestore.Desc)
query.go

PHP

PHP

מידע נוסף על התקנה ויצירה של לקוח Cloud Firestore זמין במאמר ספריות לקוח של Cloud Firestore.

$query = $citiesRef->orderBy('state')->orderBy('population', 'DESC');
query_order_multi.php

Unity

Query query = citiesRef.OrderBy("State").OrderByDescending("Population");

C#‎

Query query = citiesRef.OrderBy("State").OrderByDescending("Population");
Program.cs

Ruby

query = cities_ref.order("state").order("population", "desc")
order_limit_data.rb

אפשר לשלב בין מסנני where() לבין orderBy() ו-limit(). בדוגמה הבאה, השאילתות מגדירות סף לאוכלוסייה, ממיינות לפי אוכלוסייה בסדר עולה ומחזירות רק את התוצאות הראשונות שעולות על הסף:

Web

import { query, where, orderBy, limit } from "firebase/firestore";  

const q = query(citiesRef, where("population", ">", 100000), orderBy("population"), limit(2));
filter_and_order.js

Web

מידע נוסף על Web API מודולרי שאפשר להשתמש בו בטכניקת Tree Shaking, ועל היתרונות שלו בהשוואה ל-API עם מרחב שמות.

citiesRef.where("population", ">", 100000).orderBy("population").limit(2);
test.firestore.js

Swift

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

citiesRef
  .whereField("population", isGreaterThan: 100000)
  .order(by: "population")
  .limit(to: 2)
ViewController.swift

Objective-C

הערה: המוצר הזה לא זמין ב-watchOS ובמטרות של קליפים של אפליקציות.

[[[citiesRef queryWhereField:@"population" isGreaterThan:@100000]
    queryOrderedByField:@"population"]
    queryLimitedTo:2];
ViewController.m

Kotlin

citiesRef.whereGreaterThan("population", 100000).orderBy("population").limit(2)
DocSnippets.kt

Java

citiesRef.whereGreaterThan("population", 100000).orderBy("population").limit(2);
DocSnippets.java

Dart

final citiesRef = db.collection("cities");
citiesRef
    .where("population", isGreaterThan: 100000)
    .orderBy("population")
    .limit(2);
firestore.dart

Java

Query query = cities.whereGreaterThan("population", 2500000L).orderBy("population").limit(2);
QueryDataSnippets.java

Python

cities_ref = db.collection("cities")
query = (
    cities_ref.where(filter=FieldFilter("population", ">", 2500000))
    .order_by("population")
    .limit(2)
)
results = query.stream()
snippets.py

Python

cities_ref = db.collection("cities")
query = (
    cities_ref.where(filter=FieldFilter("population", ">", 2500000))
    .order_by("population")
    .limit(2)
)
results = query.stream()
snippets.py

C++‎

cities_ref.WhereGreaterThan("population", FieldValue::Integer(100000))
    .OrderBy("population")
    .Limit(2);
snippets.cpp

Node.js

const biggestRes = await citiesRef.where('population', '>', 2500000)
  .orderBy('population').limit(2).get();
index.js

Go

query := cities.Where("population", ">", 2500000).OrderBy("population", firestore.Desc).Limit(2)
query.go

PHP

PHP

מידע נוסף על התקנה ויצירה של לקוח Cloud Firestore זמין במאמר ספריות לקוח של Cloud Firestore.

$query = $citiesRef
    ->where('population', '>', 2500000)
    ->orderBy('population')
    ->limit(2);
query_order_limit_field_valid.php

Unity

Query query = citiesRef
    .WhereGreaterThan("Population", 2500000)
    .OrderBy("Population")
    .Limit(2);

C#‎

Query query = citiesRef
    .WhereGreaterThan("Population", 2500000)
    .OrderBy("Population")
    .Limit(2);
Program.cs

Ruby

query = cities_ref.where("population", ">", 2_500_000).order("population").limit(2)
order_limit_data.rb

עם זאת, אם יש לכם מסנן עם השוואה של טווח (<,‏ <=,‏ >,‏ >=), המיון הראשון צריך להיות באותו שדה. בהמשך מופיעה רשימה של orderBy() מגבלות.

מגבלות

שימו לב להגבלה הבאה לגבי סעיפים orderBy():

• סעיף orderBy() גם מסנן את השדות הנתונים לפי קיומם. קבוצת התוצאות לא תכלול מסמכים שלא מכילים את השדות שצוינו.

orderBy וקיום

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

לדוגמה, השאילתה הבאה לא תחזיר מסמכים שבהם השדה population לא מוגדר, גם אם הם עומדים בדרישות של מסנני השאילתה.

Java

db.collection("cities").whereEqualTo("country", “USA”).orderBy(“population”);

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

Java

db.collection(“cities”).where(or(“country”, USA”), greaterThan(“population”, 250000));

השאילתה שלמעלה כוללת סעיף order-by משתמע על אי-השוויון, והיא שוות ערך לשאילתה הבאה:

Java

db.collection(“cities”).where(or(“country”, USA”), greaterThan(“population”, 250000)).orderBy(“population”);