mongodrdl

Opciones principales

--help

Devuelve información sobre las opciones y el uso de mongodrdl.

--version

Devuelve el número de versión de la mongodrdl.

--verbose <level>, -v <level>

Especifica que mongodrdl debe proporcionar una salida de registro más detallada. Inclúyelo varias veces para mayor nivel de verbosidad (p. ej. -vvvvv), o especifica un valor numérico (p. ej. --verbose=5).

--quiet

Oculta toda la salida del registro.

--uri <mongodb-uri>

Novedad en la versión 2.12.

Cadena de conexión URI de MongoDB.

Importante

Las siguientes opciones de línea de comandos no pueden utilizarse junto con la opción --uri:

• --host

• --port

• --db

• --username

• --password (si la cadena de conexión URI también incluye la contraseña)

• --authenticationDatabase

• --authenticationMechanism

En su lugar, especifica estas opciones como parte de tu cadena de conexión --uri.

--host <hostname><:port>, -h <hostname><:port>

Por defecto: localhost:27017

Especifica un hostname resolvible para el mongod al que conectar. Por defecto, el mongodrdl intenta conectarse a una instancia de MongoDB que se ejecuta en localhost en el puerto número 27017.

Para conectarse a un set de réplicas, especifica el replSetName y una lista de nodos iniciales de los miembros del set, tal como se muestra a continuación:

<replSetName>/<hostname1><:port>,<hostname2><:port>,<...>

Siempre puede conectarse directamente a una única instancia de MongoDB especificando directamente el host y el número de puerto.

--port <port>

Por defecto: 27017

Especifica el puerto TCP en el que la instancia de MongoDB escucha las conexiones de los clientes.

--db <database>, -d <database>

Especifica una base de datos a partir de la cual generar un archivo de esquema .drdl.

--collection <collection>, -c <collection>

Especifica una colección de la cual generar un archivo de esquema .drdl. Si no especifica una colección, esta opción utilizará todas las colecciones en la base de datos o instancia especificada.

--customFilterField <name>, -f <name>

Especifica el nombre del campo que se va a añadir para un filtro personalizado de MongoDB. Consulta Filtros personalizados para obtener más detalles.

--out <path>, -o <path>

por defecto: Salida estándar.

Especifica la ruta donde mongodrdl guardará el archivo del esquema. Para enviar el esquema a la salida estándar, especifica “-” en lugar de una ruta.

--sampleSize <size>, -s <size>

Por defecto: 1000

Especifica la cantidad de documentos que se deben muestrear al generar el esquema de la colección.

--uuidSubtype3Encoding <old|csharp|java>, -b <old|csharp|java>

Especifique la codificación utilizada para generar el subtip Binario UUID 3. Elija uno de los siguientes valores:

• oldReprensentación anterior del subtipo binario BSON

• csharp: La representación UUID heredada de C#/.NET

• javaLa representación heredada UUID de Java

--preJoined

Generar tablas desglosadas incluyendo columnas ascendentes, lo que da como resultado una tabla "preunida".

--schema <db-id>

Novedad en la versión 2.11.

Obligatorio. Especifica la representación en string del ObjectId del esquema.

--name <db-name>

Novedad en la versión 2.11.

Especifica el nombre del esquema.

Importante

Si cargas un esquema personalizado, debes almacenarlo con su nombre especificado, usando name-schema, y luego especificar ese nombre en el mongosqld con --schemaName. Si no almacenas el nombre del esquema al subirlo, el nombre del esquema se establece por defecto en defaultSchema. Si el esquema de nombre no existe, esto resulta en un error de mongosqld similar al siguiente: El esquema de MongoDB aún no está disponible. Error al inicializar el esquema: no se encontró un esquema para el nombre.

--schemaSource <db-name>

Novedad en la versión 2.11.

Especifica la base de datos donde se almacena la información del esquema. Esta opción no es utilizada por el comando sample.

Opciones TLS/SSL

--ssl

Por defecto: False

Instruye a mongodrdl a usar TLS/SSL al conectarse a una instancia de MongoDB.

