Menu Docs

Atualizar versões da biblioteca

Neste guia, você pode aprender sobre as alterações que deve fazer no seu aplicação ao atualizar para uma nova versão da Biblioteca PHP do MongoDB . Esta página também descreve como atualizar sua extensão PHP para uma nova versão.

Antes de atualizar, execute as seguintes ações:

  • Certifique-se de que a nova versão da biblioteca PHP seja compatível com as versões do MongoDB Server às quais seu aplicação se conecta e com a versão do PHP com a qual seu aplicação é compilado. Para obter informações sobre compatibilidade de versão, consulte a página Compatibilidade da biblioteca PHP do MongoDB .

  • Resolva quaisquer alterações significativas entre a versão da biblioteca que seu aplicação está usando e a versão de atualização planejada na seção Alterações significativas.

Dica

Para garantir a compatibilidade entre as versões do MongoDB Server ao atualizar as versões da biblioteca, use a Stable API.

Versões principais e secundárias da extensão e biblioteca PHP estão sincronizadas. Isso significa que você pode executar um comando de atualização para a extensão para também atualizar a biblioteca PHP.

As versões de patch (XXX) para a biblioteca e extensão não estão em sincronizadas. Execute os respectivos comandos para atualizar para as versões de patch da biblioteca ou extensão.

Para atualizar a extensão PHP, substitua <version-number> pelo número da versão para a qual você deseja atualizar e execute o seguinte comando no diretório do seu aplicativo:

pecl upgrade mongodb-<version-number>

Para atualizar a versão da biblioteca PHP, substitua <version-number> pelo número da versão para a qual você deseja atualizar e execute o seguinte comando no diretório do seu aplicativo:

composer require mongodb/mongodb:<version-number>

Instruções de instalação detalhadas podem ser encontradas na documentação do PHP.net.

Uma alteração interruptiva significativa é uma alteração de uma convenção ou comportamento a partir de uma versão específica da biblioteca. Esse tipo de alteração pode impedir que seu aplicação funcione corretamente se não for resolvido antes de atualizar a biblioteca.

As mudanças significativas nesta seção são categorizadas pela versão da biblioteca que as introduziram. Ao atualizar as versões da biblioteca, resolva todas as alterações significativas entre a versão atual e a atualizada.

Para obter mais informações sobre as alterações de versão, consulte as notas de versão e os tickets JIRA associados para cada versão no Github.

Esta versão da biblioteca introduz as seguintes alterações de quebra:

  • Os métodos a seguir retornam void em vez da resposta bruta do comando:

    • MongoDB\\Client: dropDatabase()

    • MongoDB\\Collection: drop(), dropIndex(), dropIndexes(), dropSearchIndex(), rename()

    • MongoDB\\Database: createCollection(), drop(), dropCollection(), renameCollection()

    O método MongoDB\\Database::createEncryptedCollection() retorna a lista de campos criptografados em vez da resposta bruta do comando.

    Se houver um erro, os métodos lançam uma exceção.

    Se você precisar acessar a resposta bruta do comando dos métodos anteriores, poderá registrar um CommandSubscriber em seu aplicação.

Esta versão da biblioteca introduz as seguintes alterações de quebra:

  • Suporte de drops para o MongoDB Server 3.6.

Para as versões da biblioteca 1.19 e anteriores, consulte as notas de versão e os tickets do JIRA associados para cada versão no Github.