Эта страница переведена с помощью Cloud Translation API.

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

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

Заказать и ограничить данные

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

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

Web modular API

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

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

Web namespaced 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

Дополнительные сведения об установке и создании клиента 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 modular API

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

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

Web namespaced 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

$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 modular API

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

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

Web namespaced 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')
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

$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() с orderBy() и limit() . В следующем примере запросы определяют пороговое значение совокупности, сортируются по совокупности в порядке возрастания и возвращают только первые несколько результатов, превышающих пороговое значение:

Web modular 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 namespaced 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(
    'population', '>', 2500000).order_by('population').limit(2)
results = query.stream()snippets.py

Python

cities_ref = db.collection("cities")
query = cities_ref.where("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

$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 в одном и том же поле.

Web modular API

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

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

Web namespaced API

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

Быстрый

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

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

Цель-C

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

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

Kotlin+KTX

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

Java

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

Dart

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

Джава

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

питон

cities_ref = db.collection('cities')
query = cities_ref.where(
    'population', '>', 2500000).order_by('population')
results = query.stream()snippets.py

Python

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

Node.js

citiesRef.where('population', '>', 2500000).orderBy('population');index.js

Идти

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

PHP

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

Единство

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

С#

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

Рубин

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

Недействительно : фильтр диапазона и первый orderBy по разным полям.

Web modular API

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

const q = query(citiesRef, where("population", ">", 100000), orderBy("country"));invalid_filter_and_order.js

Web namespaced API

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

Быстрый

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

citiesRef
    .whereField("population", isGreaterThan: 100000)
    .order(by: "country")ViewController.swift

Цель-C

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

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

Kotlin+KTX

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

Java

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

Dart

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

Джава

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

питон

cities_ref = db.collection('cities')
query = cities_ref.where('population', '>', 2500000).order_by('country')
results = query.stream()snippets.py

Python

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

С++

// BAD EXAMPLE -- will crash the program:
cities_ref.WhereGreaterThan("population", FieldValue::Integer(100000))
    .OrderBy("country");snippets.cpp

Node.js

citiesRef.where('population', '>', 2500000).orderBy('country');index.js

Идти

// Note: This is an invalid query. It violates the constraint that range
// and order by are required to be on the same field.
query := cities.Where("population", ">", 2500000).OrderBy("country", firestore.Asc)query.go

PHP

$invalidRangeQuery = $citiesRef
    ->where('population', '>', 2500000)
    ->orderBy('country');query_order_field_invalid.php

Единство

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

С#

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

Рубин

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

Вы не можете упорядочить свой запрос по какому-либо полю, включенному в равенство ( = ) или in предложение.

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