Visão geral
Nesta seção, você pode identificar as alterações que deve fazer no seu aplicação para atualizar seu driver para uma nova versão.
Antes de atualizar, execute as seguintes ações:
Certifique-se de que a nova versão do driver seja compatível com as versões do MongoDB Server às quais seu aplicação se conecta e com o Java Runtime Environment (JRE) em que seu aplicação é executado. Para visualizar informações de compatibilidade, consulte a páginade compatibilidade do.
Resolva quaisquer alterações significativas entre a versão atual do driver que seu aplicação está usando e a versão de atualização planejada na seção Alterações significativas. Para saber mais sobre as alterações de compatibilidade da versão do MongoDB Server, consulte a seção Alterações de compatibilidade da versão do servidor.
Dica
Para minimizar o número de alterações que seu aplicação pode exigir quando você atualizar as versões do driver no futuro, use a API estável.
Mudanças de última hora
Uma alteração interruptiva é uma modificação em uma convenção ou comportamento em uma versão específica do driver que pode impedir que sua aplicação funcione corretamente se não for resolvida antes da atualização.
As mudanças significativas nesta seção são categorizadas pela versão do driver que as introduziram. Ao atualizar as versões do driver, resolva todas as alterações significativas entre a versão atual e a atualizada. Por exemplo, se você estiver atualizando o driver de v4.0 para v4.7, resolva todas as alterações significativas da versão posterior a v4.0 incluindo qualquer um listado para v4.7.
Versão 5.5 Alterações interruptivas
O driver não é mais compatível com o MongoDB Server versão 4.0. Para saber mais sobre essa alteração, consulte a seção Alterações de suporte do servidor da versão do driver 5.5 .
Versão 5.2 Alterações interruptivas
Esta versão do driver apresenta a seguinte alteração interruptiva:
Elimina o suporte para o MongoDB Server v3.6. Para saber mais sobre essa alteração, consulte a seção Alterações de suporte do servidor da versão do 5.2 driver.
Revisa a versão de dependência mongodb-crypt para corresponder à versão dos drivers da JVM . Versões futuras do
mongodb-cryptserão lançadas junto com o driver e compartilharão o mesmo número de versão. Você deve atualizar sua dependênciamongodb-cryptpara v5.2.0 ao atualizar seu driver para esta versão.
Versão 5.1 Alterações interruptivas
Esta versão do driver apresenta a seguinte alteração interruptiva:
Ao usar o mecanismo de autenticação
MONGODB-OIDC, você não deve incluir vírgulas no valor da string de conexãoauthMechanismProperties.
alteração interruptiva na versão 5.0
Esta versão do driver apresenta a seguinte alteração interruptiva:
Introduza as seguintes alterações na classe
ConnectionId:O construtor
ConnectionIdagora aceita um valor do tipolongcomo seu segundo parâmetro em vez do tipoint. Da mesma forma, o construtor agora aceita um valor do tipoLongcomo seu terceiro parâmetro em vez do tipoInteger. Como essa alteração quebra a compatibilidade binária, recrie qualquer código existente que chame o construtorConnectionId.O método
withServerValue()agora aceita um parâmetro do tipolongem vez do tipoint. Como essa alteração quebra a compatibilidade binária, você deve recompilar qualquer código que chame o métodowithServerValue().O método
getServerValue()agora retorna um valor do tipoLongem vez do tipoInteger. Da mesma forma, o métodogetLocalValue()retorna um valor do tipolongem vez do tipoint. Como essa alteração quebra a compatibilidade binária e de origem, atualize qualquer código-fonte que use esses métodos e reconstrua seu binário.
Substitui as seguintes anotações de registro do pacote
org.bson.codecs.record.annotationspor anotações do mesmo nome do pacoteorg.bson.codecs.pojo.annotations:BsonIdBsonPropertyBsonRepresentation
Altera o tipo de dados do parâmetro de duração do tempo limite
connectTimeoutpara os métodosSocketSettings.Builder.connectTimeout()eSocketSettings.Builder.readTimeout(). O tipo de dados deste parâmetro é agoralongem vez deint.Nas versões anteriores, esse parâmetro é do tipo
intpara ambos os métodos. Essa alteração quebra a compatibilidade binária e requer recompilação, mas não requer alterações de código.Remove o método
Filters.eqFull(), lançado exclusivamente emBeta, que permitia construir um filtro de igualdade ao executar uma pesquisa vetorial. Em vez disso, você pode usar o métodoFilters.eq()ao instanciar um tipoVectorSearchOptions, conforme mostrado no código a seguir:VectorSearchOptions opts = vectorSearchOptions().filter(eq("x", 8));
Remove a classe implícita
org.mongodb.scala.ObservableImplicits.ToSingleObservableVoid. O tipoorg.reactivestreams.Publisher[Void]não converte mais automaticamente paraorg.mongodb.scala.SingleObservable[Void]. A API também expõeorg.mongodb.scala.Observable[Unit]em vez deorg.mongodb.scala.Observable[Void].Para obter mais informações, consulte a documentação de tração observável da API Scala.
Altera como
ClusterSettingscalcula a configuraçãoClusterConnectionMode, tornando-a mais consistente usando o nome do conjunto de réplicas especificado, independentemente de como ela é configurada. Anteriormente, o driver tratava o nome do conjunto de réplicas somente se ele fosse definido na string de conexão.Por exemplo, as duas amostras de código a seguir retornam o valor
ClusterConnectionMode.MULTIPLE. Anteriormente, o segundo exemplo retornavaClusterConnectionMode.SINGLE.ClusterSettings.builder() .applyConnectionString(new ConnectionString("mongodb://127.0.0.1:27017/?replicaSet=replset")) .build() .getMode() ClusterSettings.builder() .hosts(Collections.singletonList( new ServerAddress("127.0.0.1", 27017) )) .requiredReplicaSetName("replset") .build() .getMode() BsonDecimal128os valores respondem às chamadas de método da mesma forma que os valoresDecimal128.BsonDecimal128.isNumber()agora retornatrueeBsonDecimal128.asNumber()retorna o equivalenteBsonNumber.Remove os métodos ServerAddress
getSocketAddress()egetSocketAddresses().Em vez de
getSocketAddress(), utilize o método de instânciagetByName()dejava.net.InetAddress.Em vez de
getSocketAddresses(), utilize o método de instânciagetAllByName()dejava.net.InetAddress.Remove os métodos UnixServerAddress
getSocketAddress()egetUnixSocketAddress().Em vez de
getSocketAddress(), utilize o método de instânciagetByName()dejava.net.InetAddress.Em vez de
getUnixSocketAddress(), construa uma instância dejnr.unixsocket.UnixSocketAddress. Passe o caminho completo do arquivo de soquete UNIX para o construtor. Por padrão, o MongoDB cria um arquivo de soquete UNIX localizado em"/tmp/mongodb-27017.sock". Para saber mais sobre a classeUnixSocketAddress, consulte a documentação da API UnixSocketAddress.Remove a interface do
Parameterizable. Em vez de implementar essa interface em um tipoCodecpersonalizado, substitua o métodoCodecProvider.get()noCodecProviderdo codec se o codec for destinado a um tipo parametrizado.Remove o método
isSlaveOk()das classesReadPreferenceeTaggableReadPreference. Para verificar se uma preferência de leitura permite a leitura de um membro secundário de um conjunto de réplicas, use os métodosisSecondaryOk()dessas classes.Remove os métodos auxiliares
DBCollection.getStats()eDBCollection.isCapped()do comandocollStats. Em vez desses métodos, você pode utilizar o estágio de pipeline de agregação$collStats.Remove as classes
MapCodeceIterableCodec. Em vez deMapCodec, useMapCodecProvider. Em vez deIterableCodec, useCollectionCodecProviderouIterableCodecProviderpara tipos deIterableque não são tiposCollection.Remove os métodos
sharded()enonAtomic()das classesMapReducePublishereMapReduceIterable.Remove os seguintes métodos para utilizar com índices
geoHaystack:Indexes.geoHaystack()IndexOptions.getBucketSize()IndexOptions.bucketSize()
Em vez disso, você pode usar o estágio de pipeline de agregação
$geoNearou um operador de query geoespacial em um índice 2d. Para obter mais informações, consulte a página de queries geoespaciais no manual do MongoDB Server.Remove a opção
oplogReplaydas operações de localização. Os seguintes métodos dooplogReplaynão estão mais disponíveis:DBCursor.oplogReplay()DBCollectionFindOptions.isOplogReplay()DBCollectionFindOptions.oplogReplay()FindPublisher.oplogReplay()FindIterable.oplogReplay()
Remove os seguintes construtores
Exception:MongoBulkWriteException(BulkWriteResult, List<BulkWriteError>, WriteConcernError, ServerAddress)MongoCursorNotFoundException(long, ServerAddress)MongoQueryException(ServerAddress, int, String)MongoQueryException(ServerAddress, int, String, String)MongoQueryException(MongoCommandException)
Remove as seguintes sobrecargas para o método
BulkWriteResult.acknowledged():acknowledged(Type, int, List<BulkWriteUpsert>)acknowledged(Type, int, Integer, List<BulkWriteUpsert>)acknowledged(int, int, int, Integer, List<BulkWriteUpsert>)
Remove os seguintes construtores
ChangeStreamDocument:ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, TDocument, BsonDocument, ...)ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)
Remove os seguintes construtores para eventos:
CommandEvent(RequestContext, int, ConnectionDescription, String)CommandEvent(int, ConnectionDescription, String)CommandEvent(RequestContext, long, int, ConnectionDescription, String)CommandFailedEvent(RequestContext, int, ConnectionDescription, String, long, Throwable)CommandFailedEvent(int, ConnectionDescription, String, long, Throwable)CommandStartedEvent(RequestContext, int, ConnectionDescription, String, String, BsonDocument)CommandStartedEvent(int, ConnectionDescription, String, String, BsonDocument)CommandSucceededEvent(RequestContext, int, ConnectionDescription, String, BsonDocument, long)CommandSucceededEvent(int, ConnectionDescription, String, BsonDocument, long)ConnectionCheckedInEvent(ConnectionId)ConnectionCheckedOutEvent(ConnectionId, long)ConnectionCheckedOutEvent(ConnectionId)ConnectionCheckOutFailedEvent(ServerId, long, Reason)ConnectionCheckOutFailedEvent(ServerId, Reason)ConnectionCheckOutStartedEvent(ServerId)ConnectionReadyEvent(ConnectionId)ServerHeartbeatFailedEvent(ConnectionId, long, Throwable)ServerHeartbeatSucceededEvent(ConnectionId, BsonDocument, long)
Remove a opção
errorLabelsda classeWriteConcernError. Isso inclui os métodosaddLabel()egetErrorLabels()e o construtor que inclui um parâmetroerrorLabels. Em vez disso, você pode usar os rótulos de erro incluídos no objetoMongoExceptionque contém oWriteConcernError.Remove as seguintes classes do pacote
com.mongodb.event:ConnectionAddedEventConnectionPoolOpenedEventConnectionRemovedEventClusterListenerAdapterConnectionPoolListenerAdapterServerListenerAdapterServerMonitorListenerAdapter
O driver também remove os seguintes métodos relacionados da interface
ConnectionPoolListener:connectionAdded()connectionPoolOpened()connectionRemoved()
Para obter mais informações sobre o pacote
com.mongodb.event, consulte a documentação da API.
Adiciona a opção
authorizedCollectionpara o comandolistCollections. Isso introduz uma alteração binária de quebra no métodoMongoDatabase.listCollectionNames(). Essa alteração não requer nenhuma alteração no código-fonte, mas você deve recompilar qualquer código que use esse método.Remove os seguintes métodos e tipos relacionados à interface Stream:
MongoClientSettings.Builder.streamFactoryFactory()método. Use o métodoMongoClientSettings.Builder.transportSettings().MongoClientSettings.getStreamFactoryFactory()método. Use o métodoMongoClientSettings.getTransportSettings().NettyStreamFactoryFactoryclasse. Em vez disso, chame o métodoTransportSettings.nettyBuilder()para criar um objetoNettyTransportSettings. Em seguida, chame o métodoMongoClientSettings.Builder.transportSettings()para aplicar as configurações.NettyStreamFactoryclasse.AsynchronousSocketChannelStreamFactoryclasse.AsynchronousSocketChannelStreamFactoryFactoryclasse.BufferProviderinterface.SocketStreamFactoryclasse.Streaminterface.StreamFactoryinterface.StreamFactoryFactoryinterface.TlsChannelStreamFactoryFactoryclasse.
Alterações significativas na versão 4.8
Esta versão do driver apresenta a seguinte alteração interruptiva:
Termina o suporte para conexão com as versões do MongoDB Server v3.4 e anteriores. Para saber mais sobre essa alteração, consulte a seção Alterações de suporte do servidor da versão do 4.8 driver.
Requer a adição de uma dependência explícita no módulo
org.bson.codecs.recordse seu aplicação distribuir o driver em um contêiner OSGi e depender do driver para codificar e decodificar registros Java .RecordCodecdesserializa POJOs e classes de registro que são especificados como parâmetros de tipo de camposListouMappara o registro apropriado e tipos de POJO. Anteriormente, este codec os desserializava como valoresDocument.Por exemplo, as seguintes definições da classe de registro mostram um registro
Bookque contém umaListque recebe um parâmetro do tipoChapter:public record Book(String title, List<Chapter> chapters) {} public record Chapter(Integer number, String text) {} A partir desta versão, o codec desserializa dados no
Listem classes de registro doChapterem vez de valores deDocument.
Versão 4.7: mudanças importantes
Esta versão do driver apresenta a seguinte alteração interruptiva:
A API do construtor
setWindowFieldsnão está mais em versão beta. O novo método de construtor de estágio do pipeline quebra a compatibilidade binária e de origem. Consulte a documentação da API de agregações para obter informações sobre as novassetWindowFields()assinaturas de método.Se seu aplicação usa esse construtor em uma versão anterior à v4.7, atualize seu código-fonte para usar a nova assinatura de método e reconstruir seu binário.
Alterações significativas na versão 4.2
Esta versão do driver apresenta a seguinte alteração interruptiva:
Atualiza a classe
ObjectIde seu camposerialVersionUIDpara usar um novo formato que reduz problemas de compatibilidade de serialização em diferentes versões do driver.Se um aplicação utilizando a versão do driver 4.2 ou posterior tenta executar a serialização de objetos Java em quaisquer objetos que contenham um
ObjectIde foram serializados por uma versão anterior do driver, Java lança umInvalidClassException.Para saber mais sobre a serialização de objetos Java, consulte Objetos serializáveis na documentação Java.
Alterações significativas na versão 4.0
Esta versão do driver apresenta a seguinte alteração interruptiva:
Remove várias classes e métodos marcados como obsoletos na versão 3.12.
Modifica inserir métodos assistente para retornar um objeto
InsertOneResultouInsertManyResultem vez devoid.Modifica os métodos
toJson()nas classesBsonDocument,DocumenteDbObjectpara retornar um formato de JSON relaxado em vez de um formato de JSON rigoroso. Isso torna os documentos JSON mais legíveis, mas pode dificultar a identificação das informações do tipo de BSON, como a diferença entre um número inteiro de 32bits e 64bits. Se o seu aplicação depender do formato JSON rigoroso, utilize o modo rigoroso ao ler ou gravar dados.Altera a representação BSON padrão dos valores
java.util.UUIDdeJAVA_LEGACYparaUNSPECIFIED. Os aplicativos que armazenam ou recuperam valores UUID devem especificar explicitamente qual representação usar. Você pode especificar a representação na propriedadeuuidRepresentationde um objetoMongoClientSettings.A representação do UUID que você especifica controla estritamente como o driver decodifica os UUIDs. Na versão 4.0, a representação
JAVA_LEGACYfunciona somente com subtipo 3. Nas versões anteriores do driver, se você especificasse a representaçãoJAVA_LEGACY, o driver decodificaria objetos binários dos subtipos 3 e 4 como UUIDs.Para obter uma lista de nós na enumeração
UuidRepresentation, consulte a documentação da API v4.0O pool de conexões não restringe mais o número de threads de fila de espera ou tarefas assíncronas que exigem uma conexão com o MongoDB. O aplicação limita as solicitações conforme necessário, em vez de depender do driver para lançar um
MongoWaitQueueFullException.O driver deixa de registrar utilizando o pacote
java.util.logginge somente suporta o framework de registro SLF4J.Os drivers incorporados e de Android foram removidos. Se o seu aplicativo depender desses drivers, você deverá continuar usando uma versão 3.x do driver Java.
Os uber JARs para o driver Java ,
mongo-java-driveremongodb-driver, não são mais publicados. Se o seu aplicação depender desses uber JARs, remova-os como uma dependência e use um dos seguintes pacotes:Se seu aplicação usar a API atual, adicione o pacote
mongodb-driver-synccomo dependência.Se seu aplicação usar a API legado , adicione o pacote
mongodb-driver-legacycomo dependência.
Várias classes introduzem quebras de compatibilidade binária, como a alteração da assinatura do método para os métodos assistente de inserção. Recompile todas as classes vinculadas ao driver nessa versão ou posterior para garantir que elas continuem funcionando.
Alterações na compatibilidade da versão do servidor
Uma alteração de compatibilidade de versão do servidor é uma modificação no driver Scala que descontinua o suporte para um conjunto de versões do MongoDB Server .
O driver interrompe o suporte para uma versão do Servidor MongoDB após atingir o fim da vida útil (EOL).
Para saber mais sobre o suporte MongoDB para produtos EOL, consulte a Política de Suporte Legado.
Versão do driver 5.5 Alterações no suporte do servidor
O driver v5.5 elimina o suporte para o MongoDB Server 4.0. Para usar o v5.5 driver, você deve se conectar ao MongoDB Server 4.2 ou posterior. Para saber como atualizar seu sistema do MongoDB Server, consulte Notas de versão no manual do MongoDB Server.
Versão do servidor 8.1 Mudanças no suporte
Você não pode usar uma versão 3.x do driver Scala para se conectar a uma implementação do MongoDB executando o MongoDB Server v8.1. Iniciando no MongoDB Server v8.1, o comando buildinfo exige autenticação, causando uma incompatibilidade com o v3.x motorista.
Versão do driver 5.2 Alterações no suporte do servidor
O driver v5.2 elimina o suporte para o MongoDB Server 3.6. Para usar o v5.2 driver, você deve se conectar ao MongoDB Server 4.0 ou posterior. Para saber como atualizar seu sistema do MongoDB Server, consulte Notas de versão no manual do MongoDB Server.
Versão do driver 4.8 Alterações no suporte do servidor
O driver v4.8 elimina o suporte para o MongoDB Server 3.4 e versões anteriores. Para usar o v4.8 driver, você deve se conectar ao MongoDB Server 3.6 ou posterior. Para saber como atualizar seu sistema do MongoDB Server, consulte Notas de versão no manual do MongoDB Server.