MongoDB\UpdateResult::getUpsertedId()

Definição

MongoDB\UpdateResult::getUpsertedId()

Retornar o ID (ou seja valor do campo _id ) do documento atualizado e inserido.

function getUpsertedId(): mixed|null

Return Values

O ID (ou seja valor do campo _id ) do documento atualizado e inserido. Se nenhum documento foi atualizado, null será retornado.

Se o documento tivesse um ID antes do upsering (ou seja, o servidor não precisou gerar um ID), ele conterá seu valor de campo _id. Qualquer ID gerado pelo servidor será uma instância MongoDB\BSON\ObjectId.

Erros/exceções

MongoDB\Exception\BadMethodCallException se esse método for chamado e a operação de gravação usar uma write concern não reconhecida.

Veja também

• MongoDB\Driver\WriteResult::getUpsertedIds()