From teiid-commits at lists.jboss.org Thu Mar 25 18:08:37 2010 Content-Type: multipart/mixed; boundary="===============4299064938119623936==" MIME-Version: 1.0 From: teiid-commits at lists.jboss.org To: teiid-commits at lists.jboss.org Subject: [teiid-commits] teiid SVN: r2003 - trunk/documentation/quick-start-example/src/main/docbook/en-US/content. Date: Thu, 25 Mar 2010 18:08:37 -0400 Message-ID: <201003252208.o2PM8bcX005020@svn01.web.mwc.hst.phx2.redhat.com> --===============4299064938119623936== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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/b= uildvdb.xml trunk/documentation/quick-start-example/src/main/docbook/en-US/content/c= onnect-vdb.xml trunk/documentation/quick-start-example/src/main/docbook/en-US/content/d= eployment.xml trunk/documentation/quick-start-example/src/main/docbook/en-US/content/d= ownload.xml Log: TEIID-833: fixing the quick start for 7.0 changes Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/co= ntent/buildvdb.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- 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 @@ Building a VDB Once you start the Designer, there are several steps you must pe= rform 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. + summarized in the following table. This is a video = + will take you though all the steps involved. (please note this video i= s based on old version of Designer, a updated one coming soon..) Switch to the Designer Perspective, by opening the "Window->= Open Perspective.." @@ -61,16 +61,5 @@ Export or copy the VDB for use in your application. - \ No newline at end of file Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/co= ntent/connect-vdb.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- 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 @@ Connecting to a VDB through JDBC 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.= + this process is no different than connecting to any other JDBC source = like Oracle. Stand-alone Java Application Deployment 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 optiona= l properties that you would like to set. - Teiid defaults to allowing the admin user with password teiid. Add= itional 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 "te= iid". Additional user accounts can be added. + A JDBC connection can be obtained through the Teiid driver "org.teiid.jdbc.TeiidDriver" with the URL syntax of - jdbc:teiid:<VDB-Name>@((mm|mms)://<host name>:= <port>)|(<path to deploy.properties>) + jdbc:teiid:<VDB-Name>@(mm|mms)://<host name>:&= lt;port> - When the path to deploy.properties is specified Teiid operates in - embedded mode and runs in the same VM as the application. - You can add optional properties at the end of the URL using a semi-colon= (;) name=3Dvalue format. For example - jdbc:metamatrix:<VDB-Name>;dqp.logFile=3D/home/query= .log + jdbc:teiid:<VDB-Name>@(mm|mms)://<host name>:&= lt;port>;autoCommitTxn=3DDETECT @@ -87,7 +84,7 @@ To execute this demonstration, follow these steps: = Ensure Derby is running - Change to the /examples/portfolio directory within you= r Teiid installation + Change to the ${jboss-install}/server/profile/teiid-ex= amples/portfolio directory Execute the run script (either for Linux or Windows) The sample query, "select * from CustomerAccount", queries the v= iew model and, from that, queries the two underlying @@ -101,6 +98,8 @@ 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 = org.teiid.jdbc.TeiidDataSource and assigning it a J= NDI name. = - Refer to d= eployment to application server for more information. + Refer to deplo= yment to application server for more information. = + + "embedded" mode is only available in versions of Teiid up to= 6.2 = \ No newline at end of file Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/co= ntent/deployment.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- 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 @@ Deployment - Having built the VDB, it must be deployed so it can be access thr= ough a JDBC connection. - Note there are two steps involved in this deployment: - - - Deploying Teiid - - - Deploying a VDB - - + Having built the VDB, it must be deployed so it can be access thr= ough a JDBC connection. Teiid is typically used in one of two manners: @@ -33,11 +24,34 @@ Stand-alone Application Deployment - Add the "${teiid.home}/client/teiid-${version}-client.jar" t= o your application classpath + Add the "${jboss-install}/server/${profile}/lib/teiid-${vers= ion}-client.jar" to your application classpath - Place your VDB in a the "${teiid.home}/deploy". = + + 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 JBo= ss AS, then this is exactly the same operation. = + = + 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.x= ml + = + The reason we created a data source and also a connector bin= ding for Derby is, the data source provides a = + JDBC connection to the portfolio database, and the connector bindi= ng provides a Teiid wrapper around = + data source that understands execution and query translation defin= ed by the Teiid runtime. The concerns about the + connection and Teiid access are separated into two different sourc= es. So, the data source can be used by any other application + however the Teid connector is only used by the Teiid. This will b= e case for any JDBC + based sources. The same is not true for File source, because File = Connector can access the resource directly itself. + 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. + = + + Place your VDB in a the "${jboss-install}/server/{profile}/d= eploy" 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. + Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/co= ntent/download.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- 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 @@ - For this Quick Start, download the - Teiid Kit - and extract this tar/zip file to a directory you can access. + For this Quick Start, download and install JBoss AS 5.1.0. = + Then download Teiid runtime and unzip the content= s 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 clas= ses. - 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 b= inaries either directly or indirectly - required to execute Teiid. Later sections describe installing these ar= tifacts. + In the "<jboss-install>/server/<profile>/lib" director= y, you will find "teiid-${version}-client.jar", which = + is the main client binary jar file for Teiid. This jar file contains t= he Teiid's JDBC driver and data source classes. - Teiid requires Java 6 to run. + JBoss AS requires Java 6 to run. 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 - DataDirect - If you have access to these JDBC drivers, we recommend their use. + the user supplying their own JDBC drivers in the deployment. Copy th= e JDBC driver files into = + "<jboss-install>/server/<profile>/lib" before you create= any data sources. - \ No newline at end of file --===============4299064938119623936==--