Substituir documentos

Nesta página

Visão geral

Dados de amostra
Operação de substituição
Parâmetros necessários
Valor de retorno
Exemplo
Modificar a operação de substituição
Exemplo
Informações adicionais
Documentação da API

Visão geral

Neste guia, você pode aprender como usar a biblioteca PHP do MongoDB para executar uma operação de substituição em uma coleção do MongoDB . Uma operação de substituição tem desempenho diferente de uma operação de atualização. Uma operação de atualização modifica somente os campos especificados em um documento de destino. Uma operação de substituição remove todos os campos do documento de destino e os substitui por novos.

Para substituir um documento, use o método MongoDB\Collection::replaceOne() .

Dados de amostra

Os exemplos neste guia utilizam a coleção do restaurants no banco de dados de dados do sample_restaurants a partir dos conjuntos de dados de amostra do Atlas. Para acessar essa coleção a partir do seu aplicação PHP , instancie um MongoDB\Client que se conecte a um Atlas cluster e atribua o seguinte valor à sua variável $collection :

$collection = $client->sample_restaurants->restaurants;

Para saber como criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte o guia Iniciar com Atlas .

Operação de substituição

Você pode executar uma operação de substituição usando MongoDB\Collection::replaceOne(). Esse método remove todos os campos, exceto o campo _id do primeiro documento que corresponde aos critérios de pesquisa. Em seguida, ele insere os campos e valores especificados no documento.

Parâmetros necessários

O método replaceOne() exige os seguintes parâmetros:

documento de filtro de query , que determina os documentos a serem substituídos. Para obter mais informações sobre filtros de query, consulte a seção Documentos de filtro de query no manual do MongoDB Server .
Substituir documento, que especifica os campos e valores a serem inseridos no novo documento.

Valor de retorno

O método replaceOne() retorna um objeto MongoDB\UpdateResult . O tipo MongoDB\UpdateResult contém os seguintes métodos:

Método	Descrição
`getMatchedCount()`	Returns the number of documents that matched the query filter, regardless of how many were updated.
`getModifiedCount()`	Returns the number of documents modified by the update operation. If an updated document is identical to the original, it is not included in this count.
`getUpsertedCount()`	Returns the number of documents upserted into the database, if any.
`getUpsertedId()`	Returns the ID of the document that was upserted in the database, if the driver performed an upsert.
`isAcknowledged()`	Returns a boolean indicating whether the write operation was acknowledged.

Exemplo

O exemplo a seguir usa o método replaceOne() para substituir os campos e valores de um documento no qual o valor do campo name é 'Pizza Town'. Em seguida, imprime o número de documentos modificados:

$replace_document = [
    'name' => 'Mongo\'s Pizza',
    'cuisine' => 'Pizza',
    'address' => [
        'street' => '123 Pizza St',
        'zipCode' => '10003',
    ],
    'borough' => 'Manhattan'
];
$result = $collection->replaceOne(['name' => 'Pizza Town'], $replace_document);
echo 'Modified documents: ', $result->getModifiedCount();

Modified documents: 1

Importante

Os valores dos campos _id são imutáveis. Se o documento de substituição especificar um valor para o campo _id, ele deverá corresponder ao valor _id do documento existente.

Modificar a operação de substituição

Você pode modificar o comportamento do método MongoDB\Collection::replaceOne() passando uma array que especifique valores de opção como um parâmetro. A tabela a seguir descreve algumas opções que você pode definir na array:

Opção	Descrição
`upsert`	Specifies whether the replace operation performs an upsert operation if no documents match the query filter. For more information, see the upsert statement in the MongoDB Server manual. Defaults to `false`.
`bypassDocumentValidation`	Specifies whether the replace operation bypasses document validation. This lets you replace documents that don't meet the schema validation requirements, if any exist. For more information about schema validation, see Schema Validation in the MongoDB Server manual. Defaults to `false`.
`collation`	Specifies the kind of language collation to use when sorting results. For more information, see Collation in the MongoDB Server manual.
`hint`	Gets or sets the index to scan for documents. For more information, see the hint statement in the MongoDB Server manual.
`session`	Specifies the client session to associate with the operation.
`let`	Specifies a document with a list of values to improve operation readability. Values must be constant or closed expressions that don't reference document fields. For more information, see the let statement in the MongoDB Server manual.
`comment`	Attaches a comment to the operation. For more information, see the insert command fields guide in the MongoDB Server manual.

Exemplo

O código a seguir usa o método replaceOne() para localizar o primeiro documento no qual o campo name tem o valor 'Food Town' e, em seguida, substitui esse documento por um novo documento no qual o valor name é 'Food World'. Como a opção upsert está definida como true, a biblioteca insere um novo documento se o filtro de query não corresponder a nenhum documento existente:

$replace_document = [
    'name' => 'Food World',
    'cuisine' => 'Mixed',
    'address' => [
        'street' => '123 Food St',
        'zipCode' => '10003',
    ],
    'borough' => 'Manhattan'
];
$result = $collection->replaceOne(
    ['name' => 'Food Town'],
    $replace_document,
    ['upsert' => true]
);

Informações adicionais

Para saber mais sobre as operações de atualização, consulte o guia Atualizar documentos .

Para saber mais sobre como criar filtros de queries, consulte o guia Especifique uma consulta.

Documentação da API

Para saber mais sobre qualquer um dos métodos ou tipos discutidos neste guia, consulte a seguinte documentação da API:

Voltar

Excluir

Operações de gravação em massa