Заказывайте и ограничивайте данные с помощью Cloud Firestore

Cloud Firestore предоставляет мощные функции запросов, позволяющие указать, какие документы вы хотите получить из коллекции. Эти запросы также можно использовать с помощью get() или addSnapshotListener() , как описано в разделе «Получение данных» .

Примечание. Хотя примеры кода охватывают несколько языков, текст, объясняющий примеры, относится к именам веб-методов.

Данные о заказах и лимитах

По умолчанию запрос извлекает все документы, удовлетворяющие запросу, в порядке возрастания идентификатора документа. Вы можете указать порядок сортировки ваших данных с помощью orderBy() и ограничить количество извлекаемых документов с помощью limit() . Если вы укажете limit() , значение должно быть больше или равно нулю.

Примечание. Предложение orderBy() также фильтрует наличие данного поля . В набор результатов не будут включены документы, не содержащие данное поле.

Например, вы можете запросить первые 3 города в алфавитном порядке с помощью:

Web

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

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

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

Web

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

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

Быстрый

Примечание. Этот продукт недоступен для целевых устройств watchOS и App Clip.

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

Цель-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

Ява

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

Питон

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

С++

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

Node.js

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

Идти

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

Единство

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

С#

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

Руби

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

Вы также можете отсортировать по убыванию, чтобы получить последние 3 города:

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

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

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

Быстрый

Примечание. Этот продукт недоступен для целевых устройств watchOS и App Clip.

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

Цель-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

Ява

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

Питон

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

С++

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

Идти

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

Единство

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

С#

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

Руби

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

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

Web

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

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

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

Web

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

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

Быстрый

Примечание. Этот продукт недоступен для целевых устройств watchOS и App Clip.

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

Цель-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

Ява

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

Питон

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

С++

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

Идти

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

Единство

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

С#

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

Руби

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

Вы можете комбинировать фильтрыwhere where() с orderBy() и limit() . В следующем примере запросы определяют порог численности, сортируют по численности населения в порядке возрастания и возвращают только первые несколько результатов, превышающих порог:

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

Узнайте больше о модульном веб-API, поддерживающем древовидную структуру, и обновите API с пространством имен.

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

Быстрый

Примечание. Этот продукт недоступен для целевых устройств watchOS и App Clip.

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

Цель-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

Ява

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

Питон

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

С++

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

Идти

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

Единство

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

С#

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

Руби

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

Однако если у вас есть фильтр со сравнением диапазонов ( < , <= , > , >= ), ваш первый порядок должен быть в том же поле, см. список ограничений orderBy() ниже.

Ограничения

Обратите внимание на следующее ограничение для предложений orderBy() :

• Предложение orderBy() также фильтрует наличие заданных полей . В набор результатов не будут включены документы, не содержащие данные поля.

orderBy и существование

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

Например, следующий запрос не вернет документы, в которых не задано поле population , даже если в остальном они соответствуют фильтрам запроса.

Ява

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

Похожий эффект применим и к неравенствам. Запрос с фильтром неравенства в поле также подразумевает упорядочивание по этому полю. Следующий запрос не возвращает документы без поля population , даже если в этом документе country = USA . В качестве обходного пути вы можете выполнить отдельные запросы для каждого порядка или присвоить значение всем полям, по которым вы упорядочиваете.

Ява

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

Приведенный выше запрос включает в себя подразумеваемый порядок неравенства и эквивалентен следующему:

Ява

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