[teiid-commits] teiid SVN: r2003 - trunk/documentation/quick-start-example/src/main/docbook/en-US/content.
teiid-commits at lists.jboss.org
teiid-commits at lists.jboss.org
Thu Mar 25 18:08:37 EDT 2010
Author: rareddy
Date: 2010-03-25 18:08:37 -0400 (Thu, 25 Mar 2010)
New Revision: 2003
Modified:
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/buildvdb.xml
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/connect-vdb.xml
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/deployment.xml
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/download.xml
Log:
TEIID-833: fixing the quick start for 7.0 changes
Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/buildvdb.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/buildvdb.xml 2010-03-25 20:13:40 UTC (rev 2002)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/buildvdb.xml 2010-03-25 22:08:37 UTC (rev 2003)
@@ -24,8 +24,8 @@
<sect1 id="step-3">
<title>Building a VDB</title>
<para>Once you start the Designer, there are several steps you must perform to create a VDB. These steps are
- summarized in the following table. There is a video at the end of the
- list that will take you though all the steps involved.</para>
+ summarized in the following table. This is a <ulink url="../images/EmbeddedDesignerExampleVideo.swf">video</ulink>
+ will take you though all the steps involved. (please note this video is based on old version of Designer, a updated one coming soon..)</para>
<orderedlist>
<listitem>
<para>Switch to the Designer Perspective, by opening the "Window->Open Perspective.."</para>
@@ -61,16 +61,5 @@
<para>Export or copy the VDB for use in your application.</para>
</listitem>
</orderedlist>
- <!--
- <center>
- <OBJECT CLASSID="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" WIDTH="802" HEIGHT="687" CODEBASE="http://active.macromedia.com/flash5/cabs/swflash.cab#version=5,0,0,0">
- <PARAM NAME=movie VALUE="EmbeddedDesignerExampleVideo.swf">
- <PARAM NAME=play VALUE=true>
- <PARAM NAME=loop VALUE=false>
- <PARAM NAME=quality VALUE=low>
- <EMBED SRC="../images/EmbeddedDesignerExampleVideo.swf" WIDTH=802 HEIGHT=687 quality=low loop=false TYPE="application/x-shockwave-flash" PLUGINSPAGE="http://www.macromedia.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash"></EMBED>
- </OBJECT>
- </center>
- -->
</sect1>
</chapter>
\ No newline at end of file
Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/connect-vdb.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/connect-vdb.xml 2010-03-25 20:13:40 UTC (rev 2002)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/connect-vdb.xml 2010-03-25 22:08:37 UTC (rev 2003)
@@ -4,29 +4,26 @@
<title>Connecting to a VDB through JDBC</title>
<para>At this point you have deployed Teiid and your VDB. Now it's time to connect the sample application
to this VDB, issue SQL queries, and view the returned, integrated data. Note that
- this process is no different than connecting to any other JDBC source.</para>
+ this process is no different than connecting to any other JDBC source like Oracle.</para>
<sect1>
<title>Stand-alone Java Application Deployment</title>
<para>
For a Java application to connect to a JDBC source, it needs a URL, user-id, and password. To
connect to your VDB all you need is a URL and any additional optional properties that you would like to set.
- Teiid defaults to allowing the admin user with password teiid. Additional user accounts can be added through
- Teiid extensible MembershipDomain mechanism. A JDBC connection can be obtained through the Teiid driver
+ Teiid defaults to allowing the "admin" as user with password as "teiid". Additional user accounts can be added.
+ A JDBC connection can be obtained through the Teiid driver
<emphasis>"org.teiid.jdbc.TeiidDriver"</emphasis>
with the URL syntax of
</para>
<para>
- <emphasis>jdbc:teiid:<VDB-Name>@((mm|mms)://<host name>:<port>)|(<path to deploy.properties>)</emphasis>
+ <emphasis>jdbc:teiid:<VDB-Name>@(mm|mms)://<host name>:<port></emphasis>
</para>
- <para>When the path to deploy.properties is specified Teiid operates in
- embedded mode and runs in the same VM as the application.
- </para>
<para>
You can add optional properties at the end of the URL using a semi-colon(;) name=value
format. For example</para>
<para />
<para>
- <emphasis>jdbc:metamatrix:<VDB-Name>;dqp.logFile=/home/query.log</emphasis>
+ <emphasis>jdbc:teiid:<VDB-Name>@(mm|mms)://<host name>:<port>;autoCommitTxn=DETECT</emphasis>
</para>
<para />
<para>
@@ -87,7 +84,7 @@
To execute this demonstration, follow these steps:</para>
<orderedlist numeration="arabic">
<listitem><para>Ensure Derby is running</para></listitem>
- <listitem><para>Change to the /examples/portfolio directory within your Teiid installation</para></listitem>
+ <listitem><para>Change to the ${jboss-install}/server/profile/teiid-examples/portfolio directory</para></listitem>
<listitem><para>Execute the run script (either for Linux or Windows)</para></listitem>
</orderedlist>
<para>The sample query, "select * from CustomerAccount", queries the view model and, from that, queries the two underlying
@@ -101,6 +98,8 @@
<para>If your application is Web based, you can also deploy Teiid in an application server
and treat it as any other JDBC source by creating a connection pool with the
<emphasis>org.teiid.jdbc.TeiidDataSource</emphasis> and assigning it a JNDI name.
- Refer to <ulink url="https://www.jboss.org/community/docs/DOC-13183">deployment to application server</ulink> for more information.</para>
+ Refer to <ulink url="https://community.jboss.org/docs/DOC-13888">deployment to application server</ulink> for more information.
+ </para>
+ <note><para>"embedded" mode is only available in versions of Teiid up to 6.2</para></note>
</sect1>
</chapter>
\ No newline at end of file
Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/deployment.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/deployment.xml 2010-03-25 20:13:40 UTC (rev 2002)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/deployment.xml 2010-03-25 22:08:37 UTC (rev 2003)
@@ -2,16 +2,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="deployment">
<title>Deployment</title>
- <para> Having built the VDB, it must be deployed so it can be access through a JDBC connection.
- Note there are two steps involved in this deployment:</para>
- <orderedlist>
- <listitem>
- <para>Deploying Teiid</para>
- </listitem>
- <listitem>
- <para>Deploying a VDB</para>
- </listitem>
- </orderedlist>
+ <para> Having built the VDB, it must be deployed so it can be access through a JDBC connection.</para>
<para> Teiid is typically used in one of two manners:</para>
<itemizedlist>
<listitem>
@@ -33,11 +24,34 @@
<title>Stand-alone Application Deployment</title>
<orderedlist>
<listitem>
- <para>Add the "${teiid.home}/client/teiid-${version}-client.jar" to your application classpath</para>
+ <para>Add the "${jboss-install}/server/${profile}/lib/teiid-${version}-client.jar" to your application classpath</para>
</listitem>
<listitem>
- <para>Place your VDB in a the "${teiid.home}/deploy".
+ <para>
+ Before we can deploy the VDB to the server, we need to create and deploy the required Connector Bindings for Derby
+ and File sources. Connector bindings are JCA sources that provide the data then their data is integrated through Teiid. If you are
+ familiar with creating data sources or connection factories in JBoss AS, then this is exactly the same operation.
</para>
+
+ <para>For this example we need to create three (3) different data sources. You would first need to create a data source to Derby.
+ See ${teiid-examples}/portfolio/PortfolioModel/portfolio-ds.xml.
+ Then create Teiid specific connectors to Derby and File sources.
+ See ${teiid-examples}/portfolio/PortfolioModel/derby-connector-ds.xml
+ and ${teiid-examples}/portfolio/PortfolioModel/text-connector-ds.xml</para>
+
+ <para>The reason we created a data source and also a connector binding for Derby is, the data source provides a
+ JDBC connection to the portfolio database, and the connector binding provides a Teiid wrapper around
+ data source that understands execution and query translation defined by the Teiid runtime. The concerns about the
+ connection and Teiid access are separated into two different sources. So, the data source can be used by any other application
+ however the Teid connector is only used by the Teiid. This will be case for any JDBC
+ based sources. The same is not true for File source, because File Connector can access the resource directly itself.</para>
+ <para>To deploy these connector bindings copy the "-ds.xml" files into "${jboss-install}/server/{profile}/deploy" directory.
+ Make sure they are started correctly and you have supplied correct credentials for data source. </para>
+ </listitem>
+ <listitem>
+ <para>Place your VDB in a the "${jboss-install}/server/{profile}/deploy" directory. If the JBoss AS is not already
+ started, start by running the "${jboss-install}/bin/run.sh" or "${jboss-install}/bin/run.bat" scripts.
+ </para>
</listitem>
<listitem>
<para>
Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/download.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/download.xml 2010-03-25 20:13:40 UTC (rev 2002)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/download.xml 2010-03-25 22:08:37 UTC (rev 2003)
@@ -20,26 +20,20 @@
</listitem>
</orderedlist>
<para>
- For this Quick Start, download the
- <emphasis>Teiid Kit</emphasis>
- and extract this tar/zip file to a directory you can access.
+ For this Quick Start, download and install <ulink url="http://www.jboss.org/jbossas/downloads.html">JBoss AS 5.1.0</ulink>.
+ Then download <emphasis>Teiid</emphasis> runtime and unzip the contents of the Teiid under any of one of the JBoss AS profiles
+ like "default" or "all". For example in "<jboss-install>/server/default". The Teiid runtime directory structure matches that
+ of the JBoss profile directly, so you can just overlay the needed classes.
</para>
- <para>In the expanded directory, you will find "client/teiid-${version}-client.jar", which is the main client binary jar
- file for Teiid, and the "lib" and "extension" directories containing binaries either directly or indirectly
- required to execute Teiid. Later sections describe installing these artifacts.</para>
+ <para>In the "<jboss-install>/server/<profile>/lib" directory, you will find "teiid-${version}-client.jar", which
+ is the main client binary jar file for Teiid. This jar file contains the Teiid's JDBC driver and data source classes. </para>
<note>
- <para>Teiid requires <ulink url="http://java.sun.com/javase/downloads">Java 6</ulink> to run.
+ <para>JBoss AS requires <ulink url="http://java.sun.com/javase/downloads">Java 6</ulink> to run.
</para>
<para>
Access to physical data sources such as Oracle, MS-SQL Server, DB2, and Sybase through Teiid relies upon
- the user supplying their own JDBC drivers in the deployment. Teiid
- has been tested extensively with
- <ulink url="http://www.datadirect.com">DataDirect</ulink>
- If you have access to these JDBC drivers, we recommend their use.
+ the user supplying their own JDBC drivers in the deployment. Copy the JDBC driver files into
+ "<jboss-install>/server/<profile>/lib" before you create any data sources.
</para>
- <!--
- <para>Free open source software JDBC drivers for MySQL, Postgres,and Derby are included in the "lib" folder as the LGPL
- license permits them to be included with the Teiid kit.</para>
- -->
</note>
</chapter>
\ No newline at end of file
More information about the teiid-commits
mailing list