MongoDB ラッパー¶
ここでは、 CREATE WRAPPER MONGODB
コマンドの構文について説明します。このコマンドを手動で生成するのは難しいため、MongoDB の基本ビューを作成する場合は、 Administration Tool または Design Studio を使用することをお勧めします。
CREATE [ OR REPLACE ] WRAPPER MONGODB <name:identifier>
[ FOLDER = <literal> ]
DATASOURCENAME = <name:identifier>
DATABASE = <literal>
COLLECTION = <literal>
[ LIMITDOCUMENTS = <integer> ]
[ PIPELINE = <literal> ]
[ OUTPUTSCHEMA ( <field> [, <field> ]* ) ]
<field> ::=
<name:identifier> [ = <mapping:literal> ] [ : <type:literal> ]
[ ( { OBL | OPT } ) ]
[ ( DEFAULTVALUE <literal> ) ]
[ EXTERN ]
[ <inline constraints> ]*
| <name:identifier> [ = <mapping:literal> ] : ARRAY OF ( <register field> )
[ ( DEFAULTVALUE <literal> ) ]
[ <inline constraints> ]*
| <name:register field>
<register field> ::=
<name:identifier> [ = <mapping:literal> ] :
REGISTER OF ( <field> [, <field> ]* ) [ <inline constraints> ]*
[ ( DEFAULTVALUE <literal> ) ]
[ <inline constraints> ]*
<inline constraint> ::=
[ NOT ] NULL
| [ NOT ] UPDATEABLE
| { SORTABLE [ ASC | DESC ] | NOT SORTABLE }
既存の MongoDB ラッパーを変更するには、ALTER WRAPPER MongoDB ステートメントを使用します。
ALTER WRAPPER MONGODB <name:identifier>
[ DATASOURCENAME = <name:identifier> ]
[ DATABASE = <literal> ]
[ COLLECTION = <literal> ]
[ LIMITDOCUMENTS = <integer> ]
[ PIPELINE = <literal> ]
[ OUTPUTSCHEMA ( <field> [, <field> ]* ) ]
<field> ::= (「 CREATE WRAPPER MONGODB ステートメントの構文 」を参照)
OUTPUTSCHEMA
句は、ラッパーが提供するデータのスキーマを定義します (「 ラッパーメタデータ 」のセクションを参照)。単純型エレメントごとに型を指定する必要があります。さらに、ラッパーによって返されるフィールド名と MongoDB 内のフィールド名とのアソシエーションをマッピングで指定されたとおりに示すことができます。
MongoDB ラッパーは、MongoDB コレクションに保存されたドキュメントから情報を取得します。これを行うには、コレクションの名前 (COLLECTION
) と、そのコレクションが属するデータベース (DATABASE
)、さらに MongoDB データソースの名前 (DATASOURCENAME
) を指定する必要があります。
Administration Tool や Design Studio で基本ビューを作成する際に、ラッパーのスキーマの取得時に分析されるドキュメントの数を、パラメータ LIMITDOCUMENTS
を使用して指定できます。このパラメータのデフォルト値は 150 ドキュメントで、コレクション内のすべてのドキュメントを分析するには LIMITDOCUMENTS
の値を 0 に設定します。
さらに、 PIPELINE
パラメータを使用して、コレクションから取得したドキュメントに適用する JSON 集約パイプラインを指定できます。集約パイプラインには補間文字列を含めることができます (「 クエリの実行コンテキストと補間文字列 」を参照)。