Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [INFORMATION] >  [SCHEMA] >  [REFERENTIALCONSTRAINTS]
Private  Storage   

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

SQL Table Name: REFERENTIAL_CONSTRAINTS

Returns one row for each FOREIGN KEY table constraint in the current namespace for tables that can be accessed by the current user in the current namespace. The REFERENTIAL_CONSTRAINTS table has one row for each row in the TABLE_CONSTRAINTS table that has a CONSTRAINT_TYPE value of "FOREIGN KEY".

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 15 2


Summary

Properties
CONSTRAINTCATALOG CONSTRAINTNAME CONSTRAINTSCHEMA CONSTRAINTTABLENAME
DELETERULE MATCHOPTION UNIQUECONSTRAINTCATALOG UNIQUECONSTRAINTNAME
UNIQUECONSTRAINTSCHEMA UNIQUECONSTRAINTTABLE UPDATERULE

Methods
%AddToSaveSet %AddToSyncSet %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 %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject


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 CONSTRAINTCATALOG as %String(MAXLEN=128) [ Calculated,SqlFieldName = CONSTRAINT_CATALOG ];
Catalog qualifier - always NULL in InterSystems IRIS.
• property CONSTRAINTNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = CONSTRAINT_NAME ];
Foreign key constraint name.
• property CONSTRAINTSCHEMA as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = CONSTRAINT_SCHEMA ];
Name of schema that contains the foreign key constraint.
• property CONSTRAINTTABLENAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = CONSTRAINT_TABLE_NAME,Required ];
Name of the table that contains the foreign key constraint.
• property DELETERULE as %String(MAXLEN=11,VALUELIST=",CASCADE,SET NULL,SET DEFAULT,RESTRICT,NO ACTION") [ SqlFieldName = DELETE_RULE,Required ];
The values of DELETE_RULE have the following meanings for foreign keys constraints:
  • NO ACTION - A referential action of NO ACTION was specified.
  • SET NULL - A referential action of SET NULL was specified.
  • SET DEFAULT - A referential action of SET DEFAULT was specified.
  • RESTRICT - A referential action of RESTRICT was specified.
  • CASCADE - A referential action of CASCADE was specified.
• property MATCHOPTION as %String(MAXLEN=7,VALUELIST=",NONE,PARTIAL,FULL") [ Calculated,SqlFieldName = MATCH_OPTION ];
The values of MATCH_OPTION have the following meanings:
  • NONE - No match type was specified.
  • PARTIAL - A match type of partial was specified.
  • FULL - A match type of full was specified.
For InterSystems IRIS MATCH_OPTION is always NONE.
• property UNIQUECONSTRAINTCATALOG as %String(MAXLEN=128) [ Calculated,SqlFieldName = UNIQUE_CONSTRAINT_CATALOG ];
Unique Constraint qualifier - always NULL in InterSystems IRIS.
• property UNIQUECONSTRAINTNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = UNIQUE_CONSTRAINT_NAME,Required ];
Name of the unique constraint the foreign key constraint references.
• property UNIQUECONSTRAINTSCHEMA as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = UNIQUE_CONSTRAINT_SCHEMA,Required ];
Name of the schema that contains the unique constraint the foreign key references.
• property UNIQUECONSTRAINTTABLE as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = UNIQUE_CONSTRAINT_TABLE,Required ];
Name of the table that contains the unique constraint the foreign key references.
• property UPDATERULE as %String(MAXLEN=11,VALUELIST=",CASCADE,SET NULL,SET DEFAULT,RESTRICT,NO ACTION") [ SqlFieldName = UPDATE_RULE,Required ];
The values of UPDATE_RULE have the following meanings for foreign keys constraints:
  • NO ACTION - A referential action of NO ACTION was specified.
  • SET NULL - A referential action of SET NULL was specified.
  • SET DEFAULT - A referential action of SET DEFAULT was specified.
  • RESTRICT - A referential action of RESTRICT was specified.
  • CASCADE - A referential action of CASCADE was specified.

Indices

•index (PKeyIndex on CONSTRAINTSCHEMA,CONSTRAINTNAME) [PrimaryKey];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.