Class INFORMATION.SCHEMA.KEYCOLUMNUSAGE

persistent class INFORMATION.SCHEMA.KEYCOLUMNUSAGE extends %Library.Persistent

SQL Table Name: KEY_COLUMN_USAGE

Returns one row for each columns for each UNIQUE, PRIMARY KEY, or FOREIGN KEY table constraint in the current namespace for tables that can be accessed by the current user in the current namespace. The KEY_COLUMN_USAGE table has one or more rows for each row in the TABLE_CONSTRAINTS table that has a CONSTRAINT_TYPE of "UNIQUE", "PRIMARY KEY", or "FOREIGN KEY". The rows list the columns that constitute each unique constraint, and the referencing columns in each foreign key constraint.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	20			2

Summary

Properties
COLUMNNAME	CONSTRAINTCATALOG	CONSTRAINTNAME	CONSTRAINTSCHEMA
CONSTRAINTTYPE	ORDINALPOSITION	POSITIONINUNIQUECONSTRAINT	REFERENCEDCOLUMNNAME
REFERENCEDCONSTRAINTNAME	REFERENCEDTABLECATALOG	REFERENCEDTABLENAME	REFERENCEDTABLESCHEMA
TABLECATALOG	TABLENAME	TABLESCHEMA

Methods
%AddToSaveSet	%AddToSyncSet	%BuildDeferredIndices	%BuildIndicesAsync
%BuildIndicesAsyncResponse	%CheckConstraints	%CheckConstraintsForExtent	%ClassIsLatestVersion
%ClassName	%ComposeOid	%ConstructClone	%Delete
%DeleteExtent	%DeleteId	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%Exists	%ExistsId	%Extends
%GUID	%GUIDSet	%GetLock	%GetParameter
%GetSwizzleObject	%Id	%IsA	%IsModified
%IsNull	%KillExtent	%LockExtent	%LockId
%New	%NormalizeObject	%ObjectIsNull	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDeleteFinally	%OnDetermineClass
%OnOpenFinally	%OnSaveFinally	%Open	%OpenId
%OriginalNamespace	%PackageName	%PurgeIndices	%Reload
%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack	%Save
%SaveDirect	%SerializeObject	%SetModified	%SortBegin
%SortEnd	%SyncObjectIn	%SyncTransport	%UnlockExtent
%UnlockId	%ValidateIndices	%ValidateObject	%ValidateTable

Parameters

• parameter READONLY = 1;

READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

• property COLUMNNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = COLUMN_NAME,Required ];

Name of the column.

• property CONSTRAINTCATALOG as %String(MAXLEN=128) [ Calculated,SqlFieldName = CONSTRAINT_CATALOG ];

Table qualifier - always NULL in InterSystems IRIS.

• property CONSTRAINTNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = CONSTRAINT_NAME ];

Name of the constraint.

• property CONSTRAINTSCHEMA as %String(COLLATION="Upper",MAXLEN=128) [ Calculated,SqlFieldName = CONSTRAINT_SCHEMA ];

Name of schema that contains the constraint. Always the same as the TABLE_SCHEMA.

• property CONSTRAINTTYPE as %String(MAXLEN=11,VALUELIST=",FOREIGN KEY,UNIQUE,PRIMARY KEY,CHECK") [ SqlFieldName = CONSTRAINT_TYPE,Required ];

CONSTRAINT_TYPE Returns one of the following values:

FOREIGN KEY - The constraint being described is a foreign key constraint.

UNIQUE - The constraint being described is a unique constraint.

PRIMARY KEY - The constraint being described is a primary key constraint.

CHECK - The constraint being described is a check constraint.

• property ORDINALPOSITION as %Integer(MINVAL=1) [ SqlFieldName = ORDINAL_POSITION,Required ];

Column's ordinal position within the contraint. The value of ORDINAL_POSITION is the ordinal position of the specific column in the constraint being described. If the constraint described is a key of cardinality 1 (one), then the value of ORDINAL_POSITION is always 1 (one).

• property POSITIONINUNIQUECONSTRAINT as %Integer(MINVAL=1) [ Calculated,SqlFieldName = POSITION_IN_UNIQUE_CONSTRAINT ];

Referenced column's ordinal position in the referenced unique constraint.
If the constraint being described is a foreign key constraint, then the value of POSITION_IN_UNIQUE_CONSTRAINT is the ordinal position of the referenced column corresponding to the referencing column being described, in the corresponding unique key constraint.

• property REFERENCEDCOLUMNNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = REFERENCED_COLUMN_NAME ];

Name of the column this foreign key references.

• property REFERENCEDCONSTRAINTNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = REFERENCED_CONSTRAINT_NAME ];

Name of the constraint this foreign key references.

• property REFERENCEDTABLECATALOG as %String(COLLATION="Upper",MAXLEN=128) [ Calculated,SqlFieldName = REFERENCED_TABLE_CATALOG ];

Referenced table qualifier - always NULL in InterSystems IRIS.

• property REFERENCEDTABLENAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = REFERENCED_TABLE_NAME ];

Name of the table this foreign key references.

• property REFERENCEDTABLESCHEMA as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = REFERENCED_TABLE_SCHEMA ];

Name of schema that contains the table this foreign key references.

• property TABLECATALOG as %String(MAXLEN=128) [ Calculated,SqlFieldName = TABLE_CATALOG ];

Table qualifier - always NULL in InterSystems IRIS.

• property TABLENAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = TABLE_NAME,Required ];

Name of the table.

• property TABLESCHEMA as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = TABLE_SCHEMA,Required ];

Name of schema that contains the table.

Indices

•index (PKeyIndex on TABLESCHEMA,TABLENAME,CONSTRAINTNAME,COLUMNNAME) [PrimaryKey];

Class Reference IRIS for UNIX 2024.1.2
Documentation Search