cursor.maxAwaitTimeMS()

Nesta página

Definição

Compatibilidade
Exemplo

Definição

cursor.maxAwaitTimeMS(<time limit>)

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação de um driver de idioma específico, como Node.js.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

Especifica o tempo máximo para o servidor esperar por novos documentos que correspondam a uma query decursor persistente em uma collection limitada. Para obter mais informações sobre a iteração de um cursor retornado por uma consulta, consulte: Iterar um cursor no mongosh.

O método maxAwaitTimeMS() tem a seguinte forma de protótipo:

db.collection.find(
   { <query> },
   { <projection> }
).tailable( { awaitData: true } ).maxAwaitTimeMS( <milliseconds> )

O método maxAwaitTimeMS() tem o seguinte parâmetro:

Parâmetro	Tipo	Descrição
`milliseconds`	inteiro	Especifica um tempo máximo de espera para novos documentos.

Importante

Esse método, maxAwaitTimeMS(), define um limite para o tempo que um cursor persistente espera pela próxima resposta. maxTimeMS() define um limite no tempo total de processamento.

Compatibilidade

Esse método está disponível em implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

Observação

Este comando é aceito em todos os clusters do MongoDB Atlas. Para obter informações sobre o suporte do Atlas a todos os comandos, consulte Comandos não suportados.

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Exemplo

Query a collection limitada sales para encontrar os totais de vendas semanais do agente Mary Key:

db.sales.find(
   { agent: "Mary Kay" },
   { _id: 0, agent: 1, weeklyTotal: 1  }
).tailable( { awaitData: true } ).maxAwaitTimeMS( 1000 )

A linha destacada cria um cursor persistente na coleção sales . O maxAwaitTimeMS() define um tempo máximo de espera de um segundo para a próxima atualização do cursor.

Voltar

cursor.max

cursor.maxTimeMS