/ /

getMore (comando de banco de dados)

Definição

getMore: Use com comandos que retornam um cursor, como find e aggregate, para retornar os próximos lotes de documentos de um cursor.

Compatibilidade

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

MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Observação

This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.

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

Sintaxe

O comando tem a seguinte sintaxe:

db.runCommand(
   {
      getMore: <long>,
      collection: <string>,
      batchSize: <int>,
      maxTimeMS: <int>,
      comment: <any>
   }
)

Campos de comando

O comando aceita os seguintes campos:

Campo	Tipo	Descrição
`getMore`	long	O identificador do cursor.
`collection`	string	O nome da collection sobre a qual o cursor está operando.
`batchSize`	número inteiro positivo	opcional. O número máximo de documentos retornados para cada lote. Se `batchSize` não estiver definido, `getMore` retornará até 16 mebibytes (MiB) para cada lote. Se `batchSize` estiver definido, `getMore` retornará o menor entre `batchSize` documentos ou 16 MiB.
`maxTimeMS`	non-negative integer	Opcional. Especifica quanto tempo o servidor espera por novos documentos que correspondam a uma query de cursor persistente em uma coleção limitada. `maxTimeMS` em um `getMore` para um cursor `awaitData` persistente é equivalente a `maxAwaitTimeMS()`. Os drivers definem esse valor apenas para cursores persistentes em coleções limitadas onde `awaitData` é `true`. Caso contrário, o comando que cria o cursor define `maxTimeMS` como o limite de tempo cumulativo para a operação inicial e todas as operações `getMore` subsequentes. Para cursores persistentes com `awaitData` definido como `true`, o seguinte é verdadeiro: Se nenhum valor for fornecido, o tempo de espera tem como padrão `1` (1000 milissegundos). `maxTimeMS` em `getMore` especifica a quantidade máxima de tempo que o MongoDB espera para que novos documentos sejam inseridos na collection limitada para esse comando `getMore` específico. `maxTimeMS` é definido individualmente pelo driver para cada chamada para `getMore`. O MongoDB encerra as operações que excedem o limite de tempo usando o mesmo mecanismo de `db.killOp()`, mas apenas em pontos de interrupção designados. Você não pode definir `maxTimeMS` ao chamar `getMore` em um cursor não tailable. Em vez disso, defina-o usando `maxTimeMS()` ao criar o cursor. Para usar `getMore` com `maxTimeMS` em um cursor tailable, habilite `awaitData` ao criar o cursor usando `cursor.tailable()`. A configuração de `maxTimeMS` no comando que cria um cursor apenas define o limite de tempo para essa operação. Use `getMore` para definir um limite para operações adicionais. Você pode definir ou omitir `maxTimeMS` para cada chamada para `getMore` e não precisa usar o mesmo valor. Em um cursor tailable, um tempo limite em `getMore` retém os documentos acumulados no cursor antes da ocorrência do tempo limite. Para um cursor não tailable, um tempo limite gera um erro.
`comment`	any	Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais: mensagens de log do mongod, no campo `attr.command.cursor.comment`. Saída do perfil do banco de dados, no campo `command.comment`. Saída de `currentOp`, no campo `command.comment`. Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc). Se omitido, `getMore` herda qualquer `comment` definido no comando `find` ou `aggregate` de origem.

Saída

O comando retorna um documento que contém as informações do cursor e o próximo lote.

Por exemplo, executar o getMore em um cursor criado por uma operação find em um cluster fragmentado retorna um documento semelhante a esta saída:

{
   "cursor" : {
      "id" : Long("678960441858272731"),
      "ns" : "test.contacts",
      "nextBatch" : [
         {
            "_id" : ObjectId("5e8e501e1a32d227f9085857"),
            "zipcode" : "220000"
         }
      ],
      "partialResultsReturned" : true,
      "postBatchResumeToken": "< Resume Token >"
   },
   "ok" : 1,
   "operationTime" : Timestamp(1586385239, 2),
   "$clusterTime" : {
      "clusterTime" : Timestamp(1586385239, 2),
      "signature" : {
         "hash" : BinData(0,"lLjejeW6AQGReR9x1PD8xU+tP+A="),
         "keyId" : Long("6813467763969884181")
      }
   }
}

Campo	Descrição
`cursor`	Contém as informações do cursor, incluindo a ID do cursor e o `nextBatch` dos documentos. If `find` (or subsequent `getMore` commands) returns partial results because the queried shard(s) aren't available, the find output includes a `partialResultsReturned` indicator field. If the queried shards are available for the initial `find` command, but one or more shards become unavailable for subsequent `getMore` commands, only the `getMore` commands that run while the shards aren't available include `partialResultsReturned` in their output. O campo `postBatchResumeToken` pode ser utilizado com o pipeline `$changeStream` para iniciar ou retomar um fluxo de alteração a partir deste ponto.
`"ok"`	Indica se o comando foi bem-sucedido (`1`) ou falhou (`0`).

Campo

Descrição

cursor

Contém as informações do cursor, incluindo a ID do cursor e o nextBatch dos documentos.

If find (or subsequent getMore commands) returns partial results because the queried shard(s) aren't available, the find output includes a partialResultsReturned indicator field. If the queried shards are available for the initial find command, but one or more shards become unavailable for subsequent getMore commands, only the getMore commands that run while the shards aren't available include partialResultsReturned in their output.

O campo postBatchResumeToken pode ser utilizado com o pipeline $changeStream para iniciar ou retomar um fluxo de alteração a partir deste ponto.

"ok"

Indica se o comando foi bem-sucedido (1) ou falhou (0).

Além desses campos, a resposta db.runCommand() inclui as seguintes informações para conjuntos de réplicas e clusters fragmentados:

$clusterTime
operationTime

Para obter mais informações, consulte resposta de db.runCommand().

Comportamento

Controle de acesso

Se a autenticação estiver habilitada, você somente poderá executar getMore em cursores que você criou.

Sessões

Para cursores criados dentro de uma sessão, não é possível fazer chamadas getMore fora da sessão.

Para cursores criados fora de uma sessão, não é possível chamar getMore dentro de uma sessão.

Transações

Para transações com vários documentos:

For cursors created outside of a transaction, you cannot call getMore inside the transaction.
For cursors created in a transaction, you cannot call getMore outside the transaction.

Queries lentas

Starting in MongoDB 5.1, when a getMore command is logged as a slow query, the queryHash and planCacheKey fields are added to the slow query log message and the profiler log message.

Saiba mais

Iterar um cursor em mongosh

Voltar

encontrar e modificar

insert