/ /

PyMongo

Operações CRUD

Página inicial do Docs

Bibliotecas do cliente

Python

PyMongo

Operações CRUD

Substituir documentos

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 cluster gratuito do MongoDB Atlas 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`	Especifica se a operação de substituição executa uma operação upsert se nenhum documento corresponder ao filtro de queries. Para obter mais informações, consulte a declaração upsert no manual do MongoDB Server. O padrão é `False`
`bypass_document_validation`	Especifica se a operação de substituição ignora a validação do documento . Isso permite substituir documentos que não atendem aos requisitos de validação de esquema , se houver. Para obter mais informações sobre validação de esquema, consulte Validação de esquema no manual do MongoDB Server . O padrão `False` é.
`collation`	Especifica o tipo de agrupamento de idiomas a ser usado ao classificar os resultados. Para obter mais informações, consulte Agrupamento no manual do MongoDB Server .
`hint`	Obtém ou define o índice para procurar documentos. Para obter mais informações, consulte a declaração de dica no manual do MongoDB Server .
`session`	Uma instância de `ClientSession`.
`let`	Um mapa de nomes e valores de parâmetros. Os valores devem ser expressões constantes ou fechadas que não façam referência aos campos do documento. Para obter mais informações, consulte a declaração let no manual do MongoDB Server .
`comment`	Um comentário a ser anexado à operação. Para obter mais informações, consulte o guia de campos de comando de inserção no manual do MongoDB Server .

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`	O número de documentos que corresponderam ao filtro de queries, independentemente de quantos foram atualizados.
`modified_count`	O número de documentos modificados pela operação de atualização. Se um documento atualizado for idêntico ao original, ele não será incluído nesta contagem.
`raw_result`	O documento do resultado bruto retornado pelo servidor.
`upserted_id`	A ID do documento que foi atualizado no banco de dados, se o driver tiver realizado um upsert. Caso contrário, `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:

Voltar

Atualize documentos

Exclua documentos