Ordena y limita datos con Cloud Firestore

Cloud Firestore proporciona una potente funcionalidad de consulta para especificar qué documentos desea recuperar de una colección. Estas consultas también se pueden utilizar con get() o addSnapshotListener() , como se describe en Obtener datos .

Ordenar y limitar datos

De forma predeterminada, una consulta recupera todos los documentos que satisfacen la consulta en orden ascendente por ID de documento. Puede especificar el orden de clasificación de sus datos usando orderBy() y puede limitar la cantidad de documentos recuperados usando limit() . Si especifica un limit() , el valor debe ser mayor o igual a cero.

Por ejemplo, podrías consultar las primeras 3 ciudades alfabéticamente con:

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

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

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

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

[[citiesRef queryOrderedByField:@"name"] queryLimitedTo:3];
ViewController.m

citiesRef.orderBy("name").limit(3)
DocSnippets.kt

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

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

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

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

$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

También puedes ordenar en orden descendente para obtener las últimas 3 ciudades:

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

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

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

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

[[citiesRef queryOrderedByField:@"name" descending:YES] queryLimitedTo:3];
ViewController.m

citiesRef.orderBy("name", Query.Direction.DESCENDING).limit(3)
DocSnippets.kt

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

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

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

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

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

$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

También puedes ordenar por múltiples campos. Por ejemplo, si desea ordenar por estado y dentro de cada estado ordenar por población en orden descendente:

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

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

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

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

[[citiesRef queryOrderedByField:@"state"] queryOrderedByField:@"population" descending:YES];
ViewController.m

citiesRef.orderBy("state").orderBy("population", Query.Direction.DESCENDING)
DocSnippets.kt

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

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

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

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

$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

Puede combinar filtros where() con orderBy() y limit() . En el siguiente ejemplo, las consultas definen un umbral de población, se clasifican por población en orden ascendente y devuelven solo los primeros resultados que superan el umbral:

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

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

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

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

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

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

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

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

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

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

$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

Sin embargo, si tiene un filtro con una comparación de rango ( < , <= , > , >= ), su primer pedido debe estar en el mismo campo; consulte la lista de limitaciones de orderBy() a continuación.

Limitaciones

Tenga en cuenta las siguientes restricciones para las cláusulas orderBy() :

• Una cláusula orderBy() también filtra la existencia de los campos dados . El conjunto de resultados no incluirá documentos que no contengan los campos indicados.

• Si incluye un filtro con una comparación de rango ( < , <= , > , >= ), su primer pedido debe estar en el mismo campo:

  Válido : filtro de rango y orderBy en el mismo campo

  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

  Rápido

  Nota: Este producto no está disponible en destinos watchOS y App Clip.

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

  C objetivo

  Nota: Este producto no está disponible en destinos watchOS y 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ón

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

  Python

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

  Nodo.js

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

  Ir

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

  PHP

  PHP

  Para obtener más información sobre cómo instalar y crear un cliente de Cloud Firestore, consulte Bibliotecas de clientes de Cloud Firestore .

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

  Unidad

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

  C#

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

  Rubí

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

  No válido : filtro de rango y primer orderBy en diferentes campos

  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

  Rápido

  Nota: Este producto no está disponible en destinos watchOS y App Clip.

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

  C objetivo

  Nota: Este producto no está disponible en destinos watchOS y 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ón

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

  Python

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

  Nodo.js

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

  Ir

  // 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 obtener más información sobre cómo instalar y crear un cliente de Cloud Firestore, consulte Bibliotecas de clientes de Cloud Firestore .

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

  Unidad

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

  C#

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

  Rubí

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

orderBy y existencia

Cuando ordena una consulta por un campo determinado, la consulta puede devolver solo los documentos donde existe el campo ordenar por.

Por ejemplo, la siguiente consulta no devolverá ningún documento donde el campo population no esté configurado, incluso si cumplen con los filtros de consulta.

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

Un efecto relacionado se aplica a las desigualdades. Una consulta con un filtro de desigualdad en un campo también implica ordenar por ese campo. La siguiente consulta no devuelve documentos sin un campo population incluso si country = USA en ese documento. Como solución alternativa, puede ejecutar consultas separadas para cada pedido o puede asignar un valor para todos los campos por los que ordena.

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

La consulta anterior incluye un orden implícito en la desigualdad y es equivalente a lo siguiente:

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