Заказ и ограничение данных с Cloud Firestore

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

Данные для заказа и лимита

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

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

Веб-версия 9

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

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

Веб-версия 8

citiesRef.orderBy("name").limit(3);
Быстрый
citiesRef.order(by: "name").limit(to: 3)
Цель-C
[[citiesRef queryOrderedByField:@"name"] queryLimitedTo:3];

Джава

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

Котлин + KTX

citiesRef.orderBy("name").limit(3)
Джава
Query query = cities.orderBy("name").limit(3);
Query query = cities.orderBy("name").limitToLast(3);
Python
cities_ref = db.collection("cities")
query = cities_ref.order_by("name").limit_to_last(2)
results = query.get()

Python

cities_ref = db.collection("cities")
query = cities_ref.order_by("name").limit_to_last(2)
results = await query.get()
C ++
cities_ref.OrderBy("name").Limit(3);
Node.js
const firstThreeRes = await citiesRef.orderBy('name').limit(3).get();
Идти
query := cities.OrderBy("name", firestore.Asc).Limit(3)
query := cities.OrderBy("name", firestore.Asc).LimitToLast(3)
PHP
$query = $citiesRef->orderBy('name')->limit(3);
Единство
Query query = citiesRef.OrderBy("Name").Limit(3);
C #
Query query = citiesRef.OrderBy("Name").Limit(3);
Рубин
query = cities_ref.order("name").limit(3)

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

Веб-версия 9

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

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

Веб-версия 8

citiesRef.orderBy("name", "desc").limit(3);
Быстрый
citiesRef.order(by: "name", descending: true).limit(to: 3)
Цель-C
[[citiesRef queryOrderedByField:@"name" descending:YES] queryLimitedTo:3];

Джава

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

Котлин + KTX

citiesRef.orderBy("name", Query.Direction.DESCENDING).limit(3)
Джава
Query query = cities.orderBy("name", Direction.DESCENDING).limit(3);
Python
cities_ref = db.collection(u'cities')
query = cities_ref.order_by(
    u'name', direction=firestore.Query.DESCENDING).limit(3)
results = query.stream()

Python

cities_ref = db.collection("cities")
query = cities_ref.order_by("name", direction=firestore.Query.DESCENDING).limit(3)
results = query.stream()
C ++
cities_ref.OrderBy("name", Query::Direction::kDescending).Limit(3);
Node.js
const lastThreeRes = await citiesRef.orderBy('name', 'desc').limit(3).get();
Идти
query := cities.OrderBy("name", firestore.Desc).Limit(3)
PHP
$query = $citiesRef->orderBy('name', 'DESC')->limit(3);
Единство
Query query = citiesRef.OrderByDescending("Name").Limit(3);
C #
Query query = citiesRef.OrderByDescending("Name").Limit(3);
Рубин
query = cities_ref.order("name", "desc").limit(3)

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

Веб-версия 9

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

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

Веб-версия 8

citiesRef.orderBy("state").orderBy("population", "desc");
Быстрый
citiesRef
    .order(by: "state")
    .order(by: "population", descending: true)
Цель-C
[[citiesRef queryOrderedByField:@"state"] queryOrderedByField:@"population" descending:YES];

Джава

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

Котлин + KTX

citiesRef.orderBy("state").orderBy("population", Query.Direction.DESCENDING)
Джава
Query query = cities.orderBy("state").orderBy("population", Direction.DESCENDING);
Python
cities_ref = db.collection(u'cities')
cities_ref.order_by(u'state').order_by(
    u'population', direction=firestore.Query.DESCENDING)

Python

cities_ref = db.collection("cities")
cities_ref.order_by("state").order_by(
    "population", direction=firestore.Query.DESCENDING
)
C ++
cities_ref.OrderBy("state").OrderBy("name", Query::Direction::kDescending);
Node.js
const byStateByPopRes = await citiesRef.orderBy('state').orderBy('population', 'desc').get();
Идти
query := client.Collection("cities").OrderBy("state", firestore.Asc).OrderBy("population", firestore.Desc)
PHP
$query = $citiesRef->orderBy('state')->orderBy('population', 'DESC');
Единство
Query query = citiesRef.OrderBy("State").OrderByDescending("Population");
C #
Query query = citiesRef.OrderBy("State").OrderByDescending("Population");
Рубин
query = cities_ref.order("state").order("population", "desc")

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

Веб-версия 9

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

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

Веб-версия 8

citiesRef.where("population", ">", 100000).orderBy("population").limit(2);
Быстрый
citiesRef
    .whereField("population", isGreaterThan: 100000)
    .order(by: "population")
    .limit(to: 2)
Цель-C
[[[citiesRef queryWhereField:@"population" isGreaterThan:@100000]
    queryOrderedByField:@"population"]
    queryLimitedTo:2];

Джава

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

Котлин + KTX

