Table Metadata

You are looking at an older version of the documentation. The latest version is found here.

SYS.Tables

This table supplies information about all the groups (tables, views, documents, etc.) in the virtual database.

Column Name	Type	Description
`VDBName`	string	VDB name
`SchemaName`	string	Schema name
`Name`	string	Short group name
`Type`	string	Table type (Table, View, Document, etc.)
`NameInSource`	string	Name of this group in the source
`IsPhysical`	boolean	`TRUE` if this is a source table
`SupportsUpdates`	boolean	`TRUE` if the group can be updated
`UID`	string	Group unique ID
`Cardinality`	integer	Approximate number of rows in the group
`Description`	string	Description
`IsSystem`	boolean	`TRUE` if in the system table
`IsMaterialized`	boolean	Defines whether the corresponding table/view is materialized or cached in Teiid
`OID`	integer	Unique ID

SYSADMIN.MatViews

This table supplies information about all the materialized views in the virtual database.

Column Name	Type	Description
`VDBName`	string	VDB name
`SchemaName`	string	Schema name
`Name`	string	Short group name
`TargetSchemaName`	string	Name of the materialized table schema
`TargetName`	string	Name of the materialized table
`Valid`	boolean	`TRUE` if the materialized table is currently valid
`LoadState`	boolean	Load state, can be one of `NEEDS_LOADING`, `LOADING`, `LOADED`, `FAILED_LOAD`
`Updated`	timestamp	Timestamp of the last full refresh
`Cardinality`	integer	Number of rows in the materialized view table

SYS.Columns

This table supplies information about the virtual database's elements (columns, tags, attributes, etc.).

Column Name	Type	Description
VDBName	string	VDB name
`SchemaName`	string	Schema name
`TableName`	string	Table name
`Name`	string	Element name (not qualified)
`Position`	integer	Position in the group (1-based)
`NameInSource`	string	Name of the element in the source
`DataType`	string	Data Virtuality Server runtime data type name
`Scale`	integer	Number of digits after the decimal point
`Length`	integer	Element length (mostly used for strings)
`isLengthFixed`	boolean	Whether the length is fixed or variable
`SupportsSelect`	boolean	Element can be used in `SELECT`
`SupportsUpdates`	boolean	Values can be inserted or updated in the element
`IsCaseSensitive`	boolean	Element is case-sensitive
`IsSigned`	boolean	Element is a signed numeric value
`IsCurrency`	boolean	Element represents monetary value
`IsAutoIncremented`	boolean	Element is auto-incremented in the source
`NullType`	string	Nullability: "`Nullable`", "`No Nulls`", "`Unknown`"
`MinRange`	string	Minimum value
`MaxRange`	string	Maximum value
`DistinctCount`	integer	Distinct value count, `-1` can indicate unknown
`NullCount`	integer	Null value count, `-1` can indicate unknown
`SearchType`	string	Searchability: "`Searchable`", "`All Except Like`", "`Like Only`", "`Unsearchable`"
`Format`	string	Format of the string value
`DefaultValue`	string	Default value
`JavaClass`	string	Java class that will be returned
`Precision`	integer	Number of digits as a numeric value
`CharOctetLength`	integer	Measure of return value size
`Radix`	integer	Radix for numeric values
`UID`	string	Element unique ID
`Description`	string	Description
`OID`	integer	Unique ID
`NativeType`	string	Data source native data type
`NativePrecision`	integer	Data source native precision
`NativeScale`	integer	Data source native scale
`NativeLength`	integer	Data source native length
`ColumnSize`	integer	For numeric data types, it is equal to the precision; For the character, it is equal to the length; For date/time, it is the string length of a literal value

Native information for JDBC data sources is presented as provided by their JDBC drivers.

SYS.Keys

This table supplies information about primary, foreign, and unique keys.

Column Name	Type	Description
`VDBName`	string	VDB name
`SchemaName`	string	Schema name
`Table Name`	string	Table name
`Name`	string	Key name
`Description`	string	Description
`NameInSource`	string	Name of key in source system
`Type`	string	Type of key: "`Primary`", "`Foreign`", "`Unique`", etc
`IsIndexed`	boolean	`TRUE` if the key is indexed
`RefKeyUID`	string	Referenced key UID (if foreign key)
`UID`	string	Key unique ID
`OID`	integer	Unique ID

SYS.KeyColumns

This table supplies information about the columns referenced by a key.

Column Name	Type	Description
`VDBName`	string	VDB name
`SchemaName`	string	Schema name
`TableName`	string	Table name
`Name`	string	Element name
`KeyName`	string	Key name
`KeyType`	string	Key type: "`Primary`", "`Foreign`", "`Unique`", etc
`RefKeyUID`	string	Referenced key UID
`UID`	string	Key UID
`Position`	integer	Position in key
`OID`	integer	Unique ID

SYS.ReferenceKeyColumns

Column Name	Type	Description
`PKTABLE_CAT`	string	Primary key catalogue
`PKTABLE_SCHEM`	string	Primary key schema
`PKTABLE_NAME`	string	Primary key table
`PKCOLUMN_NAME`	string	Primary key column name
`FKTABLE_CAT`	string	Foreign key catalogue
`FKTABLE_SCHEM`	string	Foreign key schema
`FKTABLE_NAME`	string	Foreign key table
`FKCOLUMN_NAME`	string	Foreign key column name
`KEY_SEQ`	short	Key sequence
`UPDATE_RULE`	integer	Update rule
`DELETE_RULE`	integer	Delete rule
`FK_NAME`	string	Foreign key name
`PK_NAME`	string	Primary key name
`DEFERRABILITY`	integer	Deferrability