Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [Objects] >  [EntityUnique]
Private  Storage   

persistent class %iKnow.Objects.EntityUnique 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 unique Entities.

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.EntityAPI and other query classes to consult Entity data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

Note: the EntUni index only works for entities up to 150 characters.

NOTE: This object assumes all underlying data structures are present. Use domain-specific copies of these objects for domains where not all indices are built. See also the GenerateAllObjectsForDomain() method in %iKnow.Objects.Utils.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 11 6


CorpusDominanceAsConcept CorpusDominanceAsRelation CorpusFrequency CorpusFrequencyAsConcept
CorpusFrequencyAsRelation CorpusSpread CorpusSpreadAsConcept CorpusSpreadAsRelation
DomainId EntUniId EntityValue

%AddToSaveSet %AddToSyncSet %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 %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices


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


• property CorpusDominanceAsConcept as %Numeric [ Calculated ];
• property CorpusDominanceAsRelation as %Numeric [ Calculated ];
• property CorpusFrequency as %Integer [ Calculated ];
• property CorpusFrequencyAsConcept as %Integer [ Calculated ];
• property CorpusFrequencyAsRelation as %Integer [ Calculated ];
• property CorpusSpread as %Integer [ Calculated ];
• property CorpusSpreadAsConcept as %Integer [ Calculated ];
• property CorpusSpreadAsRelation as %Integer [ Calculated ];
• property DomainId as %Integer;
• property EntUniId as %Integer;
• property EntityValue as %String(MAXLEN=2000);


•index (EntUni on DomainId,EntityValue) [Unique];
This Index only works for strings of up to 150 ($$$IKHASHIZE) characters
•index (EntUniFreqCon on DomainId,CorpusFrequencyAsConcept);
•index (EntUniFreqRel on DomainId,CorpusFrequencyAsRelation);
•index (EntUniSpreadCon on DomainId,CorpusSpreadAsConcept);
•index (EntUniSpreadRel on DomainId,CorpusSpreadAsRelation);
•index (PKINDEX on DomainId,EntUniId) [IdKey,PrimaryKey,Unique];

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