citiesRef.whereGreaterThan("population", 100000).orderBy("population").limit(2)
Джава
Query query = cities.whereGreaterThan("population", 2500000L).orderBy("population").limit(2);
Python
cities_ref = db.collection(u'cities')
query = cities_ref.where(
    u'population', u'>', 2500000).order_by(u'population').limit(2)
results = query.stream()

Python

cities_ref = db.collection("cities")
query = cities_ref.where("population", ">", 2500000).order_by("population").limit(2)
results = query.stream()
C ++
cities_ref.WhereGreaterThan("population", FieldValue::Integer(100000))
    .OrderBy("population")
    .Limit(2);
Node.js
const biggestRes = await citiesRef.where('population', '>', 2500000)
  .orderBy('population').limit(2).get();
Идти
query := cities.Where("population", ">", 2500000).OrderBy("population", firestore.Desc).Limit(2)
PHP
$query = $citiesRef
    ->where('population', '>', 2500000)
    ->orderBy('population')
    ->limit(2);
Единство
Query query = citiesRef
    .WhereGreaterThan("Population", 2500000)
    .OrderBy("Population")
    .Limit(2);
C #
Query query = citiesRef
    .WhereGreaterThan("Population", 2500000)
    .OrderBy("Population")
    .Limit(2);
Рубин
query = cities_ref.where("population", ">", 2_500_000).order("population").limit(2)

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

Ограничения

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

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

    Действительно: Диапазон фильтра и orderBy на том же поле

    Веб-версия 9

    import { query, where, orderBy } from "firebase/firestore";  
    
    const q = query(citiesRef, where("population", ">", 100000), orderBy("population"));

    Веб-версия 8

    citiesRef.where("population", ">", 100000).orderBy("population");
    Быстрый
    citiesRef
        .whereField("population", isGreaterThan: 100000)
        .order(by: "population")
    Цель-C
    [[citiesRef queryWhereField:@"population" isGreaterThan:@100000]
        queryOrderedByField:@"population"];

    Джава

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

    Котлин + KTX

    citiesRef.whereGreaterThan("population", 100000).orderBy("population")
    Джава
    Query query = cities.whereGreaterThan("population", 2500000L).orderBy("population");
    Python
    cities_ref = db.collection(u'cities')
    query = cities_ref.where(
        u'population', u'>', 2500000).order_by(u'population')
    results = query.stream()

    Python

    cities_ref = db.collection("cities")
    query = cities_ref.where("population", ">", 2500000).order_by("population")
    results = query.stream()
    Node.js
    citiesRef.where('population', '>', 2500000).orderBy('population');
    Идти
    query := cities.Where("population", ">", 2500000).OrderBy("population", firestore.Asc)
    PHP
    $query = $citiesRef
        ->where('population', '>', 2500000)
        ->orderBy('population');
    Единство
    Query query = citiesRef
        .WhereGreaterThan("Population", 2500000)
        .OrderBy("Population");
    C #
    Query query = citiesRef
        .WhereGreaterThan("Population", 2500000)
        .OrderBy("Population");
    Рубин
    query = cities_ref.where("population", ">", 2_500_000).order("population")

    Invalid: Диапазон фильтр и первый orderBy на разных полях

    Веб-версия 9

    import { query, where, orderBy } from "firebase/firestore";  
    
    const q = query(citiesRef, where("population", ">", 100000), orderBy("country"));

    Веб-версия 8

    citiesRef.where("population", ">", 100000).orderBy("country");
    Быстрый
    citiesRef
        .whereField("population", isGreaterThan: 100000)
        .order(by: "country")
    Цель-C
    [[citiesRef queryWhereField:@"population" isGreaterThan:@100000] queryOrderedByField:@"country"];

    Джава

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

    Котлин + KTX

    citiesRef.whereGreaterThan("population", 100000).orderBy("country")
    Джава
    Query query = cities.whereGreaterThan("population", 2500000L).orderBy("country");
    Python
    cities_ref = db.collection(u'cities')
    query = cities_ref.where(u'population', u'>', 2500000).order_by(u'country')
    results = query.stream()

    Python

    cities_ref = db.collection("cities")
    query = cities_ref.where("population", ">", 2500000).order_by("country")
    results = query.stream()
    C ++
    // BAD EXAMPLE -- will crash the program:
    cities_ref.WhereGreaterThan("population", FieldValue::Integer(100000))
        .OrderBy("country");
    Node.js
    citiesRef.where('population', '>', 2500000).orderBy('country');
    Идти
    // 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)
    PHP
    $invalidRangeQuery = $citiesRef
        ->where('population', '>', 2500000)
        ->orderBy('country');
    Единство
    Query query = citiesRef
        .WhereGreaterThan("Population", 2500000)
        .OrderBy("Country");
    C #
    Query query = citiesRef
        .WhereGreaterThan("Population", 2500000)
        .OrderBy("Country");
    Рубин
    query = cities_ref.where("population", ">", 2_500_000).order("country")
  • Вы не можете заказать свой запрос по любому полю , включенного в равенства ( = ) или in пункте.