IRISLIB database
KEYCOLUMNUSAGE Class Reference

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. More...

Inheritance diagram for KEYCOLUMNUSAGE:
Collaboration diagram for KEYCOLUMNUSAGE:

Public Attributes

 COLUMNNAME
 Name of the column. More...
 
 CONSTRAINTCATALOG
 Table qualifier - always NULL in InterSystems IRIS. More...
 
 CONSTRAINTNAME
 Name of the constraint. More...
 
 CONSTRAINTSCHEMA
 Name of schema that contains the constraint. More...
 
 CONSTRAINTTYPE
 CONSTRAINT_TYPE Returns one of the following values: More...
 
 ORDINALPOSITION
 Column's ordinal position within the contraint. More...
 
 POSITIONINUNIQUECONSTRAINT
 Referenced column's ordinal position in the referenced unique constraint. More...
 
 REFERENCEDCOLUMNNAME
 Name of the column this foreign key references. More...
 
 REFERENCEDCONSTRAINTNAME
 Name of the constraint this foreign key references. More...
 
 REFERENCEDTABLECATALOG
 Referenced table qualifier - always NULL in InterSystems IRIS. More...
 
 REFERENCEDTABLENAME
 Name of the table this foreign key references. More...
 
 REFERENCEDTABLESCHEMA
 Name of schema that contains the table this foreign key references. More...
 
 TABLECATALOG
 Table qualifier - always NULL in InterSystems IRIS. More...
 
 TABLENAME
 Name of the table. More...
 
 TABLESCHEMA
 Name of schema that contains the table. More...
 

Additional Inherited Members

- Public Member Functions inherited from Persistent
_.Library.Status AcquireLock (_.Library.String locktype)
 Acquires a lock for the current instance. More...
 
_.Library.Status LoadData (_.Library.String id)
 LoadData() - loads an object from storage. More...
 
_.Library.Status OnAfterSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnOpen ()
 This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
 
_.Library.Status OnReload ()
 This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
 
_.Library.Status OnRollBack ()
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status ReleaseLock (_.Library.String locktype)
 Releases a lock for the current instance. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() - saves an object to disk, checks uniqueness and referential More...
 
- Public Member Functions inherited from SwizzleObject
_.Library.Status OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
 This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Member Functions inherited from Persistent
_.Library.Status DeleteData (_.Library.String id, _.Library.Integer concurrency)
 This method is normally generated by the storage class for persistent classes using. More...
 
_.Library.Status KillExtentData (_.Library.Boolean killstreams)
 KillExtentData() - kills extent data in storage. More...
 
_.Library.Status OnAfterBuildIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnAfterDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
_.Library.Status OnAfterPurgeIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnBeforeBuildIndices (_.Library.String indexlist)
 
_.Library.Status OnBeforePurgeIndices (_.Library.String indexlist)
 
_.Library.Status OnDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
- Static Public Attributes inherited from Persistent
 XCOMPACTANCESTRY
 XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
 
 DATALOCATIONGLOBAL = None
 Global name containing master map data for this class. More...
 
 DEFAULTGLOBAL = None
 
 DSCONDITION = None
 DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
 
 DSINTERVAL = None
 DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
 
 DSTIME = None
 If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
 
 EXTENTQUERYSPEC = None
 The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
 
 EXTENTSIZE = None
 The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
 
 GUIDENABLED = None
 If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
 
 IDENTIFIEDBY = None
 The IDENTIFIEDBY parameter can optionally be set to the name. More...
 
 MANAGEDEXTENT = None
 The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
 
 READONLY = None
 READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
 
 ROWLEVELSECURITY = None
 ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
 
 SQLPREVENTFULLSCAN = None
 SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
 
 STORAGEDEFAULT = None
 STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
 
 USEEXTENTSET = None
 
 VERSIONCLIENTNAME = None
 VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
 
 VERSIONPROPERTY = None
 VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
 
- Static Public Attributes inherited from SwizzleObject
 DEFAULTCONCURRENCY = None
 DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
 
 JOURNALSTREAM = None
 If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
 
 OBJJOURNAL = None
 if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

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.

Member Data Documentation

◆ COLUMNNAME

COLUMNNAME

Name of the column.

 

◆ CONSTRAINTCATALOG

CONSTRAINTCATALOG

Table qualifier - always NULL in InterSystems IRIS.

 

◆ CONSTRAINTNAME

CONSTRAINTNAME

Name of the constraint.

 

◆ CONSTRAINTSCHEMA

CONSTRAINTSCHEMA

Name of schema that contains the constraint.

Always the same as the TABLE_SCHEMA.

 

◆ CONSTRAINTTYPE

CONSTRAINTTYPE

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.

 

◆ ORDINALPOSITION

ORDINALPOSITION

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).  

◆ POSITIONINUNIQUECONSTRAINT

POSITIONINUNIQUECONSTRAINT

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.  

◆ REFERENCEDCOLUMNNAME

REFERENCEDCOLUMNNAME

Name of the column this foreign key references.

 

◆ REFERENCEDCONSTRAINTNAME

REFERENCEDCONSTRAINTNAME

Name of the constraint this foreign key references.

 

◆ REFERENCEDTABLECATALOG

REFERENCEDTABLECATALOG

Referenced table qualifier - always NULL in InterSystems IRIS.

 

◆ REFERENCEDTABLENAME

REFERENCEDTABLENAME

Name of the table this foreign key references.

 

◆ REFERENCEDTABLESCHEMA

REFERENCEDTABLESCHEMA

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

 

◆ TABLECATALOG

TABLECATALOG

Table qualifier - always NULL in InterSystems IRIS.

 

◆ TABLENAME

TABLENAME

Name of the table.

 

◆ TABLESCHEMA

TABLESCHEMA

Name of schema that contains the table.