Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%iKnow] >  [Objects] >  [MetadataField]
Private  Storage   

deprecatedpersistent class %iKnow.Objects.MetadataField extends %Persistent

Note: the use of this class is no longer recommended for accessing elements of a specific domain. For those scenarios, %iKnow.Tables.Utils offers a more flexible and customizable way of projecting iKnow domain data to SQL

This is a read-only object representation wrapping the internal iKnow data structures for Metadata fields.

This class can be used from ObjectScript or SQL to access a single or small number of entries, but the storage mappings are not meant to support elaborate or complex queries targeting this SQL table.

Please use the predefined queries in %iKnow.Queries.MetadataAPI and other query classes to consult metadata as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 11 2


Summary

Properties
DataType DomainId FieldId HasBitstringStorage
Hidden IsCaseSensitive ListOfValuesId Name
StorageType SupportedOperators ValidateListOfValues

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 DataType as %String;
• property DomainId as %Integer;
• property FieldId as %Integer;
• property HasBitstringStorage as %Boolean [ Calculated ];
• property Hidden as %Boolean;
• property IsCaseSensitive as %Boolean;
• property ListOfValuesId as %Integer;
• property Name as %String(MAXLEN=1000);
• property StorageType as %Integer;
• property SupportedOperators as %String [ Calculated ];
• property ValidateListOfValues as %Boolean;

Indices

•index (NameIndex on DomainId,Name) [Unique];
•index (PKINDEX on DomainId,FieldId) [IdKey,PrimaryKey,Unique];

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