Skip to main content


deprecated persistent class %iFind.Entity extends %Library.Persistent

SQL Table Name: %iFind.Entity

The InterSystems IRIS NLP iKnow technology on which this output type is based is now deprecated. Please see the product documentationOpens in a new tab for more detail. The %iKnow.Index.Basic and %iKnow.Index.Minimal index types, which only generate word-level content, remain fully supported.

This table contains all entities identified by iFind Semantic or Analytic indices in this namespace using namespace-wide shared storage (cf the IFINDSHAREDSTORAGELOCATION parameter in %iFind.Index.Basic).

Property Inventory

Method Inventory


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.


property EntityId as %Integer [ Required ];
Property methods: EntityIdDisplayToLogical(), EntityIdGet(), EntityIdIsValid(), EntityIdLogicalToDisplay(), EntityIdNormalize(), EntityIdSet()
property StrippedEntityId as %iFind.Entity [ Calculated ];
Calculated property returning the entity ID of the entity corresponding to this row, with all words stripped of leading and trailing punctuation. If no such entity exists, this record's entity ID is returned.
Property methods: StrippedEntityIdCompute(), StrippedEntityIdGet(), StrippedEntityIdGetObject(), StrippedEntityIdGetObjectId(), StrippedEntityIdSQLCompute()
property Value as %String (COLLATION = "EXACT");
String value for this entity
Property methods: ValueDisplayToLogical(), ValueGet(), ValueIsValid(), ValueLogicalToDisplay(), ValueLogicalToOdbc(), ValueNormalize(), ValueSet()


classmethod GetEntityId(pValue As %String) as %Integer [ SQLProc = GetEntityId ]
Projected as the stored procedure: GetEntityId
Returns the Entity ID corresponding to the supplied string
classmethod GetStrippedEntityId(pEntity As %String, pOriginalId As %Integer = "", pKeepChars As %String = $$$STRIPKEEP) as %Integer [ SQLProc = GetStrippedEntityId ]
Projected as the stored procedure: GetStrippedEntityId
Returns the Entity ID corresponding to the supplied string, after stripping off punctuation. If no such entity exists, pOriginalId is returned.


index (EntityIdx on EntityId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: EntityIdxCheck(), EntityIdxDelete(), EntityIdxExists(), EntityIdxOpen(), EntityIdxSQLCheckUnique(), EntityIdxSQLExists(), EntityIdxSQLFindPKeyByConstraint(), EntityIdxSQLFindRowIDByConstraint()
index (ValueIdx on Value) [Type = key, Unique];
Index methods: ValueIdxCheck(), ValueIdxCheckUnique(), ValueIdxDelete(), ValueIdxExists(), ValueIdxOpen(), ValueIdxSQLCheckUnique(), ValueIdxSQLExists(), ValueIdxSQLFindPKeyByConstraint(), ValueIdxSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: SQLStorage

Maps: 2

  • Map number 1 is named Data

    thismap.Global: ^IRIS.IF.EntityD

  • Map number 2 is named ValueIdx

    thismap.Global: ^IRIS.IF.EntityI

  • ^IRIS.IF.EntityD({EntityId})
    Node Delimiter Piece Name
    $c(0) 1 Value
    Node Delimiter Piece Name
    $c(0) 1 EntityId
FeedbackOpens in a new tab