cursor.addOption()
Definição
cursor.addOption(flag)
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.
Observação
Descontinuado desde a v3.2
A partir de v3.2, o operador
cursor.addOption()
é preterido emmongo
. Use os métodos de cursor disponíveis.Usado para alterar o comportamento da query definindo os sinalizadores listados abaixo.
O método
cursor.addOption()
tem o seguinte parâmetro:ParâmetroTipoDescriçãoflag
flagParamongosh
, você pode usar os sinalizadores de cursor listados abaixo. Para obter a lista específica de drivers, consulte a documentação do driver.
Flags
mongosh
fornece vários sinalizadores de cursor adicionais para modificar o comportamento do cursor.
bandeira | Descrição |
---|---|
Define o cursor para não fechar assim que os últimos dados forem recebidos, permitindo que a query continue retornando dados adicionados após os resultados iniciais se esgotarem. | |
Permite a query de uma réplica secundária. | |
Impede que o servidor atinja o tempo limite de cursores ociosos. | |
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 no lugar de não retornar nenhum dado imediatamente. O cursor só não retorna dados se o tempo limite expirar. | |
Define o cursor para retornar todos os dados retornados pela query de uma só vez, em vez de dividir os resultados em lotes. | |
Define o cursor para retornar dados parciais de uma query em um cluster fragmentado no qual alguns shards não respondem em vez de lançar um erro. |
Exemplo
O exemplo a seguir adiciona o sinalizador DBQuery.Option.tailable
e o sinalizador DBQuery.Option.awaitData
para garantir que a query retorne um cursor persistente. A sequência cria um cursor. Depois de retornar o conjunto completo de resultados, ele aguarda o intervalo padrão de 1000 milissegundos para poder capturar e retornar dados adicionais adicionados durante a query:
var t = db.myCappedCollection; var cursor = t.find().addOption(DBQuery.Option.tailable). addOption(DBQuery.Option.awaitData)
Aviso
Adicionar sinalizadores de protocolo de conexão incorretos pode causar problemas e/ou carga extra do servidor.