Skip to end of metadata
Go to start of metadata

External materialized views cache their data in an external database system. External materialized views give the administrator full control over the loading and refresh strategies.

Starting from Teiid version 8.5, Teiid gives the option to configure metadata on the view to control the loading and refreshing policies for cache. However, this is optional and administrators of Teiid system are free to choose to define and manage this externally through other means based on their needs.

User Managed Materialization Management

Typical Usage Steps

  • Create materialized views and corresponding physical materialized target tables in Designer. This can be done through setting the materialized and target table manually, or by selecting the desired views, right clicking, then selecting Modeling->"Create Materialized Views"
  • Generate the DDL for your physical model materialization target tables. This can be done by selecting the model, right clicking, then choosing Export->"Metadata Modeling"->"Data Definition Language (DDL) File". This script can be used to create the desired schema for your materialization target on whatever source you choose.
  • Determine a load and refresh strategy. With the schema created the most simplistic approach is to just load the data. The load can even be done through Teiid with

That however may be too simplistic because your index creation may be more performant if deferred until after the table has been created. Also full snapshot refreshes are best done to a staging table then swapping it for the existing physical table to ensure that the refresh does not impact user queries and to ensure that the table is valid prior to use.

Metadata Based Materialization Management

Users when they are designing their views, they can define additional metadata on their views to control the loading and refreshing of external materialization cache. This option provides a limited but a powerful way to manage the materialization views. For this purpose, SYSADMIN model in your VDB defines three stored procedures (loadMatView, updateMatView, matViewStatus) in its schema. Based on the defined metadata on the view, and these SYSADMIN procedures a simple scheduler automatically starts during the VDB deployment and loads and keeps the cache fresh.

The Designer tooling for this feature is lacking at this moment but this will be added in coming releases.

Usage Steps

  • To manage and report the loading and refreshing activity of materialization view, Teiid expects the user to define "Status" table with following schema in any one of the source models. Create this table on the physical database, before you do the import of this physical source.
  • Create Views and corresponding physical materialized target tables in Designer or using DDL in Dynamic VDB. This can be done through setting the materialized and target table manually, or by selecting the desired views, right clicking, then selecting Modeling->"Create Materialized Views" in the Designer.
  • Define the following extension properties on the view.
Property Name Description Optional Default Value
teiid_rel:ALLOW_MATVIEW_MANAGEMENT Allow Teiid based management false false
teiid_rel:MATVIEW_STATUS_TABLE fully qualified Status Table Name defined above false n/a
teiid_rel:MATVIEW_BEFORE_LOAD_SCRIPT semi-colon(;) separated DDL/DML commands to run before the actual load of the cache, typically used to truncate staging table true When not defined, no script will be run
teiid_rel:MATVIEW_LOAD_SCRIPT semi-colon(;) separated DDL/DML commands to run for loading of the cache true will be determined based on view transformation
teiid_rel:MATVIEW_AFTER_LOAD_SCRIPT semi-colon(;) separated DDL/DML commands to run after the actual load of the cache. Typically used to rename staging table to actual cache table true When not defined, no script will be run
teiid_rel:MATVIEW_SHARE_SCOPE Allowed values are {NONE, VDB, SCHEMA}, which define if the cached contents are shared among different VDB versions and different VDBs as long as schema names match true NONE
teiid_rel:MATVIEW_STAGE_TABLE When MATVIEW_LOAD_SCRIPT property not defined, Teiid loads the cache contents into this table true n/a
teiid_rel:ON_VDB_CREATE_SCRIPT DML commands to run start of vdb true n/a
teiid_rel:ON_VDB_DROP_SCRIPT DML commands to run at VDB un-deploy; typically used for cleaning the cache/status tables true n/a
teiid_rel:MATVIEW_ONERROR_ACTION Action to be taken when mat view contents are requested but cache is invalid. Allowed values are (THROW_EXCEPTION = throws an exception, IGNORE = ignores the warning and supplied invalidated data, WAIT = waits until the data is refreshed and valid then provides the updated data) false n/a
  • Once the VDB with a model with above properties defined and deployed, the following sequence of events will take place
  1. Upon the VDB deployment, teiid_rel:ON_VDB_CREATE_SCRIPT will be run on completion of the deployment.
  2. Based on the [Cache Hint] defined on the view transformation, a scheduler entry will be created to run SYSADMIN.loadMatView procedure, which loads the cache contents.
  3. This procedure, first inserts/updates a entry in teiid_rel:MATVIEW_STATUS_TABLE, which indicates that the cache is being loaded.
  4. In same procedure, then teiid_rel:MATVIEW_BEFORE_LOAD_SCRIPT will be run if defined
  5. In same procedure, then teiid_rel:MATVIEW_LOAD_SCRIPT will be run if defined, otherwise one will be automatically created based on the view's transformation logic.
  6. Then, teiid_rel:MATVIEW_AFTER_LOAD_SCRIPT will be run, to close out and create any indexes on the mat view table.
  7. The procedure, then will set teiid_rel:MATVIEW_STATUS_TABLE entry to "LOADED" and valid.
  8. Based on the Cache Hint, the SYSADMIN.matViewStatus is ran by the Scheduler, to queue further cache re-loads.
  9. When VDB is un-deployed (not when server is restarted) the teiid_rel:ON_VDB_DROP_SCRIPT script will be run.

User can any time run SYSADMIN.updateMatView procedure to partially update the cache contents rather than complete refresh of contents with SYSADMIN.loadMatview procedure. When partially update is run the cache expiration time is renewed for new term based on Cache Hint again.

A sample Dynamic VDB with these properties can be defined as below

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.