SYSTEMTABLEFOREIGNKEYS: Data Dictionary Foreign Keys
read only
- Catalog:
DataDictionary - Schema:
Invantive - Label: Foreign Keys
Foreign keys per table per data container, one row per column of a foreign key.
Can only retrieve data.
Summary
Lists the foreign keys the driver knows of the tables it has loaded the metadata of. The guarantee tells whether the engine may trust a foreign key to leave out an inner join: 'Declared' foreign keys are shown but not relied upon.
Table Columns
The columns of the table SYSTEMTABLEFOREIGNKEYS are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
COLUMN_ |
varchar2 |
Column Name | Name of the column. | ||
COLUMN_ |
int32 |
Column Position | Position of the column within the key, starting at 1. | ||
ID |
int32 |
ID | Unique ID of the row. | ||
KEY_ |
int32 |
Columns | Number of columns of the key. | ||
KEY_ |
varchar2 |
Description | When the relation holds or what it was found on, in words; always filled for a textual or candidate foreign key. | ||
KEY_ |
varchar2 |
Key Status | What holds the key: 'Declared' (not relied upon), 'Enforced' or 'EnforcedIgnoringTrailingBlanks' (enforced, comparing texts without their trailing blanks). | ||
KEY_ |
varchar2 |
Key Type | Kind of the foreign key: 'Key' (the columns refer to a key of the table referred to), 'Textual' (described in words only, such as a polymorphic reference or a row that may have moved to an archive) or 'Candidate' (follows from the names and holds in the data, but is not stated by the platform). | ||
KEY_ |
varchar2 |
Key Name | Name of the key, when known. | ||
PROVIDER_ |
varchar2 |
Data Container Alias | Data container alias. | ||
PROVIDER_ |
varchar2 |
Data Container ID | Data container ID. | ||
PROVIDER_ |
varchar2 |
Provider Description | Provider description. | ||
PROVIDER_ |
guid |
Provider Instance UID | Unique ID of the provider instance. | ||
PROVIDER_ |
varchar2 |
Provider Name | Name of the provider. | ||
PROVIDER_ |
varchar2 |
Provider Short Name | Provider short name. | ||
REFERENCED_ |
varchar2 |
Reference Column Name | Name of the column referred to, at the same position in the key referred to. | ||
REFERENCED_ |
varchar2 |
Reference Table | Name of the table referred to. | ||
REFERENCED_ |
varchar2 |
Reference Schema | Schema of the table referred to, when known. | ||
TABLE_ |
varchar2 |
Table Catalog | Catalog where the tables are contained in. | ||
TABLE_ |
varchar2 |
Table Full Qualified Name | Full qualified name. | ||
TABLE_ |
varchar2 |
Table Name | Name of the table or view. | ||
TABLE_ |
varchar2 |
Table Schema | Schema within the catalog where the table is contained in. | ||
TABLE_ |
varchar2 |
Table Type | Type, can be either 'view' or 'table'. |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
SYSTEMTABLEFOREIGNKEYS_ |
PROVIDER_ |
SYSTEMDATACONTAINERS. |
Key | |
SYSTEMTABLEFOREIGNKEYS_ |
PROVIDER_ |
SYSTEMTABLES. |
Key | |
SYSTEMTABLEFOREIGNKEYS_ |
TABLE_ |
SYSTEMTABLES. |
Key | |
SYSTEMTABLEFOREIGNKEYS_ |
TABLE_ |
SYSTEMTABLES. |
Key | |
SYSTEMTABLEFOREIGNKEYS_ |
TABLE_ |
SYSTEMTABLES.NAME |
Key |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: