mongodrdl

核心选项

--help

返回 mongodrdl 的选项和使用的信息。

--version

返回 mongodrdl 版本号。

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

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

--quiet

隐藏所有日志输出。

--uri <mongodb-uri>

版本 2.12 新增内容。

MongoDB URI 连接字符串。

重要

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

• --host

• --port

• --db

• --username

• --password （如果 URI 连接字符串还包含密码）

• --authenticationDatabase

• --authenticationMechanism

相反，请将这些选项指定为--uri连接string的一部分。

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

默认：localhost:27017

指定要连接的mongod的可解析主机名。 默认， mongodrdl会尝试连接到在本地主机端口号27017上运行的MongoDB实例。

要连接到副本集，请指定 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

生成包括父列在内的未绑定表，形成“预连接”表。

--schema <db-id>

2.11 版新增功能。

必需。 指定模式的string 的ObjectId 表示形式。

--name <db-name>

2.11 版新增功能。

指定模式名称。

重要

如果您上传自定义架构，则必须使用 name-schema 存储该架构，对其命名，然后使用 --schemaName 将此名称指定给 mongosqld。如果在上传架构时不存储架构名称，则架构名称默认为 defaultSchema。如果架构的名称不存在，则会导致 mongosqld 中的错误，类似于以下内容：MongoDB 架构尚不可用。初始化架构时出错：找不到此名称的架构。

--schemaSource <db-name>

2.11 版新增功能。

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

TLS/SSL 选项

--ssl

默认值：False

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

--sslCAFile <filename>

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

警告

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

--sslPEMKeyFile <filename>

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

使用--ssl选项连接到已启用CAFile且未启用net.ssl.allowConnectionsWithoutCertificates的mongod或mongos时，需要使用此选项。

--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 标准Salted 质询响应身份验证机制。
SCRAM-SHA-256	版本 2.6 中的新增内容： RFC 7677 标准 Salted 挑战响应身份验证机制（使用 SHA2 哈希函数）
普通版 (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 返回的任何结果。 BI Connector 在从 SQL 向下推送的任何其他阶段之前应用此阶段。

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

有关自定义过滤器的使用示例，请参阅自定义过滤器示例。

模式生成示例

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

{
    "_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

如需在标准 SQL 中添加特殊的 MongoDB 查询阶段，请使用以下 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命令的选项。

要创建.drdl 文件，mongod实例身份验证命令格式：

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