Skip to main content


persistent class %BI.Hi extends %Library.Persistent

SQL Table Name: %BI.Hi

This [read-only] class/table maps to a single condition row in ^SpeedI.Hi It contains one record per Id present in the bitstring. The Id is Col#, the data is Id in target class. It can be used as a normal table, as in select Name,City,Country,Sex into :name,:city,:country,:sex from Speed.Hi,SQLUser.HPerson where Class = "User.HPerson" and Cond = 1961 and TheId = SQLUser.HPerson.Id

Property Inventory

Method Inventory


property Class as %String (TRUNCATE = 1) [ Required ];
Property methods: ClassDisplayToLogical(), ClassGet(), ClassIsValid(), ClassLogicalToDisplay(), ClassLogicalToOdbc(), ClassNormalize(), ClassSet()
property Col as %Integer [ Required ];
Property methods: ColDisplayToLogical(), ColGet(), ColIsValid(), ColLogicalToDisplay(), ColNormalize(), ColSet()
property Cond as %BI.Condition [ Required ];
Property methods: CondGet(), CondGetObject(), CondGetObjectId(), CondGetSwizzled(), CondIsValid(), CondNewObject(), CondSet(), CondSetObject(), CondSetObjectId(), CondUnSwizzle()
property NumericId as %Integer;
Property methods: NumericIdDisplayToLogical(), NumericIdGet(), NumericIdIsValid(), NumericIdLogicalToDisplay(), NumericIdNormalize(), NumericIdSet()
property StringId as %String (TRUNCATE = 1);
Property methods: StringIdDisplayToLogical(), StringIdGet(), StringIdIsValid(), StringIdLogicalToDisplay(), StringIdLogicalToOdbc(), StringIdNormalize(), StringIdSet()


final method %OnBeforeSave(Insert As %Boolean) as %Status
Inherited description: This callback method is invoked by the %Save() method to provide notification that the object is being saved. It is called before any data is written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save() will fail.

final classmethod %OnDelete(Oid As %ObjectIdentity) as %Status
Inherited description: This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted.


index (Col on Class,Cond,Col) [IdKey, Type = key];
Index methods: ColCheck(), ColDelete(), ColDisplayToLogical(), ColExists(), ColGet(), ColIsValid(), ColLogicalToDisplay(), ColNormalize(), ColOpen(), ColSQLCheckUnique(), ColSQLExists(), ColSQLFindPKeyByConstraint(), ColSQLFindRowIDByConstraint(), ColSet()


trigger HyperDelete (BEFORE event DELETE);
trigger HyperInsert (BEFORE event INSERT);
trigger HyperUpdate (BEFORE event UPDATE);

Inherited Members

Inherited Methods


Storage Model: CacheSQLStorage

Maps: 1

  • Map number 1 is named HiMaster

    Row Reference: ^BIidx.Col({Class},{Col})

    thismap.Global: ^BIidx.Hi

  • ^BIidx.Hi({Class},{Cond},{Col})
    Node Delimiter Piece Name
FeedbackOpens in a new tab