Consultas de Datastore

Una consulta recupera entidades de Firestore en modo Datastore que cumplen con un conjunto específico de condiciones.

La consulta opera en entidades de una categoría determinada, puede especificar filtros para los valores de propiedad, las claves y los principales de las entidades, y puede mostrar cero o más entidades como resultados. Una consulta también puede especificar órdenes de clasificación para secuenciar los resultados según los valores de propiedad. Los resultados incluyen todas las entidades que tienen al menos un valor por cada propiedad mencionada en los filtros y órdenes de clasificación, y cuyos valores de propiedad cumplen con todos los criterios de filtro especificados. La consulta puede mostrar entidades completas, entidades proyectadas o solo claves de entidad.

Una consulta típica incluye lo siguiente:

El tipo de entidad al cual se aplica la consulta
Cero o más filtros basados en los valores de las propiedades, las claves y los principales de las entidades
Cero o más órdenes de clasificación para secuenciar los resultados

Cuando se ejecuta, la consulta recupera todas las entidades de ese tipo que satisfacen todos los filtros indicados, en el orden que se especificó. Las consultas se ejecutan en modo de solo lectura.

Nota: Para conservar la memoria y mejorar el rendimiento, las consultas deben especificar, siempre que sea posible, un límite en la cantidad de resultados que se muestran.

Cada consulta calcula los resultados mediante uno o más índices, que contienen claves de entidad en una secuencia especificada por las propiedades del índice y, de forma opcional, los principales de la entidad. Los índices se actualizan de forma incremental con los cambios que la aplicación haga a sus entidades, de modo que los resultados correctos de todas las consultas estén disponibles sin necesidad de realizar cálculos adicionales.

El mecanismo de consultas basado en índices admite una amplia variedad de consultas y es apropiado para la mayoría de las aplicaciones. Sin embargo, no admite algunos tipos de consultas comunes en otras tecnologías de bases de datos: en particular, las consultas de unión y agregación no son compatibles con el motor de consultas en modo Datastore. Consulta Restricciones de las consultas para obtener más información sobre las limitaciones en las consultas del modo Datastore.

Interfaz de consulta

A continuación, mostramos un ejemplo básico para realizar una consulta en una base de datos en modo Datastore. Recupera todas las tareas que aún no se hicieron con prioridad de 4 o más y las clasifica en orden descendente según la prioridad:

C#

Para obtener información sobre cómo instalar y usar la biblioteca cliente de Cloud Datastore, consulta Bibliotecas cliente de Cloud Datastore. Si deseas obtener más información, consulta la documentación de referencia de la API de C# de Cloud Datastore.

Para autenticarte en Cloud Datastore, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

Query query = new Query("Task")
{
    Filter = Filter.And(Filter.Equal("done", false),
        Filter.GreaterThanOrEqual("priority", 4)),
    Order = { { "priority", PropertyOrder.Types.Direction.Descending } }
};

Go

query := datastore.NewQuery("Task").
	FilterField("Done", "=", false).
	FilterField("Priority", ">=", 4).
	Order("-Priority")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            CompositeFilter.and(
                PropertyFilter.eq("done", false), PropertyFilter.ge("priority", 4)))
        .setOrderBy(OrderBy.desc("priority"))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    and([
      new PropertyFilter('done', '=', false),
      new PropertyFilter('priority', '>=', 4),
    ])
  )
  .order('priority', {
    descending: true,
  });

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('done', '=', false)
    ->filter('priority', '>=', 4)
    ->order('priority', Query::ORDER_DESCENDING);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("done", "=", False))
query.add_filter(filter=PropertyFilter("priority", ">=", 4))
query.order = ["-priority"]

Ruby

query = datastore.query("Task")
                 .where("done", "=", false)
                 .where("priority", ">=", 4)
                 .order("priority", :desc)

GQL


SELECT * FROM Task
WHERE done = FALSE AND priority >= 4
ORDER BY priority DESC

Usa estos modelos para ejecutar consultas.

C#

Query query = new Query("Task");
DatastoreQueryResults tasks = _db.RunQuery(query);

Go

it := client.Run(ctx, query)
for {
	var task Task
	_, err := it.Next(&task)
	if err == iterator.Done {
		break
	}
	if err != nil {
		log.Fatalf("Error fetching next task: %v", err)
	}
	fmt.Printf("Task %q, Priority %d\n", task.Description, task.Priority)
}

Java

QueryResults<Entity> tasks = datastore.run(query);

Node.js

const [tasks] = await datastore.runQuery(query);
console.log('Tasks:');
tasks.forEach(task => console.log(task));

PHP

$result = $datastore->runQuery($query);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query()
results = list(query.fetch())

Ruby

tasks = datastore.run query

GQL

No aplicable

Estructura de la consulta

Una consulta puede especificar un tipo de entidad, cero o más filtros, y cero o más órdenes de clasificación.

Filtros

El conjunto de filtros de una consulta limita las propiedades, claves y los principales de las entidades que se recuperarán.

Filtros de propiedades

Un filtro de propiedad especifica lo siguiente:

El nombre de una propiedad
Un operador de comparación
El valor de una propiedad

En este ejemplo, se muestran entidades Task marcadas como no realizadas:

C#

Query query = new Query("Task")
{
    Filter = Filter.Equal("done", false)
};

Go

query := datastore.NewQuery("Task").FilterField("Done", "=", false)

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.eq("done", false))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(new PropertyFilter('done', '=', false));

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('done', '=', false);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("done", "=", False))

Ruby

query = datastore.query("Task")
                 .where("done", "=", false)

GQL


SELECT * FROM Task WHERE done = FALSE

La aplicación debe proporcionar el valor de la propiedad. No se le puede hacer referencia ni se puede calcular en términos de otras propiedades. Una entidad satisface el filtro si tiene una propiedad con el nombre dado, cuyo valor se compara con el valor especificado en el filtro, de acuerdo con la descripción del operador de comparación. Si la propiedad del nombre dado tiene un arreglo de valores, la entidad cumple los requisitos del filtro siempre que alguno de esos valores guarde con el valor especificado en el filtro la relación que describe el operador de comparación.

El operador de comparación puede ser cualquiera de las siguientes opciones:

Operador	Significado
`EQUAL`	Igual que
`LESS_THAN`	Menor que
`LESS_THAN_OR_EQUAL`	Menor que o igual que
`GREATER_THAN`	Mayor que
`GREATER_THAN_OR_EQUAL`	Mayor que o igual que
`NOT_EQUAL`	No igual a
`IN`	Miembro de la lista especificada. Igual a cualquiera de los valores de una lista especificada.
`NOT_IN`	No es miembro de la lista especificada. No es igual a ninguno de los valores de una lista especificada.

Filtros compuestos

Un filtro compuesto consta de más de un filtro de propiedad. Puedes combinar filtros con AND y OR. En este ejemplo, se muestran entidades Task que están marcadas como no listas y tienen una prioridad de 4:

C#

Query query = new Query("Task")
{
    Filter = Filter.And(Filter.Equal("done", false),
        Filter.Equal("priority", 4)),
};

Go

query := datastore.NewQuery("Task").
	FilterField("Done", "=", false).
	FilterField("Priority", "=", 4)

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            CompositeFilter.and(
                PropertyFilter.eq("done", false), PropertyFilter.eq("priority", 4)))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    and([
      new PropertyFilter('done', '=', false),
      new PropertyFilter('priority', '=', 4),
    ])
  );

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('done', '=', false)
    ->filter('priority', '=', 4);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("done", "=", False))
query.add_filter(filter=PropertyFilter("priority", "=", 4))

Ruby

query = datastore.query("Task")
                 .where("done", "=", false)
                 .where("priority", "=", 4)

GQL


SELECT * FROM Task WHERE done = FALSE AND priority = 4

En este ejemplo, se combinan filtros con un OR lógico:

C#

Fragmento no disponible.

Go

Fragmento no disponible.

Java

Para obtener información sobre cómo instalar y usar la biblioteca cliente del modo Datastore, consulta Bibliotecas cliente del modo Datastore. Si deseas obtener más información, consulta la documentación de referencia de la API Java del modo Datastore.

