Skip to main content
Skip table of contents

Table Metadata

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 set at the CData Virtuality Server

OriginalDescriptionstringDescription from the data source

IsSystem

boolean

TRUE if in the system table

IsMaterializedbooleanDefines whether the corresponding table/view is materialized or cached in Teiid

OID

integer

Unique ID*

* The OID column is guaranteed to be unique/consistent unsafe-only for the given version running instance of a VDB. If a different version of the VDB is deployed, these IDs are not guaranteed to be the same or unique across both versions of the VDB. Dynamic VDB OIDs are not cluster-safe.

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

CData 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

DescriptionstringDescription set at the CData Virtuality Server
OriginalDescriptionstringDescription from the data source

OID

integer

Unique ID*

NativeTypestringData source native data type
NativePrecisionintegerData source native precision
NativeScaleintegerData source native scale
NativeLengthintegerData source native length
ColumnSizeinteger
  • 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

* The OID column is guaranteed to be unique/consistent unsafe-only for the given version running instance of a VDB. If a different version of the VDB is deployed, these IDs are not guaranteed to be the same or unique across both versions of the VDB. Dynamic VDB OIDs are not cluster-safe.

(info) 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*

* The OID column is guaranteed to be unique/consistent unsafe-only for the given version running instance of a VDB. If a different version of the VDB is deployed, these IDs are not guaranteed to be the same or unique across both versions of the VDB. Dynamic VDB OIDs are not cluster-safe.

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*

* The OID column is guaranteed to be unique/consistent unsafe-only for the given version running instance of a VDB. If a different version of the VDB is deployed, these IDs are not guaranteed to be the same or unique across both versions of the VDB. Dynamic VDB OIDs are not cluster-safe.

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_RULEintegerDelete rule
FK_NAMEstringForeign key name
PK_NAMEstringPrimary key name
DEFERRABILITYintegerDeferrability

SYSADMIN.Remarks

This table supplies information about the remarks created for data source objects in CData Virtuality Server.

Column Name

Type

Description

id

string

Remark ID

resName

string

Name of the object the remark is issued for

resType

string

Type of object with the remark (i.e. table, procedure, table_column, etc.)

remark

string

Remark text

orphaned

boolean

Flag indicating if the remark is obsolete

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.