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

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

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

סדרת נתונים והגבלת נתונים

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

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

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

Web

מידע נוסף על Web API מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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

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

Web

מידע נוסף על Web API מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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

Swift

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Objective-C

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Kotlin+KTX

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

מידע נוסף על Web API מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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

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

Web

מידע נוסף על Web API מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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

Swift

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Objective-C

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Kotlin+KTX

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

מידע נוסף על Web API מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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

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

Web

מידע נוסף על Web API מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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

Swift

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Objective-C

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Kotlin+KTX

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

מידע נוסף על Web API מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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 מודולרי שניתן לניפוי עצים ושדרוג מ-API עם מרחבי שמות.

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

Swift

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Objective-C

הערה: המוצר הזה לא זמין ליעדים של watchOS ו-App Clip.

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

Kotlin+KTX

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 במסמך הזה הוא null . כפתרון עקיף, אפשר להריץ שאילתות נפרדות לכל סדר או להקצות ערך לכל השדות לפי הסדר.

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”);