<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/Multi-Source+Models">Multi-Source Models</a></h2>
<h4>Page <b>edited</b> by <a href="https://docs.jboss.org/author/display/~shawkins">Steven Hawkins</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. Configuration <br> <br></td></tr>
<tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">To mark a model as multi-source, the model property _supports-multi-source_\-bindings needs set to true in the "vdb.xml" file. The model is then allowed to define more than one source. Here is a code example showing dynamic vdb with single model with multiple sources defined. <br></td></tr>
<tr><td class="diff-added-lines" style="background-color: #dfd;">To mark a model as multi-source, the model property _multisource_ can be set to true or more than one source can be listed for the model in the "vdb.xml" file. Here is a code example showing dynamic vdb with single model with multiple sources defined. <br></td></tr>
<tr><td class="diff-unchanged" > <br>{code:lang=XML}<vdb name="vdbname" version="1"> <br> <model visible="true" type="PHYSICAL" name="Customers" path="/Test/Customers.xmi"> <br></td></tr>
<tr><td class="diff-changed-lines" ><property <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">name="supports-multi-source-bindings"</span> <span class="diff-added-words"style="background-color: #dfd;">name="multisource"</span> value="true"/> <br></td></tr>
<tr><td class="diff-unchanged" > <!-- optional properties <br> <property name="multisource.columnName" value="somename"/> <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<p>Multi-source models can be used to quickly access data in multiple sources with homogeneous metadata. When you have multiple instances using identical schema (horizontal sharding), Teiid can help you gather data across all the instances, using "multi-source" models. In this scenario, instead of creating/importing a model for every data source, one source model is defined to represents the schema and is configured with multiple data "sources" underneath it. During runtime when a query issued against this model, the query engine analyzes the information and gathers the required data from all sources configured and gathers the results and provides in a single result. Since all sources utilize the same physical metadata, this feature is most appropriate for accessing the same source type with multiple instances.</p>
<h2><a name="Multi-SourceModels-Configuration"></a>Configuration</h2>
<p>To mark a model as multi-source, the model property <em>multisource</em> can be set to true or more than one source can be listed for the model in the "vdb.xml" file. Here is a code example showing dynamic vdb with single model with multiple sources defined.</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="vdbname" version="1">
<model visible="true" type="PHYSICAL" name="Customers" path="/Test/Customers.xmi">
<property name="multisource" value="true"/>
<!-- optional properties
<property name="multisource.columnName" value="somename"/>
<property name="multisource.addColumn" value="true"/>
-->
<source name="chicago"
translator-name="oracle" connection-jndi-name="chicago-customers"/>
<source name="newyork"
translator-name="oracle" connection-jndi-name="newyork-customers"/>
<source name="la"
translator-name="oracle" connection-jndi-name="la-customers"/>
</model>
</vdb></pre>
</div></div>
<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>Currently the tooling support for managing the multi-source feature is limited, so if you need to use this feature build the VDB as usual in the Teiid Designer and then edit the "vdb.xml" file in the VDB archive using a Text editor to add the additional sources as defined above. You must deploy a separate data source for each source defined in the xml file.</td></tr></table></div>
<p>In the above example, the VDB has a single model called <tt>Customers</tt>, that has multiple sources (<tt>chicago</tt>, <tt>newyork</tt>, and <tt>la</tt>) that define different instances of data.</p>
<h3><a name="Multi-SourceModels-TheMultisourceColumn"></a>The Multi-source Column</h3>
<p>When a model is marked as multi-source, the engine will add or use an existing column on each table to represent the source name values. In the above vdb.xml the column would return <tt>chicago</tt>, <tt>la</tt>, <tt>newyork</tt> for each of the respective sources. The name of the column defaults to SOURCE_NAME, but is configurable by setting the model property <b>multisource.columnName</b>. If a column already exists on the table (or an IN procedure parameter) with the same name, the engine will assume that it should represent the multi-source column and it will not be used to retrieve physical data. If the multi-source column is not present, the generated column will be treated as a pseudo column which is not selectable via wildcards (* nor tbl.*).</p>
<p>This allows queries like the following:</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 * from table where SOURCE_NAME = 'newyork'
update table column=value where SOURCE_NAME='chicago'
delete from table where column = x and SOURCE_NAME='la'
insert into table (column, SOURCE_NAME) VALUES ('value', 'newyork')
</pre>
</div></div>
<h4><a name="Multi-SourceModels-TheMultiSourceColumninSystemMetadata"></a>The Multi-Source Column in System Metadata</h4>
<p>The pseudo column is by default not present in your actual metadata; it is not added on source tables/procedures when you import the metadata. If you would like to use the multi-source column in your transformations to control which sources are accessed or updated and/or want the column reported via metadata facilities, there are several options: </p>
<ul>
<li>With either VDB type to make the multi-source column present in the system metadata, you may set the model property <b>multisource.addColumn</b> to true on a multi-source model. Care should be taken though when using this property in Designer as any transformation logic (views/procedures) that you have defined will not have been aware of the multisource column and may fail validation upon server deployment.</li>
<li>If using Designer, you can manually add the multi-source column. </li>
<li>If using Dynamic VDBs, the pseduo-column will already be available to transformations, but will not be present in your System metadata by default. If using DDL and want to be selective (rather than using the <b>multisource.addColumn</b> property), you can manually add the column via DDL. </li>
</ul>
<h2><a name="Multi-SourceModels-PlanningandExecution"></a>Planning and Execution</h2>
<p>The planner logically treats a multi-source table as if it were a view containing the union all of the respective source tables. More complex partitioning scenarios, such as heterogeneous sources or list partitioning will require the use of a <a href="/author/display/TEIID/Federated+Optimizations#FederatedOptimizations-PartitionedUnion">Federated Optimizations#Partitioned Union</a>.</p>
<p>Most of the federated optimizations available over unions are still applicable in multi-source mode. This includes aggregation pushdown/decomposition, limit pushdown, join partitioning, etc.</p>
<h3><a name="Multi-SourceModels-SELECTs%2CUPDATEs%2CDELETEs"></a>SELECTs, UPDATEs, DELETEs</h3>
<ul class="alternate" type="square">
<li>A multi-source query against a SELECT/UPDATE/DELETE may affect any subset of the sources based upon the evaluation of the WHERE clause.</li>
</ul>
<ul class="alternate" type="square">
<li>The multi-source column may not be targeted in an update change set.</li>
</ul>
<ul class="alternate" type="square">
<li>The sum of the update counts for UPDATEs/DELETEs will be returned as the resultant update count.</li>
</ul>
<ul class="alternate" type="square">
<li>When running under a transaction in a mode that detects the need for a transaction and multiple updates may performed or a transactional read is required and multiple sources may be read from, a transaction will be started to enlist each source.</li>
</ul>
<h3><a name="Multi-SourceModels-INSERTs"></a>INSERTs</h3>
<ul class="alternate" type="square">
<li>A multi-source INSERT must use the source_name column as an insert column to specify which source should be targeted by the INSERT. Only an INSERT using the VALUES clause is supported.</li>
</ul>
<h3><a name="Multi-SourceModels-StoredProcedures"></a>Stored Procedures</h3>
<p>A physical stored procedures requires the addition of a string in parameter matching the multi-source column name to specify which source the procedure is executed on. If the parameter is not present and defaults to a null value, then the procedure will be executed on each source. It is not possible to execute procedures that are required to return IN/OUT, OUT, or RETURN parameters values on more than 1 source.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Example DDL</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN PROCEDURE PROC (arg1 IN STRING NOT NULL, arg2 IN STRING, SOURCE_NAME IN STRING)
</pre>
</div></div>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Example Calls Against A Single Source</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CALL PROC(arg1=>'x', SOURCE_NAME=>'sourceA')
EXEC PROC('x', 'y', 'sourceB')
</pre>
</div></div>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Example Calls Against All Sources</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CALL PROC(arg1=>'x')
EXEC PROC('x', 'y')
</pre>
</div></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/Multi-Source+Models">View Online</a>
|
<a href="https://docs.jboss.org/author/pages/diffpagesbyversion.action?pageId=18646287&revisedVersion=8&originalVersion=7">View Changes</a>
|
<a href="https://docs.jboss.org/author/display/TEIID/Multi-Source+Models?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>