Class INFORMATION.SCHEMA.TABLECONSTRAINTS

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

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

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	13			2

Summary

Properties
CONSTRAINTCATALOG	CONSTRAINTNAME	CONSTRAINTSCHEMA	CONSTRAINTTYPE
INITIALLYDEFERRED	ISDEFERRABLE	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 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 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 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 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) [PrimaryKey];

Class Reference IRIS for UNIX 2024.1.2
Documentation Search