mongodrdl

Opciones principales

--help

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

--version

Devuelve el mongodrdl número de versión.

--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 se pueden utilizar junto con la --uri opción:

• --host

• --port

• --db

• --username

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

• --authenticationDatabase

• --authenticationMechanism

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

--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 sola 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 desde la cual generar un archivo de esquema .drdl.

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

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

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

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

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

Predeterminado: Salida estándar.

Especifica la ruta donde escribirá el archivo de esquema. Para enviar el esquema a la salida estándar, especifique mongodrdl "-" en lugar de una ruta.

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

Por defecto: 1000

Especifica la cantidad de documentos a 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 subtipo binario UUID 3. Elija uno de los siguientes valores:

• old: Antigua representación del subtipo binario BSON

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

• java:La representación UUID heredada de Java

--preJoined

Generar tablas desenrolladas que incluyan columnas principales, lo que da como resultado una tabla "preunida".

--schema <db-id>

Nuevo en la versión 2.11.

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

--name <db-name>

Nuevo en la versión 2.11.

Especifica el nombre del esquema.

Importante

Si carga un esquema personalizado, debe almacenarlo con su nombre especificado name-schema () y luego especificar este nombre en mongosqld --schemaNamecon. Si no almacena el nombre del esquema al cargarlo, el nombre predeterminado defaultSchema será. Si el nombre del esquema no existe, se generará un error de similar al siguiente: Esquema de MongoDB aún no disponible. Error al inicializar mongosqld el esquema: no se encontró ningún esquema para el nombre.

--schemaSource <db-name>

Nuevo en la versión 2.11.

Especifica la base de datos donde se almacena la información del esquema. El comando no utiliza esta opción.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 de certificación. Especifique el nombre del archivo .pem mediante rutas relativas o absolutas.

Advertencia

Para las conexiones SSL (--ssl) amongodymongos, simongodrdlse ejecuta sin--sslCAFile, mongodrdlno intentará validar los certificados del servidor. Esto crea una vulnerabilidad para los certificadosmongodymongoscaducados, así como para los procesos externos que se hacen pasar por instanciasmongodomongosválidas. Asegúrese de especificar siempre el archivo de CA para validar los certificados del servidor en casos donde exista la posibilidad de intrusión.

--sslPEMKeyFile <filename>

Especifica el .pem archivo que contiene el certificado TLS/SSL y la clave que mongosqld usará al conectarse a MongoDB. Puede especificar el nombre del .pem archivo mediante una ruta relativa o absoluta.

Esta opción es necesaria cuando se utiliza la opción--sslpara conectarse a unmongodomongosque tieneCAFilehabilitado sinnet.ssl.allowConnectionsWithoutCertificates.

--sslPEMKeyPassword <password>

Especifica la ruta a un archivo que contiene el certificado y la 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 no válido. Al usar la configuración, MongoDB registra el uso del certificado no válido como allowInvalidCertificates advertencia.

--sslAllowInvalidHostnames

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

--sslFIPSMode

Indica a que use el modo FIPS de la biblioteca OpenSSL instalada. Su mongodrdl --sslFIPSMode sistema debe tener una biblioteca OpenSSL compatible con FIPS para usar la opción.

--minimumTLSVersion <TLS1_0|TLS1_1|TLS1_2>

Predeterminado: TLS1_1

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

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 donde se crea el usuario. Consulte Base de datos de autenticación.

--authenticationMechanism <name>

Por defecto: SCRAM-SHA-1

Especifica el mecanismo de autenticación que mongodrdl utiliza la instancia para autenticarse en mongod mongoso.

Valor	Descripción
SCRAM-SHA-1	Mecanismo de autenticación de respuesta al desafío con sal estándarRFC que utiliza la 5802 1 función hash SHA.
SCRAM-SHA-256	Novedades en la versión 2.6: Mecanismo de autenticación de respuesta al desafío con sal estándarRFC que utiliza la 7677 2 función hash SHA.
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>

Predeterminado: mongodb

Nombre del servicio a utilizar durante la autenticación mediante GSSAPI/Kerberos.

--gssapiHostName <hostname>

Predeterminado: dirección del servidor remoto

Nombre de host a utilizar durante la autenticación mediante GSSAPI/Kerberos.

Filtros personalizados

El Conector de BI utiliza una canalización de agregación de MongoDB para realizar consultas en una base de datos MongoDB. Puede agregar un campo especial a su esquema para pasar una cadena de consulta personalizada `$match` de MongoDB a su 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 consulta puede hacer referencia a cualquier campo de 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 esquemas

Dados documentos de la siguiente forma en la colección abc en la base de datos test:

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

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

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

El archivo de esquema generado (schema.drdl) se parece 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, especifique el indicador --customFilterField con el nombre que desea 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 de consulta especial de MongoDB a su SQL estándar, utilice 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 conector de BI traducirá el SQL anterior en 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 usar este filtro personalizado en cualquier herramienta de inteligencia empresarial filtrando por su campo especial y proporcionando el valor correspondiente como una cadena entre comillas simples que representa un JSON válido. Todas las comillas dentro del JSON deben ser dobles.

Ejemplo de autenticación

Si su servidor MongoDB se ejecuta con la autenticación habilitada, debe especificar un nombre de usuario, una contraseña y una base de datos de autenticación como opciones para su mongodrdl comando.

Para crear un archivo .drdl desde una instancia de 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