InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > INFORMATION.SCHEMA.TABLECONSTRAINTS

INFORMATION.SCHEMA.TABLECONSTRAINTS

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

SQL Table Name: INFORMATION_SCHEMA.TABLE_CONSTRAINTS

Returns one row for each table constraint in the current namespace for tables that can be accessed by the current user in the current namespace.

Property Inventory

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

property CONSTRAINTCATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = CONSTRAINT_CATALOG ];
Table qualifier - always NULL in InterSystems IRIS.
Property methods: CONSTRAINTCATALOGCompute(), CONSTRAINTCATALOGDisplayToLogical(), CONSTRAINTCATALOGGet(), CONSTRAINTCATALOGIsValid(), CONSTRAINTCATALOGLogicalToDisplay(), CONSTRAINTCATALOGLogicalToOdbc(), CONSTRAINTCATALOGNormalize(), CONSTRAINTCATALOGSQLCompute()
property CONSTRAINTNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = CONSTRAINT_NAME , Required ];
Name of the constraint.
Property methods: CONSTRAINTNAMEDisplayToLogical(), CONSTRAINTNAMEGet(), CONSTRAINTNAMEIsValid(), CONSTRAINTNAMELogicalToDisplay(), CONSTRAINTNAMELogicalToOdbc(), CONSTRAINTNAMENormalize(), CONSTRAINTNAMESet()
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 methods: CONSTRAINTSCHEMACompute(), CONSTRAINTSCHEMADisplayToLogical(), CONSTRAINTSCHEMAGet(), CONSTRAINTSCHEMAIsValid(), CONSTRAINTSCHEMALogicalToDisplay(), CONSTRAINTSCHEMALogicalToOdbc(), CONSTRAINTSCHEMANormalize(), CONSTRAINTSCHEMASQLCompute()
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 methods: CONSTRAINTTYPEDisplayToLogical(), CONSTRAINTTYPEGet(), CONSTRAINTTYPEIsValid(), CONSTRAINTTYPELogicalToDisplay(), CONSTRAINTTYPELogicalToOdbc(), CONSTRAINTTYPENormalize(), CONSTRAINTTYPESet()
property INITIALLYDEFERRED as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ Calculated , SqlFieldName = INITIALLY_DEFERRED , Required ];
If the constraint is initially deferred, INITIALLY_DEFERRED returns YES, otherwise NO. InterSystems IRIS only supports non-deferrable constraints.
Property methods: INITIALLYDEFERREDCompute(), INITIALLYDEFERREDDisplayToLogical(), INITIALLYDEFERREDGet(), INITIALLYDEFERREDIsValid(), INITIALLYDEFERREDLogicalToDisplay(), INITIALLYDEFERREDLogicalToOdbc(), INITIALLYDEFERREDNormalize(), INITIALLYDEFERREDSQLCompute()
property ISDEFERRABLE as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ Calculated , SqlFieldName = IS_DEFERRABLE , Required ];
If the constraint is deferrable, IS_DEFERRABLE returns YES, otherwise NO. InterSystems IRIS only supports non-deferrable constraints.
Property methods: ISDEFERRABLECompute(), ISDEFERRABLEDisplayToLogical(), ISDEFERRABLEGet(), ISDEFERRABLEIsValid(), ISDEFERRABLELogicalToDisplay(), ISDEFERRABLELogicalToOdbc(), ISDEFERRABLENormalize(), ISDEFERRABLESQLCompute()
property TABLECATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = TABLE_CATALOG ];
Table qualifier - always NULL in InterSystems IRIS.
Property methods: TABLECATALOGCompute(), TABLECATALOGDisplayToLogical(), TABLECATALOGGet(), TABLECATALOGIsValid(), TABLECATALOGLogicalToDisplay(), TABLECATALOGLogicalToOdbc(), TABLECATALOGNormalize(), TABLECATALOGSQLCompute()
property TABLENAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = TABLE_NAME , Required ];
Name of the table.
Property methods: TABLENAMEDisplayToLogical(), TABLENAMEGet(), TABLENAMEIsValid(), TABLENAMELogicalToDisplay(), TABLENAMELogicalToOdbc(), TABLENAMENormalize(), TABLENAMESet()
property TABLESCHEMA as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = TABLE_SCHEMA , Required ];
Name of schema that contains the table.
Property methods: TABLESCHEMADisplayToLogical(), TABLESCHEMAGet(), TABLESCHEMAIsValid(), TABLESCHEMALogicalToDisplay(), TABLESCHEMALogicalToOdbc(), TABLESCHEMANormalize(), TABLESCHEMASet()

Indexes

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

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: SQLStorage

Maps: 2

Feedback