--sslCAFile <filename>

Especifica el archivo .pem de la instancia de MongoDB que contiene la cadena de certificados raíz de la autoridad certificadora. Especifique el nombre del archivo .pem utilizando rutas relativas o absolutas.

Advertencia

Para las conexiones SSL (--ssl) a mongod y mongos, si el mongodrdl se ejecuta sin el --sslCAFile, mongodrdl no intentará validar los certificados del servidor. Esto crea una vulnerabilidad frente a la caducidad de los certificados mongod y mongos, así como ante procesos externos que se hacen pasar por instancias válidas de mongod o mongos. Asegúrate de siempre especificar el archivo CA para validar los certificados del servidor en casos donde exista la posibilidad de intrusión.

--sslPEMKeyFile <filename>

Especifica el archivo .pem que contiene tanto el certificado como la clave TLS/SSL para que mongosqld use al conectarse a MongoDB. Puede especificar el nombre del archivo .pem utilizando una ruta relativa o absoluta.

Esta opción es necesaria al usar la opción --ssl para conectarse a mongod o mongos que tengan habilitado CAFile sin allowConnectionsWithoutCertificates.

--sslPEMKeyPassword <password>

Especifica la ruta hacia el archivo que contiene el certificado y clave privada para conectarse a MongoDB.

--sslCRLFile <filename>

Especifica el archivo .pem que contiene la Lista de revocación de certificados. Especifica el nombre del archivo .pem con rutas relativas o absolutas.

--sslAllowInvalidCertificates

Permite que la instancia de MongoDB presente un certificado SSL/TLS de servidor inválido. Al utilizar la configuración allowInvalidCertificates, MongoDB registra el uso del certificado no válido como una advertencia.

--sslAllowInvalidHostnames

Desactiva la validación de los nombres de host en los certificados TLS/SSL. Permite que mongodrdl se conecte a instancias de MongoDB si el nombre de host de sus certificados no coincide con el nombre de host especificado.

--sslFIPSMode

Indica al mongodrdl que utilice el modo FIPS de la librería OpenSSL instalada. Su sistema debe contar con una librería OpenSSL compatible con FIPS para utilizar la opción --sslFIPSMode.

--minimumTLSVersion <TLS1_0|TLS1_1|TLS1_2>

Por defecto: TLS1_1

Especifica la versión mínima requerida de TLS para que mongodrdl se conecte a una instancia de mongod o mongos. El valor por defecto TLS1_1 corresponde a la versión TLS 1.1.

Opciones de autenticación

--username <username>, -u <username>

Especifica un nombre de usuario con el cual autenticarse en una base de datos MongoDB que requiere autenticación. Utilízalo en conjunto con las opciones --password y --authenticationDatabase.

--password <password>, -p <password>

Especifica una contraseña con la que autenticarse en una base de datos de MongoDB que requiere autenticación. Utilízalo en conjunto con las opciones --username y --authenticationDatabase.

--authenticationDatabase <dbname>

Especifica la base de datos en la que se crea el usuario. Consulta la base de datos de autenticación.

--authenticationMechanism <name>

Por defecto: SCRAM-SHA-1

Especifica el mecanismo de autenticación que la instancia de mongodrdl usa para autenticarse en mongod o mongos.

Valor	Descripción
SCRAM-SHA-1	RFC 5802 mecanismo estándar de autenticación de respuesta a desafío basado en sal (Salted Challenge Response Authentication Mechanism) utilizando la función hash SHA1.
SCRAM-SHA-256	Nuevo en la versión 2.6: RFC 7677 mecanismo estándar de autenticación por desafío con salt (SCRAM) mediante la función de hash SHA2.
PLAIN (SASL LDAP)	Autenticación externa mediante LDAP. También puede utilizar PLAIN para autenticar a los usuarios de base de datos. PLAIN transmite las contraseñas en texto sin cifrar. Este mecanismo está disponible solo en MongoDB Enterprise.
GSSAPI (Kerberos)	Autenticación externa utilizando Kerberos. Este mecanismo está disponible solo en MongoDB Enterprise.

