Solicite e limite dados com o Cloud Firestore

O Cloud Firestore oferece funcionalidades de consulta poderosas para especificar quais documentos você deseja recuperar de uma coleção. Essas consultas também podem ser usadas com get() ou addSnapshotListener() , conforme descrito em Get Data .

Encomendar e limitar dados

Por padrão, uma consulta recupera todos os documentos que atendem à consulta em ordem crescente por ID do documento. Você pode especificar a ordem de classificação dos seus dados usando orderBy() e pode limitar o número de documentos recuperados usando limit() . Se você especificar limit() , o valor deverá ser maior ou igual a zero.

Por exemplo, você poderia consultar as três primeiras cidades em ordem alfabética com:

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

const q = query(citiesRef, orderBy("name"), limit(3));
citiesRef.orderBy("name").limit(3);
Observação: este produto não está disponível em destinos watchOS e App Clip.
citiesRef.order(by: "name").limit(to: 3)
Observação: este produto não está disponível em destinos watchOS e App Clip.
[[citiesRef queryOrderedByField:@"name"] queryLimitedTo:3];
citiesRef.orderBy("name").limit(3)
citiesRef.orderBy("name").limit(3);
final citiesRef = db.collection("cities");
citiesRef
.orderBy("name").limit(3);
Query query = cities.orderBy("name").limit(3);
Query query = cities.orderBy("name").limitToLast(3);
cities_ref = db.collection("cities")
query
= cities_ref.order_by("name").limit_to_last(2)
results
= query.get()
cities_ref = db.collection("cities")
query
= cities_ref.order_by("name").limit_to_last(2)
results
= await query.get()
cities_ref.OrderBy("name").Limit(3);
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

Para obter mais informações sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

$query = $citiesRef->orderBy('name')->limit(3);
Query query = citiesRef.OrderBy("Name").Limit(3);
Query query = citiesRef.OrderBy("Name").Limit(3);
query = cities_ref.order("name").limit(3)

Você também pode classificar em ordem decrescente para obter as três últimas cidades:

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

const q = query(citiesRef, orderBy("name", "desc"), limit(3));
citiesRef.orderBy("name", "desc").limit(3);
Observação: este produto não está disponível em destinos watchOS e App Clip.
citiesRef.order(by: "name", descending: true).limit(to: 3)
Observação: este produto não está disponível em destinos watchOS e App Clip.
[[citiesRef queryOrderedByField:@"name" descending:YES] queryLimitedTo:3];
citiesRef.orderBy("name", Query.Direction.DESCENDING).limit(3)
citiesRef.orderBy("name", Direction.DESCENDING).limit(3);
final citiesRef = db.collection("cities");
citiesRef
.orderBy("name", descending: true).limit(3);
Query query = cities.orderBy("name", Direction.DESCENDING).limit(3);
cities_ref = db.collection("cities")
query
= cities_ref.order_by("name", direction=firestore.Query.DESCENDING).limit(3)
results
= query.stream()
cities_ref = db.collection("cities")
query
= cities_ref.order_by("name", direction=firestore.Query.DESCENDING).limit(3)
results
= query.stream()
cities_ref.OrderBy("name", Query::Direction::kDescending).Limit(3);
const lastThreeRes = await citiesRef.orderBy('name', 'desc').limit(3).get();
query := cities.OrderBy("name", firestore.Desc).Limit(3)

PHP

Para obter mais informações sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

$query = $citiesRef->orderBy('name', 'DESC')->limit(3);
Query query = citiesRef.OrderByDescending("Name").Limit(3);
Query query = citiesRef.OrderByDescending("Name").Limit(3);
query = cities_ref.order("name", "desc").limit(3)

Você também pode ordenar por vários campos. Por exemplo, se você quiser ordenar por estado e dentro de cada estado ordenar por população em ordem decrescente:

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

const q = query(citiesRef, orderBy("state"), orderBy("population", "desc"));
citiesRef.orderBy("state").orderBy("population", "desc");
Observação: este produto não está disponível em destinos watchOS e App Clip.
citiesRef
 
.order(by: "state")
 
.order(by: "population", descending: true)
Observação: este produto não está disponível em destinos watchOS e App Clip.
[[citiesRef queryOrderedByField:@"state"] queryOrderedByField:@"population" descending:YES];
citiesRef.orderBy("state").orderBy("population", Query.Direction.DESCENDING)
citiesRef.orderBy("state").orderBy("population", Direction.DESCENDING);
final citiesRef = db.collection("cities");
citiesRef
.orderBy("state").orderBy("population", descending: true);
Query query = cities.orderBy("state").orderBy("population", Direction.DESCENDING);
cities_ref = db.collection("cities")
cities_ref
.order_by("state").order_by(
   
"population", direction=firestore.Query.DESCENDING
)
cities_ref = db.collection("cities")
cities_ref
.order_by("state").order_by(
   
"population", direction=firestore.Query.DESCENDING
)
cities_ref.OrderBy("state").OrderBy("name", Query::Direction::kDescending);
const byStateByPopRes = await citiesRef.orderBy('state').orderBy('population', 'desc').get();
query := client.Collection("cities").OrderBy("state", firestore.Asc).OrderBy("population", firestore.Desc)

PHP

Para obter mais informações sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

$query = $citiesRef->orderBy('state')->orderBy('population', 'DESC');
Query query = citiesRef.OrderBy("State").OrderByDescending("Population");
Query query = citiesRef.OrderBy("State").OrderByDescending("Population");
query = cities_ref.order("state").order("population", "desc")

Você pode combinar filtros where() com orderBy() e limit() . No exemplo a seguir, as consultas definem um limite populacional, classificam por população em ordem crescente e retornam apenas os primeiros resultados que excedem o limite:

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

const q = query(citiesRef, where("population", ">", 100000), orderBy("population"), limit(2));
citiesRef.where("population", ">", 100000).orderBy("population").limit(2);
Observação: este produto não está disponível em destinos watchOS e App Clip.
citiesRef
 
.whereField("population", isGreaterThan: 100000)
 
.order(by: "population")
 
.limit(to: 2)
Observação: este produto não está disponível em destinos watchOS e App Clip.
[[[citiesRef queryWhereField:@"population" isGreaterThan:@100000]
    queryOrderedByField
:@"population"]
    queryLimitedTo
:2];
citiesRef.whereGreaterThan("population", 100000).orderBy("population").limit(2)
citiesRef.whereGreaterThan("population", 100000).orderBy("population").limit(2);
final citiesRef = db.collection("cities");
citiesRef
   
.where("population", isGreaterThan: 100000)
   
.orderBy("population")
   
.limit(2);
Query query = cities.whereGreaterThan("population", 2500000L).orderBy("population").limit(2);
cities_ref = db.collection("cities")
query
= (
    cities_ref
.where(filter=FieldFilter("population", ">", 2500000))
   
.order_by("population")
   
.limit(2)
)
results
= query.stream()
cities_ref = db.collection("cities")
query
= (
    cities_ref
.where(filter=FieldFilter("population", ">", 2500000))
   
.order_by("population")
   
.limit(2)
)
results
= query.stream()
cities_ref.WhereGreaterThan("population", FieldValue::Integer(100000))
   
.OrderBy("population")
   
.Limit(2);
const biggestRes = await citiesRef.where('population', '>', 2500000)
 
.orderBy('population').limit(2).get();
query := cities.Where("population", ">", 2500000).OrderBy("population", firestore.Desc).Limit(2)

PHP

Para obter mais informações sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

$query = $citiesRef
   
->where('population', '>', 2500000)
   
->orderBy('population')
   
->limit(2);
Query query = citiesRef
   
.WhereGreaterThan("Population", 2500000)
   
.OrderBy("Population")
   
.Limit(2);
Query query = citiesRef
   
.WhereGreaterThan("Population", 2500000)
   
.OrderBy("Population")
   
.Limit(2);
query = cities_ref.where("population", ">", 2_500_000).order("population").limit(2)

Porém, se você tiver um filtro com comparação de intervalo ( < , <= , > , >= ), sua primeira ordenação deverá estar no mesmo campo, veja a lista de limitações de orderBy() abaixo.

Limitações

