A JBoss Project
Red Hat

This site is no longer current and is for archival purposes only. All relevant content is moving to http://teiid.io


A model is a representation of a set of information constructs. A familiar model is the relational model, which defines tables composed of columns and containing records of data.

In Teiid, models are used to define the entities, and relationships between those entities, required to fully define the integration of information sets so that they may be accessed in a uniform manner using a single API and access protocol. Teiid can automatically map a relational model to JSON or XML for consumption via OData.

Source models define the structural and data characteristics of the information contained in data sources. Teiid uses the information in source models to access the information in multiple sources, so that from a user's viewpoint these all appear to be in a single source.

In addition to source models, Teiid provides the ability to define a variety of view models. These can be used to define a layer of abstraction above the physical layer, so that information can be presented to end users and consuming applications in business terms rather than as it is physically stored. These business views can be in a variety of forms: relational, XML, JSON, or Web services. Views are defined using transformations between models.

Types of Models

Teiid Designer can be used to model a variety of classes of models. Each of these represent a conceptually different classification of models.

  • Relational, which model data that can be represented in table – columns and records – form. Relational models can represent structures found in relational databases, spreadsheets, text files, or simple Web services.
  • Model Extensions, for defining property name/value extensions to other model classes.

VDBs contain two primary varieties of model types - source and view. Source models represent the structure and characteristics of physical data sources, whereas view models represent the structure and characteristics of abstract structures you want to expose to your applications.

Models and VDBs

Models used for data integration are packaged into a virtual database (VDB). The models must be in a complete and consistent state when used for data integration. That is, the VDB must contain all the models and all resources they depend upon.

Models contained within a VDB can be imported into the Teiid Designer. In this way, VDBs can be used as a way to exchange a set of related models.

Models and Translators, Resource Adaptors

Source models must be configured with a Translator and a Resource Adaptor with them before a VDB is tested in Designer or deployed for data access.

It is possible that multiple models may use the same settings, but each model must define these configurations.

Model Validation

Models must be in a valid state in order to be used for data access. Validation of a single model means that it must be in a self-consistent and complete state, meaning that there are no "missing pieces" and no references to non-existent entities. Validation of multiple models checks that all inter-model dependencies are present and resolvable.

Models must always be validated when they are deployed in a VDB for data access purposes.

Model Execution in Teiid Designer

Models can be tested in the Teiid Designer by issuing SQL queries in the SQL Explorer perspective. In this way, you can iterate between defining your integration models and testing them out to see if they are yielding the expected results.

Model Files

Models are stored in XML format, using the XMI syntax defined by the OMG.

Model files should never be modified "by hand". While it is possible to do so, there is the possibility that you may corrupt the file such that it cannot be used within the JBoss Enterprise Data Services Platform.

Dynamic VDBs and Models

The information in this artical applies to the VDBs that are built using the Teiid Designer. If you are building Dynamic VDBs, much of the information does not apply in that case. However, even Dynamic VDBs have models but they only define configuration for importing metadata and Translators and Resource Adaptors.

Looking for a fully supported, certified Data Virtualization Platform?

tei·id (TEE-id)

adj.     pertaining to a family of tropical American whip-tailed lizards noted for speed and agility.
n.     a set of open source enterprise information integration tools noted for their ability to rapidly create data services that can quickly adapt to changes in your IT environment.

Blog Posts

Control your business in real-time with automated decision making

Find a security issue with a JBoss Project or Product? Report it now
back to top