Menu Docs

Página inicial do Docs → Desenvolver aplicações → Drivers Python → PyMongo

Substituir documentos

Nesta página

  • Visão geral
  • Dados de amostra
  • Operação de substituição
  • Parâmetros necessários
  • replaceOne
  • Personalizar a operação de substituição
  • Valor de retorno
  • Informações adicionais
  • Documentação da API

Visão geral

Neste guia, você pode aprender como usar o PyMongo para executar uma operação de substituição em um documento em uma coleção 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 saber mais sobre as operações de atualização, consulte o guia Atualizar documentos.

Dados de amostra

Os exemplos neste guia usam a collection sample_restaurants.restaurants dos conjuntos de dados de amostra do Atlas. Para saber como criar um MongoDB Atlas cluster e carregar os conjuntos de dados de amostra, consulte o tutorial Introdução ao PyMongo .

Operação de substituição

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

Parâmetros necessários

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

  • Um documento de filtro de query , que determina quais documentos substituir. Para obter mais informações sobre filtros de query, consulte a seção Documentos de filtro de query no manual do MongoDB Server .

  • Um documento de substituição , que especifica os campos e valores a serem inseridos no novo documento.

replaceOne

O exemplo a seguir usa o método replace_one() para substituir os campos e valores de um documento por um valor de campo name de "Pizza Town":

restaurants = database["restaurants"]
query_filter = {"name" : "Pizza Town"}
replace_document = { "name" : "Mongo's Pizza",
                     "cuisine" : "Pizza",
                     "address" : {
                         "street" : "123 Pizza St",
                         "zipCode" : "10003"
                     },
                     "borough" : "Manhattan"
                   }
result = restaurants.replace_one(query_filter, replace_document)

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.

Personalizar a operação de substituição

O método replace_one() aceita opcionalmente parâmetros adicionais, que representam opções que você pode usar para configurar a operação de substituição. Se você não especificar nenhuma opção adicional, o driver não personalizará a operação de substituição.

Propriedade
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
bypass_document_validation
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
An instance of ClientSession.
let
A Map of parameter names and values. 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
A comment to attach to the operation. For more information, see the insert command fields guide in the MongoDB Server manual.

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

restaurants = database["restaurants"]
query_filter = {"name" : "Food Town"}
replace_document = { "name" : "Food World",
                     "cuisine" : "Mixed",
                     "address" : {
                         "street" : "123 Food St",
                         "zipCode" : "10003"
                     },
                     "borough" : "Manhattan"
                   }
result = restaurants.replace_one(query_filter, replace_document, upsert = True)

Valor de retorno

O método replace_one() retorna um objeto UpdateResult. O tipo UpdateResult contém as seguintes propriedades:

Propriedade
Descrição
matched_count
The number of documents that matched the query filter, regardless of how many were updated.
modified_count
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.
raw_result
The raw result document returned by the server.
upserted_id
The ID of the document that was upserted in the database, if the driver performed an upsert. Otherwise None.

Informações adicionais

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:

← Atualize documentos
Exclua documentos →

Nesta página