/ /

Métodos mongosh

Conexiones

Docs Home

Manual de MongoDB

Referencia

Métodos mongosh

Conexiones

Mongo()

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 5.0, consulte Procedimientos de actualización de MongoDB.6.0

Descripción

Mongo(host, ClientSideFieldLevelEncryptionOptions, api)

Constructor de JavaScript para instanciar una conexión de base de datos desde o desde un archivo mongosh JavaScript.

El método Mongo() tiene los siguientes parámetros:

Parameter	Tipo	Descripción
`host`	string	Opcional. El host, ya sea en `<host>` formato `<host><:port>` o. Si se omite, `Mongo()` instancia una conexión a la interfaz localhost en el puerto `27017` predeterminado.
`ClientSideFieldLevelEncryptionOptions`	Documento	Opcional. Parámetros de configuración para habilitar el cifrado a nivel de campo del lado del cliente. `ClientSideFieldLevelEncryptionOptions` Anula la configuración de cifrado de campo del cliente de la conexión a la base de datos. Si se omite, `Mongo()` hereda la configuración de cifrado de campo del cliente de la conexión a la base de datos actual. `ClientSideFieldLevelEncryptionOptions` Consulte para obtener detalles de uso y sintaxis.
`api`	Documento	Opcional.Opciones de configuración para habilitar la API estable. `api` Consulte para obtener detalles de uso y sintaxis.

Tip

Mongo.getDB() y db.getMongo()

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

`ClientSideFieldLevelEncryptionOptions`

El ClientSideFieldLevelEncryptionOptions documento especifica las opciones de configuración para el cifrado de campo del lado del cliente. Si la conexión a la base de datos ya tiene una configuración de cifrado de campo del lado del cliente, especificar la ClientSideFieldLevelEncryptionOptions anula.

Por ejemplo, al iniciar con mongosh las opciones de línea de comandos de cifrado a nivel de campo del lado del cliente, se habilita el cifrado del lado del cliente para esa conexión. Las nuevas conexiones de base de datos creadas con Mongo() heredan la configuración de cifrado,a menos Mongo() que ClientSideFieldLevelEncryptionOptions incluya.

El documento ClientSideFieldLevelEncryptionOptions tiene la siguiente sintaxis:

{
  "keyVaultClient" : <object>,
  "keyVaultNamespace" : "<string>",
  "kmsProviders" : <object>,
  "schemaMap" : <object>,
  "bypassAutoEncryption" : <boolean>
}

El documento ClientSideFieldLevelEncryptionOptions toma los siguientes parámetros:

Parameter

Tipo

Descripción

keyVaultClient

Mongo() objeto de conexión.

(Opcional) El clúster MongoDB que aloja la colección de bóveda de claves.

Especifica un Mongo() objeto de conexión que apunte al clúster:

var keyVaultClient = Mongo(<MongoDB URI>);
var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultClient" : keyVaultClient,
  "keyVaultNamespace" : "<database>.<collection>",
  "kmsProviders" : { ... }
}

Si keyVaultClient se omite, el host especificado para el objeto que contiene Mongo() el ClientSideFieldLevelEncryptionOptions documento se utiliza como host del almacén de claves.

keyVaultNamespace

string

(Obligatorio) El espacio de nombres completo de la colección de bóveda de claves.

kmsProviders

Documento

(Obligatorio) El Servicio de Gestión de Claves (KMS) que utiliza el cifrado de campo del lado del cliente para gestionar una Clave Maestra de Cliente (CMK). El cifrado de campo del lado del cliente utiliza la CMK para cifrar y descifrar las claves de cifrado de datos.

El cifrado a nivel de campo del lado del cliente admite los siguientes proveedores de KMS:

Si es posible, considere definir las credenciales proporcionadas en kmsProviders como variables de entorno y luego pasarlas a mongosh mediante la opción. Esto minimiza --eval la posibilidad de que las credenciales se filtren en los registros. Consulte "Crear una clave de cifrado de datos" para ver ejemplos de este enfoque para cada KMS compatible.

