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 como especificar a compatibilidade da stable API ao se conectar a uma instância ou conjunto de réplicas do MongoDB.

O recurso de stable API força o servidor a executar operações com comportamentos compatíveis com a versão de API que você especificar. 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 stable API 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 Stable API para seu cliente MongoDB . Para obter mais informações sobre a Stable API, incluindo uma lista dos comandos que ela abrange, consulte apágina de referência doMongoDB .

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 Stable API . Se você precisar executar comandos usando mais de uma versão da Stable API, instancie um cliente separado com essa versão.

Se você precisar executar comandos não cobertos pela stable API, certifique-se de que a opção "strict" esteja desativada. Consulte a seção sobre opções destable API 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:

Construa uma instância do ServerApi e especifique uma versão Stable API .
Construa um objeto MongoClientSettings e defina a propriedade ServerApi.
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 stable API.

Nome da opção	Descrição
Strict	Optional. When `true`, if you call a command that is not part of the declared API version, the driver raises an exception. Default: false
deprecationErrors	Optional. When `true`, if you call a command that is deprecated in the declared API version, the driver raises an exception. Default: 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 stable API com o driver MongoDB .NET/C# , consulte a seguinte documentação da API :

Voltar

Atlas Search

Mecanismos de autenticação