mongodrdl

Opções principais

--help

Retorna informações sobre as opções e uso do mongodrdl.

--version

Retorna o número de versão do mongodrdl.

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

Especifica que mongodrdl deve fornecer uma saída de log mais detalhada. Incluir várias vezes para maior verbosidade (por exemplo, -vvvvv) ou especificar um valor numérico (por exemplo, --verbose=5).

--quiet

Oculta todas as saídas de registro.

--uri <mongodb-uri>

Novidades na versão 2.12.

Cadeia de conexão de URI do MongoDB.

Importante

As seguintes opções de linha de comando não podem ser utilizadas em conjunto com a opção --uri :

• --host

• --port

• --db

• --username

• --password (se a cadeia de conexão do URI também incluir a senha)

• --authenticationDatabase

• --authenticationMechanism

Em vez disso, especifique essas opções como parte de sua string de conexão --uri .

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

Padrão: localhost:27017

Especifica um nome de host resolvível para o mongod ao qual se conectar. Por padrão, mongodrdl tenta se conectar a uma instância do MongoDB em execução no host local na porta número 27017.

Para se conectar a um conjunto de réplicas, especifique o replSetName e uma lista de sementes de nós do conjunto, como a seguir:

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

Você sempre pode se conectar diretamente a uma única instância MongoDB especificando o número do host e da porta diretamente.

--port <port>

Padrão: 27017

Especifica a porta TCP na qual a instância do MongoDB escuta conexões de cliente.

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

Especifica um banco de dados do qual gerar um arquivo de esquema do .drdl.

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

Especifica uma coleção a partir da qual gerar um arquivo de esquema do .drdl. Se você não especificar uma coleção, esta opção utilizará todas as coleções no banco de dados ou instância especificada.

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

Especifica o nome do campo a ser adicionado para um filtro MongoDB personalizado. Consulte Filtros personalizados para obter mais detalhes.

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

Padrão: Padrão para fora.

Especifica o caminho em que mongodrdl gravará o arquivo de esquema. Para enviar o esquema para a saída padrão, especifique "-" em vez de um caminho.

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

Padrão: 1000

Especifica o número de documentos a serem amostrados ao gerar o esquema da coleção.

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

Especifique a codificação usada para gerar o subtipo binário UUID 3. Escolha um dos seguintes valores:

• old: Representação antiga do subtipo binário BSON

• csharp: A representação legada de UUID em C#/.NET

• java: A representação legada de UUID em Java

--preJoined

Gere tabelas desenroladas, incluindo colunas principais, resultando em uma tabela "pré-unida ".

--schema <db-id>

Novidades na versão 2,11.

Obrigatório. Especifica a representação de string do ObjectId do esquema.

--name <db-name>

Novidades na versão 2,11.

Especifica o nome do esquema.

Importante

Se você carregar um esquema personalizado, deverá armazená-lo com seu nome especificado, usando name-schema e, em seguida, especificar esse nome para o mongosqld com --schemaName. Se você não armazenar o nome do esquema ao carregá-lo, o nome do esquema padrão será defaultSchema. Se o nome do esquema não existir, isso resultará em um erro de mongosqld semelhante ao seguinte: esquema do MongoDB ainda não disponível. Erro ao inicializar esquema: nenhum esquema encontrado para o nome.

--schemaSource <db-name>

Novidades na versão 2,11.

Especifica o banco de dados de dados onde as informações do esquema são armazenadas. Esta opção não é utilizada pelo comando sample .

Opções TLS/SSL

--ssl

Padrão: falso

Instrui o mongodrdl para usar TLS/SSL ao conectar a uma instância MongoDB.

--sslCAFile <filename>

Especifica o arquivo .pem da instância MongoDB contendo a cadeia de certificado raiz da Autoridade de certificação. Especifique o nome do arquivo .pem usando caminhos relativos ou absolutos.

Aviso

Para conexões SSL (--ssl) para mongod e mongos, se o mongodrdl executar sem o --sslCAFile, mongodrdl não tentará validar os certificados do servidor. Isso cria uma vulnerabilidade para certificados mongod e mongos expirados, bem como para processos externos que se fazem passar por instâncias mongod ou mongos válidas. Certifique-se de sempre especificar o arquivo de autoridade de certificação para validar os certificados do servidor nos casos em que a intrusão é uma possibilidade.

--sslPEMKeyFile <filename>

Especifica o arquivo .pem que contém o certificado TLS/SSL e a chave para mongosqld a serem usados na conexão com o MongoDB. Você pode especificar o nome do arquivo .pem utilizando um caminho relativo ou absoluto.

Esta opção é exigida ao utilizar a opção --ssl para conectar a um mongod ou mongos que tenha CAFile habilitado sem net.ssl.allowConnectionsWithoutCertificates.

--sslPEMKeyPassword <password>

Especifica o caminho para um arquivo que contém o certificado e a chave privada para se conectar ao MongoDB.

--sslCRLFile <filename>

