Stable API

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 Stable API força o servidor a executar operações com comportamentos compatíveis com a versão da API especificada. Uma versão da API define o comportamento esperado das operações que ela abrange e o formato das respostas do servidor. As operações e as respostas do servidor podem ser diferentes dependendo da versão da API especificada.

Quando você usa o recurso API estável com um driver oficial do MongoDB, você pode atualizar seu driver ou servidor sem se preocupar com compatibilidade com versões anteriores problemas dos comandos cobertos pela API estável.

Para saber mais sobre os comandos que o servidor abrange, consulte Stable API.

Especificar uma versão da API

Opcionalmente, o Client leva um tipo ServerAPIOptions através do ClientOptions.

Para especificar uma versão da API, anexe o método SetServerAPIOptions() com as opções da API do servidor às ClientOptions. Depois de especificar uma versão da API, o Client executa operações compatíveis com a versão da API durante a conexão.

// Specify a server URI to connect to
uri := "mongodb://<hostname>:<port>"
// Specify the Stable API version in the ClientOptions object
serverAPI := options.ServerAPI(options.ServerAPIVersion1)
// Pass in the URI and the ClientOptions to the Client
client, err := mongo.Connect(options.Client().ApplyURI(uri).SetServerAPIOptions(serverAPI))
if err != nil {
    panic(err)
}

Modificar comportamento

Você pode modificar ainda mais o comportamento da stable API anexando ao tipo ServerAPIOptions. Se você não especificar nenhuma opção, o driver usará os valores padrão para cada opção.

// Specify a server URI to connect to
uri := "mongodb://<hostname>:<port>"
// Specify the Stable API version and append options in the ClientOptions object
serverAPI := options.ServerAPI(options.ServerAPIVersion1).SetStrict(true).SetDeprecationErrors(true)
// Pass in the URI and the ClientOptions to the Client
client, err := mongo.Connect(options.Client().ApplyURI(uri).SetServerAPIOptions(serverAPI))
if err != nil {
    panic(err)
}

Informações adicionais

Para saber mais sobre como se conectar à sua instância ou conjunto de réplicas do MongoDB, consulte o guia Escolher um destino de conexão.