Nota
La función API estable requiere MongoDB Server 5.0 o posterior.
Utilice la función API estable solo si todos los servidores MongoDB a los que se conecta admiten esta función.
Overview
En esta guía, puede aprender cómo especificar la compatibilidad de API estable al conectarse a una instancia de MongoDB o un conjunto de réplicas.
La función API estable obliga al servidor a ejecutar operaciones con comportamientos compatibles con la versión de API que especifique. Una versión de API define el comportamiento esperado de las operaciones que cubre y el formato de las respuestas del servidor. Las operaciones y las respuestas del servidor pueden variar según la versión de API que especifique.
Cuando utiliza la función API estable con un controlador oficial de MongoDB, puede actualizar su controlador o servidor sin preocuparse por problemas de compatibilidad con versiones anteriores de los comandos cubiertos por la API estable.
Para obtener más información sobre los comandos que cubre el servidor, consulte API estable.
Especificar una versión de API
El Client Opcionalmente toma un tipo ServerAPIOptions a través del ClientOptions.
Para especificar una versión de API, añada el SetServerAPIOptions() método con las opciones de API de su servidor a ClientOptions su. Después de especificar una versión de API, el método Client ejecuta operaciones compatibles con ella mientras dure la conexión.
Nota
Actualmente, el controlador MongoDB Go solo admite ServerAPIVersion1.
Ejemplo
El siguiente ejemplo instancia un Client que establece la versión Stable API y se conecta a un servidor.
// 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 el comportamiento
Puede modificar aún más el comportamiento de la función estable de la API añadiendo "ServerAPIOptions " al tipo. Si no especifica ninguna opción, el controlador usa los valores predeterminados para cada una.
Método | Descripción |
|---|---|
| The API version to use. Default: ServerAPIVersion1 |
| Flag that indicates whether the server should return errors for features that aren't part of the API version. Default: false |
| Flag that indicates whether the server should return errors for deprecated features. Default: false |
Ejemplo
Este ejemplo especifica que el servidor debe realizar las siguientes acciones:
Utilice la versión 1 de la API
Devuelve errores para funciones que no forman parte de la versión 1
Devolver errores para funciones obsoletas
// 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) }
Información Adicional
Para obtener más información sobre cómo conectarse a su instancia o conjunto de réplicas de MongoDB, consulte Elija una guía de destino de conexión.
Documentación de la API
Para obtener más información sobre las opciones de esta sección, consulte la siguiente documentación de API: