Home > Class Reference > ENSLIB namespace > INFORMATION.SCHEMA.REFERENTIALCONSTRAINTS

INFORMATION.SCHEMA.REFERENTIALCONSTRAINTS

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

SQL Table Name: INFORMATION_SCHEMA.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".

Property Inventory (Including Private)

Parameters

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

Properties (Including Private)

property CONSTRAINTCATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = CONSTRAINT_CATALOG ];
Catalog qualifier - always NULL in Caché.
Property methods: CONSTRAINTCATALOGCompute(), CONSTRAINTCATALOGDisplayToLogical(), CONSTRAINTCATALOGGet(), CONSTRAINTCATALOGIsValid(), CONSTRAINTCATALOGLogicalToDisplay(), CONSTRAINTCATALOGLogicalToOdbc(), CONSTRAINTCATALOGNormalize(), CONSTRAINTCATALOGSQLCompute()
property CONSTRAINTNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = CONSTRAINT_NAME , Required ];
Foreign key constraint name.
Property methods: CONSTRAINTNAMEDisplayToLogical(), CONSTRAINTNAMEGet(), CONSTRAINTNAMEIsValid(), CONSTRAINTNAMELogicalToDisplay(), CONSTRAINTNAMELogicalToOdbc(), CONSTRAINTNAMENormalize(), CONSTRAINTNAMESet()
property CONSTRAINTSCHEMA as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = CONSTRAINT_SCHEMA , Required ];
Name of schema that contains the foreign key constraint.
Property methods: CONSTRAINTSCHEMADisplayToLogical(), CONSTRAINTSCHEMAGet(), CONSTRAINTSCHEMAIsValid(), CONSTRAINTSCHEMALogicalToDisplay(), CONSTRAINTSCHEMALogicalToOdbc(), CONSTRAINTSCHEMANormalize(), CONSTRAINTSCHEMASet()
property CONSTRAINTTABLENAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = CONSTRAINT_TABLE_NAME , Required ];
Name of the table that contains the foreign key constraint.
Property methods: CONSTRAINTTABLENAMEDisplayToLogical(), CONSTRAINTTABLENAMEGet(), CONSTRAINTTABLENAMEIsValid(), CONSTRAINTTABLENAMELogicalToDisplay(), CONSTRAINTTABLENAMELogicalToOdbc(), CONSTRAINTTABLENAMENormalize(), CONSTRAINTTABLENAMESet()
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 methods: DELETERULEDisplayToLogical(), DELETERULEGet(), DELETERULEIsValid(), DELETERULELogicalToDisplay(), DELETERULELogicalToOdbc(), DELETERULELogicalToStorage(), DELETERULENormalize(), DELETERULESet(), DELETERULEStorageToLogical()
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 Caché MATCH_OPTION is always NONE.
Property methods: MATCHOPTIONCompute(), MATCHOPTIONDisplayToLogical(), MATCHOPTIONGet(), MATCHOPTIONIsValid(), MATCHOPTIONLogicalToDisplay(), MATCHOPTIONLogicalToOdbc(), MATCHOPTIONNormalize(), MATCHOPTIONSQLCompute()
property UNIQUECONSTRAINTCATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = UNIQUE_CONSTRAINT_CATALOG ];
Unique Constraint qualifier - always NULL in Caché.
Property methods: UNIQUECONSTRAINTCATALOGCompute(), UNIQUECONSTRAINTCATALOGDisplayToLogical(), UNIQUECONSTRAINTCATALOGGet(), UNIQUECONSTRAINTCATALOGIsValid(), UNIQUECONSTRAINTCATALOGLogicalToDisplay(), UNIQUECONSTRAINTCATALOGLogicalToOdbc(), UNIQUECONSTRAINTCATALOGNormalize(), UNIQUECONSTRAINTCATALOGSQLCompute()
property UNIQUECONSTRAINTNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = UNIQUE_CONSTRAINT_NAME , Required ];
Name of the unique constraint the foreign key constraint references.
Property methods: UNIQUECONSTRAINTNAMEDisplayToLogical(), UNIQUECONSTRAINTNAMEGet(), UNIQUECONSTRAINTNAMEIsValid(), UNIQUECONSTRAINTNAMELogicalToDisplay(), UNIQUECONSTRAINTNAMELogicalToOdbc(), UNIQUECONSTRAINTNAMENormalize(), UNIQUECONSTRAINTNAMESet()
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 methods: UNIQUECONSTRAINTSCHEMADisplayToLogical(), UNIQUECONSTRAINTSCHEMAGet(), UNIQUECONSTRAINTSCHEMAIsValid(), UNIQUECONSTRAINTSCHEMALogicalToDisplay(), UNIQUECONSTRAINTSCHEMALogicalToOdbc(), UNIQUECONSTRAINTSCHEMANormalize(), UNIQUECONSTRAINTSCHEMASet()
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 methods: UNIQUECONSTRAINTTABLEDisplayToLogical(), UNIQUECONSTRAINTTABLEGet(), UNIQUECONSTRAINTTABLEIsValid(), UNIQUECONSTRAINTTABLELogicalToDisplay(), UNIQUECONSTRAINTTABLELogicalToOdbc(), UNIQUECONSTRAINTTABLENormalize(), UNIQUECONSTRAINTTABLESet()
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.
Property methods: UPDATERULEDisplayToLogical(), UPDATERULEGet(), UPDATERULEIsValid(), UPDATERULELogicalToDisplay(), UPDATERULELogicalToOdbc(), UPDATERULELogicalToStorage(), UPDATERULENormalize(), UPDATERULESet(), UPDATERULEStorageToLogical()

Indexes

index (PKeyIndex on CONSTRAINTSCHEMA,CONSTRAINTNAME) [PrimaryKey];
Index methods: PKeyIndexCheck(), PKeyIndexCheckUnique(), PKeyIndexDelete(), PKeyIndexExists(), PKeyIndexOpen(), PKeyIndexSQLCheckUnique(), PKeyIndexSQLExists(), PKeyIndexSQLFindPKeyByConstraint(), PKeyIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)