Menu Docs
Página inicial do Docs
/
Idiomas
/
PHP
/
Manual da Biblioteca PHP
/
Conecte-se ao MongoDB

Stable API

Nesta página

  • Visão geral
  • Habilitar a stable API
  • Configurar a stable API
  • Documentação da API

Observação

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

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. Quando você atualiza sua biblioteca ou versão do servidor , a versão da API é alterada, o que pode alterar a forma como essas operações se comportam. 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 suportados, consultestable API no manual do MongoDB Server .

Habilitar a stable API

Para habilitar a stable API, execute as seguintes etapas:

  1. Construa um objeto MongoDB\Driver\ServerApi e passe a versão da Stable API que deseja usar. Atualmente, a biblioteca suporta apenas a versão 1.

  2. Construa um objeto MongoDB\Client . Para o parâmetro driverOptions , passe uma array que contenha a opção serverApi . Defina esta opção para o objeto MongoDB\Driver\ServerApi que você criou na etapa anterior.

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

$uri = "mongodb://<hostname>:<port>";
$driverOptions = ['serverApi' => new MongoDB\Driver\ServerApi('1')];
$client = new MongoDB\Client($uri, [], $driverOptions);

Observação

Depois de criar uma instância do MongoDB\Client 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 instância do MongoDB\Client.

Configurar a stable API

O construtor MongoDB\Driver\ServerApi também aceita os seguintes parâmetros opcionais. Você pode usar esses parâmetros para personalizar o comportamento da Stable API.

Parâmetro
Descrição
estrito
Optional. When true, if you call a command that isn't part of the declared API version, the server raises an exception.

Default: null. If this parameter is null, the server applies its default value of false.
deprecationErrors
Optional. When true, if you call a command that is deprecated in the declared API version, the server raises an exception.

Default: null. If this parameter is null, the server applies its default value of false.

O seguinte exemplo de código mostra como você pode utilizar estes parâmetros ao construir um objeto MongoDB\Driver\ServerApi :

$uri = "mongodb://<hostname>:<port>";
$serverApi = new MongoDB\Driver\ServerApi('1', strict: true, deprecationErrors: true);
$driverOptions = ['serverApi' => $serverApi];
$client = new MongoDB\Client($uri, [], $driverOptions);

Documentação da API

Para obter mais informações sobre a classe MongoDB\Client , consulte a seguinte documentação da API da biblioteca PHP:

  • MongoDB\Client

Para obter mais informações sobre a classe MongoDB\Driver\ServerApi , consulte a seguinte documentação da API de extensão PHP:

Voltar

Configurar TLS

Próximo

reconhecimento de data center e collection