mongodrdl

核心选项¶

--help¶

返回有关mongodrdl选项和用法的信息。

--version¶

返回mongodrdl版本号。

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

指定mongodrdl应该提供更详细的日志输出。包括多次以获得更多详细信息（例如-vvvvv），或指定一个数值（例如--verbose=5）。

--quiet¶

隐藏所有日志输出。

--uri <mongodb-uri>¶

2.12版中的新功能。

MongoDB URI连接字符串。

重要

以下命令行选项不能与--urioption 一起使用：

• --host
• --port
• --db
• --username
• --password （如果URI连接字符串还包含密码）
• --authenticationDatabase
• --authenticationMechanism

而是将这些选项指定为--uri 连接字符串的一部分。

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

默认值：本地主机：27017

指定mongod要连接的主机名称。默认情况下，mongodrdl尝试连接到端口号为localhost的MongoDB实例27017。

要连接到副本集，请指定replSetName集合成员的 和种子列表，如下所示：

复制

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

您始终可以通过直接指定主机和端口号直接直接连接到单个MongoDB实例。

--port <port>¶

默认值：27017

指定MongoDB实例在其上侦听客户端连接的TCP端口。

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

指定要从中生成.drdl架构文件的数据库。

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

指定从中生成.drdl架构文件的集合。如果未指定集合，则此选项将使用指定数据库或实例中的所有集合。

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

指定要为自定义MongoDB过滤器添加的字段名称。有关更多详细信息，请参见 自定义过滤器。

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

默认值：标准输出。

指定将在其中mongodrdl写入架构文件的路径。要将模式发送到标准输出，请指定“ -”而不是路径。

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

默认值：1000

指定在生成集合的架构时要采样的文档数。

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

指定用于生成UUID二进制子类型3的编码。选择以下值之一：

• old：旧的BSON二进制子类型表示
• csharp：C＃/。NET旧版UUID表示形式
• java：Java旧版UUID表示形式

--preJoined¶

生成包含父列的展开表，从而生成“预联接”表。

--schemaSource <db-name>¶

2.11版中的新功能。

指定存储架构信息的数据库。该sample命令不使用此选项。

TLS / SSL选项¶

--ssl¶

默认值：False

指示mongodrdl连接到MongoDB实例时使用TLS / SSL。

--sslCAFile <filename>¶

指定.pem包含来自证书颁发机构的根证书链的MongoDB实例的文件。.pem使用相对或绝对路径指定文件的文件名。

警告

对于--ssl与mongod和的 SSL连接（）mongos，如果mongodrdl在不使用的情况下运行 --sslCAFile，mongodrdl将不会尝试验证服务器证书。这会造成过期mongod和mongos证书以及伪装成有效mongod或 mongos实例的外部进程的漏洞。如果可能发生入侵，请确保始终指定CA文件来验证服务器证书。

--sslPEMKeyFile <filename>¶

指定.pem包含TLS / SSL证书和mongosqld连接到MongoDB时要使用的密钥的文件。您可以.pem使用相对路径或绝对路径来指定文件的文件名 。

使用--ssl选项连接到mongod或mongos已 CAFile启用而未 启用时，此选项是必需的allowConnectionsWithoutCertificates。

--sslPEMKeyPassword <password>¶

指定包含用于连接到MongoDB的证书和私钥的文件的路径。

--sslCRLFile <filename>¶

指定.pem包含证书吊销列表的文件。.pem使用相对或绝对路径指定文件的文件名。

--sslAllowInvalidCertificates¶

允许MongoDB实例提供无效的服务器SSL / TLS证书。使用该allowInvalidCertificates 设置时，MongoDB会将无效证书的使用记录为警告。

--sslAllowInvalidHostnames¶

禁用TLS / SSL证书中的主机名验证。如果其证书的主机名与指定的主机名不匹配，则允许 mongodrdl连接到MongoDB实例。

--sslFIPSMode¶

指示mongodrdl使用已安装的OpenSSL库的FIPS模式。您的系统必须具有FIPS兼容的OpenSSL库才能使用该--sslFIPSMode选项。

--minimumTLSVersion <TLS1_0|TLS1_1|TLS1_2>¶

默认值：TLS1_1

指定mongodrdl连接到mongod或 mongos实例所需的最低TLS版本 。默认值TLS1_1 对应于TLS版本1.1。

验证选项¶

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

指定用于向使用身份验证的MongoDB数据库进行身份验证的用户名。与--password和 --authenticationDatabase选项结合使用。

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

指定用于对使用身份验证的MongoDB数据库进行身份验证的密码。与--username和 --authenticationDatabase选项结合使用。

--authenticationDatabase <dbname>¶

指定在其中创建用户的数据库。请参阅身份验证数据库。

--authenticationMechanism <name>¶

默认值：SCRAM-SHA-1

指定mongodrdl实例用于对mongod或进行身份验证的身份验证机制mongos。

值	描述
SCRAM-SHA-1	使用SHA1哈希函数的RFC 5802标准咸化挑战响应身份验证机制。
SCRAM-SHA-256	2.6版中的新功能： 使用SHA2哈希函数的RFC 7677标准咸化挑战响应身份验证机制。
普通（LDAP SASL）	使用LDAP的外部身份验证。您还可以PLAIN 用于验证数据库内用户。PLAIN以纯文本形式传输密码。此机制仅在MongoDB Enterprise中可用 。
GSSAPI（Kerberos）	使用Kerberos的外部身份验证。此机制仅在MongoDB Enterprise中可用。

--gssapiServiceName <service-name>¶

默认值：mongodb

使用GSSAPI / Kerberos进行身份验证时要使用的服务名称。

--gssapiHostName <hostname>¶

默认值：远程服务器的地址

使用GSSAPI / Kerberos进行身份验证时要使用的主机名。

自定义过滤器¶

BI Connector使用MongoDB 聚合管道 对MongoDB数据库执行查询。您可以在架构中添加一个特殊字段，以将自定义的MongoDB $ match 查询字符串传递到您的MongoDB实例。

使用--customFilterField选项和mongodrdl命名自定义过滤器字段。该字段经过一个本机的MongoDB $ match 阶段，用作聚合管道的第一阶段，该阶段过滤从MongoDB返回的所有结果。从SQL下推任何其他阶段之前，BI连接器将应用此阶段。

该查询可以引用集合中的任何字段，即使这些字段未在关系模式中公开。

有关自定义过滤器用法的示例，请参见“ 自定义过滤器示例”。

架构生成实施例¶

给定abc数据库中集合中具有以下形状的文档test：

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

运行mongodrdl以基于此集合生成模式：

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

生成的模式文件（schema.drdl）类似于以下内容：

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

自定义过滤器示例¶

要使用此字段，请指定--customFilterField您希望该字段具有的名称的标志：

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

您的DRDL文件schema.drdl将在每个生成的表中包括以下字段：

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

要将特殊的MongoDB查询阶段添加到标准SQL中，请使用以下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"}}}'

BI Connector将上面的SQL转换为以下MongoDB 聚合表达式：

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

您可以在任何商业智能工具中使用此自定义过滤器，方法是对特殊字段进行过滤，并提供值以匹配为一个表示有效JSON的单引号字符串进行匹配。JSON内的所有引号必须为双引号。

身份验证示例¶

如果您的MongoDB服务器在启用身份验证的情况下运行，则必须指定用户名，密码和身份验证数据库作为mongodrdl命令的选项 。

创建一个