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接続文字列の一部としてこれらのオプションを指定します。

--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 の新機能。

必須。 スキーマのObjectIdの string 表現を指定します。

--name <db-name>

バージョン 2.11 の新機能。

スキーマ名を指定します。

重要

カスタム スキーマをアップロードする場合、 を使用して、指定された名前でスキーマを保存してから、name-schema を使用してこの名前をmongosqld --schemaNameに指定する必要があります。アップロード時にスキーマの名前を保存しない場合、デフォルトのスキーマ名であるdefaultSchemaが適用されます。 スキーマ名が存在しない場合は、 mongosqldから次のようなエラーが返されます。「MongoDB スキーマはまだ利用できません。 スキーマの初期化エラー: 名前に対応するスキーマが見つかりません。

--schemaSource <db-name>

バージョン 2.11 の新機能。

スキーマ情報を保存するデータベースを指定します。 このオプションはsampleコマンドでは使用されません。

TLS/SSL オプション

--ssl

デフォルト: False

MongoDB インスタンスに接続するときに TLS/SSL を使用するようにmongodrdlに指示します。

--sslCAFile <filename>

MongoDB インスタンスの .pem ファイルのうち、認証局からのルート証明書チェーンを含むものを指定します。相対パスまたは絶対パスを使用して、.pem ファイルのファイル名を指定します。

警告

mongodおよびmongosへの SSL 接続（ --ssl ）の場合、 mongodrdlが--sslCAFileなしで実行される場合、 mongodrdlはサーバー証明書の検証を試行しません。 これにより、期限切れのmongodおよびmongos証明書、および有効なmongodまたはmongosインスタンスを引き受ける外部プロセスに対する脆弱性が生じます。 違反が発生する可能性がある場合に備えて、サーバー証明書を検証するために、常にCA ファイルを指定するようにしてください。

--sslPEMKeyFile <filename>

MongoDB への接続時にmongosqldが使用する TLS/SSL 証明書と鍵の両方を含む.pemファイルを指定します。 相対パスまたは絶対パスを使用して、 .pemファイルのファイル名を指定できます。

このオプションは、--ssl オプションを使用して、net.ssl.allowConnectionsWithoutCertificates なしでmongodmongos CAFileが有効になっている または に接続する場合に必要です。

--sslPEMKeyPassword <password>

MongoDB への接続用証明書と秘密キーを含むファイルへのパスを指定します。

--sslCRLFile <filename>

証明書失効リストを含む .pem ファイルを指定します。相対パスまたは絶対パスを使用して .pem ファイルのファイル名を指定します。

--sslAllowInvalidCertificates

MongoDB インスタンスが無効なサーバー SSL/TLS 証明書を提示することを許可します。 allowInvalidCertificates設定を使用すると、MongoDB は警告として無効な証明書の使用をログに記録します。

--sslAllowInvalidHostnames

TLS/SSL 証明書のホスト名の検証を無効にします。 証明書のホスト名が指定されたホスト名と一致しない場合、 mongodrdlによる MongoDB インスタンスへの接続を許可します。

--sslFIPSMode

インストールされた OpenSSL ライブラリの FIPS モードを使用するようにmongodrdlに指示します。 --sslFIPSModeオプションを使用するには、システムに FIPS 準拠の OpenSSL ライブラリが必要です。

--minimumTLSVersion <TLS1_0|TLS1_1|TLS1_2>

デフォルト: TLS1_1

mongodrdlがmongodまたはmongosインスタンスに接続するために最小限必要な TLS バージョンを指定します。 デフォルト値TLS1_1は TLS バージョン1に対応します。 1 。

認証オプション

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

認証を使用する MongoDB database への認証すに使用するユーザー名を指定します。 --passwordおよび--authenticationDatabaseオプションと組み合わせて使用します。

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

認証を使用する MongoDB database に対して認証するためのパスワードを指定します。 --usernameおよび--authenticationDatabaseオプションと組み合わせて使用します。

--authenticationDatabase <dbname>

ユーザーが作成されるデータベースを指定します。 詳細については、「認証データベース 」を参照してください。

--authenticationMechanism <name>

デフォルト: SCRAM-SHA-1

mongodrdl インスタンスが mongod または mongos. への認証に使用する認証メカニズムを指定します。

値	説明
SCRAM-SHA-1	RFC5802 標準の Salted Challenge Response Authentication Mechanism。1
SCRAM-SHA-256	バージョン 2.6 の新機能: RFC7677 標準の Salted Challenge Response Authentication Mechanism。2
PLAIN（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 databaseに対してクエリを実行します。 スキーマに特別なフィールドを追加して、カスタムMongoDB $matchクエリstringをMongoDBインスタンスに渡すことができます。

カスタム フィルター フィールドに名前を付けるには、 mongodrdlと--customFilterFieldオプションを併用します。 このフィールドでは、ネイティブの 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

DDL ファイル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}}
]);

このカスタム フィルターは、特別なフィールドでフィルタリングし、有効なbusiness intelligence を表す単一の引用 として一致する値を提供することで、任意のstring JSONツールで使用できます。JSON内のすべての引用符はdouble引用符である必要があります。

認証例

MongoDB サーバーが認証を有効にして実行している場合は、 mongodrdlコマンドのオプションとしてユーザー名、パスワード、認証データベースを指定する必要があります。

.drdlを作成するには 認証が有効になっているmongodインスタンスからの ファイルには、次のコマンド形式を使用します。

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