Especifica o arquivo .pem que contém a lista de certificados revogados. Especifique o nome do arquivo .pem usando caminhos relativos ou absolutos.

--sslAllowInvalidCertificates

Permite que a instância MongoDB apresente um certificado SSL/TLS de servidor inválido. Ao usar a configuração allowInvalidCertificates, o MongoDB registra o uso do certificado inválido como um aviso.

--sslAllowInvalidHostnames

Desabilita a validação dos nomes de host em certificados TLS/SSL. Permite que mongodrdl se conectem a instâncias do MongoDB se o nome do host seus certificados não corresponderem ao nome de host especificado.

--sslFIPSMode

Direciona o mongodrdl para utilizar o modo FIPS da biblioteca OpenSSL instalada. Seu sistema deve ter uma biblioteca OpenSSL compatível com FIPS para usar a opção --sslFIPSMode .

--minimumTLSVersion <TLS1_0|TLS1_1|TLS1_2>

Padrão: TLS1_1

Especifica a versão mínima necessária do TLS para que mongodrdl se conecte a uma instância mongod ou mongos. O valor padrão TLS1_1 corresponde à versão 1.1 do TLS.

Opções de autenticação

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

Especifica um nome de usuário com o qual autenticar em um banco de dados MongoDB que usa autenticação. Use em conjunto com as opções --password e --authenticationDatabase.

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

Especifica uma senha com a qual autenticar em um banco de dados MongoDB que usa autenticação. Use em conjunto com as opções --username e --authenticationDatabase.

--authenticationDatabase <dbname>

Especifica o banco de dados no qual o usuário é criado. Consulte Banco de dados de autenticação.

--authenticationMechanism <name>

Padrão: SCRAM-SHA-1

Especifica o mecanismo de autenticação que a instância do mongodrdl utiliza para autenticar no mongod ou mongos.

Valor	Descrição
SCRAM-SHA-1	RFC 5802 Mecanismo de Autenticação de Resposta do Desafio Salgado padrão usando a função com hash SHA1.
SCRAM-SHA-256	Novidades na versão 2.6: Salted Challenge Response Authentication Mechanism RFC 7677 padrão usando a função de hash SHA2.
PLAIN (LDAP SASL)	Autenticação externa usando LDAP. Você também pode utilizar o PLAIN para autenticar usuários do banco de dados. PLAIN transmite senhas em texto simples. Esse mecanismo está disponível apenas no MongoDB Enterprise.
GSSAPI (Kerberos)	Autenticação externa usando Kerberos. Esse mecanismo está disponível somente no MongoDB Enterprise.

--gssapiServiceName <service-name>

Padrão: mongodb

Nome do serviço a ser usado ao autenticar usando GSSAPI/Kerberos.

--gssapiHostName <hostname>

Padrão: endereço do servidor remoto

Nome de host a ser usado ao autenticar usando GSSAPI/Kerberos.

Filtros personalizados

O BI Connector usa um pipeline de agregação do MongoDB para executar queries em um banco de dados do MongoDB. Você pode adicionar um campo especial ao seu esquema para passar uma string da query personalizada do MongoDB $match para sua instância do MongoDB.

Utilize a opção --customFilterField com mongodrdl para nomear um campo de filtro personalizado. Esse campo passa um estágio $match nativo do MongoDB para ser usado como o primeiro estágio do pipeline de agregação, que filtra todos os resultados retornados do MongoDB. O BI Connector aplica esse estágio antes de qualquer estágio adicional enviado do SQL.

A query pode referir-se a qualquer campo da collection, mesmo que os campos não estejam expostos no esquema relacional.

Para ver um exemplo de uso de filtro personalizado, consulte Exemplo de filtro personalizado.

Exemplo de geração de esquema

Documentos fornecidos da seguinte forma na coleção abc no banco de dados test:

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

Execute o mongodrdl para gerar um esquema baseado nesta coleção:

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

O arquivo de esquema gerado (schema.drdl) parece semelhante ao seguinte:

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

Exemplo de filtro personalizado

Para utilizar este campo, especifique a bandeira --customFilterField com o nome que pretende que este campo tenha:

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

Seu arquivo DRDL schema.drdl incluirá o seguinte campo em cada tabela gerada:

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

Para adicionar o estágio de query MongoDB especial ao seu SQL padrão, use a seguinte sintaxe 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"}}}'

O BI Connector traduzirá o SQL acima para a seguinte expressão de agregação MongoDB:

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

Você pode usar esse filtro personalizado em qualquer ferramenta de business intelligence filtrando seu campo especial e fornecendo o valor a ser correspondido como uma única string entre aspas representando um JSON válido. Todas as aspas dentro do JSON devem ser aspas duplas.

Exemplo de autenticação

Se seu servidor MongoDB estiver executando com autenticação habilitada, você deverá especificar um nome de usuário, senha e banco de banco de dados de autenticação como opções para seu comando mongodrdl .

Para criar um arquivo .drdl de uma instância do mongod com a autenticação ativada, use o seguinte formato de comando:

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