Amazon Web Services KMS

IMPORTANTE: Para la compatibilidad con mongosh AWS KMS, utilice o el 4.2.2 shell heredado de MongoDB o mongo posterior. Los shells 4 heredados,,2 0 y,4 2y1 mongo no son compatibles con el servicio AWS KMS debido a un cambio inesperado en el objeto de respuesta de KMS.Consulte SERVER-44721 Para más información.

Especifique el documento aws a kmsProviders con los siguientes campos:

"kmsProviders" : {
   "aws" : {
     "accessKeyId" : "AWSAccessKeyId",
     "secretAccessKey" : "AWSSecretAccessKey"
   }
 }

El accessKeyId especificado debe corresponder a un usuario de IAM con todos los permisos List y Read para el servicio KMS.

Azure Key Vault

Especifique el documento azure a kmsProviders con los siguientes campos:

"kmsProviders" : {
  "azure" : {
    "tenantId" : "AzureTenantId",
    "clientId" : "AzureClientId",
    "clientSecret" : "AzureClientSecret"
  }
}

Nuevo en la versión 5.0.

Google Cloud KMS

Especifique el documento gcp a kmsProviders con los siguientes campos:

"kmsProviders" : {
  "gcp" : {
    "email" : "GCPEmail",
    "privateKey" : "GCPPrivateKey"
  }
}

Nuevo en la versión 5.0.

Clave gestionada localmente

Especifique el documento local a kmsProviders con el siguiente campo:

"kmsProviders" : {
  "local" : {
     "key" : BinData(0, "<96 byte base-64 encoded key>")
  }
}

El especificado key debe ser una64 96cadena de bytes codificada en base sin caracteres de nueva línea.

schemaMap

Documento

(opcional) Las reglas automáticas de cifrado a nivel de campo del lado del cliente especificadas mediante la sintaxis estándar del borrador 4 del JSON schema y palabras clave específicas de cifrado.

Para la documentación completa, consulta Reglas de cifrado automático.

bypassAutoEncryption

booleano

(Opcional) Especifique true para omitir las reglas de cifrado automático a nivel de campo del lado del cliente y realizar un cifrado explícito (manual) por campo.

`api`

El api parámetro especifica las opciones de configuración de la API estable. Puede habilitar o deshabilitar el comportamiento opcional mediante las siguientes opciones:

Opción	Tipo	Descripción
`version`	string	Especifica la versión de la API. `"1"` es actualmente la única versión compatible.
`strict`	booleano	Si `true`: El uso de un comando que no es parte de la versión de API declarada devuelve un error APIStrictError. El planificador de consultas ignora losíndices que no son compatibles con la API estable. Si especifica `strict`, también debe especificar `version`. Si no se especifica, el valor predeterminado es `false`.
`deprecationErrors`	booleano	Si `true` es, al usar un comando o comportamiento obsoleto en la versión de API especificada, se devuelve un error APIDeprecationError. Si `deprecationErrors` especifica, también debe `version` especificar. Si no se especifica, el valor predeterminado es `false`.

El parámetro api tiene la siguiente sintaxis:

{ api: { version: <string>, strict: <boolean>, deprecationErrors: <boolean> } }

Ejemplos

Conectarse a un clúster de MongoDB

La siguiente operación crea un nuevo objeto de conexión desde dentro de una mongosh sesión:

cluster = Mongo("mongodb://mymongo.example.net:27017/?replicaSet=myMongoCluster")

Emita operaciones contra el objeto cluster para interactuar con el clúster mymongo.example.net:27017:

myDB = cluster.getDB("myDB"); //returns the database object
myColl = myDB.getCollection("myColl"); // returns the collection object

Conectarse a un clúster con cifrado del lado del cliente habilitado

Para configurar el cifrado a nivel de campo del lado del cliente para una clave administrada localmente, se requiere especificar una cadena de bytes codificada64en base 96sin saltos de línea. La siguiente operación genera una clave que cumple los requisitos indicados y la carga mongosh en:

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")
mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