Observe as seguintes restrições para cláusulas orderBy() :

  • Uma cláusula orderBy() também filtra a existência dos campos fornecidos . O conjunto de resultados não incluirá documentos que não contenham os campos fornecidos.
  • Se você incluir um filtro com comparação de intervalo ( < , <= , > , >= ), sua primeira ordenação deverá estar no mesmo campo:

    Válido : filtro de intervalo e orderBy no mesmo campo

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

    const q = query(citiesRef, where("population", ">", 100000), orderBy("population"));
    citiesRef.where("population", ">", 100000).orderBy("population");
    Observação: este produto não está disponível em destinos watchOS e App Clip.
    citiesRef
     
    .whereField("population", isGreaterThan: 100000)
     
    .order(by: "population")
    Observação: este produto não está disponível em destinos watchOS e App Clip.
    [[citiesRef queryWhereField:@"population" isGreaterThan:@100000]
        queryOrderedByField
    :@"population"];
    citiesRef.whereGreaterThan("population", 100000).orderBy("population")
    citiesRef.whereGreaterThan("population", 100000).orderBy("population");
    final citiesRef = db.collection("cities");
    citiesRef
    .where("population", isGreaterThan: 100000).orderBy("population");
    Query query = cities.whereGreaterThan("population", 2500000L).orderBy("population");
    cities_ref = db.collection("cities")
    query
    = cities_ref.where(filter=FieldFilter("population", ">", 2500000)).order_by(
       
    "population"
    )
    results
    = query.stream()
    cities_ref = db.collection("cities")
    query
    = cities_ref.where(filter=FieldFilter("population", ">", 2500000)).order_by(
       
    "population"
    )
    results
    = query.stream()
    citiesRef.where('population', '>', 2500000).orderBy('population');
    query := cities.Where("population", ">", 2500000).OrderBy("population", firestore.Asc)

    PHP

    Para obter mais informações sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

    $query = $citiesRef
       
    ->where('population', '>', 2500000)
       
    ->orderBy('population');
    Query query = citiesRef
       
    .WhereGreaterThan("Population", 2500000)
       
    .OrderBy("Population");
    Query query = citiesRef
       
    .WhereGreaterThan("Population", 2500000)
       
    .OrderBy("Population");
    query = cities_ref.where("population", ">", 2_500_000).order("population")

    Inválido : filtro de intervalo e primeiro orderBy em campos diferentes

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

    const q = query(citiesRef, where("population", ">", 100000), orderBy("country"));
    citiesRef.where("population", ">", 100000).orderBy("country");
    Observação: este produto não está disponível em destinos watchOS e App Clip.
    citiesRef
     
    .whereField("population", isGreaterThan: 100000)
     
    .order(by: "country")
    Observação: este produto não está disponível em destinos watchOS e App Clip.
    [[citiesRef queryWhereField:@"population" isGreaterThan:@100000] queryOrderedByField:@"country"];
    citiesRef.whereGreaterThan("population", 100000).orderBy("country")
    citiesRef.whereGreaterThan("population", 100000).orderBy("country");
    final citiesRef = db.collection("cities");
    citiesRef
    .where("population", isGreaterThan: 100000).orderBy("country");
    Query query = cities.whereGreaterThan("population", 2500000L).orderBy("country");
    cities_ref = db.collection("cities")
    query
    = cities_ref.where(filter=FieldFilter("population", ">", 2500000)).order_by(
       
    "country"
    )
    results
    = query.stream()
    cities_ref = db.collection("cities")
    query
    = cities_ref.where(filter=FieldFilter("population", ">", 2500000)).order_by(
       
    "country"
    )
    results
    = query.stream()
    // BAD EXAMPLE -- will crash the program:
    cities_ref
    .WhereGreaterThan("population", FieldValue::Integer(100000))
       
    .OrderBy("country");
    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

    Para obter mais informações sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

    $invalidRangeQuery = $citiesRef
       
    ->where('population', '>', 2500000)
       
    ->orderBy('country');
    Query query = citiesRef
       
    .WhereGreaterThan("Population", 2500000)
       
    .OrderBy("Country");
    Query query = citiesRef
       
    .WhereGreaterThan("Population", 2500000)
       
    .OrderBy("Country");
    query = cities_ref.where("population", ">", 2_500_000).order("country")

orderBy e existência

Quando você ordena uma consulta por um determinado campo, a consulta pode retornar apenas os documentos onde existe o campo ordenado por.

Por exemplo, a consulta a seguir não retornaria nenhum documento cujo campo population não estivesse definido, mesmo que eles atendessem aos filtros da consulta.

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

Um efeito relacionado aplica-se às desigualdades. Uma consulta com filtro de desigualdade em um campo também implica ordenação por esse campo. A consulta a seguir não retorna documentos sem um campo population mesmo se country = USA nesse documento. Como solução alternativa, você pode executar consultas separadas para cada ordenação ou pode atribuir um valor para todos os campos ordenados.

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

A consulta acima inclui uma ordem implícita na desigualdade e é equivalente ao seguinte:

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