Ordenar e limitar dados com o Cloud Firestore

O Cloud Firestore fornece funcionalidade de consulta poderosa 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 Obter dados .

Observação: embora os exemplos de código abranjam vários idiomas, o texto que explica os exemplos refere-se aos nomes dos métodos da Web.

Dados de pedido e limite

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 de seus dados usando orderBy() e pode limitar o número de documentos recuperados usando limit() .

Observação: uma cláusula orderBy() também filtra a existência do campo fornecido. O conjunto de resultados não incluirá documentos que não contenham o campo fornecido.

Por exemplo, você pode consultar as 3 primeiras cidades em ordem alfabética com:

Web version 9

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

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

Web version 8

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

Rápido

Observação: este produto não está disponível em destinos de watchOS e App Clip.

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

Objective-C

Observação: este produto não está disponível em destinos de watchOS e 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

Pitão

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

Vai

query := cities.OrderBy("name", firestore.Asc).Limit(3)
query := cities.OrderBy("name", firestore.Asc).LimitToLast(3)
query.go

PHP

PHP

Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

$query = $citiesRef->orderBy('name')->limit(3);
query_order_limit.php

Unidade

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

C #

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

Rubi

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

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

Web version 9

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

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

Web version 8

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

Rápido

Observação: este produto não está disponível em destinos de watchOS e App Clip.

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

Objective-C

Observação: este produto não está disponível em destinos de watchOS e 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

Pitão

cities_ref = db.collection(u'cities')
query = cities_ref.order_by(
    u'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

Vai

query := cities.OrderBy("name", firestore.Desc).Limit(3)
query.go

PHP

PHP

Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

$query = $citiesRef->orderBy('name', 'DESC')->limit(3);
query_order_desc_limit.php

Unidade

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

C #

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

Rubi

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

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:

Web version 9

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

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

Web version 8

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

Rápido

Observação: este produto não está disponível em destinos de watchOS e App Clip.

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

Objective-C

Observação: este produto não está disponível em destinos de watchOS e 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

Pitão

cities_ref = db.collection(u'cities')
cities_ref.order_by(u'state').order_by(
    u'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

Vai

query := client.Collection("cities").OrderBy("state", firestore.Asc).OrderBy("population", firestore.Desc)
query.go

PHP

PHP

Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

$query = $citiesRef->orderBy('state')->orderBy('population', 'DESC');
query_order_multi.php

Unidade

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

C #

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

Rubi

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

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

Web version 9

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

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

Web version 8

Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

Rápido

Observação: este produto não está disponível em destinos de watchOS e App Clip.

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

Objective-C

Observação: este produto não está disponível em destinos de watchOS e 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

Pitão

cities_ref = db.collection(u'cities')
query = cities_ref.where(
    u'population', u'>', 2500000).order_by(u'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

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

Vai

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

PHP

PHP

Para saber mais 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_order_limit_field_valid.php

Unidade

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

C #

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

Rubi

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

No entanto, se você tiver um filtro com uma comparação de intervalo ( < , <= , > , >= ), sua primeira ordenação deve ser no mesmo campo, consulte 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 uma comparação de intervalo ( < , <= , > , >= ), sua primeira ordenação deverá estar no mesmo campo:

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

  Web version 9

  Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

  Web version 8

  Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

  Rápido

  Observação: este produto não está disponível em destinos de watchOS e App Clip.

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

  Objective-C

  Observação: este produto não está disponível em destinos de watchOS e 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

  Java

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

  Pitão

  cities_ref = db.collection(u'cities')
  query = cities_ref.where(
      u'population', u'>', 2500000).order_by(u'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

  Vai

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

  PHP

  PHP

  Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

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

  Unidade

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

  C #

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

  Rubi

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

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

  Web version 9

  Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

  Web version 8

  Saiba mais sobre o SDK modular Web v9 que pode ser sacudido em árvore e atualize a partir da versão 8.

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

  Rápido

  Observação: este produto não está disponível em destinos de watchOS e App Clip.

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

  Objective-C

  Observação: este produto não está disponível em destinos de watchOS e 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

  Java

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

  Pitão

  cities_ref = db.collection(u'cities')
  query = cities_ref.where(u'population', u'>', 2500000).order_by(u'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

  C++

  // 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

  Vai

  // 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

  PHP

  Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .

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

  Unidade

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

  C #

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

  Rubi

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

• Você não pode ordenar sua consulta por nenhum campo incluído em uma cláusula de igualdade ( = ) ou in .