Para autenticarte en el modo Datastore, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

import com.google.cloud.datastore.Datastore;
import com.google.cloud.datastore.DatastoreOptions;
import com.google.cloud.datastore.Entity;
import com.google.cloud.datastore.Query;
import com.google.cloud.datastore.QueryResults;
import com.google.cloud.datastore.StructuredQuery.CompositeFilter;
import com.google.cloud.datastore.StructuredQuery.Filter;
import com.google.cloud.datastore.StructuredQuery.PropertyFilter;

public class OrFilterQuery {
  public static void invoke() throws Exception {

    // Instantiates a client
    Datastore datastore = DatastoreOptions.getDefaultInstance().getService();
    String propertyName = "description";

    // Create the two filters
    Filter orFilter =
        CompositeFilter.or(
            PropertyFilter.eq(propertyName, "Feed cats"),
            PropertyFilter.eq(propertyName, "Buy milk"));

    // Build the query
    Query<Entity> query = Query.newEntityQueryBuilder().setKind("Task").setFilter(orFilter).build();

    // Get the results back from Datastore
    QueryResults<Entity> results = datastore.run(query);

    if (!results.hasNext()) {
      throw new Exception("query yielded no results");
    }

    while (results.hasNext()) {
      Entity entity = results.next();
      System.out.printf("Entity: %s%n", entity);
    }
  }
}

Node.js

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = "your Google Cloud project id";

// Imports the Cloud Datastore
const {Datastore, PropertyFilter, or} = require('@google-cloud/datastore');

async function queryFilterOr() {
  // Instantiate the Datastore
  const datastore = new Datastore();
  const query = datastore
    .createQuery('Task')
    .filter(
      or([
        new PropertyFilter('description', '=', 'Buy milk'),
        new PropertyFilter('description', '=', 'Feed cats'),
      ])
    );

  const [entities] = await datastore.runQuery(query);
  entities.sort();
  for (const entity of entities) {
    console.log(`Entity found: ${entity['description']}`);
  }
}

queryFilterOr();

PHP

Fragmento no disponible.

Python

from google.cloud import datastore
from google.cloud.datastore import query

def query_filter_or(project_id: str) -> None:
    """Builds a union of two queries (OR) filter.

    Arguments:
        project_id: your Google Cloud Project ID
    """
    client = datastore.Client(project=project_id)

    or_query = client.query(kind="Task")
    or_filter = query.Or(
        [
            query.PropertyFilter("description", "=", "Buy milk"),
            query.PropertyFilter("description", "=", "Feed cats"),
        ]
    )

    or_query.add_filter(filter=or_filter)

    results = or_query.fetch()
    for result in results:
        print(result["description"])

Rita

Fragmento no disponible.

GQL

Fragmento no disponible.

Firestore en modo Datastore admite la combinación de filtros con operadores AND y OR. En este ejemplo, se muestran entidades Task que están destacadas o marcadas como no listas y tienen una prioridad de 4:

C#

Fragmento no disponible.

Go

Fragmento no disponible.

Java

Query query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(CompositeFilter.or(
            PropertyFilter.eq("starred", true)),
            CompositeFilter.and(
                PropertyFilter.eq("done", false),
                PropertyFilter.eq("priority", 4)))
        .build();

Node.js

Fragmento no disponible.

PHP

Fragmento no disponible.

Python

and_or_query = client.query(kind="Task")

query_filter = query.Or(
    [
        query.PropertyFilter("starred", "=", True),
        query.And([query.PropertyFilter("done", "=", False),
                    query.PropertyFilter("priority", "=", 4,),
        ]
        )
    ]
)

and_or_query.add_filter(filter=query_filter)

results = and_or_query.fetch()
for result in results:
    print(result["description"])

Rita

Fragmento no disponible.

GQL

Fragmento no disponible.

Filtros de clave

Para filtrar el valor de la clave de una entidad, usa la propiedad especial __key__:

C#

Query query = new Query("Task")
{
    Filter = Filter.GreaterThan("__key__", _keyFactory.CreateKey("aTask"))
};

Go

key := datastore.NameKey("Task", "someTask", nil)
query := datastore.NewQuery("Task").FilterField("__key__", ">", key)

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.gt("__key__", keyFactory.newKey("someTask")))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    new PropertyFilter('__key__', '>', datastore.key(['Task', 'someTask']))
  );

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('__key__', '>', $datastore->key('Task', 'someTask'));

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
first_key = client.key("Task", "first_task")
# key_filter(key, op) translates to add_filter('__key__', op, key).
query.key_filter(first_key, ">")

Ruby

query = datastore.query("Task")
                 .where("__key__", ">", datastore.key("Task", "someTask"))

GQL


SELECT * FROM Task WHERE __key__ > KEY(Task, 'someTask')

Cuando se usa un comparador de desigualdad, se aplican los siguientes criterios para clasificar las claves, en orden:

Ruta del principal
Tipo de entidad
Identificador (nombre de clave o ID numérico)

Los elementos de la ruta principal se comparan de manera similar: por tipo (string) y, luego, por nombre de clave o ID numérico. Los tipos y los nombres de clave son strings y se ordenan por valor de byte. Los ID numéricos son números enteros ordenados de forma numérica. Si varias entidades que tienen el mismo principal y tipo usan una combinación de ID numéricos y strings con nombre de clave, las entidades que tienen ID numéricos anteceden a las que tienen nombres de clave.

Las consultas sobre claves usan índices, al igual que las consultas sobre propiedades, y requieren índices personalizados en los mismos casos, salvo algunas excepciones: los filtros de desigualdad o un orden de clasificación ascendente en la clave no requieren un índice personalizado, pero si se usa un orden de clasificación descendente en la clave, sí. Al igual que con todas las consultas, el servidor de desarrollo crea entradas adecuadas en el archivo de configuración de índices cuando una consulta que requiere un índice personalizado se usa en el entorno de programación.

Órdenes de clasificación

Un orden de clasificación de consulta especifica:

Un nombre de propiedad
Una dirección de clasificación (ascendente o descendente). El orden de clasificación predeterminado es ascendente

En este ejemplo, se clasifican entidades Task por tiempo de creación en orden ascendente:

C#

Query query = new Query("Task")
{
    Order = { { "created", PropertyOrder.Types.Direction.Ascending } }
};

Go

query := datastore.NewQuery("Task").Order("created")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder().setKind("Task").setOrderBy(OrderBy.asc("created")).build();

Node.js

const query = datastore.createQuery('Task').order('created');

PHP

$query = $datastore->query()
    ->kind('Task')
    ->order('created');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.order = ["created"]

Ruby

query = datastore.query("Task")
                 .order("created", :asc)

GQL


SELECT * FROM Task ORDER BY created ASC

En este ejemplo, se clasifican entidades Task por tiempo de creación en orden descendente

C#

Query query = new Query("Task")
{
    Order = { { "created", PropertyOrder.Types.Direction.Descending } }
};

Go

query := datastore.NewQuery("Task").Order("-created")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder().setKind("Task").setOrderBy(OrderBy.desc("created")).build();

Node.js

const query = datastore.createQuery('Task').order('created', {
  descending: true,
});

PHP

$query = $datastore->query()
    ->kind('Task')
    ->order('created', Query::ORDER_DESCENDING);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.order = ["-created"]

Ruby

query = datastore.query("Task")
                 .order("created", :desc)

GQL


SELECT * FROM Task ORDER BY created DESC

Si una consulta incluye varios órdenes de clasificación, estos se aplican en la secuencia especificada. En el siguiente ejemplo, primero se clasifica por prioridad descendente y, luego, por tiempo de creación ascendente:

C#

Query query = new Query("Task")
{
    Order = { { "priority", PropertyOrder.Types.Direction.Descending },
        { "created", PropertyOrder.Types.Direction.Ascending } }
};

Go

query := datastore.NewQuery("Task").Order("-priority").Order("created")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setOrderBy(OrderBy.desc("priority"), OrderBy.asc("created"))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .order('priority', {
    descending: true,
  })
  .order('created');

PHP

