[teiid-commits] teiid SVN: r3082 - in trunk/documentation/quick-start-example/src/main/docbook/en-US: content and 1 other directory.
teiid-commits at lists.jboss.org
teiid-commits at lists.jboss.org
Mon Apr 11 11:36:29 EDT 2011
Author: vhalbert at redhat.com
Date: 2011-04-11 11:36:29 -0400 (Mon, 11 Apr 2011)
New Revision: 3082
Added:
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/datasources.xml
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
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/example-explained.xml
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/preface.xml
trunk/documentation/quick-start-example/src/main/docbook/en-US/quick_start_example.xml
Log:
TEIID-1519 - updated the quick-start and how it uses the dynamicvdb-portfolio and the HSQL database, instead of Derby.
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 2011-04-11 15:34:06 UTC (rev 3081)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/buildvdb.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -1,36 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="step-3">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<chapter id="buildVDB">
<title>Building a VDB</title>
- <para>A VDB can be built with either the <ulink url="http://www.jboss.org/teiiddesigner.html">Designer</ulink> tool or through a
- simple XML file called a dynamic VDB. See the "dyanmicvdb-portolio" for an example dynamic VDB.
- for this example purpose we will use the a dynamic VDB. If you would like to use the
- Designer to build your VDB, check out the Designer examples. If you need to build any view layers using your source,
- you must use Designer based approach to building the VDB. A sample Designer based VDB is
- available in the "teiid-examples/dynamicvdb-portfolio/PortfolioModel" directory.</para>
-
+
+ <para>A VDB can be built with either the <ulink
+ url="http://www.jboss.org/teiiddesigner.html">Designer</ulink> tool or
+ through a simple XML file called a dynamic VDB. See the
+ "dyanmicvdb-portolio" for an example dynamic VDB. For this example we will
+ use the dynamic VDB. If you would like to use the Designer to build your
+ VDB, check out the Designer examples. If you need to build any view layers
+ using your source, you must use the Designer based approach to building the
+ VDB. A sample Designer based VDB is available in the
+ "teiid-examples/dynamicvdb-portfolio/PortfolioModel" directory.</para>
+
<section id="dynamic_vdb">
- <title>Building Dynamic VDB</title>
- <para>This XML file is defines a set of sources that need to treated as single source by the client application.
- Dynamic VDB does not yet allow for the creation of view layers. Below XML file defines "dynamicvdb-portfolio" example
- vdb.</para>
- <para>portfolio-vdb.xml (copy available in "teiid-examples/dynamicvdb-portfolio" directory)</para>
- <programlisting><![CDATA[
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<vdb name="DynamicPortfolio" version="1">
+ <title>Building Dynamic VDB</title>
- <description>A Dynamic VDB</description>
+ <para>This XML file defines a set of sources that can be accessed by the
+ client application. A dynamic VDB does not yet allow for the creation of
+ view layers. Below is the "dynamicvdb-portfolio" example vdb.</para>
+
+ <para>portfolio-vdb.xml (copy available in
+ "teiid-examples/dynamicvdb-portfolio" directory)</para>
+
+ <programlisting>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<vdb name="DynamicPortfolio" version="1">
+
+ <description>A Dynamic VDB</description>
- <!--
+ <!--
Setting to use connector supplied metadata. Can be "true" or "cached".
"true" will obtain metadata once for every launch of Teiid.
"cached" will save a file containing the metadata into
- the deploy/<vdb name>/<vdb version/META-INF directory
- -->
- <property name="UseConnectorMetadata" value="cached" />
+ the deploy/<vdb name>/<vdb version/META-INF directory
+ -->
+ <property name="UseConnectorMetadata" value="true" />
- <!--
+ <!--
Each model represents a access to one or more sources.
The name of the model will be used as a top level schema name
for all of the metadata imported from the connector.
@@ -38,50 +47,74 @@
NOTE: Multiple model, with different import settings, can be bound to
the same connector binding and will be treated as the same source at
runtime.
- -->
- <model name="MarketData">
- <!--
+ -->
+ <model name="MarketData">
+ <!--
Each source represents a translator and data source. There are
pre-defined translators, or you can create one. ConnectionFactories
or DataSources in JBoss AS they are typically defined using "xxx-ds.xml" files.
- -->
- <source name="text-connector" translator-name="file" connection-jndi-name="java:marketdata-file"/>
- </model>
+ -->
+ <source name="text-connector" translator-name="file" connection-jndi-name="java:marketdata-file"/>
+ </model>
- <model name="Accounts">
- <!--
+ <model name="Accounts">
+ <!--
JDBC Import settings
importer.useFullSchemaName directs the importer to drop the source
schema from the Teiid object name, so that the Teiid fully qualified name
- will be in the form of <model name>.<table name>
- -->
- <property name="importer.useFullSchemaName" value="false"/>
+ will be in the form of <model name>.<table name>
+ -->
+ <property name="importer.useFullSchemaName" value="false"/>
- <!--
- This connector is defined in the "derby-connector-ds.xml"
- -->
- <source name="derby-connector" translator-name="derby" connection-jndi-name="java:PortfolioDS"/>
- </model>
+ <!--
+ This connector is defined in the "portfoio-ds.xml"
+ -->
+ <source name="hsql-connector" translator-name="hsql" connection-jndi-name="java:PortfolioDS"/>
+ </model>
-</vdb>
- ]]></programlisting>
-
- <para>The XML file is explained below.</para>
+</vdb>
+ </programlisting>
+ </section>
+
+ <section>
+ <title>Dynamic VDB XML Structure</title>
+
+ <para>The above vdb XML structure is explained.</para>
+
<orderedlist>
- <listitem><para>The above XML file defines a "vdb" with name "DynamicPortfolio" with version "1"</para></listitem>
- <listitem><para>A "model" XML element represents a schema that being integrated. This sample
- defines two sources, "MarketData" that represents the schema for the text file that has the
- stock price information and "Accounts" that represents the "portfolio" schema in the Derby database.
- </para></listitem>
- <listitem><para>The "source" element inside the "model" element defines name of the source (can be any name), and
- name of the translator (defines the type of the source like oracle, db2, mysql, h2, file, ws etc..) and the
- "connection-jndi-name" defines the source's JNDI name in the JBoss AS container.</para></listitem>
- <listitem><para>Also note that inside the "model" elements, some "property" elements are used to define how
- metadata can be imported from source. For more information check out the Reference Guide's Dynamic VDB section.</para></listitem>
- <listitem><para>Note that you need to also create the necessary deployment
- files for the data sources (Connection Factories) too.</para></listitem>
+ <listitem>
+ <para>The "vdb" element defines the virtualdatase that has a name of
+ "DynamicPortfolio" with version "1"</para>
+ </listitem>
+
+ <listitem>
+ <para>A "model" element represents a schema that being integrated.
+ This sample defines two sources, "MarketData" that represents the
+ schema for the text file that has the stock price information and
+ "Accounts" that represents the "portfolio" schema in the HSQL
+ database.</para>
+ </listitem>
+
+ <listitem>
+ <para>The "source" element inside the "model" element defines name of
+ the source (can be any name), and name of the translator (defines the
+ type of the source like oracle, db2, mysql, h2, file, ws etc..) and
+ the "connection-jndi-name" defines the source's JNDI name in the JBoss
+ AS container.</para>
+ </listitem>
+
+ <listitem>
+ <para>Also note that inside the "model" elements, some "property"
+ elements are used to define how metadata can be imported from source.
+ For more information check out the Reference Guide's Dynamic VDB
+ section.</para>
+ </listitem>
+
+ <listitem>
+ <para>Note that you need to also create the necessary deployment files
+ for the data sources (Connection Factories) too.</para>
+ </listitem>
</orderedlist>
-
</section>
-</chapter>
\ No newline at end of file
+</chapter>
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 2011-04-11 15:34:06 UTC (rev 3081)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/connect-vdb.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -83,7 +83,6 @@
<para>The Teiid installation includes a simple Java class which demonstrates JDBC access of the deployed VDB.
To execute this demonstration, follow these steps:</para>
<orderedlist numeration="arabic">
- <listitem><para>Ensure Derby is running</para></listitem>
<listitem><para>Change to the ${jboss-install}/server/profile/teiid-examples/simpleclient directory</para></listitem>
<listitem><para>Execute the run script (either for Linux or Windows)</para></listitem>
</orderedlist>
@@ -92,7 +91,7 @@
VDB, but also the SYS schema tables.
</para>
- <para>If your application is Web based, you can create data source for your VDB using the above and treat it as any other JDBC source using
+ <para>If your application is Web based, you can create data source for your VDB using the above and treat it as any other JDBC source using
<code>org.teiid.jdbc.TeiidDataSource</code> and assigning it a JNDI name.
Refer to Client Developer's Guide deployment for more information on creating a DataSource.
</para>
Added: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/datasources.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/datasources.xml (rev 0)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/datasources.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % CustomDTD SYSTEM "../../../../../../docbook/custom.dtd">
+%CustomDTD;
+]>
+<chapter id="setupDS">
+ <title>Setup Data Sources / Connection Factories</title>
+
+ <section id="setup-1">
+ <title>Install Data Sources / Connection Factories</title>
+
+ <para>This examples uses two data sources, a relational database and a
+ text file. An HSQL database is used here since it is Open Source, comes
+ with JBoss AS and is light-weight. This section will describe how to setup
+ the data sources in order to run the example.</para>
+
+ <para>We need to create and deploy the required Connection Factories for
+ HSQL database and File sources. Connection Factories are sources that
+ provide the data when 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>Perform the following steps to install and setup the data
+ sources:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Copy the following files from
+ "teiid-examples/dynamicvdb-portfolio" directory to the
+ "<jboss-install>/server/default/deploy" directory</para>
+
+ <para>(1) portfolio-ds.xml</para>
+
+ <para>(2) marketdata-file-ds.xml</para>
+ </listitem>
+
+ <listitem>
+ <para>If the server has not been started, start it</para>
+ </listitem>
+
+ <listitem>
+ <para>Using a web browser, goto the JMX console
+ (http://localhost:8080/jmx-console/) and select:
+ <emphasis>database-portfolioDB,service=PortfolioService</emphasis> to
+ present the bean options.</para>
+ </listitem>
+
+ <listitem>
+ <para>Now click invoke "startDatabaseManager" to bring up HSQL
+ Database Manager</para>
+ </listitem>
+
+ <listitem>
+ <para>Use the File/Open Script menu option to load the
+ customer-schema.sql script located in
+ "teiid-examples/dynamicvdb-portfolio"</para>
+ </listitem>
+
+ <listitem>
+ <para>Click the Execute SQL button to create the required tables and
+ insert the example data</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Make sure you did not have any issues when creating the schema as it
+ is needed for going forward in this example.</para>
+ </section>
+
+ <section id="setup-2">
+ <title>Describe the CSV file and its contents</title>
+
+ <para>In order to use a Text file as the source, we need a data file which
+ defines the data in the table</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Data File: Each data file contains column information for the
+ table. The column information is typically defined on line 1 as header
+ line in the file, and all the following lines contain the actual rows
+ of data. Each single line corresponds to single row. A portion of the
+ sample file is shown below. The complete sample file is
+ "teiid-examples/dynamicvdb-portfolio/data/marketdata-price.txt".</para>
+
+ <programlisting>
+ SYMBOL,PRICE
+ IBM,83.46
+ RHT,11.84
+ BA, 44.58
+ ORCL,17.37
+
+ </programlisting>
+ </listitem>
+ </orderedlist>
+
+ <para>You can use the provide data files or create your own data
+ files.</para>
+
+ <para>At this point, both data sources are ready to access.</para>
+ </section>
+</chapter>
Property changes on: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/datasources.xml
___________________________________________________________________
Added: svn:mime-type
+ text/plain
Added: svn:keywords
+ Id Revision
Added: svn:eol-style
+ LF
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 2011-04-11 15:34:06 UTC (rev 3081)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/deployment.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -1,43 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<!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 into Teiid server, so it can be accessed through a JDBC connection.</para>
+ <title>VDB Deployment</title>
- <para />
- <para>This example deploys Teiid within a JBoss AS. The sample deployment is shown below.
- You can find more details about deploying to application servers on the Teiid web-site</para>
- <para />
- <section id="teiid-runtime">
- <title>JBoss AS Application Deployment</title>
-
- <orderedlist>
- <listitem>
- <para>
- Before we can deploy the VDB to the server, we need to create and deploy the required Connection Factories for Derby
- and File sources. Connection Factories are 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>Access to Derby first requires that the the Derby client jar (${derby-install}/lib/derbyclient.jar) be placed in the ${jboss-install}/server/{profile}/lib directory.</para>
-
- <para>See or copy the following:</para>
- <programlisting><![CDATA[${teiid-examples}/dynamicvdb-portfolio/portfolio-ds.xml
-${teiid-examples}/dynamicvdb-portfolio/marketdata-file-ds.xml]]> </programlisting>
- <para>files into "${jboss-install}/server/{profile}/deploy" directory to create the Derby and File data sources respectively.</para>
- </listitem>
- <listitem>
- <para>The above data sources provide the data to your VDB. Now to deploy your VDBl place your VDB file (either the dynamicvdb-portfolio/portfolio-vdb.xml file or the full .vdb file) 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.
- Check the logs or the console to make sure there were no errors during the deployment of the VDB.
- </para>
- </listitem>
- <listitem>
- <para>
- Now, go to the next section to learn how to
- <link linkend="OpenConnection">connect to the VDB</link>
- </para>
- </listitem>
- </orderedlist>
- </section>
-</chapter>
\ No newline at end of file
+ <para>Having built the VDB or using the example dynamic vdb, it must be
+ deployed into the JBoss AS server so it can be accessed using a Teiid JDBC
+ connection.</para>
+
+ <para></para>
+
+ <para>This example is using the dynamic vdb and requires that it be deployed
+ into the JBoss AS server. To deploy the vdb, copy the following file into
+ "<emphasis><jboss-install>/server/default/deploy</emphasis>"
+ directory:</para>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>teiid-examples/dynamicvdb-portfolio/portfolio-vdb.xml</para>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+
+ <para>Now, go to the next section to learn how to <link
+ linkend="OpenConnection">connect to the VDB.</link></para>
+
+ <para></para>
+</chapter>
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 2011-04-11 15:34:06 UTC (rev 3081)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/download.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -1,41 +1,52 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % CustomDTD SYSTEM "../../../../../../docbook/custom.dtd">
%CustomDTD;
]>
<chapter id="download">
<title>Download</title>
- <para>
- You need to download the binaries for
- <ulink url="http://www.jboss.org/teiid/downloads.html">Teiid</ulink>
- . Note that there are three different artifacts are available for download.
- </para>
+
+ <para>You need to download the binaries for <ulink
+ url="http://www.jboss.org/teiid/downloads.html">Teiid</ulink> . Note that
+ there are three different artifacts are available for download.</para>
+
<orderedlist>
<listitem>
<para>Teiid Source - contains all of the source code</para>
</listitem>
+
<listitem>
<para>Teiid AdminShell - contains the admin client</para>
</listitem>
+
<listitem>
<para>Teiid Runtime - contains the Teiid engine and required 3rd party
- dependencies</para>
+ dependencies</para>
</listitem>
</orderedlist>
- <para>
- For this Quick Start, download and install <ulink url="http://www.jboss.org/jbossas/downloads.html">JBoss AS 5.1.0</ulink>.
- Then download the Teiid runtime and unzip the contents under any of the JBoss AS profiles, such as "default" or "all".
- The default profile is the typical installation location, for example "<jboss-install>/server/default". The Teiid runtime directory structure matches JBoss profiles directly - it is just an overlay.
- </para>
- <para>In the "<jboss-install>/server/<profile>/lib" directory, you will find "teiid-&versionNumber;-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>
+
+ <para>For this Quick Start, download and install <ulink
+ url="http://www.jboss.org/jbossas/downloads.html">JBoss AS 5.1.0</ulink>.
+ Then download the Teiid runtime and unzip the contents under any of the
+ JBoss AS profiles, such as "default" or "all". The default profile is the
+ typical installation location, for example
+ "<jboss-install>/server/default". The Teiid runtime directory
+ structure matches JBoss profiles directly - it is just an overlay.</para>
+
+ <para>In the "<jboss-install>/server/<profile>/lib" directory,
+ you will find "teiid-&versionNumber;-client.jar", which is the main client
+ binary jar file for Teiid. This jar file contains the Teiid's JDBC driver
+ and data source driver jar's.</para>
+
<note>
- <para>JBoss AS 5.1 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. Copy the JDBC driver files into
- "<jboss-install>/server/<profile>/lib" before you create any data sources.
- </para>
+ <para>JBoss AS 5.1 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. Copy the JDBC driver files into
+ "<jboss-install>/server/<profile>/lib" before you create any
+ data sources.</para>
</note>
-</chapter>
\ No newline at end of file
+</chapter>
Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/example-explained.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/example-explained.xml 2011-04-11 15:34:06 UTC (rev 3081)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/example-explained.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -1,123 +1,57 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="example-explained">
- <title>Example Explained</title>
+ <title>Portfolio Example Explained</title>
+
<section>
- <title>Portfolio Application Explained</title>
- <para>
- The investor's portfolio information is stored in a Derby database and
- "current" stock prices are stored in a delimited text file. When the VDB is completed, a single query will cause
- Teiid to access the relational and non-relational sources, calculate the portfolio values, and
- return the results.
- </para>
+ <para>The investor's portfolio example information is stored in a HSQL
+ database and "current" stock prices are stored in a delimited text file.
+ When the VDB is completed, a single query will cause Teiid to access the
+ relational and non-relational sources, calculate the portfolio values, and
+ return the results.</para>
+
<figure id="steps">
<title>Various Steps involved in creating the example</title>
- <graphic align="center" scale="100" fileref="../images/steps-defined.png" />
+
+ <graphic align="center" fileref="../images/steps-defined.png"
+ scale="100" />
</figure>
+
<itemizedlist>
<listitem>
<para>
- <link linkend="step-1">Step-1: Create the Relational Database's schema and load the sample data</link>
+ <link linkend="setupDS">Step-1: Setup Data Sources /
+ ConnectionFactories</link>
</para>
</listitem>
+
<listitem>
<para>
- <link linkend="step-2">Step-2: Describe the CSV file and its contents</link>
+ <link linkend="buildVDB">Step-3: Build a VDB</link>
</para>
</listitem>
+
<listitem>
<para>
- <link linkend="step-3">Step-3: Build a VDB</link>
+ <link linkend="deployment">Step-4: Deploy the VDB in JBoss AS</link>
</para>
</listitem>
+
<listitem>
<para>
- <link linkend="deployment">Step-4: Deploy the VDB in Teiid</link>
+ <link linkend="OpenConnection">Step-5: Access the VDB using the JDBC
+ API</link>
</para>
</listitem>
- <listitem>
- <para>
- <link linkend="OpenConnection">Step-5: Access the VDB using the JDBC API</link>
- </para>
- </listitem>
</itemizedlist>
</section>
+
<note>
- <para>
- <ulink url="http://db.apache.org/derby/">Derby</ulink>
- is used here since it is Open Source, easily obtained, and light-weight. You can substitute any other relational
- database, as long as you have a suitable JDBC driver. The schema file provided, and described below, is
- specific to Derby, but can be easily converted for use with other databases.
- </para>
+ <para>HSQL database is used here since it is Open Source and comes with
+ JBoss AS and is light-weight. You can substitute any other relational
+ database, as long as you have a suitable JDBC driver. The schema file
+ provided, and described below, is specific to HSQL, but can be easily
+ converted for use with other databases.</para>
</note>
- <section id="step-1">
- <title>Create the Relational Database's schema and load the sample data</title>
- <para>
- This example is written using
- <ulink url="http://db.apache.org/derby/">"Derby"</ulink>
- as the relational database.
- <ulink url="http://db.apache.org/derby/derby_downloads.html">Download</ulink>
- and install Derby on your machine. An existing local or remote instance can be used if it exists.
- </para>
- <para>We need to start the Derby RDBMS and create the "accounts" database with the below schema. These
- commands are intended for a Linux environment. For starting the Derby instance on another platform, you will need to use
- commands appropriate to that platform.</para>
- <para>Start a terminal session, and change directory to where
- Derby is installed and execute following commands</para>
- <programlisting><![CDATA[export DERBY_HOME=`pwd`
-./bin/startNetworkServer]]>
- </programlisting>
- <para>This starts the Derby in network mode. Now, start another terminal and we will use Derby''s 'ij' tool
- (like SQL*PLus for Oracle) to create the schema, using the "customer-schema.sql" file in
- "examples/dynamicvdb-portfolio" directory</para>
- <programlisting><![CDATA[export DERBY_HOME=`pwd`
-./bin/ij /path/to/customer-schema.sql]]>
- </programlisting>
- <para>This will create the accounts schema. It's abbreviated ddl is shown below. </para>
- <programlisting><![CDATA[--Contains the name and address of a Customer who owns portfolio account
-CREATE TABLE CUSTOMER
-...
-
---Contains Customer's account number and its current status
-CREATE TABLE ACCOUNT
-...
-
---Contains information about stock symbol, company name etc.
-CREATE TABLE PRODUCT
-...
-
---Contains each Account's holdings of Stocks
-CREATE TABLE HOLDINGS
-...]]></programlisting>
-
- <para>
- Make sure you did not have any issues when creating the schema as it is needed for going forward in this example.
- You can use 'ij' tool to verify the tables were created. As an alternative, you may use other tools like
- <ulink url="http://www.squirrelsql.org/">SQuirreL</ulink>
- , or
- <ulink url="http://www.eclipse.org/datatools/">Eclipse's Data Tools</ulink>
- plugin to connect to the Derby instance to check the schema and sample data.
- </para>
- </section>
- <section id="step-2">
- <title>Describe the CSV file and its contents</title>
- <para>In order to use a Text file as the source, we need a data file defines data inside a table</para>
- <orderedlist>
- <listitem>
- <para>Data File: Each data file contains column information for the table. The
- column information is typically defined on line 1 as header line in the file, and all the following lines
- contain the actual rows of data. Each single line corresponds to single row. A portion of the sample file
- is shown below. The complete sample file is "examples/dynamicvdb-portfolio/marketdata-price.txt".</para>
- <programlisting><![CDATA[
- SYMBOL,PRICE
- IBM,83.46
- RHT,11.84
- BA, 44.58
- ORCL,17.37
- ]]>
- </programlisting>
- </listitem>
- </orderedlist>
- <para>Just locate the sample data files provided or create your own data files. Now, both our sources are ready.</para>
- </section>
-</chapter>
\ No newline at end of file
+</chapter>
Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/preface.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/preface.xml 2011-04-11 15:34:06 UTC (rev 3081)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/preface.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -1,47 +1,60 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<preface>
<title>Preface</title>
- <section>
+
+ <section>
<title>What is Teiid?</title>
- <para>Teiid is runtime for executing queries against a Virtual Database or VDB. Before you can access your data in a federated
- manner, use can use Teiid Designer or the Dynamic VDB feature to build a VDB. This picture shows the relationship between the tools
- involved.</para>
+
+ <para>Teiid is runtime for executing queries against a Virtual Database or
+ VDB. Before you can access your data in a federated manner, user can use
+ Teiid Designer or the Dynamic VDB feature to build a VDB. This picture
+ shows the relationship between the tools involved.</para>
+
<figure id="lifecycle">
<title>Lifecycle of Events</title>
- <graphic align="center" scale="100" fileref="../images/steps.png" />
+
+ <graphic align="center" fileref="../images/steps.png" scale="100" />
</figure>
+
<section>
- <title>What is a Virtual Database?</title>
- <para> A Virtual Database (VDB) is an artifact that combines one or more
- physical data sources to provide for easy data integration. Integration is encapsulated through view and procedures that Teiid will process in an optimized way against their respective sources.
- The physical sources can be JDBC sources, delimited text files, spreadsheets, or even Web services.</para>
- </section>
-
- <para>The Teiid Designer tool lets you define physical data sources by importing the required metadata
- (schema) from these sources. Once the metadata is imported, Designer can assist in building additional view layers.
- The collection of physical and view models will form a VDB.</para>
+ <title>What is a Virtual Database?</title>
+
+ <para>A Virtual Database (VDB) is an artifact that combines one or more
+ physical data sources to provide for easy data integration. Integration
+ is encapsulated through view and procedures that Teiid will process in
+ an optimized way against their respective sources. The physical sources
+ can be JDBC sources, delimited text files, spreadsheets, or even Web
+ services.</para>
+ </section>
+
+ <para>The Teiid Designer tool lets you define physical data sources by
+ importing the required metadata (schema) from these sources. Once the
+ metadata is imported, Designer can assist in building additional view
+ layers. The collection of physical and view models will form a VDB.</para>
</section>
-
+
<section>
<title>What is This Guide About?</title>
- <para>This guide takes you through an introduction to the concepts important to Teiid,
- downloading the software, and building and deploying a virtual database in 60 minutes.
- There is a lot to cover, so let's begin!</para>
+
+ <para>This guide takes you through an introduction to the concepts
+ important to Teiid, downloading the software, and building and deploying a
+ virtual database in 60 minutes. There is a lot to cover, so let's
+ begin!</para>
</section>
-
+
<note>
- <para>
- Please read
- <ulink url="http://www.jboss.org/teiid/basics.html">Federation Basics</ulink>
- to understand different terminologies used, resources needed, and artifacts to be generated before
- developing a successful application. This example takes advantage of only a minimal set of features from
- Teiid for the sake of simplicity and time.
- </para>
+ <para>Please read <ulink
+ url="http://www.jboss.org/teiid/basics.html">Federation Basics</ulink> to
+ understand different terminologies used, resources needed, and artifacts
+ to be generated before developing a successful application. This example
+ takes advantage of only a minimal set of features from Teiid for the sake
+ of simplicity and time.</para>
</note>
-
- <para>Commercial development support, production support, and training for Teiid is available through JBoss.
- Teiid is a Professional Open Source project and a critical component of the JBoss Enterprise Data Services
- Platform.</para>
-
-</preface>
\ No newline at end of file
+
+ <para>Commercial development support, production support, and training for
+ Teiid is available through JBoss. Teiid is a Professional Open Source
+ project and a critical component of the JBoss Enterprise Data Services
+ Platform.</para>
+</preface>
Modified: trunk/documentation/quick-start-example/src/main/docbook/en-US/quick_start_example.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/quick_start_example.xml 2011-04-11 15:34:06 UTC (rev 3081)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/quick_start_example.xml 2011-04-11 15:36:29 UTC (rev 3082)
@@ -49,6 +49,7 @@
<xi:include href="content/preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/download.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/example-explained.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/datasources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/buildvdb.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/connect-vdb.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
More information about the teiid-commits
mailing list