--gssapiServiceName <service-name>

Por defecto: MongoDB

Nombre del servicio que se utilizará al autenticarse usando GSSAPI/Kerberos.

--gssapiHostName <hostname>

por defecto: dirección del servidor remoto

Nombre de host que se utilizará para la autenticación usando GSSAPI/Kerberos.

Filtros personalizados

BI Connector utiliza una pipeline de agregación de MongoDB para realizar consultas a una base de datos MongoDB. Puedes añadir un campo especial a tu esquema para pasar una string del query de MongoDB $match personalizada a tu instancia de MongoDB.

Usa la opción --customFilterField con mongodrdl para nombrar un campo de filtro personalizado. Este campo pasa una etapa nativa de MongoDB $match para usar como la primera etapa del pipeline de agregación, que filtra cualquier resultado devuelto de MongoDB. El conector BI aplica esta etapa antes de que cualquier etapa adicional se aplique desde SQL.

La query puede hacer referencia a cualquier campo en la colección, incluso si los campos no están expuestos en el esquema relacional.

Para un ejemplo de uso de filtros personalizados, consulta Ejemplo de filtro personalizado.

Ejemplo de generación de esquema

Dados los documentos con la siguiente estructura en la colección abc de la base de datos test:

{
    "_id": ObjectId(),
    "close": 7.45,
    "detail": { "a": 2, "b": 3 }
}

Ejecute mongodrdl para crear un esquema basado en esta colección:

mongodrdl -d test -c abc -o schema.drdl

El archivo de esquema generado (schema.drdl) es similar al siguiente:

schema:
- db: test
  tables:
  - table: abc
    collection: abc
    pipeline: []
    columns:
    - Name: _id
      MongoType: bson.ObjectId
      SqlName: _id
      SqlType: varchar
    - Name: close
      MongoType: float64
      SqlName: close
      SqlType: numeric
    - Name: detail.a
      MongoType: float64
      SqlName: detail.a
      SqlType: numeric
    - Name: detail.b
      MongoType: float64
      SqlName: detail.b
      SqlType: numeric

Ejemplo de filtro personalizado

Para utilizar este campo, especifica la bandera --customFilterField con el nombre que desees que tenga este campo:

mongodrdl [ other options ] --customFilterField _MONGOFILTER -o schema.drdl

Su archivo DRDL schema.drdl incluirá el siguiente campo en cada tabla generada:

- Name: _MONGOFILTER
  MongoType: mongo.Filter
  SqlName: _MONGOFILTER
  SqlType: varchar

Para agregar la etapa especial de la query de MongoDB a tu SQL estándar, utiliza la siguiente sintaxis SQL:

SELECT <normal>
  FROM <tablename>
  WHERE <normal conditions> AND
      _MONGOFILTER='{ <json string that represents query to use> }'
SELECT name,age
  FROM users
  WHERE active='t' AND
      _MONGOFILTER='{"addr":{"$elemMatch":{"city":"Springfield","state":"CA"}}}'

El BI Connector traducirá el SQL anterior a la siguiente expresión de agregación de MongoDB:

db.users.aggregate([
   {$match:{"addr":{"$elemMatch":{"city":"Springfield","state":"CA"}}},
   {$match:{"active":true}},
   {$project:{"name":1, "age":1}}
]);

Puede utilizar este filtro personalizado en cualquier herramienta de business intelligence filtrando en su campo especial y proporcionando el valor a coincidir como una string entre comillas simples que represente un JSON válido. Todas las comillas dentro del JSON deben ser double quotes.

Ejemplo de autenticación

Si su servidor MongoDB está ejecutándose con autenticación habilitada, debe especificar un nombre de usuario, contraseña y base de datos de autenticación como opciones para su comando mongodrdl.

Para crear un .drdl archivo de una instancia mongod con autenticación habilitada, use el siguiente formato de comando:

mongodrdl --host myhost.example.net:27017 \
          --username dbUser \
          --password myPassword \
          --db reports \
          --collection FY2017 \
          --authenticationDatabase admin \
          --out schema.drdl