$query = $datastore->query()
    ->kind('Task')
    ->order('priority', Query::ORDER_DESCENDING)
    ->order('created');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.order = ["-priority", "created"]

Ruby

query = datastore.query("Task")
                 .order("priority", :desc)
                 .order("created", :asc)

GQL


SELECT * FROM Task ORDER BY priority DESC, created ASC

Si no se especifica ningún orden de clasificación, los resultados se muestran en el orden en que se recuperaron en el modo Datastore.

Restricciones

Ten en cuenta las siguientes restricciones para los órdenes de clasificación:

Debido a la forma en que el modo Datastore ejecuta las consultas, si una consulta especifica filtros de desigualdad en una propiedad y órdenes de clasificación en otras propiedades, la propiedad que se use en los filtros de desigualdad deberá ordenarse antes que las demás propiedades.
Si se especifica el orden, el conjunto de propiedades especificado en la cláusula distinct on debe aparecer antes de cualquier propiedad que no sea disintct on en los órdenes de clasificación. Consulta cómo agrupar consultas.
Se ignoran todos los pedidos de las propiedades con filtros de igualdad.

Tipos especiales de consultas

Hay algunos tipos específicos de consultas que merecen una mención especial:

`!= Not equal`

Usa el operador de no igual (!=) para mostrar entidades en las que exista la propiedad determinada y no coincida con el valor de comparación.

C#

No aplicable

Go

package datastore_snippets

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/datastore"
	"google.golang.org/api/iterator"
)

func queryNotEquals(w io.Writer, projectId string) error {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectId)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer client.Close()

	q := datastore.NewQuery("TaskList")
	q.FilterField("Task", "!=", []string{"notASimpleTask"})

	it := client.Run(ctx, q)
	for {
		var dst struct {
			Task string
		}
		key, err := it.Next(&dst)
		if err == iterator.Done {
			break
		}

		if err != nil {
			return err
		}
		fmt.Fprintf(w, "Key retrieved: %v\n", key)
	}

	return nil
}

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.neq("category", "Work"))
        .build();

Node.js

No aplicable

PHP

No aplicable

Python

query = client.query(kind="Task")
query.add_filter("category", "!=", "work")

Ruby

No aplicable

GQL


SELECT * FROM Task WHERE category != 'work'

Esta consulta muestra todas las entidades Task en las que existe la propiedad category y se establece en cualquier valor distinto de Work.

Esta consulta no muestra entidades en las que no exista la propiedad category. Las consultas de no igual (!=) y NOT_IN excluyen las entidades en las que la propiedad determinada no existe o en las que la propiedad se excluye de la indexación. Una propiedad existe cuando se configura con cualquier valor, incluida una string vacía o null.

Limitaciones

Ten en cuenta las siguientes limitaciones de las consultas !=:

Solo las entidades en las que existe la propiedad determinada pueden coincidir con la consulta.
Solo se permite un NOT_IN o != por consulta.

`IN`

Usa el operador IN para combinar hasta 30 cláusulas de igualdad (==) en la misma propiedad con un OR lógico. Una consulta IN muestra entidades en las que la propiedad determinada coincide con cualquiera de los valores de comparación.

C#

No aplicable

Go

package datastore_snippets

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/datastore"
	"google.golang.org/api/iterator"
)

func queryIn(w io.Writer, projectId string) error {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectId)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer client.Close()

	q := datastore.NewQuery("TaskList")
	q.FilterField("Task", "in", []string{"simpleTask", "easyTask"})

	it := client.Run(ctx, q)
	for {
		var dst struct {
			Task string
		}
		key, err := it.Next(&dst)
		if err == iterator.Done {
			break
		}

		if err != nil {
			return err
		}
		fmt.Fprintf(w, "Key retrieved: %v\n", key)
	}

	return nil
}

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.in("tag", ListValue.of("learn", "study")))
        .build();

Node.js

No aplicable

PHP

No aplicable

Python

query = client.query(kind="Task")
query.add_filter("tag", "IN", ["learn", "study"])

Ruby

No aplicable

GQL


SELECT * FROM Task WHERE tag IN ARRAY('learn', 'study')

Esta consulta muestra cada entidad Task en la que la propiedad tag se configura como learn o study. Esto incluye las entidades Task en las que la propiedad tag incluye uno de estos valores, pero no el otro.

`NOT_IN`

Usa el operador NOT_IN para combinar hasta 10 cláusulas de no igual (!=) en la misma propiedad con un AND lógico. Una consulta NOT_IN muestra entidades en las que existe la propiedad determinada y no coincide con ninguno de los valores de comparación.

C#

No aplicable

Go

package datastore_snippets

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/datastore"
	"google.golang.org/api/iterator"
)

func queryNotIn(w io.Writer, projectId string) error {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectId)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer client.Close()

	q := datastore.NewQuery("TaskList")
	q.FilterField("Task", "not-in", []string{"notASimpleTask", "notAnEasyTask"})

	it := client.Run(ctx, q)
	for {
		var dst struct {
			Task string
		}
		key, err := it.Next(&dst)
		if err == iterator.Done {
			break
		}

		if err != nil {
			return err
		}
		fmt.Fprintf(w, "Key retrieved: %v\n", key)
	}

	return nil
}

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.not_in("category", ListValue.of("Work", "Chores", "School")))
        .build();

Node.js

No aplicable

PHP

No aplicable

Python

query = client.query(kind="Task")
query.add_filter("category", "NOT_IN", ["work", "chores", "school"])

Ruby

No aplicable

GQL


SELECT * FROM Task WHERE category NOT IN ARRAY('work', 'chores', 'school')

Esta consulta no muestra entidades en las que la entidad category no existe. Las consultas de no igual (!=) y NOT_IN excluyen las entidades en las que no existe la propiedad dada. Una propiedad existe cuando se configura con cualquier valor, incluida una string vacía o null.

Limitaciones

Ten en cuenta las siguientes limitaciones de las consultas NOT_IN:

Solo las entidades en las que existe la propiedad determinada pueden coincidir con la consulta.
Solo se permite un NOT_IN o != por consulta.

Consultas principales

Una consulta principal limita sus resultados a la entidad especificada y a sus secundarios. En este ejemplo, se muestran todas las entidades Task cuyo principal es una entidad TaskList especificada:

C#

Query query = new Query("Task")
{
    Filter = Filter.HasAncestor(_db.CreateKeyFactory("TaskList")
        .CreateKey(keyName))
};

Go

ancestor := datastore.NameKey("TaskList", "default", nil)
query := datastore.NewQuery("Task").Ancestor(ancestor)

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            PropertyFilter.hasAncestor(
                datastore.newKeyFactory().setKind("TaskList").newKey("default")))
        .build();

Node.js

const ancestorKey = datastore.key(['TaskList', 'default']);

const query = datastore.createQuery('Task').hasAncestor(ancestorKey);

PHP

$ancestorKey = $datastore->key('TaskList', 'default');
$query = $datastore->query()
    ->kind('Task')
    ->hasAncestor($ancestorKey);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

# Query filters are omitted in this example as any ancestor queries with a
# non-key filter require a composite index.
ancestor = client.key("TaskList", "default")
query = client.query(kind="Task", ancestor=ancestor)

Ruby

# task_list_name = "default"
ancestor_key = datastore.key "TaskList", task_list_name

query = datastore.query("Task")
                 .ancestor(ancestor_key)

GQL


SELECT * FROM Task WHERE __key__ HAS ANCESTOR KEY(TaskList, 'default')

Limitaciones de las consultas principales

Ten en cuenta las siguientes limitaciones de las consultas Ancestor:

Todas las disyunciones evaluadas deben tener el mismo filtro principal.

Consultas sin categoría

Cuando una consulta no especifica la categoría ni el principal, se muestran todas las entidades de una aplicación del modo Datastore. Estas consultas sin categoría no pueden incluir filtros ni órdenes de clasificación para los valores de las propiedades. No obstante, pueden filtrar las claves de entidad y usar filtros principales. Para usar los filtros de clave, se puede especificar __key__ como el nombre de la propiedad:

C#

