[teiid-commits] teiid SVN: r2244 - 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
Thu Jun 17 22:57:40 EDT 2010
Author: shawkins
Date: 2010-06-17 22:57:39 -0400 (Thu, 17 Jun 2010)
New Revision: 2244
Removed:
trunk/documentation/quick-start-example/src/main/docbook/en-US/content/learn.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-922 updated the links/text of the quick start guide. also made it less designer centric. we'll still need to update the portfolio vdb with a new designer build
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-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/buildvdb.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -1,8 +1,11 @@
<?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="designer">
+<chapter id="step-3">
+ <title>Building a VDB</title>
+ <para>A VDB can be built with either the <link linkend="designer">Designer</link> tool or through a simple XML file called a dynamic VDB. See the dyanmicvdb-portolio for an example dynamic VDB. You can skip the next section if you choose to use a dynamic VDB.</para>
+ <sect1 id="designer">
<title>Using Teiid Designer to build a VDB</title>
- <sect1>
+ <sect2>
<title>Download Teiid Designer</title>
<note>
@@ -16,16 +19,14 @@
<para>
The Teiid Designer project provides a Eclipse based designer tool for this purpose of building a VDB. You can
download Teiid Designer
- <ulink url="http://teiid.org/teiiddesigner.html">here</ulink>
+ <ulink url="http://www.jboss.org/teiiddesigner/downloads.html">here</ulink>
Once downloaded, please follow the installation instructions. Start the Teiid Designer and return here to continue
building the VDB.
</para>
- </sect1>
- <sect1 id="step-3">
- <title>Building a VDB</title>
+ </sect2>
+
<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. 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>
+ summarized in the following table.</para>
<orderedlist>
<listitem>
<para>Switch to the Designer Perspective, by opening the "Window->Open Perspective.."</para>
@@ -39,9 +40,6 @@
<listitem>
<para>Manually create the view model for the "Text File". Create a Table called "Price" with
"stock" and "price" as column names. In the transformation window add the following SQL</para>
- <programlisting><![CDATA[
- SQL text here..
- ]]> </programlisting>
</listitem>
<listitem>
<para>Create a view model called "AccountView"</para>
@@ -64,5 +62,5 @@
<para>Export or copy the VDB for use in your application.</para>
</listitem>
</orderedlist>
- </sect1>
+ </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-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/connect-vdb.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -9,77 +9,69 @@
<title>Stand-alone Java Application Deployment</title>
<para>Before you can make a JDBC connection to the Teiid VDB, add the Teiid's driver jar file to your application's classpath</para>
- <programlisting><![CDATA[
- ${jboss-install}/server/${profile}/lib/teiid-${version}-client.jar
- ]]> </programlisting>
+ <programlisting><![CDATA[${jboss-install}/server/${profile}/lib/teiid-${version}-client.jar]]> </programlisting>
<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" 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>
+ <code>"org.teiid.jdbc.TeiidDriver"</code>
with the URL syntax of
</para>
<para>
- <emphasis>jdbc:teiid:<VDB-Name>@(mm|mms)://<host name>:<port></emphasis>
+ <emphasis>jdbc:teiid:<VDB-Name>@mm(s)://<host name>:<port></emphasis>
</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:teiid:<VDB-Name>@(mm|mms)://<host name>:<port>;autoCommitTxn=DETECT</emphasis>
+ <emphasis>jdbc:teiid:<VDB-Name>@mm(s)://<host name>:<port>;autoCommitTxn=DETECT</emphasis>
</para>
- <para />
<para>
You can use any of these <ulink url="https://www.jboss.org/community/docs/DOC-13157"> optional connection properties </ulink>
in your URL. Here is sample code showing how to make JDBC connection.
</para>
- <programlisting><![CDATA[
- public void execute() throws SQLException {
- String url = "jdbc:metamatrix:Portfolio at mm://localhost:31000";
- String sql = "select firstname, lastname from customer";
-
- Class.forName("org.teiid.jdbc.TeiidDriver");
-
- Connection connection;
- try{
- connection = DriverManager.getConnection(url, "admin", "teiid");
- Statement statement = connection.createStatement();
- ResultSet results = statement.executeQuery(sql);
- while(results.next()) {
- System.out.println(results.getString(1));
- System.out.println(results.getString(2));
- ...
- }
- results.close();
- statement.close();
- } catch (SQLException e){
- e.printStackTrace();
- throw e;
- } finally {
- try{
- connection.close();
- }catch(SQLException e1){
- // ignore
- }
- }
- }
- ]]></programlisting>
- <para>You can also use <emphasis>org.teiid.jdbc.TeiidDataSource</emphasis>
+ <programlisting><![CDATA[public void execute() throws SQLException {
+ String url = "jdbc:teiid:Portfolio at mm://localhost:31000";
+ String sql = "select firstname, lastname from customer";
+
+ Class.forName("org.teiid.jdbc.TeiidDriver");
+
+ Connection connection;
+ try{
+ connection = DriverManager.getConnection(url, "admin", "teiid");
+ Statement statement = connection.createStatement();
+ ResultSet results = statement.executeQuery(sql);
+ while(results.next()) {
+ System.out.println(results.getString(1));
+ System.out.println(results.getString(2));
+ ...
+ }
+ results.close();
+ statement.close();
+ } catch (SQLException e){
+ e.printStackTrace();
+ throw e;
+ } finally {
+ try{
+ connection.close();
+ }catch(SQLException e1){
+ // ignore
+ }
+ }
+}]]></programlisting>
+ <para>You can also use <code>org.teiid.jdbc.TeiidDataSource</code>
to make connection in your Java application. For example, you can use following code fragment to make a
connection to the VDB and issuing the query exactly same as in the above example</para>
- <programlisting><![CDATA[
- TeiidDataSource ds = new TeiidDataSource();
- ds.setDatabaseName("Portfolio");
- ds.setEmbeddedBootstrapFile("<teiid home>/deploy.properties");
- ds.setUser("admin");
- ds.setPassword("teiid");
-
- Connection connection = ds.getConnection();
- ...
- ]]></programlisting>
+ <programlisting><![CDATA[TeiidDataSource ds = new TeiidDataSource();
+ds.setDatabaseName("Portfolio");
+ds.setUser("admin");
+ds.setPassword("teiid");
+
+Connection connection = ds.getConnection();
+...]]></programlisting>
<para>TeiidDataSource source also provides an option to set optional parameters using the "set" methods on the
data source look. For all the allowable properties at the
<ulink url="https://www.jboss.org/community/docs/DOC-13158">data source properties</ulink>.</para>
@@ -93,16 +85,13 @@
<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
- data sources: one relational, one file-based. All the sample Java class does is connect to the VDB, issue the query,
- and print the results. Teiid does the "heavy lifting" of integrating the results.
- (For the complete code used in this example, look in the "examples/portfolio" directory.)</para>
- <para>
- You are encouraged to experiment with queries that go beyond the simple "select * from CustomerAccount".
+ <para>Depending on the VDB you deployed, see the relevant README file for example queries. If you are using a graphical client, such
+ as <ulink url="http://www.squirrelsql.org/">SQuirreL</ulink>, have a look at the metadata tree to see not only what is exposed by your
+ 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
- <emphasis>org.teiid.jdbc.TeiidDataSource</emphasis> and assigning it a JNDI name.
+ <code>org.teiid.jdbc.TeiidDataSource</code> and assigning it a JNDI name.
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>
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-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/deployment.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -21,16 +21,14 @@
<para>For this example we need to create three (2) different data sources. You would first need to create a data source to Derby,
then to File source. See or copy the following</para>
- <programlisting><![CDATA[
- ${teiid-examples}/portfolio/PortfolioModel/portfolio-ds.xml
- ${teiid-examples}/portfolio/PortfolioModel/marketdata-file-ds.xml
- ]]> </programlisting>
+ <programlisting><![CDATA[${teiid-examples}/portfolio/portfolio-ds.xml
+${teiid-examples}/portfolio/marketdata-file-ds.xml]]> </programlisting>
<para>files into "${jboss-install}/server/{profile}/deploy" directory.</para>
</listitem>
<listitem>
- <para>The above data sources provide the data to your VDB. Now to deploy your VDB, place your VDB in a the "${jboss-install}/server/{profile}/deploy" directory.
+ <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.
- Make sure there were no errors during the deply of the VDB
+ Check the logs or the console to make sure there were no errors during the deployment of the VDB.
</para>
</listitem>
<listitem>
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-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/download.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -4,31 +4,31 @@
<title>Download</title>
<para>
You need to download the binaries for
- <ulink url="http://teiid.org/Download.html">Teiid</ulink>
+ <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 the source code for all modules</para>
+ <para>Teiid Source - contains all of the source code</para>
</listitem>
<listitem>
- <para>Teiid Adminshell - contains the admin client binary code</para>
+ <para>Teiid Adminshell - contains the admin client</para>
</listitem>
<listitem>
- <para>Teiid Kit - contains only required modules and their required 3rd party
+ <para>Teiid Runtime - contains the Teiid engine and required 3rd party
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 <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.
+ Then download Teiid runtime and unzip the contents of the Teiid under any of one of the JBoss AS profiles
+ like "default" or "all". The default profile is the typical installation location, for example "<jboss-install>/server/default". The Teiid runtime directory structure matches that
+ of the JBoss profile directly.
</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>JBoss AS requires <ulink url="http://java.sun.com/javase/downloads">Java 6</ulink> to run.
+ <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
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 2010-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/example-explained.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -5,23 +5,10 @@
<sect1>
<title>Portfolio Application Explained</title>
<para>
- To demonstrate how Teiid Designer and Teiid work together, follow these steps to build a simple
- portfolio valuation virtual database. The investor's portfolio information is stored in a Derby database and
- "current" stock prices are stored in a delimited text file. When completed, a single query will cause
+ 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. Here are some of key points to consider as you build this example:
- <itemizedlist>
- <listitem>
- <para>It's pretty simple to do</para>
- </listitem>
- <listitem>
- <para>You're querying a text file as though it was a relational database</para>
- </listitem>
- <listitem>
- <para>Imagine how much more complete this would be if you replaced the text file with a connection
- to a financial Web site. (Hint: You can with Teiid and a custom connector.)</para>
- </listitem>
- </itemizedlist>
+ return the results.
</para>
<figure id="steps">
<title>Various Steps involved in creating the example</title>
@@ -45,12 +32,12 @@
</listitem>
<listitem>
<para>
- <link linkend="step-4">Step-4: Deploy the VDB in Teiid</link>
+ <link linkend="deployment">Step-4: Deploy the VDB in Teiid</link>
</para>
</listitem>
<listitem>
<para>
- <link linkend="step-5">Step-5: Access the VDB using JDBC API</link>
+ <link linkend="OpenConnection">Step-5: Access the VDB using the JDBC API</link>
</para>
</listitem>
</itemizedlist>
@@ -58,63 +45,51 @@
<note>
<para>
<ulink url="http://db.apache.org/derby/">Derby</ulink>
- is suggested as it is Open Source, easily obtained, and light-weight. You can substitute any other relational
+ 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>
</note>
<sect1 id="step-1">
- <title>Step-1: Create the Relational Database's schema and load the sample data</title>
+ <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, or if you have access to an installed instance use that. It is
- expected that you create a database called "accounts" in this Derby instance that is used by this example
- application.
+ and install Derby on your machine. An existing local or remote instance can be used if it exists.
</para>
- <para>
- Below find the corresponding schema. For the complete schema, please refer to
- <emphasis>"examples/portfolio/customer-schema.sql"</emphasis>
- file of the downloaded kit.
- </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>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><![CDATA[export DERBY_HOME=`pwd`
+./bin/startNetworkServer]]>
</programlisting>
- <para>The above starts the Derby in network mode. Now, start another terminal and we will use Derby''s 'ij' tool
+ <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/portfolio" directory</para>
- <programlisting><![CDATA[
- export DERBY_HOME=`pwd`
- ./bin/ij /path/to/customer-schema.sql
- ]]>
+ <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
@@ -125,7 +100,7 @@
</para>
</sect1>
<sect1 id="step-2">
- <title>Step-2: Describe the CSV file and its contents</title>
+ <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>
@@ -143,8 +118,6 @@
</programlisting>
</listitem>
</orderedlist>
- <para>Just locate the sample data files provided or create your own data files. Make sure that the
- descriptor file contains the full path to the data file. Now, both our sources are ready to be
- used to build a VDB</para>
+ <para>Just locate the sample data files provided or create your own data files. Now, both our sources are ready.</para>
</sect1>
</chapter>
\ No newline at end of file
Deleted: trunk/documentation/quick-start-example/src/main/docbook/en-US/content/learn.xml
===================================================================
--- trunk/documentation/quick-start-example/src/main/docbook/en-US/content/learn.xml 2010-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/learn.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -1,32 +0,0 @@
-<?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="learn">
- <title>Learning about Virtual Databases (VDB)</title>
- <sect1>
- <title>What is a Virtual Database?</title>
- <para> A Virtual Database (VDB) is an artifact that defines the logical schema model combining one or more
- physical data sources to provide easy data integration. This is accomplished by use of virtual tables,
- virtual views and virtual procedures, transformed by queries to their underlying
- physical data sources. The physical sources can be JDBC sources, delimited text files, spreadsheets
- or even Web services.</para>
- <para>Your JDBC application references the virtual (logical) schema defined in this VDB. When tables, or
- other objects, in the VDB's models are queried, the Teiid query engine interprets the virtual schema,
- makes the appropriate calls to the actual physical sources, combines and translates them as requested, and
- returns the top level results to the application.</para>
- </sect1>
- <sect1>
- <title>What is Teiid?</title>
- <para> Teiid is runtime for executing queries against a VDB. Before you can access your data in a federated
- manner, use the Teiid Designer 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" />
- </figure>
- <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, use the Designer to build a virtual data model.
- The collection of physical and logical models form a virtual schema. Once the user has completed the models,
- the Designer is used to package them in a Virtual Database, or VDB. So, a VDB can be further defined as a
- collection of logical (virtual) data models.</para>
- </sect1>
-</chapter>
\ No newline at end of file
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 2010-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/content/preface.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -2,37 +2,46 @@
<!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>
- <para> Teiid offers the power of a federated relational query engine for use with any Java
- application - without the need for a separate server process. Accessing your federated data is as easy as
- making a JDBC connection to any relational data source. This guide will take you through</para>
- <itemizedlist>
- <listitem>
- <para>Deployment of Teiid in your environment</para>
- </listitem>
- <listitem>
- <para>Building and deploying a Virtual Database(VDB)</para>
- </listitem>
- <listitem>
- <para>Connecting to your VDB and issuing federated queries against your VDB and getting results
- back</para>
- </listitem>
- </itemizedlist>
- <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>
+ <sect1>
+ <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>
+ <figure id="lifecycle">
+ <title>Lifecycle of Events</title>
+ <graphic align="center" scale="100" fileref="../images/steps.png" />
+ </figure>
+ <sect2>
+ <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>
+ </sect2>
+
+ <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>
+ </sect1>
+
<sect1>
<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 demonstration virtual database in 60 minutes.
+ downloading the software, and building and deploying a virtual database in 60 minutes.
There is a lot to cover, so let's begin!</para>
</sect1>
+
<note>
<para>
Please read
<ulink url="http://www.jboss.org/teiid/basics.html">Federation Basics</ulink>
- and understand different terminologies used, resources needed and artifacts that need to be generated before
+ 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 Embedded for the sake of simplicity and time.
+ 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
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 2010-06-18 01:43:01 UTC (rev 2243)
+++ trunk/documentation/quick-start-example/src/main/docbook/en-US/quick_start_example.xml 2010-06-18 02:57:39 UTC (rev 2244)
@@ -48,7 +48,6 @@
<toc />
<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/learn.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/buildvdb.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="content/deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
More information about the teiid-commits
mailing list