O Python 2 não é mais compatível com a comunidade. Recomendamos que você migre aplicativos do Python 2 para o Python 3.

Cursores de consulta

Os cursores de consulta permitem a recuperação, por parte de um aplicativo, dos resultados de uma consulta em lotes convenientes, sendo o uso recomendado em deslocamentos inteiros para paginação. Para mais informações sobre a estruturação de consultas para o aplicativo, acesse a página Consultas.

Cursores de consulta

Os cursores de consulta permitem a recuperação, por parte de um aplicativo, dos resultados de uma consulta em lotes convenientes, evitando a sobrecarga do deslocamento dessa consulta. Após executar uma operação de recuperação, o aplicativo recebe um cursor, uma string opaca codificada em base64 que marca a posição do índice do último resultado recuperado. O aplicativo pode salvar essa string, por exemplo, no Datastore, no Memcache, em um payload de tarefa da fila de tarefas ou incorporada em uma página da Web como parâmetro HTTP GET ou POST e depois usa o cursor como ponto de partida para uma operação de recuperação subsequente. Nesse caso, o próximo lote de resultados será conseguido a partir do ponto em que a recuperação anterior terminou. É possível que uma recuperação também especifique um cursor de término para limitar a extensão do conjunto de resultados retornados.

Deslocamentos versus cursores

O Datastore é compatível com deslocamentos de números inteiros, mas convém evitá-los. Em vez disso, use cursores. O uso de um deslocamento evita apenas o retorno de entidades ignoradas ao aplicativo, mas é possível recuperá-las internamente. Na verdade, as entidades ignoradas afetam a latência da consulta. Além disso, o aplicativo será cobrado pelas operações de leitura necessárias para a recuperação dessas entidades. Use cursores em vez de deslocamentos para evitar todos esses custos.

Exemplo de cursor de consulta

No Python, um aplicativo recebe um cursor depois de recuperar os resultados da consulta chamando o método cursor() do objeto Query. Para recuperar mais resultados no ponto do cursor, o aplicativo prepara uma consulta semelhante com o mesmo tipo, filtros e ordem de classificação da entidade e transmite o cursor para o método with_cursor() da consulta antes de realizar a recuperação:

from google.appengine.api import memcache
from google.appengine.ext import db

# class Person(db.Model): ...

# Start a query for all Person entities
people = Person.all()

# If the application stored a cursor during a previous request, use it
person_cursor = memcache.get('person_cursor')
if person_cursor:
  people.with_cursor(start_cursor=person_cursor)

# Iterate over the results
for person in people:
  # Do something

# Get updated cursor and store it for next time
person_cursor = people.cursor()
memcache.set('person_cursor', person_cursor)

Limitações dos cursores

Os cursores estão sujeitos às seguintes limitações:

  • Um cursor é usado somente pelo mesmo projeto que executou a consulta original e para continuar a mesma consulta. Para usar o cursor em uma operação de recuperação posterior, reconstitua na íntegra a consulta original, incluindo o mesmo tipo de entidade, filtro de ancestrais e de propriedades e ordens de classificação. Não é possível recuperar resultados usando um cursor sem configurar a mesma consulta que o gerou.
  • Como os operadores != e IN são implementados com várias consultas, as consultas que os usam não são compatíveis com cursores.
  • Cursores nem sempre funcionam como esperado em uma consulta que usa um filtro de desigualdade ou uma ordem de classificação em uma propriedade com valores múltiplos. A lógica de eliminar a duplicação para essas propriedades não se mantém entre as recuperações. Assim, é possível que o mesmo resultado seja retornado mais de uma vez.
  • Novas versões do App Engine podem alterar os detalhes de implementação internos, invalidando cursores que dependem deles. Se um aplicativo tentar usar um cursor que não é mais válido, o Datastore gerará uma exceção BadRequestError.

Cursores e atualizações de dados

A posição do cursor é definida como o local na lista de resultados após o último resultado retornado. Um cursor não é uma posição relativa na lista (não é um deslocamento), mais sim um marcador para que o Datastore pode pular ao iniciar uma varredura de índice. Caso os resultados de uma consulta sofram alteração entre os usos de um cursor, ela refletirá apenas as alterações ocorridas nos resultados após o cursor. Se na consulta aparecer um novo resultado antes da posição do cursor, ele não será retornado quando forem recuperados os resultados após o cursor. Da mesma forma, caso uma entidade não seja mais o resultado de uma consulta, mesmo tendo aparecido antes do cursor, os resultados após o cursor não serão alterados. Caso o último resultado retornado seja removido do conjunto de resultados, o cursor ainda saberá como localizar o próximo.

Ao recuperar os resultados da consulta, é possível usar um cursor inicial e um cursor final para retornar um grupo contínuo de resultados do Datastore. Usar um cursor de início e de término na recuperação de resultados não garante que o tamanho dos resultados seja o mesmo de quando os cursores foram gerados. As entidades podem ser adicionadas ou excluídas do Datastore entre o momento em que os cursores são gerados e o momento em que eles são usados em uma consulta.

A seguir