Query query = new Query()
{
    Filter = Filter.GreaterThan("__key__",
        _keyFactory.CreateKey("aTask"))
};

Go

query := datastore.NewQuery("").FilterField("__key__", ">", lastSeenKey)

Java

Query<Entity> query =
    Query.newEntityQueryBuilder().setFilter(PropertyFilter.gt("__key__", lastSeenKey)).build();

Node.js

const query = datastore
  .createQuery()
  .filter(new PropertyFilter('__key__', '>', lastSeenKey))
  .limit(1);

PHP

$query = $datastore->query()
    ->filter('__key__', '>', $lastSeenKey);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

last_seen_key = client.key("Task", "a")
query = client.query()
query.key_filter(last_seen_key, ">")

Ruby

query = Google::Cloud::Datastore::Query.new
query.where "__key__", ">", last_seen_key

GQL


SELECT * WHERE __key__ > KEY(Task, 'someTask')

Consultas de proyección

La mayoría de las consultas muestran entidades completas como resultado. Sin embargo, solo unas pocas propiedades de la entidad son relevantes para las aplicaciones. Las consultas de proyección te permiten hacer consultas solo sobre las propiedades específicas de una entidad que necesitas, con una latencia y un costo más bajos que mostrar la entidad completa.

Para las consultas de proyección, se deben indexar las propiedades especificadas.

Consultas de solo claves

Una consulta de solo clave (que es un tipo de consulta de proyección) muestra solo las claves de las entidades resultantes, en lugar de las entidades en sí, con una latencia y un costo más bajos que mostrar las entidades completas.

A menudo, es más rentable hacer primero consultas de solo clave y, luego, elegir un subconjunto de entidades de los resultados, en lugar de ejecutar una consulta general que puede arrojar más entidades que las que necesitas.

Sigue estos modelos para crear consultas de solo clave:

C#

Query query = new Query("Task")
{
    Projection = { "__key__" }
};

Go

query := datastore.NewQuery("Task").KeysOnly()

Java

Query<Key> query = Query.newKeyQueryBuilder().setKind("Task").build();

Node.js

const query = datastore.createQuery().select('__key__').limit(1);

PHP

$query = $datastore->query()
    ->keysOnly();

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query()
query.keys_only()

Ruby

query = datastore.query("Task")
                 .select("__key__")

GQL


SELECT __key__ FROM Task

Una consulta de solo clave es una operación pequeña y cuenta como una única lectura de entidad para la consulta en sí.

Proyecciones

Las consultas de proyección son similares a las consultas de SQL que tienen la siguiente forma.

SELECT priority, percent_complete FROM Task

Puedes usar todas las características de filtrado y orden disponibles para las consultas de entidad estándar, pero debes tener en cuenta estos límites.

La consulta de SQL de ejemplo muestra resultados abreviados con solo las propiedades especificadas, priority y percent_complete, con valores propagados. Todas las demás propiedades no se propagan. Aquí se explica cómo puedes elaborar esto como una consulta de proyección:

C#

Query query = new Query("Task")
{
    Projection = { "priority", "percent_complete" }
};

Go

query := datastore.NewQuery("Task").Project("Priority", "PercentComplete")

Java

Query<ProjectionEntity> query =
    Query.newProjectionEntityQueryBuilder()
        .setKind("Task")
        .setProjection("priority", "percent_complete")
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .select(['priority', 'percent_complete']);

PHP

$query = $datastore->query()
    ->kind('Task')
    ->projection(['priority', 'percent_complete']);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.projection = ["priority", "percent_complete"]

Ruby

query = datastore.query("Task")
                 .select("priority", "percent_complete")

GQL


SELECT priority, percent_complete FROM Task

Sigue estos modelos para ejecutar la consulta de proyección:

C#

Query query = new Query("Task")
{
    Projection = { "priority", "percent_complete" }
};
List<long> priorities = new List<long>();
List<double> percentCompletes = new List<double>();
foreach (var entity in _db.RunQuery(query).Entities)
{
    priorities.Add((long)entity["priority"]);
    percentCompletes.Add((double)entity["percent_complete"]);
}

Go

var priorities []int
var percents []float64
it := client.Run(ctx, query)
for {
	var task Task
	if _, err := it.Next(&task); err == iterator.Done {
		break
	} else if err != nil {
		log.Fatal(err)
	}
	priorities = append(priorities, task.Priority)
	percents = append(percents, task.PercentComplete)
}

Java

List<Long> priorities = new LinkedList<>();
List<Double> percentCompletes = new LinkedList<>();
QueryResults<ProjectionEntity> tasks = datastore.run(query);
while (tasks.hasNext()) {
  ProjectionEntity task = tasks.next();
  priorities.add(task.getLong("priority"));
  percentCompletes.add(task.getDouble("percent_complete"));
}

Node.js

async function runProjectionQuery() {
  const priorities = [];
  const percentCompletes = [];
  const [tasks] = await datastore.runQuery(query);
  tasks.forEach(task => {
    priorities.push(task.priority);
    percentCompletes.push(task.percent_complete);
  });

  return {
    priorities: priorities,
    percentCompletes: percentCompletes,
  };
}

PHP

$priorities = array();
$percentCompletes = array();
$result = $datastore->runQuery($query);
/* @var Entity $task */
foreach ($result as $task) {
    $priorities[] = $task['priority'];
    $percentCompletes[] = $task['percent_complete'];
}

Python

priorities = []
percent_completes = []

for task in query.fetch():
    priorities.append(task["priority"])
    percent_completes.append(task["percent_complete"])

Ruby

priorities = []
percent_completes = []
datastore.run(query).each do |task|
  priorities << task["priority"]
  percent_completes << task["percent_complete"]
end

GQL

No aplicable

Una consulta de proyección que no usa la cláusula distinct on es una operación pequeña y cuenta como una sola lectura de entidad.

Agrupación

Las consultas de proyección pueden usar la cláusula distinct on a fin de garantizar que solo se muestre el primer resultado de cada combinación de valores para las propiedades especificadas. Se mostrará solo el primer resultado de las entidades que tengan los mismos valores para las propiedades que se proyectan.

C#

Query query = new Query("Task")
{
    Projection = { "category", "priority" },
    DistinctOn = { "category" },
    Order = {
        { "category", PropertyOrder.Types.Direction.Ascending},
        {"priority", PropertyOrder.Types.Direction.Ascending }
    }
};

Go

query := datastore.NewQuery("Task").
	Project("Priority", "Category").
	DistinctOn("Category").
	Order("Category").Order("Priority")

Java

Query<ProjectionEntity> query =
    Query.newProjectionEntityQueryBuilder()
        .setKind("Task")
        .setProjection("category", "priority")
        .setDistinctOn("category")
        .setOrderBy(OrderBy.asc("category"), OrderBy.asc("priority"))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .groupBy('category')
  .order('category')
  .order('priority');

PHP

$query = $datastore->query()
    ->kind('Task')
    ->order('category')
    ->order('priority')
    ->projection(['category', 'priority'])
    ->distinctOn('category');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.distinct_on = ["category"]
query.order = ["category", "priority"]

Ruby

query = datastore.query("Task")
                 .select("category", "priority")
                 .distinct_on("category")
                 .order("category")
                 .order("priority")

GQL


SELECT DISTINCT ON (category) category, priority FROM Task
ORDER BY category, priority

El conjunto de propiedades especificado en la cláusula distinct on debe aparecer antes de cualquier propiedad que no sea disintct on en la cláusula order by si se especifica order by.

Consultas de agregación

Firestore en modo Datastore admite la consulta de agregación count(). Consulta Consultas de agregación.

Filtros de rango y desigualdad en varias propiedades

Firestore en modo Datastore admite varios filtros de desigualdad en una consulta compuesta. Consulta Cómo realizar consultas con filtros de rango y desigualdad en varias propiedades.

Valores de matrices

El modo Datastore indexa cada valor de propiedad de arreglo único una vez por índice. Por lo tanto, para consultar si un arreglo contiene un valor, usa un filtro de igualdad.

Ten en cuenta lo siguiente cuando tus consultas incluyan propiedades con valores de arreglos.

Filtros de desigualdad

