<html>
<head>
<base href="https://docs.jboss.org/author">
<link rel="stylesheet" href="/author/s/en/2172/19/5/_/styles/combined.css?spaceKey=TEIID&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://docs.jboss.org/author/display/TEIID/MongoDB+Translator">MongoDB Translator</a></h2>
<h4>Page <b>edited</b> by <a href="https://docs.jboss.org/author/display/~rareddy">Ramesh Reddy</a>
</h4>
<br/>
<h4>Changes (3)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >h2. Data Types <br> <br></td></tr>
<tr><td class="diff-changed-lines" >MongoDB translator supports automatic mapping of Teiid data types into MongoDB data types, including the support for Blobs, Clobs and XML. The LOB support is based on GridFS in MongoDB. <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">MongoDB Arrays, Regular Expressions, MongoDB::Code, MongoDB::MinKey, MongoDB::MaxKey, MongoDB::OID is not currently supported.</span> <span class="diff-added-words"style="background-color: #dfd;">Arrays are in the form of</span> <br></td></tr>
<tr><td class="diff-unchanged" > <br></td></tr>
<tr><td class="diff-added-lines" style="background-color: #dfd;">{code} <br>{ <br> _id: 1, <br> FirstName: "John", <br> LastName: "Doe" <br> Score: [89, "ninety", 91.0] <br>} <br>{code} <br></td></tr>
<tr><td class="diff-unchanged" > <br></td></tr>
<tr><td class="diff-added-lines" style="background-color: #dfd;">are supported. User can get individual items in the array using function array_get, or can transform the array into tabular structure using ARRATTABLE. <br> <br>{note} <br>Note that even though embedded documents can also be in arrays, the handling of embedded documents is different from array with scalar values. <br>{note} <br> <br>Regular Expressions, MongoDB::Code, MongoDB::MinKey, MongoDB::MaxKey, MongoDB::OID is not currently supported. <br> <br> <br></td></tr>
<tr><td class="diff-unchanged" >h2. Extension Metadata Properties To Build Complex Documents <br>Using the above DDL or any other metadata facility, a user can map a table in a relational store into a document in MongoDB, however to make effective use of MongoDB, you need to be able to build complex documents, that can co-locate related information, so that data can queried in a single MongoDB query. Otherwise, since MongoDB does not support join relationships like relational database, you need to issue multiple queries to retrieve and join data manually. The power of MongoDB comes from its "embedded" documents and its support of complex data types like arrays and use of the aggregation framework to be able to query them. This translator provides way to achieve that goals. <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<h1><a name="MongoDBTranslator-MongoDBTranslator"></a>MongoDB Translator</h1>
<p>The MongoDB translator provides a relational view of data that resides in a MongoDB database. This translator is capable of converting Teiid SQL queries into MongoDB based queries. It supports a full range of SELECT, INSERT, UPDATE and DELETE calls.</p>
<p>MongoDB is a document based "schema-less" database with it own query language - it does not map perfectly with relational concepts or the SQL query language. More and more systems are using a MongoDB kind of NOSQL store for scalability and performance. For example, applications like storing audit logs or managing web site data fits well with MongoDB, and does not require using a structural database like Oracle, Postgres ect. MongoDB uses JSON documents as its primary storage unit, and it can have additional embedded documents inside the parent document. By using embedded documents it co-locates the related information to achieves de-normalization that typically requires either duplicate data or joins to achieve in a relational database.</p>
<p>To make MongoDB work with Teiid the challenge for the MongoDB translator is "How to design a MongoDB store that can achieve the balance between relational and document based storage?" In our opinion the advantages of "schema-less" design are great at development time. "Schema-less" can also be a problem with migration of application versions and the ability to query and make use of returned information effectively.</p>
<p>Since it is hard and may be impossible in certain situations to derive a schema based on existing the MongoDB collection(s), Teiid approaches the problem in reverse compared to other translators. When working with MongoDB, Teiid requires the user to define the MongoDB schema upfront using Teiid metadata. Since Teiid only allows relational schema as its metadata, the user needs to define their MongoDB schema in relational terms using tables, procedures, and functions. For the purposes of MongoDB, the Teiid metadata has been extended to support extension properties that can be defined on the table to convert it into a MongoDB based document. These extension properties let users define, how a MongoDB document is structured and stored. Based on the relationships (primary-key, foreign-key) defined on a table, and the cardinality (ONE-to-ONE, ONE-to-MANY, MANY-to-ONE) relations between tables are mapped such that related information can be embedded along with the parent document for co-location (see the de-normalization comment above). Thus a relational schema based design, but document based storage in MongoDB. Currently direct mapping of MANY-to-MANY is not supported.</p>
<h3><a name="MongoDBTranslator-Whoistheprimaryaudienceforthistranslator%3F"></a>Who is the primary audience for this translator?</h3>
<p>The above may not satisfy every user's needs. The document structure in MongoDB can be more complex than what Teiid can currently define. We hope this will eventually catch up in future versions of Teiid. This is currently designed for:</p>
<p>1. Users that are using relational databases and would like to move/migrate their data to MongoDB to take advantages scaling and performance with out modifying the end user applications currently running.</p>
<p>2. Users that are starting out with MongoDB and do not have experience with MongoDB, but are seasoned SQL developers. This provides a low barrier of entry compared to using MongoDB directly as an application developer.</p>
<p>3. Integrate other enterprise data sources with MongoDB based data.</p>
<h3><a name="MongoDBTranslator-Usage"></a>Usage</h3>
<p>The name of the translator to use in vdb.xml is "<em>mongodb</em>". <br/>
For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: xml; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<vdb name="nothwind" version="1">
<model name="northwind">
<source name="local" translator-name="mongodb" connection-jndi-name="java:/mongoDS"/>
</model>
<vdb>
</pre>
</div></div>
<p>The translator does not provide a connection to the MongoDB. For that purpose, Teiid has a JCA adapter that provides a connection to MongoDB using the MongoDB Java Driver. To define such connector, use the following XML fragment in standalone-teiid.xml. See a example in "<jboss-as>/docs/teiid/datasources/mongodb" </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: xml; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<resource-adapters>
<resource-adapter id="mongodb">
<module slot="main" id="org.jboss.teiid.resource-adapter.mongodb"/>
<transaction-support>NoTransaction</transaction-support>
<connection-definitions>
<connection-definition class-name="org.teiid.resource.adapter.mongodb.MongoDBManagedConnectionFactory"
jndi-name="java:/mongoDS"
enabled="true"
use-java-context="true"
pool-name="teiid-mongodb-ds">
<!-- MongoDB server list (host:port[;host:port...]) -->
<config-property name="RemoteServerList">localhost:27017</config-property>
<!-- Database Name in the MongoDB -->
<config-property name="Database">test</config-property>
<!--
Uncomment these properties to supply user name and password
<config-property name="Username">user</config-property>
<config-property name="Password">user</config-property>
-->
</connection-definition>
</connection-definitions>
</resource-adapter>
</resource-adapters>
</pre>
</div></div>
<p>The above defines the translator and connector. However as mentioned the MongoDB translator can NOT derive the metadata based on existing document collections - the user MUST define the metadata. For example, you can define a schema using DDL: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: xml; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<vdb name="nothwind" version="1">
<model name="northwind">
<source name="local" translator-name="mongodb" connection-jndi-name="java:/mongoDS"/>
<metadata type="DDL"><![CDATA[
CREATE FOREIGN TABLE Customer (
customer_id integer,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE');
]]> </metadata>
</model>
<vdb>
</pre>
</div></div>
<p>when INSERT operation below executed against table using Teiid, </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
INSERT INTO Customer(customer_id, FirstName, LastName) VALUES (1, 'John', 'Doe');
</pre>
</div></div>
<p>MongoDB translator will create a below document in the MongoDB</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
{
_id: ObjectID("509a8fb2f3f4948bd2f983a0"),
customer_id: 1,
FirstName: "John",
LastName: "Doe"
}
</pre>
</div></div>
<p>If a PRIMARY KEY is defined on the table as</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
customer_id integer PRIMARY KEY,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE');
</pre>
</div></div>
<p>then that column name is automatically used as "_id" field in the MongoDB collection, then document structure is stored in the MongoDB as </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
{
_id: 1,
FirstName: "John",
LastName: "Doe"
}
</pre>
</div></div>
<p>If you defined the composite PRIMARY KEY on Customer table as</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
customer_id integer,
FirstName varchar(25),
LastName varchar(25),
PRIMARY KEY (FirstName, LastName)
) OPTIONS(UPDATABLE 'TRUE');
</pre>
</div></div>
<p>the document structure will be </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
{
_id: {
FirstName: "John",
LastName: "Doe"
},
customer_id: 1,
}
</pre>
</div></div>
<h2><a name="MongoDBTranslator-DataTypes"></a>Data Types</h2>
<p>MongoDB translator supports automatic mapping of Teiid data types into MongoDB data types, including the support for Blobs, Clobs and XML. The LOB support is based on GridFS in MongoDB. Arrays are in the form of </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
{
_id: 1,
FirstName: "John",
LastName: "Doe"
Score: [89, "ninety", 91.0]
}
</pre>
</div></div>
<p>are supported. User can get individual items in the array using function array_get, or can transform the array into tabular structure using ARRATTABLE.</p>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Note that even though embedded documents can also be in arrays, the handling of embedded documents is different from array with scalar values.</td></tr></table></div>
<p>Regular Expressions, MongoDB::Code, MongoDB::MinKey, MongoDB::MaxKey, MongoDB::OID is not currently supported.</p>
<h2><a name="MongoDBTranslator-ExtensionMetadataPropertiesToBuildComplexDocuments"></a>Extension Metadata Properties To Build Complex Documents</h2>
<p>Using the above DDL or any other metadata facility, a user can map a table in a relational store into a document in MongoDB, however to make effective use of MongoDB, you need to be able to build complex documents, that can co-locate related information, so that data can queried in a single MongoDB query. Otherwise, since MongoDB does not support join relationships like relational database, you need to issue multiple queries to retrieve and join data manually. The power of MongoDB comes from its "embedded" documents and its support of complex data types like arrays and use of the aggregation framework to be able to query them. This translator provides way to achieve that goals.</p>
<p>When you do not define the complex embedded documents in MongoDB, Teiid can step in for join processing and provide that functionality, however if you want to make use of the power of MongoDB itself in querying the data and avoid bringing the unnecessary data and improve performance, you need to look into building these complex documents.</p>
<p>MongoDB translator defines two additional metadata properties along with other <a href="/author/display/TEIID/DDL+Metadata" title="DDL Metadata">Teiid metadata properties</a> to aid in building the complex "embedded" documents. You can use the following metadata properties in your DDL.</p>
<ul>
<li><b>teiid_mongo:EMBEDDABLE</b> - Means that data defined in this table is allowed to be included as an "embeddable" document in <b>any</b> parent document. The parent document is referenced by the foreign key relationships. In this scenario, Teiid maintains more than one copy of the data in MongoDB store, one in its own collection and also a copy in each of the parent tables that have relationship to this table. You can even nest embeddable table inside another embeddable table with some limitations. Use this property on table, where table can exist, encompass all its relations on its own. For example, a "Category" table that defines a "Product"'s category is independent of Product, which can be embeddable in "Products" table.</li>
</ul>
<ul>
<li><b>teiid_mongo:MERGE</b> - Means that data of this table is merged with the defined parent table. There is only a single copy of the data that is embedded in the parent document. Parent document is defined using the foreign key relationships.</li>
</ul>
<p>Using the above properties and FOREIGN KEY relationships, we will illustrate how to build complex documents in MongoDB.</p>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>DBRefs</b><br />All the key references are automatically stored as "DBRef" values. The examples below were stripped for clarity reasons.</td></tr></table></div>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Usage</b><br />Please note a given table can contain either the "teiid_mongo:EMBEDDABLE" property or the "teiid_mongo:MERGE" property defining the type of nesting in MongoDB. A table is not allowed to have both properties.</td></tr></table></div>
<h3><a name="MongoDBTranslator-ONE2ONEMapping"></a>ONE-2-ONE Mapping</h3>
<p>If your current DDL structure representing ONE-2-ONE relationship is like</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
CustomerId integer PRIMARY KEY,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE Address (
CustomerId integer,
Street varchar(50),
City varchar(25),
State varchar(25),
Zipcode varchar(6),
FOREIGN KEY (CustomerId) REFERENCES Customer (CustomerId)
) OPTIONS(UPDATABLE 'TRUE');
</pre>
</div></div>
<p>by default, this will produce two different collections in MongoDB, like with sample data it will look like</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
Customer
{
_id: 1,
FirstName: "John",
LastName: "Doe"
}
Address
{
_id: ObjectID("..."),
CustomerId: 1,
Street: "123 Lane"
City: "New York",
State: "NY"
Zipcode: "12345"
}
</pre>
</div></div>
<p>You can enhance the storage in MongoDB to a single collection by using "teiid_mongo:MERGE' extension property on the table's OPTIONS clause</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
CustomerId integer PRIMARY KEY,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE Address (
CustomerId integer PRIMARY KEY,
Street varchar(50),
City varchar(25),
State varchar(25),
Zipcode varchar(6),
FOREIGN KEY (CustomerId) REFERENCES Customer (CustomerId)
) OPTIONS(UPDATABLE 'TRUE', "teiid_mongo:MERGE" 'Customer');
</pre>
</div></div>
<p>this will produce single collection in MongoDB, like</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
Customer
{
_id: 1,
FirstName: "John",
LastName: "Doe",
Address:
{
_id: DBREF("Customer", 1),
Street: "123 Lane",
City: "New York",
State: "NY",
Zipcode: "12345"
}
}
</pre>
</div></div>
<p>With the above both tables are merged into a single collection that can be queried together using the JOIN clause in the SQL command. Since the existence of child/additional record has no meaning with out parent table using the "<em>teiid_mongo:MERGE</em>" extension property is right choice in this situation.</p>
<div class='panelMacro'><table class='tipMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/check.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Note that the Foreign Key defined on child table, must refer to Primary Keys on both parent and child tables to form a One-2-One relationship.</td></tr></table></div>
<h3><a name="MongoDBTranslator-ONE2MANYMapping."></a>ONE-2-MANY Mapping.</h3>
<p>Typically there can be more than two (2) tables involved in this relationship. If MANY side is only associated <b>single</b> table, then use "teiid_mongo:MERGE" property on MANY side of table and define ONE as the parent. If associated with more than single table then use "teiid_mongo:EMBEDDABLE". </p>
<p>For example if you have DDL like</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
CustomerId integer PRIMARY KEY,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE Order (
OrderID integer PRIMARY KEY,
CustomerId integer,
OrderDate date,
Status integer,
FOREIGN KEY (CustomerId) REFERENCES Customer (CustomerId)
) OPTIONS(UPDATABLE 'TRUE');
</pre>
</div></div>
<p>in the above a Single Customer can have MANY Orders. There are two options to define the how we store the MongoDB document. If in your schema, the Customer table's CustomerId is <b>only</b> referenced in Order table (i.e. Customer information used for only Order purposes), you can use</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
CustomerId integer PRIMARY KEY,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE Order (
OrderID integer PRIMARY KEY,
CustomerId integer,
OrderDate date,
Status integer,
FOREIGN KEY (CustomerId) REFERENCES Customer (CustomerId)
) OPTIONS(UPDATABLE 'TRUE', "teiid_mongo:MERGE" 'Customer');
</pre>
</div></div>
<p>that will produce a single document for Customer table like</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
{
_id: 1,
FirstName: "John",
LastName: "Doe",
Order:
[
{
_id: 100,
CustomerId: 1,
OrderDate: ISODate("2000-01-01T06:00:00Z")
Status: 2
},
{
_id: 101,
CustomerId: 1,
OrderDate: ISODate("2001-03-06T06:00:00Z")
Status: 5
}
...
]
}
</pre>
</div></div>
<p>If Customer table is referenced in more tables other than Order table, then use "teiid_mongo:EMBEDDABLE" property</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
CustomerId integer PRIMARY KEY,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE', "teiid_mongo:EMBEDDABLE" 'TRUE');
CREATE FOREIGN TABLE Order (
OrderID integer PRIMARY KEY,
CustomerId integer,
OrderDate date,
Status integer,
FOREIGN KEY (CustomerId) REFERENCES Customer (CustomerId)
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE Comments (
CommentID integer PRIMARY KEY,
CustomerId integer,
Comment varchar(140),
FOREIGN KEY (CustomerId) REFERENCES Customer (CustomerId)
) OPTIONS(UPDATABLE 'TRUE');
</pre>
</div></div>
<p>This creates three different collections in MongoDB.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
Customer
{
_id: 1,
FirstName: "John",
LastName: "Doe"
}
Order
{
_id: 100,
CustomerId: 1,
OrderDate: ISODate("2000-01-01T06:00:00Z")
Status: 2
Customer:
{
_id: 1,
FirstName: "John",
LastName: "Doe"
}
}
Comment
{
_id: 12,
CustomerId: 1,
Comment: "This works!!!"
Customer:
{
_id: 1,
FirstName: "John",
LastName: "Doe"
}
}
</pre>
</div></div>
<p>Here as you can see the Customer table contents are embedded along with other table's data where they were referenced. This creates duplicated data where multiple of these embedded documents are managed automatically in the MongoDB translator.</p>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>All the SELECT, INSERT, DELETE operations that are generated against the tables with "teiid_mongo:EMBEDDABLE" property are atomic, except for UPDATES, as there can be multiple operations involved to update all the copies. Since there are no transactions in MongoDB, Teiid plans to provide automatic compensating transaction framework around this in future releases.</td></tr></table></div>
<h3><a name="MongoDBTranslator-MANY2ONEMapping."></a>MANY-2-ONE Mapping.</h3>
<p>This is same as ONE-2-MANY, see above to define relationships.</p>
<div class='panelMacro'><table class='tipMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/check.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>A parent table can have multiple "embedded" and as well as "merge" documents inside it, it not limited so either one or other. However, please note that MongoDB imposes document size is limited can not exceed 16MB.</td></tr></table></div>
<h3><a name="MongoDBTranslator-MANY2MANYMapping."></a>MANY-2-MANY Mapping.</h3>
<p>This can also mapped with combination of "teiid_mongo:MERGE" and "teiid_mongo:EMBEDDABLE" properties (partially). For example if DDL looks like</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Order (
OrderID integer PRIMARY KEY,
OrderDate date,
Status integer
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE OrderDetail (
OrderID integer,
ProductID integer,
PRIMARY KEY (OrderID,ProductID),
FOREIGN KEY (OrderID) REFERENCES Order (OrderID),
FOREIGN KEY (ProductID) REFERENCES Product (ProductID)
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE Products (
ProductID integer PRIMARY KEY,
ProductName varchar(40)
) OPTIONS(UPDATABLE 'TRUE');
</pre>
</div></div>
<p>you modify the DDL like below, to have </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Order (
OrderID integer PRIMARY KEY,
OrderDate date,
Status integer
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE OrderDetail (
OrderID integer,
ProductID integer,
PRIMARY KEY (OrderID,ProductID),
FOREIGN KEY (OrderID) REFERENCES Order (OrderID),
FOREIGN KEY (ProductID) REFERENCES Product (ProductID)
) OPTIONS(UPDATABLE 'TRUE', "teiid_mongo:MERGE" 'Order');
CREATE FOREIGN TABLE Products (
ProductID integer PRIMARY KEY,
ProductName varchar(40)
) OPTIONS(UPDATABLE 'TRUE', "teiid_mongo:EMBEDDABLE" 'TRUE');
</pre>
</div></div>
<p>That will produce a document like</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
{
_id : 10248,
OrderDate : ISODate("1996-07-04T05:00:00Z"),
Status : 5
OrderDetails : [
{
_id : {
OrderID : 10248,
ProductID : 11
Products : {
ProductID: 11
ProductName: "Hammer"
}
}
},
{
_id : {
OrderID : 10248,
ProductID : 14
Products : {
ProductID: 14
ProductName: "Screw Driver"
}
}
}
]
}
Products
{
{
ProductID: 11
ProductName: "Hammer"
}
{
ProductID: 14
ProductName: "Screw Driver"
}
}
</pre>
</div></div>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Limitations</b><br /><ul>
<li>Currently nested embedding of documents has limited support due to capabilities of handling nested arrays is limited in the MongoDB. Nesting of "EMBEDDALBLE" property with multiple levels is OK, however more than one level with MERGE is not. Also, you need to caution about not exceeding the document size of 16 MB for single row, so deep nesting is not recommended.</li>
<li>JOINS between related tables, MUST have used either of "EMBEDDABLE" or "MERGE" property, otherwise the query will result in error. In order for Teiid to correctly plan and support the JOINS, in the case that any two tables are <b>NOT</b> embedded in each other, use <em>allow-joins=false</em> property on the Foreign Key that represents the relation. For example:</li>
</ul>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN TABLE Customer (
CustomerId integer PRIMARY KEY,
FirstName varchar(25),
LastName varchar(25)
) OPTIONS(UPDATABLE 'TRUE');
CREATE FOREIGN TABLE Order (
OrderID integer PRIMARY KEY,
CustomerId integer,
OrderDate date,
Status integer,
FOREIGN KEY (CustomerId) REFERENCES Customer (CustomerId) OPTIONS (allow-join 'FALSE')
) OPTIONS(UPDATABLE 'TRUE');
</pre>
</div></div>
<p>with the example above, Teiid will create two collections, however when user issues query such as</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
SELECT OrderID, LastName FROM Order JOIN Customer ON Order.CustomerId = Customer.CustomerId;
</pre>
</div></div>
<p>instead of resulting in error, the JOIN processing will happen in the Teiid engine, without the above property it will result in an error.</p></td></tr></table></div>
<p>When you use above properties and carefully design the MongoDB document structure, Teiid translator can intelligently collate data based on their co-location and take advantage of it while querying. </p>
<h2><a name="MongoDBTranslator-Capabilities"></a>Capabilities</h2>
<p>MongoDB translator designed on top of the MongoDB aggregation framework, use of MongoDB version that supports this framework is mandatory. Apart from SELECT queries, this translator also supports INSERT, UPDATE and DELETE queries. </p>
<p>This translator supports</p>
<ul>
<li>grouping</li>
<li>matching</li>
<li>sorting</li>
<li>filtering</li>
<li>limit</li>
<li>support for LOBs using GridFS</li>
<li>Composite primary and foreign keys.</li>
</ul>
<div class='panelMacro'><table class='tipMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/check.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>example</b><br />For a full example see <a href="https://github.com/teiid/teiid/blob/master/connectors/translator-mongodb/src/test/resources/northwind.ddl" class="external-link" rel="nofollow">https://github.com/teiid/teiid/blob/master/connectors/translator-mongodb/src/test/resources/northwind.ddl</a></td></tr></table></div>
<h3><a name="MongoDBTranslator-NativeQueries"></a>Native Queries</h3>
<p>MongoDB source procedures may be created using the teiid_rel:native-query extension - see <a href="/author/display/TEIID/Translators#Translators-native">Parameterizable Native Queries</a>. The procedure will invoke the native-query similar to a direct procedure call with the benefits that the query is predetermined and that result column types are known, rather than requiring the use of ARRAYTABLE or similar functionality.</p>
<h4><a name="MongoDBTranslator-DirectQueryProcedure"></a><b>Direct Query Procedure</b></h4>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>This feature is turned off by default because of the security risk this exposes to execute any command against the source. To enable this feature, <a href="/author/display/TEIID/Translators#Translators-OverrideExecutionProperties">override the execution property</a> called <em>SupportsDirectQueryProcedure</em> to true.</td></tr></table></div>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>By default the name of the procedure that executes the queries directly is called <b>native</b>. <a href="/author/display/TEIID/Translators#Translators-OverrideExecutionProperties">Override the execution property</a> <em>DirectQueryProcedureName</em> to change it to another name.</td></tr></table></div>
<p>The MongoDB translator provides a procedure to execute any ad-hoc aggregate query directly against the source without Teiid parsing or resolving. Since the metadata of this procedure's results are not known to Teiid, they are returned as an object array containing single blob at array location one(1). This blob contains the JSON document. XMLTABLE can be used construct tabular output for consumption by client applications.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Example MongoDB Direct Query</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
select x.* from TABLE(call native('city;{$match:{"city":"FREEDOM"}}')) t,
xmltable('/city' PASSING JSONTOXML('city', cast(array_get(t.tuple, 1) as BLOB)) COLUMNS city string, state string) x
</pre>
</div></div>
<p>In the above example, a collection called "city" is looked up with filter that matches the "city" name with "FREEDOM", using "native" procedure and then using the nested tables feature the output is passed to a XMLTABLE construct, where the output from the procedure is sent to a JSONTOXML function to construct a XML then the results of that are exposed in tabular form.</p>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The direct query MUST be in the format
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
"collectionName;{$pipeline instr}+"
</pre>
</div></div></td></tr></table></div>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://docs.jboss.org/author/users/removespacenotification.action?spaceKey=TEIID">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://docs.jboss.org/author/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://docs.jboss.org/author/display/TEIID/MongoDB+Translator">View Online</a>
|
<a href="https://docs.jboss.org/author/pages/diffpagesbyversion.action?pageId=66486643&revisedVersion=23&originalVersion=22">View Changes</a>
|
<a href="https://docs.jboss.org/author/display/TEIID/MongoDB+Translator?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>