When you want to run a quick start remember the following points:

The Simple Client quick start teaches you how to connect to Red Hat JBoss Data Virtualization using either the JDBC driver or a data source. You can use the Simple Client quick start to test your SQL queries against any JBoss Data Virtualization instance with an active virtual database. You must have an active virtual database before you run this quick start.

To run the quick start, go to the EAP_HOME/quickstarts/simpleclient directory and open the README.md file in a text editor and read the instructions it contains.

The Dynamic VDB Data Federation quick start teaches you how Red Hat JBoss Data Virtualization can federate data from different sources into one virtual database.

The quick start uses three sample data sources to illustrate this concept, namely

The virtual database that is deployed is called Portfolio. It defines a model for each data source; these will be named Accounts, MarketData and PersonalValuations, respectively. The VDB is deployed to the runtime, thereby making it accessible to the user application via JDBC.

To run the quick start, go to the EAP_HOME/quickstarts/dynamicvdb-datafederation directory and open the README.md file in a text editor and read the instructions it contains.

When you run the quick start’s test query, it joins data from the Accounts and MarketData models. Red Hat JBoss Data Virtualization then accesses both the relational and non-relational sources, calculates the portfolio values, and returns the results.

The dynamicvdb-datafederation/src/vdb/portfolio-vdb.xml file defines the resources that can be accessed by the client application.

In this model, the "vdb" element defines the virtual database that has a name of "Portfolio" with version "1". A "model" element represents a schema that is being integrated. This sample defines three sources. The "source" element inside the "model" element defines the "name" of the source (can be any name), the name of the translator (defines the type of the source like oracle, db2, mysql, h2, file or webservice) and the "connection-jndi-name" defines the source’s JNDI name in the Red Hat JBoss EAP container.

Also note that inside the "model" elements, some "property" elements can be used to define how metadata is to be imported from the source. When you configure the quick start, the portfolio-vdb.xml is deployed to the JBoss EAP server. The portfolio-vdb.xml.dodeploy file (also referred to as a marker file, which is empty) is also deployed so that the Teiid Runtime is triggered to load the virtual database. The VDB’s data sources are validated for availability. If they are available, the VDB status is set to "Active".

There are two virtual models defined in the dynamic VDB; Stocks and OtherHoldings. The Stocks virtual model contains 2 basic views. One, Stocks, to access the stock prices in the text data source and the second, StockPrices, that will join the Stocks with Products to federate the data from both data sources. The OtherHoldings contains a view that joins Accounts with OtherHoldings to show to whom the holdings belong.

This example uses three data sources, a relational database, a CSV text file and an Excel file. You can substitute any other relational database for H2, as long as you have a suitable JDBC driver. The schema file provided at dynamicvdb-datafederation/src/teiidfiles/customer-schema.sql, is specific to H2 but you can convert it for use with other databases.

In order to use a text file as the source, we need a data file which defines the data in a CSV format (comma separated values). 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 line corresponds to single row. A portion of the sample file is shown below. The complete sample file is dynamicvdb-datafederation/src/teiidfiles/data/marketdata-price.txt.

SYMBOL,PRICE
IBM,83.46
RHT,11.84
BA,44.58
ORCL,17.37

The Excel file contains sheet1, which defines a header row and subsequent data rows, similar to a text file. This example demonstrates that Excel files can be used on different operating systems, not just on Microsoft Windows. You can use the provided data files or create your own data files. The sample file is dynamicvdb-datafederation/src/teiidfiles/excelFiles/otherholdings.xls

The Dynamic VDB Data Roles quick start demonstrates how you can use data roles to control access to data. (This includes read-only and read-write access.)

In this quick start, the virtual database (portfolio-vdb.xml) has three data access roles:

To run the quick start, go to the EAP_HOME/quickstarts/dynamicvdb-dataroles directory and open the README.md file in a text editor and read the instructions it contains. Look at the application-roles.properties and application-users.properties in the EAP_HOME/MODE/configuration/ directory, because you have to use the ./add-user.sh (bat) script (as indicated in the README).

Look at the portfolio-vdb.xml file to see how the quick start is used:

  <data-role name="ReadWrite">
     <description>Allow reads and writes to tables and procedures</description>

     <permission>
         <resource-name>Accounts</resource-name>
         <allow-create>false</allow-create>
         <allow-read>true</allow-read>
         <allow-update>true</allow-update>
     </permission>

     <permission>
         <resource-name>MarketData</resource-name>
         <allow-create>false</allow-create>
         <allow-read>true</allow-read>
         <allow-update>true</allow-update>
     </permission>

       <mapped-role-name>supervisor</mapped-role-name>
 </data-role>

To see how the users and roles were defined for JAAS, look the application-roles.properties and application-users.properties files. JAAS uses application-users.properties file to determine user credentials. Thehe application-roles.properties file maps the username to the mapped-role-name element.

The Web Services as a Data Source quick start demonstrates how to use the Web Service Translator to call a web service that returns an XML document. The quick start also demonstrates how to translate the XML document into a relational database.

To run the quick start, go to the EAP_HOME/quickstarts/webservices-as-a-datasource directory, open the README.md file in a text editor and read the instructions.

When you run the quick start, the CustomerRESTWebSvc.war is deployed. This is the web service data source that JBoss Data Virtualization accesses. The dynamic VDB, namely webservice-vdb.xml, creates the VIEW using the Data Definition Language (DDL). It does so in order to read and transform the XML document returned from the web service.

The JBoss Data Grid Running as a Data Source example demonstrates how to access a Red Hat JBoss Data Grid cache using the infinispan-cache-dsl translator.

To run the quick start, go to the EAP_HOME/quickstarts/jdg-remote-cache directory and open the README.md file in a text editor and read the instructions.

The source model metadata is created dynamically based on the configured resource adapter. Notice that there is no DDL. This quick start uses the dynamically created metadata by default instead. However, you can define your own metadata and provide any necessary overrides.

The quick start shows you how to do these things:

There are two other quick starts that allow you to explore Red Hat JBoss Data Grid integration: jdg7.1-remote-cache and jdg7.1-remote-cache-materialization.

When you utilize Hibernate, you will normally have a one-object-to-one-data-source mapping. By using Red Hat JBoss Data Virtualization as the data source, you can integrate the object and the source at the data layer rather than application layer. This makes it easier to join related information and then expose that information through Hibernate.

The Hibernate on Top of Teiid quick start demonstrates how hibernate can take advantage of multiple data sources through a single Java object by using the data federation capabilities of Red Hat JBoss Data Virtualization. This quick start extends the Portfolio VDB and creates a view that is mapped to a single relationally mapped object in hibernate.

To run the quick start, go to the EAP_HOME/quickstarts/hibernate-on-top-of-teiid directory and open the README.md file in a text editor and read the instructions it contains.