Debido a la forma en que se indexan, las entidades con múltiples valores para la misma propiedad pueden interactuar con los filtros de consulta y los órdenes de clasificación de maneras inesperadas y sorprendentes.

Si una consulta tiene varios filtros de desigualdad para una propiedad determinada, una entidad coincidirá con la consulta solo si al menos uno de sus valores individuales para esa propiedad satisface todos los filtros. Por ejemplo, si una entidad del tipo Task tiene los valores fun y programming para la propiedad tag, no coincidirá con la consulta:

C#

Query query = new Query("Task")
{
    Filter = Filter.And(Filter.GreaterThan("tag", "learn"),
        Filter.LessThan("tag", "math"))
};

Go

query := datastore.NewQuery("Task").
	FilterField("Tag", ">", "learn").
	FilterField("Tag", "<", "math")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            CompositeFilter.and(
                PropertyFilter.gt("tag", "learn"), PropertyFilter.lt("tag", "math")))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    and([
      new PropertyFilter('tag', '>', 'learn'),
      new PropertyFilter('tag', '<', 'math'),
    ])
  );

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('tag', '>', 'learn')
    ->filter('tag', '<', 'math');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("tag", ">", "learn"))
query.add_filter(filter=PropertyFilter("tag", "<", "math"))

Ruby

query = datastore.query("Task")
                 .where("tag", ">", "learn")
                 .where("tag", "<", "math")

GQL


SELECT * FROM Task WHERE tag > 'learn' AND tag < 'math'

Cada uno de los valores tag de la entidad cumple con la condición de uno de los filtros, pero ningún valor individual cumple con ambos.

Varios filtros de igualdad

Se pueden usar varios filtros de igualdad para consultar entidades que contienen un conjunto de valores. Por ejemplo, una entidad de tipo Task con valores fun y programming para la propiedad tag satisfará la consulta

C#

Query query = new Query("Task")
{
    Filter = Filter.And(Filter.Equal("tag", "fun"),
        Filter.Equal("tag", "programming"))
};

Go

query := datastore.NewQuery("Task").
	FilterField("Tag", "=", "fun").
	FilterField("Tag", "=", "programming")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            CompositeFilter.and(
                PropertyFilter.eq("tag", "fun"), PropertyFilter.eq("tag", "programming")))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    and([
      new PropertyFilter('tag', '=', 'fun'),
      new PropertyFilter('tag', '=', 'programming'),
    ])
  );

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('tag', '=', 'fun')
    ->filter('tag', '=', 'programming');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("tag", "=", "fun"))
query.add_filter(filter=PropertyFilter("tag", "=", "programming"))

Ruby

query = datastore.query("Task")
                 .where("tag", "=", "fun")
                 .where("tag", "=", "programming")

GQL


SELECT * FROM Task WHERE tag = 'fun' AND tag = 'programming'

Sin embargo, ninguno de los valores tag individuales de la entidad cumple con ambas condiciones del filtro.

Orden de clasificación

Del mismo modo, el orden de clasificación para las propiedades con valores múltiples es inusual. Debido a que estas propiedades aparecen una vez en el índice por cada valor único, el primer valor que se observa en el índice determina el orden de clasificación de una entidad.

Si no se usa una propiedad con valores múltiples en ningún filtro, puede suceder lo siguiente:

Si la propiedad ordena los resultados de la consulta de forma ascendente, se usará el valor más pequeño de la propiedad para el ordenamiento.
Si la propiedad ordena los resultados de la consulta de forma descendente, se usará el valor más elevado de la propiedad para el ordenamiento.
Otros valores no afectan el orden de clasificación ni la cantidad de valores.

Esto tiene la consecuencia inusual de que la entidad con los valores de propiedad 1 y 9 antecede a una entidad con los valores 4, 5, 6 y 7, en orden ascendente y descendente.

Si se usa una propiedad con valores múltiples en un filtro de igualdad, se ignora cualquier orden de clasificación sobre esa propiedad.

Si se usa una propiedad con valores múltiples en un filtro de desigualdad o NOT_IN, sucede lo siguiente:

Si la propiedad ordena los resultados de la consulta de forma ascendente, se usará el valor más pequeño que satisfaga todos los filtros de desigualdad de la consulta para el ordenamiento.
Si la propiedad ordena los resultados de la consulta de forma descendente, se usará el valor más elevado que satisfaga todos los filtros de desigualdad de la consulta para el ordenamiento.

Ten en cuenta que si un conjunto de filtros de desigualdad en una propiedad se traduce como un filtro de igualdad, por ejemplo

WHERE tag >= 'math' AND tag <= 'math'

se ignorará cualquier orden de clasificación sobre esa propiedad, ya que los filtros evalúan lo mismo que el filtro de igualdad

WHERE tag = 'math'

Proyecciones y propiedades con valores de arreglos

La proyección de una propiedad con valores de array no propagará todos los valores para esa propiedad. En lugar de ello, se mostrará una entidad independiente por cada combinación única de valores proyectados que coincidan con la consulta. Por ejemplo, supón que tienes una entidad del tipo Task con dos propiedades con valores múltiples, tag y collaborators:

C#

Entity task = new Entity()
{
    Key = _db.CreateKeyFactory("Task").CreateKey("sampleTask"),
    ["collaborators"] = new ArrayValue() { Values = { "alice", "bob" } },
    ["tags"] = new ArrayValue() { Values = { "fun", "programming" } }
};

Go

type Task struct {
	Tags          []string
	Collaborators []string
}
task := &Task{
	Tags:          []string{"fun", "programming"},
	Collaborators: []string{"alice", "bob"},
}

Java

Entity task =
    Entity.newBuilder(taskKey)
        .set("tags", "fun", "programming")
        .set("collaborators", ListValue.of("alice", "bob"))
        .build();

Node.js

const task = {
  tags: ['fun', 'programming'],
  collaborators: ['alice', 'bob'],
};

PHP

$task = $datastore->entity(
    $key,
    [
        'tags' => ['fun', 'programming'],
        'collaborators' => ['alice', 'bob']
    ]
);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

key = client.key("Task")
task = datastore.Entity(key)
task.update({"tags": ["fun", "programming"], "collaborators": ["alice", "bob"]})

Ruby

# task_name = "sampleTask"
task = datastore.entity "Task", task_name do |t|
  t["tags"] = ["fun", "programming"]
  t["collaborators"] = ["alice", "bob"]
end

GQL

No aplicable

Entonces, la consulta de proyección

SELECT tag, collaborators FROM Task WHERE collaborators < 'charlie'

mostrará cuatro entidades con las combinaciones de valores siguientes:

tag = 'fun', collaborators = 'alice'
tag = 'fun', collaborators = 'bob'
tag = 'programming', collaborators = 'alice'
tag = 'programming', collaborators = 'bob'

Cursores, límites y compensaciones

Puedes especificar un límite para tu consulta, a fin de controlar la cantidad máxima de resultados que se muestran en un lote. En el siguiente ejemplo se muestran, como máximo, cinco entidades Task:

C#

Query query = new Query("Task")
{
    Limit = 5,
};

Go

query := datastore.NewQuery("Task").Limit(5)

Java

Query<Entity> query = Query.newEntityQueryBuilder().setKind("Task").setLimit(5).build();

Node.js

const query = datastore.createQuery('Task').limit(5);

PHP

$query = $datastore->query()
    ->kind('Task')
    ->limit(5);

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query()
tasks = list(query.fetch(limit=5))

Ruby

query = datastore.query("Task")
                 .limit(5)

GQL


SELECT * FROM Task LIMIT 5

Los cursores de consulta permiten que una aplicación recupere los resultados de una consulta en los lotes convenientes sin la sobrecarga de una compensación de consulta. Después de realizar una operación de recuperación, la aplicación puede obtener un cursor, que es una string de bytes opaca que marca la posición en el índice del último resultado recuperado. La aplicación puede guardar esta string (por ejemplo, en la base de datos del modo Datastore, en caché o incorporada en una página web como un parámetro HTTP GET o POST codificado en base-64) y, luego, puede usar el cursor como el punto de partida para una operación de recuperación posterior y obtener el siguiente lote de resultados desde el punto en que finalizó la recuperación anterior. En una recuperación, también se puede especificar un cursor de fin, para limitar la extensión del conjunto de resultados mostrados.

