Class Reference
%TSQL.sys.keys
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
  
-
  [USER] >  [%TSQL] >  [sys] >  [keys]
Private  Storage

persistent class %TSQL.sys.keys extends %Persistent

contains one row for each primary, foreign, or common key.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 14 1


Summary

Properties
constrid id key1 key2 key3
key4 key5 key6 key7 key8
keycnt parentobjname schema type

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 constrid as %Integer [ SqlFieldName = constr_id ];
Object ID of the constraint this key belongs to
• property id as %Integer;
Object ID of the table this key belongs to
• property key1 as %Integer;
Column ID
• property key2 as %Integer;
Column ID
• property key3 as %Integer;
Column ID
• property key4 as %Integer;
Column ID
• property key5 as %Integer;
Column ID
• property key6 as %Integer;
Column ID
• property key7 as %Integer;
Column ID
• property key8 as %Integer;
Column ID
• property keycnt as %Integer;
Number of non-NULL keys
• property parentobjname as %String(MAXLEN=128) [ SqlFieldName = parent_obj_name ];
Parent Object name Object name of the parent_obj.
• property schema as %String(MAXLEN=128);
Name of the schema the column resides in
• property type as %SmallInt;
Record type

Indices

•index (IDKEYIndex on id,constrid) [IdKey,Unique];

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