cursor.tailable()

Definição

cursor.tailable()

Importante

Método mongosh

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

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

Marca o cursor como rastreável , mantendo-o aberto mesmo quando o cliente esgota todos os resultados.

Para uso apenas em uma capped collection . Usar ~cursor.tailable() em uma coleção sem limite retorna um erro.

cursor.tailable() usa a seguinte sintaxe:

cursor.tailable( { awaitData : <boolean> } )

~cursor.tailable() tem o seguinte parâmetro:

Parâmetro	Tipo	Descrição
awaitData	booleano	Opcional. Para uso com DBQuery.Option.tailable. Define o cursor para bloquear o thread de query quando nenhum dado estiver disponível e aguardar os dados por um tempo definido em vez de retornar imediatamente nenhum dado. O cursor não retornará dados somente se o tempo limite expirar. Por padrão, se maxTimeMS estiver definido no comando que criou o cursor, o tempo limite para awaitData será o tempo restante. Caso contrário, o tempo limite padrão é 1000 milissegundos. Você pode definir um timeout ao executar getMore em um cursor com awaitData ativado. Padrão é false.

Retorna:	O cursor ao qual o ~cursor.tailable() está anexado.

Comportamento

Um cursor tailable executa uma varredura de collection em uma capped collection. Permanece aberto mesmo depois de chegar ao final da coleção. Os aplicativos podem continuar a iterar o cursor tailable à medida que novos dados são inseridos na coleta.

Se awaitData for true, quando o cursor atinge o final da coleção limitada, mongod bloqueia o thread de consulta para o intervalo de tempo limite e aguarda a chegada de novos dados. Quando novos dados são inseridos na coleção limitada, mongod sinaliza o thread bloqueado para ativar e retornar o próximo lote ao cliente.

Consulte Cursores rastreáveis.