En el siguiente ejemplo se explica el uso de los cursores para paginación:

C#

Query query = new Query("Task")
{
    Limit = pageSize,
};
if (!string.IsNullOrEmpty(pageCursor))
    query.StartCursor = ByteString.FromBase64(pageCursor);

return _db.RunQuery(query).EndCursor?.ToBase64();

Go

// cursorStr is a cursor to start querying at.
cursorStr := ""

const pageSize = 5
query := datastore.NewQuery("Tasks").Limit(pageSize)
if cursorStr != "" {
	cursor, err := datastore.DecodeCursor(cursorStr)
	if err != nil {
		log.Fatalf("Bad cursor %q: %v", cursorStr, err)
	}
	query = query.Start(cursor)
}

// Read the tasks.
var tasks []Task
var task Task
it := client.Run(ctx, query)
_, err := it.Next(&task)
for err == nil {
	tasks = append(tasks, task)
	_, err = it.Next(&task)
}
if err != iterator.Done {
	log.Fatalf("Failed fetching results: %v", err)
}

// Get the cursor for the next page of results.
// nextCursor.String can be used as the next page's token.
nextCursor, err := it.Cursor()

Java

EntityQuery.Builder queryBuilder =
    Query.newEntityQueryBuilder().setKind("Task").setLimit(pageSize);
if (pageCursor != null) {
  queryBuilder.setStartCursor(pageCursor);
}
QueryResults<Entity> tasks = datastore.run(queryBuilder.build());
while (tasks.hasNext()) {
  Entity task = tasks.next();
  // do something with the task
}
Cursor nextPageCursor = tasks.getCursorAfter();

Node.js

// By default, google-cloud-node will automatically paginate through all of
// the results that match a query. However, this sample implements manual
// pagination using limits and cursor tokens.
async function runPageQuery(pageCursor) {
  let query = datastore.createQuery('Task').limit(pageSize);

  if (pageCursor) {
    query = query.start(pageCursor);
  }
  const results = await datastore.runQuery(query);
  const entities = results[0];
  const info = results[1];

  if (info.moreResults !== Datastore.NO_MORE_RESULTS) {
    // If there are more results to retrieve, the end cursor is
    // automatically set on `info`. To get this value directly, access
    // the `endCursor` property.
    const results = await runPageQuery(info.endCursor);

    // Concatenate entities
    results[0] = entities.concat(results[0]);
    return results;
  }

  return [entities, info];
}

PHP

/**
 * Fetch a query cursor.
 *
 * @param DatastoreClient $datastore
 * @param int $pageSize
 * @param string $pageCursor
 */
function cursor_paging(DatastoreClient $datastore, int $pageSize, string $pageCursor = '')
{
    $query = $datastore->query()
        ->kind('Task')
        ->limit($pageSize)
        ->start($pageCursor);
    $result = $datastore->runQuery($query);
    $nextPageCursor = '';
    $entities = [];
    /* @var Entity $entity */
    foreach ($result as $entity) {
        $nextPageCursor = $entity->cursor();
        $entities[] = $entity;
    }

    printf('Found %s entities', count($entities));

    $entities = [];
    if (!empty($nextPageCursor)) {
        $query = $datastore->query()
          ->kind('Task')
          ->limit($pageSize)
          ->start($nextPageCursor);
        $result = $datastore->runQuery($query);

        foreach ($result as $entity) {
            $entities[] = $entity;
        }

        printf('Found %s entities with next page cursor', count($entities));
    }
}

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

def get_one_page_of_tasks(cursor=None):
    query = client.query(kind="Task")
    query_iter = query.fetch(start_cursor=cursor, limit=5)
    page = next(query_iter.pages)

    tasks = list(page)
    next_cursor = query_iter.next_page_token

    return tasks, next_cursor

Ruby

page_size = 2
query = datastore.query("Task")
                 .limit(page_size)
tasks = datastore.run query

page_cursor = tasks.cursor

query = datastore.query("Task")
                 .limit(page_size)
                 .start(page_cursor)

GQL

No aplicable

Aunque las bases de datos del modo Datastore admiten compensaciones de números enteros, debes evitar usarlos. En su lugar, usa cursores. Usar una compensación solo impide que se muestren las entidades omitidas en la aplicación, pero aun así se las recupera internamente. Las entidades omitidas afectan la latencia de la consulta y tu aplicación se factura por las operaciones de lectura requeridas para recuperarlas. Usar cursores en lugar de compensaciones te permite evitar todos estos costos.

Limitaciones de los cursores

Los cursores están sujetos a las siguientes limitaciones:

Un cursor solo puede usarse en el mismo proyecto que realizó la consulta original y solo continúa en la misma consulta. No se puede recuperar resultados con un cursor sin configurar la misma consulta desde la que fue generado.
Si se modifica alguno de los siguientes elementos, se puede seguir usando un cursor para las recuperaciones posteriores.
- cursor de inicio
- cursor de fin
- compensación
- límite
Si se modifica alguno de los siguientes elementos, no se puede usar un cursor para las recuperaciones posteriores.
- proyección
- tipo
- ancestor
- filtro
- distinto en
- orden de clasificación Una excepción es si el orden de clasificación final de la consulta original estaba en __key__. En ese caso, puedes usar el cursor en una consulta inversa, que es la consulta original con cada orden de clasificación invertido. La consulta inversa puede modificar el cursor de inicio, el cursor de fin, la compensación y el límite.
Los cursores no siempre se comportan de la forma esperada con una consulta que usa un filtro de desigualdad o un orden de clasificación que depende de una propiedad con valores múltiples. La lógica de deduplicación para esas propiedades con valores múltiples no persiste entre las recuperaciones, lo que, posiblemente, hará que el mismo resultado se muestre más de una vez.
Las nuevas versiones del modo Datastore pueden modificar los detalles de implementación interna, lo que invalida los cursores que dependen de ellas. Si una aplicación intenta usar un cursor que ya no es válido, Firestore en modo Datastore generará una excepción.

Actualizaciones de datos y cursores

El cursor representa la ubicación en la lista de resultados después de que se muestra el último resultado. Un cursor no es una posición relativa en la lista (no es una compensación); es un marcador al que puede saltar una base de datos del modo Datastore cuando se inicia un análisis de índice para obtener resultados. Si los resultados de una consulta cambian entre distintos usos de un cursor, la consulta observará solo los cambios que se producen en los resultados después del cursor. Si aparece un resultado nuevo antes de la posición del cursor para la consulta, no se mostrará cuando se recuperen los resultados que le siguen al cursor. Del mismo modo, si una entidad ya no es un resultado para una consulta, pero ha aparecido antes del cursor, los resultados que aparecen después del cursor no cambian. Si el último resultado que se muestra se quita del conjunto de resultados, el cursor podrá ubicar el resultado siguiente de todas maneras.

Cuando se recuperan los resultados de la consulta, puedes usar un cursor de inicio y un cursor de fin para mostrar un grupo continuo de resultados. Cuando se usa un cursor de inicio y de fin para recuperar los resultados, no hay garantía de que el tamaño de los resultados será el mismo que cuando se generaron los cursores. Se pueden agregar o borrar entidades desde la base de datos entre el momento en que los cursores se generan y en que se utilizan en una consulta.

Restricciones en las consultas

La naturaleza del mecanismo de consulta de índice impone ciertas restricciones sobre lo que puede hacer una consulta. Las consultas del modo Datastore no admiten coincidencias de substring, coincidencias que no distinguen mayúsculas de minúsculas o búsqueda en el texto completo. Además, se aplican las siguientes restricciones:

Se ignoran las entidades que carecen de una propiedad nombrada en la consulta

No es necesario que las entidades del mismo tipo tengan las mismas propiedades. Para poder devolverse como resultado de una consulta, una entidad debe poseer un valor (posiblemente nulo) para cada propiedad nombrada en los filtros de consulta y los órdenes de clasificación. De lo contrario, la entidad se omite de los índices utilizados para ejecutar la consulta y, por lo tanto, no se incluirá en los resultados de la consulta.

Filtrar propiedades sin índice no muestra resultados

Una consulta no puede hallar valores de propiedad que no están indexados y tampoco puede ordenar las propiedades. Consulta la sección Propiedades no indexadas para obtener un análisis detallado sobre el tema.

Los filtros de desigualdad se limitan a una propiedad como máximo

Para no tener que explorar el índice completo, el mecanismo de consulta confía en que todos los resultados potenciales de una consulta sean adyacentes entre sí en el índice. Para satisfacer esta restricción, una sola consulta no puede usar comparaciones de desigualdad (LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, NOT_EQUAL, NOT_IN) en más de una propiedad en todos sus filtros. Por ejemplo, la siguiente consulta es válida porque ambos filtros de desigualdad se aplican a la misma propiedad:

C#

Query query = new Query("Task")
{
    Filter = Filter.And(Filter.GreaterThan("created", _startDate),
        Filter.LessThan("created", _endDate))
};

Go

query := datastore.NewQuery("Task").
	FilterField("Created", ">", time.Date(1990, 1, 1, 0, 0, 0, 0, time.UTC)).
	FilterField("Created", "<", time.Date(2000, 1, 1, 0, 0, 0, 0, time.UTC))

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            CompositeFilter.and(
                PropertyFilter.gt("created", startDate), PropertyFilter.lt("created", endDate)))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    and([
      new PropertyFilter('created', '>', new Date('1990-01-01T00:00:00z')),
      new PropertyFilter('created', '<', new Date('2000-12-31T23:59:59z')),
    ])
  );

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('created', '>', new DateTime('1990-01-01T00:00:00z'))
    ->filter('created', '<', new DateTime('2000-12-31T23:59:59z'));

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

start_date = datetime.datetime(1990, 1, 1)
end_date = datetime.datetime(2000, 1, 1)
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("created", ">", start_date))
query.add_filter(filter=PropertyFilter("created", "<", end_date))

Ruby

query = datastore.query("Task")
                 .where("created", ">=", Time.utc(1990, 1, 1))
                 .where("created", "<", Time.utc(2000, 1, 1))

GQL


SELECT * FROM Task
WHERE created > DATETIME('1990-01-01T00:00:00z')
  AND created < DATETIME('2000-12-31T23:59:59z')

Sin embargo, esta consulta no es válida porque usa filtros de desigualdad en dos propiedades diferentes:

C#

Query query = new Query("Task")
{
    Filter = Filter.And(Filter.GreaterThan("created", _startDate),
        Filter.GreaterThan("priority", 3))
};

Go

query := datastore.NewQuery("Task").
	FilterField("Created", ">", time.Date(1990, 1, 1, 0, 0, 0, 0, time.UTC)).
	FilterField("Priority", ">", 3)

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            CompositeFilter.and(
                PropertyFilter.gt("created", startDate), PropertyFilter.gt("priority", 3)))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    and([
      new PropertyFilter('priority', '>', 3),
      new PropertyFilter('created', '>', new Date('1990-01-01T00:00:00z')),
    ])
  );

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('priority', '>', 3)
    ->filter('created', '>', new DateTime('1990-01-01T00:00:00z'));

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

    start_date = datetime.datetime(1990, 1, 1)
    query = client.query(kind="Task")
    query.add_filter(filter=PropertyFilter("created", ">", start_date))
    query.add_filter(filter=PropertyFilter("priority", ">", 3))

Ruby

query = datastore.query("Task")
                 .where("created", ">=", Time.utc(1990, 1, 1))
                 .where("priority", ">", 3)

GQL


# Invalid query!
SELECT * FROM Task
WHERE created > DATETIME('1990-01-01T00:00:00z')
AND priority > 3

Recuerda que una consulta puede combinar filtros de igualdad (EQUAL) para propiedades diferentes, junto con uno o más filtros de desigualdad en una sola propiedad. Por lo tanto, la siguiente consulta sí es válida:

C#

Query query = new Query("Task")
{
    Filter = Filter.And(Filter.Equal("priority", 4),
        Filter.GreaterThan("created", _startDate),
        Filter.LessThan("created", _endDate))
};

Go

query := datastore.NewQuery("Task").
	FilterField("Priority", "=", 4).
	FilterField("Done", "=", false).
	FilterField("Created", ">", time.Date(1990, 1, 1, 0, 0, 0, 0, time.UTC)).
	FilterField("Created", "<", time.Date(2000, 1, 1, 0, 0, 0, 0, time.UTC))

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(
            CompositeFilter.and(
                PropertyFilter.eq("priority", 4),
                PropertyFilter.gt("created", startDate),
                PropertyFilter.lt("created", endDate)))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(
    and([
      new PropertyFilter('priority', '=', 4),
      new PropertyFilter('done', '=', false),
      new PropertyFilter('created', '>', new Date('1990-01-01T00:00:00z')),
      new PropertyFilter('created', '<', new Date('2000-12-31T23:59:59z')),
    ])
  );

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('priority', '=', 4)
    ->filter('done', '=', false)
    ->filter('created', '>', new DateTime('1990-01-01T00:00:00z'))
    ->filter('created', '<', new DateTime('2000-12-31T23:59:59z'));

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

start_date = datetime.datetime(1990, 1, 1)
end_date = datetime.datetime(2000, 12, 31, 23, 59, 59)
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("priority", "=", 4))
query.add_filter(filter=PropertyFilter("done", "=", False))
query.add_filter(filter=PropertyFilter("created", ">", start_date))
query.add_filter(filter=PropertyFilter("created", "<", end_date))

Ruby

query = datastore.query("Task")
                 .where("done", "=", false)
                 .where("priority", "=", 4)
                 .where("created", ">=", Time.utc(1990, 1, 1))
                 .where("created", "<", Time.utc(2000, 1, 1))

GQL


SELECT * FROM Task
WHERE priority = 4
  AND done = FALSE
  AND created > DATETIME('1990-01-01T00:00:00z')
  AND created < DATETIME('2000-12-31T23:59:59z')

No puedes usar `NOT_EQUAL` ni `NOT_IN` al mismo tiempo

Si usas NOT_IN, tampoco puedes agregar una cláusula NOT_EQUAL.

Cuando no se especifica un orden de clasificación, no se define el orden de los resultados de la consulta

Cuando una consulta no especifica un orden de clasificación, los resultados se muestran en el orden en que se recuperan. Este orden puede cambiar a medida que evolucione la implementación del modo Datastore (o si cambian los índices de un proyecto). Por lo tanto, si tu aplicación requiere que los resultados de la consulta estén en un orden en particular, asegúrate de especificar este orden de clasificación en la consulta.

Se ignoran los órdenes de clasificación en las propiedades con filtros de igualdad

Las consultas que incluyen un filtro de igualdad para una propiedad determinada ignoran cualquier orden de clasificación especificado para esa propiedad. Esta es una optimización para ahorrar procesamiento innecesario para propiedades con un solo valor. Dado que todos los resultados tienen el mismo valor para la propiedad, no es necesario ordenar más. Sin embargo, las propiedades con valores múltiples pueden tener valores adicionales además del que coincide con el filtro de igualdad. Debido a que este caso de uso es poco frecuente y aplicar el orden de clasificación sería costoso y requeriría índices adicionales, el planificador de consultas del modo Datastore ignora el orden de clasificación incluso en el caso de valores múltiples. Esto puede hacer que los resultados de la consulta se muestren en un orden diferente al que parece implicar el orden de clasificación. Por ejemplo, el orden se ignora en la siguiente consulta:

C#

No aplicable

Go

No aplicable

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.eq("tag", "learn"))
        .setOrderBy(OrderBy.asc("tag"))
        .build();

Node.js

No aplicable

PHP

No aplicable

Python

No aplicable

Ruby

No aplicable

GQL


# Sort order on an equality filter is ignored
SELECT * FROM Task WHERE tag = 'learn' ORDER BY tag ASC

Esto no se aplica a las consultas que incluyen un filtro IN. Usa el operador IN para combinar hasta 10 cláusulas de igualdad (==) en la misma propiedad con un OR lógico. Si agregas un orden de clasificación para esa propiedad, se aplica al conjunto de resultados.

C#

No aplicable

Go

No aplicable

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.in("tag", ListValue.of("learn", "study")))
        .setOrderBy(OrderBy.asc("tag"))
        .build();

Node.js

No aplicable

PHP

No aplicable

Python

No aplicable

Ruby

No aplicable

GQL


SELECT * FROM Task WHERE tag IN ARRAY('learn', 'study') ORDER BY tag ASC

En el caso del orden ascendente, el valor más pequeño que satisface el filtro se usa para el ordenamiento.
En orden descendente, el valor máximo que satisface el filtro se usa para el ordenamiento.
Otros valores no afectan el orden de clasificación ni la cantidad de valores en la propiedad.

Primero deben clasificarse las propiedades que se usan en los filtros de desigualdad

Para recuperar todos los resultados que coinciden con un filtro de desigualdad, una consulta analiza el índice en busca de la primera fila que coincida con el filtro y, luego, lo hace hasta que encuentra una fila que no coincide. Para que las filas consecutivas abarquen el conjunto completo de resultados, deben estar ordenadas por la propiedad que se usa en el filtro de desigualdad antes de cualquier otra propiedad. Por lo tanto, si una consulta especifica uno o más filtros de desigualdad junto con uno o más órdenes de clasificación, el primer orden de clasificación debe referirse a la misma propiedad nombrada en los filtros de desigualdad. La siguiente es una consulta válida:

C#

Query query = new Query("Task")
{
    Filter = Filter.GreaterThan("priority", 3),
    Order = { { "priority", PropertyOrder.Types.Direction.Ascending},
        {"created", PropertyOrder.Types.Direction.Ascending } }
};

Go

query := datastore.NewQuery("Task").
	FilterField("Priority", ">", 3).
	Order("Priority").
	Order("Created")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.gt("priority", 3))
        .setOrderBy(OrderBy.asc("priority"), OrderBy.asc("created"))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(new PropertyFilter('priority', '>', 3))
  .order('priority')
  .order('created');

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('priority', '>', 3)
    ->order('priority')
    ->order('created');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("priority", ">", 3))
query.order = ["priority", "created"]

Ruby

query = datastore.query("Task")
                 .where("priority", ">", 3)
                 .order("priority")
                 .order("created")

GQL


SELECT * FROM Task WHERE priority > 3 ORDER BY priority, created

Esta consulta no es válida, ya que no ordena en función de la propiedad que se usa en el filtro de desigualdad:

C#

Query query = new Query("Task")
{
    Filter = Filter.GreaterThan("priority", 3),
    Order = { { "created", PropertyOrder.Types.Direction.Ascending } }
};

Go

query := datastore.NewQuery("Task").
	FilterField("Priority", ">", 3).
	Order("Created")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.gt("priority", 3))
        .setOrderBy(OrderBy.asc("created"))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(new PropertyFilter('priority', '>', 3))
  .order('created');

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('priority', '>', 3)
    ->order('created');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

    query = client.query(kind="Task")
    query.add_filter(filter=PropertyFilter("priority", ">", 3))
    query.order = ["created"]

Ruby

query = datastore.query("Task")
                 .where("priority", ">", 3)
                 .order("created")

GQL


# Invalid query!
SELECT * FROM Task WHERE priority > 3 ORDER BY created

Del mismo modo, esta consulta no es válida porque la propiedad que se usa en el filtro de desigualdad no es la primera que se usa para ordenar:

C#

Query query = new Query("Task")
{
    Filter = Filter.GreaterThan("priority", 3),
    Order = { {"created", PropertyOrder.Types.Direction.Ascending },
        { "priority", PropertyOrder.Types.Direction.Ascending} }
};

Go

query := datastore.NewQuery("Task").
	FilterField("Priority", ">", 3).
	Order("Created").
	Order("Priority")

Java

Query<Entity> query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(PropertyFilter.gt("priority", 3))
        .setOrderBy(OrderBy.asc("created"), OrderBy.asc("priority"))
        .build();

Node.js

const query = datastore
  .createQuery('Task')
  .filter(new PropertyFilter('priority', '>', 3))
  .order('created')
  .order('priority');

PHP

$query = $datastore->query()
    ->kind('Task')
    ->filter('priority', '>', 3)
    ->order('created')
    ->order('priority');

Python

from google.cloud import datastore

# For help authenticating your client, visit
# https://cloud.google.com/docs/authentication/getting-started
client = datastore.Client()

    query = client.query(kind="Task")
    query.add_filter(filter=PropertyFilter("priority", ">", 3))
    query.order = ["created", "priority"]

Ruby

query = datastore.query("Task")
                 .where("priority", ">", 3)
                 .order("created")
                 .order("priority")

GQL


# Invalid query!
SELECT * FROM Task WHERE priority > 3 ORDER BY created, priority

`OrderBy` y existencia

Cuando ordenas una consulta por una propiedad determinada, esta puede mostrar solo las entidades en las que existe la propiedad order-by.

Por ejemplo, la siguiente consulta no mostraría ninguna entidad en la que la propiedad priority no esté configurada, incluso si, de lo contrario, cumple con los filtros de consulta.

Java

Query query =
    Query.newEntityQueryBuilder().setKind("Task")
                                 .setFilter(PropertyFilter.eq("done", false))
                                 .setOrderBy(OrderBy.desc("priority"))
                                 .build();

Un efecto relacionado se aplica a las desigualdades. Una consulta con un filtro de desigualdad en una propiedad también implica ordenar según esa propiedad. La siguiente consulta no muestra entidades sin una propiedad priority, incluso si starred = true está en esa entidad. Como solución alternativa, puedes ejecutar consultas separadas para cada orden o asignar un valor a todas las propiedades en las que ordenas.

Java

Query query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(CompositeFilter.or(
            PropertyFilter.eq("starred", true)),
            PropertyFilter.ge("priority", 4))
        .build();

La consulta anterior incluye un order-by implícito sobre la desigualdad, como el siguiente. La dirección del ordenamiento implícito depende de los índices disponibles:

Java

Query query =
    Query.newEntityQueryBuilder()
        .setKind("Task")
        .setFilter(CompositeFilter.or(
            PropertyFilter.eq("starred", true)),
            PropertyFilter.ge("priority", 4)
        )
        .setOrderBy(OrderBy.asc("priority"))
        .build();

Límites de las proyecciones

Las consultas de proyección están sujetas a las limitaciones siguientes:

Solo se pueden proyectar propiedades indexadas.

Esto significa que todas las propiedades que se usan en una consulta (proyectada o de filtros) deben existir en el mismo índice. Por lo tanto, select tag from Task where priority = 1 requiere un índice compuesto con prioridad y, luego, etiqueta.

La proyección no es compatible con strings de más de 1,500 bytes, arreglos de bytes con más de 1,500 elementos ni otras propiedades marcadas explícitamente como no indexadas.
No se puede proyectar la misma propiedad más de una vez
No se pueden proyectar las propiedades mencionadas en un filtro de igualdad

Por ejemplo,
```
SELECT tag FROM Task WHERE priority = 1
```
Es una consulta válida, ya que la propiedad proyectada no se usa en el filtro de igualdad. También lo es la siguiente consulta:
```
SELECT tag FROM Task WHERE tag > 'fun`
```
No es un filtro de igualdad. Sin embargo, la siguiente consulta no es válida:
```
SELECT tag FROM Task WHERE tag = 'fun`
```
La propiedad proyectada se usa en un filtro de igualdad.
Los resultados que muestra una consulta de proyección no se deben volver a guardar en la base de datos en modo Datastore.

Debido a que la consulta muestra resultados que solo están propagados de forma parcial, no debes volver a escribirlos en la base de datos en modo Datastore.
Las consultas de proyección convierten las marcas de tiempo en números enteros

En los resultados de una consulta de proyección, el modo Datastore convierte los valores de las marcas de tiempo en valores de números enteros expresados en microsegundos.

¿Qué sigue?

Obtén más información sobre Transacciones.