Conecte-se com API estável

Visão geral

Neste guia, você pode aprender como especificar a compatibilidade de stable API ao se conectar a uma implementação do MongoDB .

O recurso Stable API força o servidor a executar operações com comportamentos compatíveis com a versão da API especificada. O uso da Stable API garante respostas consistentes do servidor e oferece estabilidade de API a longo prazo para seu aplicação.

As seções a seguir descrevem como você pode habilitar e personalizar stable API para seu cliente MongoDB . Para obter mais informações sobre a stable API, incluindo uma lista dos comandos compatíveis, consulte stable API no manual do MongoDB Server .

Habilitar a stable API

Para habilitar a stable API, execute as seguintes etapas:

1. Construa um objeto ServerApi e especifique uma versão de stable API . Você deve usar uma versão de stable API definida no enum ServerApiVersion.

2. Construa um objeto MongoClientSettings usando a classe MongoClientSettings.Builder .

3. Instancie um MongoClient utilizando o método MongoClient.create() e passe sua instância do MongoClientSettings como um parâmetro.

O seguinte exemplo de código mostra como especificar stable API a versão 1:

val serverApi = ServerApi.builder()
    .version(ServerApiVersion.V1)
    .build()
// Replace the uri string placeholder with your MongoDB deployment's connection string
val uri = "<connection string>"
val settings = MongoClientSettings.builder()
    .applyConnectionString(ConnectionString(uri))
    .serverApi(serverApi)
    .build()
val client = MongoClient.create(settings)

Depois de criar uma instância do MongoClient com uma versão de API especificada, todos os comandos que você executa com o cliente utilizam a versão especificada. Se você precisar executar comandos usando mais de uma versão da Stable API, crie uma nova MongoClient.

Configurar a stable API

A tabela seguinte descreve os parâmetros da classe ServerApi . Você pode usar esses parâmetros para personalizar o comportamento da stable API.

O exemplo de código a seguir mostra como você pode definir as duas opções em uma instância do ServerApi encadeando métodos no ServerApi.Builder:

val serverApi = ServerApi.builder()
    .version(ServerApiVersion.V1)
    .strict(true)
    .deprecationErrors(true)
    .build()

Solução de problemas

Documentação da API

Para obter mais informações sobre como usar a Stable API com o driver Kotlin Sync, consulte a seguinte documentação da API :

• API do servidor

• ServerApi.Builder

• ServerApiVersion

• ServerAddress

• Configurações do Mongo Client

• MongoClientSettings.Builder

• Cliente Mongo

• MongoClient.create()