Skip to end of metadata
Go to start of metadata

Teiid needs to be installed into an existing JBoss AS 7.5 (EAP 6.4 Alpha) installation.

Teiid provides an embedded kit, however it should be considered a tech preview as its APIs will likely evolve and there is sparse documentation.

Steps to install Teiid

  • Download the JBoss AS application server. Install the server by unzipping into a known location. Ex: /apps/jboss
You may also choose to use an existing AS installation. However if a previous version of Teiid was already installed, you must remove the old Teiid distribution artifacts before installing the new version.
  • Download Teiid. Unzip the downloaded artifact inside the JBoss AS installation. Teiid 8.11 directory structure matches JBoss AS directly - it is just an overlay. This will add necessary modules and configuration files to install Teiid in JBoss AS 7.5 (EAP 6.4 Alpha) in both Standalone and Domain modes. Teiid provides separate configuration files for both standalone mode and domain mode. Based on mode type you selected to run JBoss AS, you may have to run a CLI script to complete the Teiid installation.

The "Domain" mode recommended in a clustered environment to take advantage of clustered caching and cluster safe distribution of events. Teiid's default configuration for Domain mode through CLI script configured for high availability and clustered caching.

Standalone Mode

if you want to start the "standalone" profile, execute the following command

Installing Teiid using CLI script
The above is starting JBoss AS in a separate Teiid specific configuration that is based standalone.xml. However, if you already working with a predefined configuration for example default standalone.xml and would like to install Teiid into that configuration, then you can execute the following JBoss CLI script. First, start the server

then in a separate console window execute

this will install Teiid subsystem into the running configuration of the JBoss AS in standalone mode.

Domain Mode

To start the server in "Domain" mode, install the JBoss AS 7.5 (EAP 6.4 Alpha) and Teiid 8.11 on all the servers that are going to be part of the cluster. Select one of the servers as the "master" domain controller, the rest of the servers will be slaves that connect to the "master" domain controller for all the administrative operations. Please refer to JBoss AS provided documentation for full details.

Once you configured all the servers, start the "master" node with following command

and on "slave" nodes

The slave nodes fetch their domain configuration from the "master" node.

Once all the servers are up, complete the installation to run in domain mode by executing the following command against the "master" node. Note that this only needs to be run once per domain (i.e. cluster) install. This script will install Teiid in the HA profile. It will also re-configure main-server-group to start the HA profile. Once in domain mode, you can not statically deploy resources by dropping them in the domain/deployments folder, so this script will deploy the default resources (file, ldap, salesforce and ws connectors) using the CLI interface.

Installing "Teiid" in other profiles
If Teiid needs to be installed in profiles other than HA, before executing edit the teiid-domain-mode-install.cli file, making the appropriate changes to profile, socket-bindings, and server-groups.

Thats it!. JBoss AS and Teiid are now installed and running. See below instructions to customize various other settings.

Once VDBs have been deployed, users can now connect their JDBC applications to Teiid. If you need help on connecting your application to Teiid using JDBC check out the Client Developer's Guide.

Directory Structure Explained

This shows the contents of the Teiid 8.11 deployment. The directory structure is exactly the same under any JBoss profile.

Directory Structure


Contains installation and utility CLI scripts for setting up Teiid in different configurations.


Contains documents, examples, sample data source XML fragments and schema files.


  • standalone-teiid.xml - Master configuration file for the Teiid system. This file contains the Teiid subsystem, in addition to the standard JBoss AS web profile subsystems



This directory contains the Teiid modules for JBoss AS 7.5 (EAP 6.4 Alpha) system


This directory contains Teiid client libraries. It has the Teiid JDBC driver jar, "teiid-8.11.0.Final-jdbc.jar", and also contains "teiid-hibernate-dialect-8.11.0.Final.jar" that contains Teiid's Hibernate dialect.

{standalone or domain}tmp/teiid

This directory contains temporary files created by Teiid. These are mostly created by the buffer manager. These files are not needed across a VM restart. Creation of Teiid lob values (for example through SQL/XML) will typically create one file per lob once it exceeds the allowable in memory size of 8KB. In heavy usage scenarios, consider pointing the buffer directory at a partition that is routinely defragmented.

{standalone or domain}data/teiid-data

This directory contains cached vdb metadata files. Do not edit them manually.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jan 09, 2013

    I see mention of domain-teiid.xml for running teiid in domain mode but I cannot find it in the distribution zip or the installed directory structure. Could you point me to a specific location to retrieve this file? I've tried downloading the Teiid 8.3 alpha 2 zip and that did not have it either. Thanks.

  2. Jan 09, 2013

    I removed the references to domain-teiid.xml as that was old. You need to use the CLI script provided to finish the installation in domain mode.