La siguiente operación crea un nuevo objeto de conexión desde una mongosh sesión. La ClientSideFieldLevelEncryptionOptions opción especifica las opciones necesarias para habilitar el cifrado a nivel de campo del lado del cliente mediante una clave administrada localmente:

var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultNamespace" : "encryption.dataKeys",
  "kmsProviders" : {
    "local" : {
      "key" : BinData(0, TEST_LOCAL_KEY)
    }
  }
}
cluster = Mongo(
  "mongodb://mymongo.example.net:27017/?replicaSet=myMongoCluster",
  ClientSideFieldLevelEncryptionOptions
)

Emita operaciones contra el objeto cluster para interactuar con el clúster mymongo.example.net:27017 y realizar un cifrado explícito:

// returns the database object
myDB = cluster.getDB("myDB");
// returns the collection object
myColl = myDB.getCollection("myColl");
// returns object for managing data encryption keys
keyVault = cluster.getKeyVault();
// returns object for explicit encryption/decryption
clientEncryption = cluster.getClientEncryption();

Consulte Métodos de cifrado a nivel de campo del lado del cliente para obtener una lista completa de los métodos de cifrado a nivel de campo del lado del cliente.

Conéctate a un clúster con cifrado del lado del cliente automático habilitado

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")
mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

La siguiente operación crea un nuevo objeto de conexión desde una mongosh sesión. La opción especifica las ClientSideFieldLevelEncryptionOptions opciones necesarias para habilitar el cifrado automático del lado del hr.employees cliente en la colección:

var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultNamespace" : "encryption.dataKeys",
  "kmsProviders" : {
    "local" : {
      "key" : BinData(0,"BASE64-ENCODED-96-BYTE-LOCAL-KEY")
    }
  },
  schemaMap : {
    "hr.employees" : {
      "bsonType": "object",
      "properties" : {
        "taxid" : {
          "encrypt" : {
            "keyId" : [UUID("bffb361b-30d3-42c0-b7a4-d24a272b72e3")],
            "bsonType" : "string",
            "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
          }
        },
        "taxid-short": {
          "encrypt": {
            "keyId": [UUID("33408ee9-e499-43f9-89fe-5f8533870617")],
            "algorithm": "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic",
            "bsonType": "string"
          }
        }
      }
    }
  }
}
cluster = Mongo(
  "mongodb://mymongo.example.net:27017/?replicaSet=myMongoCluster",
  ClientSideFieldLevelEncryptionOptions
)

Emite operaciones contra el objeto cluster para interactuar con el clúster mymongo.example.net:27017 y utilizar el cifrado automático:

// returns the database object
myDB = cluster.getDB("myDB");
// returns the collection object
myColl = myDB.getCollection("myColl");
myColl.insertOne(
  {
    "name" : "J Doe",
    "taxid" : "123-45-6789",
    "taxid-short" : "6789"
  }
)

Las reglas de cifrado automático especificadas cifran los taxid campos taxid-short y utilizando la clave y el algoritmo de cifrado de datos especificados. Solo los clientes configurados para el KMS correcto y con acceso a la clave de cifrado de datos especificada pueden descifrar el campo.

Consulte Métodos de cifrado a nivel de campo del lado del cliente para obtener una lista completa de los métodos de cifrado a nivel de campo del lado del cliente.

Conectarse a un clúster con la API estable habilitada

La siguiente operación crea un nuevo objeto de conexión desde dentro de una mongosh sesión. La opción api habilita la Stable API v1 y especifica que no se puede ejecutar ningún comando obsoleto ni ningún comando fuera de la Stable API.

cluster = Mongo(
  "mongodb://mymongo.example.net:27017/?replicaSet=myMongoCluster",
   null,
   { api: { version: "1", strict: true, deprecationErrors: true } }
)

Para interactuar con el mymongo.example.net:27017 clúster, ejecute operaciones contra el cluster objeto. Para obtener una lista completa de los comandos de la API estable, consulte Comandos de la API estable.

Volver

Conectar

Mongo.getDB