Menu Docs

Página inicial do Docs → Desenvolver aplicações → MongoDB Drivers → C#/.NET

Stable API

Nesta página

  • Visão geral
  • Habilitar a API estável em um cliente MongoDB
  • Opções de API estáveis
  • Documentação da API

Observação

O recurso API estável requer MongoDB Server 5.0 ou posterior.

Você deve usar o recurso stable API somente se todos os MongoDB Server que você está conectando para suportar esse recurso.

Visão geral

Neste guia, você pode aprender a especificar a compatibilidade da API estável ao se conectar a uma instância do MongoDB ou a um conjunto de réplicas.

O recurso API estável força o servidor a executar operações com comportamentos compatíveis com a versão da API especificada. Quando você atualiza seu driver ou servidor, a versão da API muda, o que pode alterar a forma como essas operações se comportam. O uso da API estável garante respostas consistentes do servidor e fornece estabilidade de API a longo prazo para seu aplicativo.

As seções a seguir descrevem como você pode habilitar e personalizar a API estável para seu cliente MongoDB. Para obter mais informações sobre a API estável, incluindo uma lista dos comandos que ela abrange, consulte apágina de referência do MongoDB .

Habilitar a API estável em um cliente MongoDB

Para habilitar a stable API, você deve especificar uma versão da API nas configurações do seu cliente MongoDB. Depois de instanciar uma instância do MongoClient com uma versão de API especificada, todos os comandos que você executa com o cliente usam essa versão da stable API.

Dica

Depois de criar um MongoClient, você não poderá alterar sua versão da API estável. Se você precisar executar comandos usando mais de uma versão da API estável, instancie um cliente separado com essa versão.

Se você precisar executar comandos não cobertos pela API estável, certifique-se de que a opção "strict" esteja desativada. Consulte a seção sobre Opções de API estáveis para obter mais informações.

O exemplo a seguir mostra como você pode instanciar um MongoClient com uma versão da stable API e se conectar a um servidor por meio das seguintes operações:

  1. Construa uma instância do ServerApi e especifique uma versão da API estável.

  2. Construa um objeto MongoClientSettings e defina a propriedade ServerApi.

  3. Crie um MongoClient com o objeto MongoClientSettings .

var serverApi = new ServerApi(ServerApiVersion.V1);
var settings = new MongoClientSettings { ServerApi = serverApi };
var client = new MongoClient(settings);

Aviso

Se você especificar uma versão da API e se conectar a um servidor MongoDB que permita a stable API, seu código poderá gerar uma exceção ao executar um comando no seu servidor MongoDB. Se você usar um MongoClient que especifique a versão da API para consultar um servidor que não seja compatível com essa versão, sua consulta poderá falhar com uma mensagem de exceção que apresenta o seguinte texto:

Unrecognized field 'apiVersion' on server...

Opções de API estáveis

Você pode usar as opções na tabela a seguir para personalizar o comportamento da API estável.

Nome da opção
Descrição
Estrito
Opcional. Quando true, se você chamar um comando que não faz parte da versão da API declarada, o driver levanta uma exceção.

Padrão: false
DeprecationErrors
Opcional. Quando true, se você chamar um comando que foi preterido na versão da API declarada, o driver levanta uma exceção.

Padrão: false

O exemplo a seguir mostra como você pode definir estas opções ao construir um objeto ServerApi :

var serverApi = new ServerApi(ServerApiVersion.V1, strict: true,
    deprecationErrors: true);

Documentação da API

Para obter mais informações sobre como usar a API estável com o driver MongoDB .NET/C#, consulte a seguinte documentação da API:

← Atlas Search
Mecanismos de autenticação →

Nesta página