This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


persistent class %Dictionary.CompiledStorageProperty extends %Library.Persistent

SQL Table Name: %Dictionary.CompiledStorageProperty

Property Inventory

Method Inventory


parameter SQLENABLED = 1;


property AverageFieldSize as %CacheString;
Property methods: AverageFieldSizeGet(), AverageFieldSizeIsValid(), AverageFieldSizeSet()
property BiasQueriesAsOutlier as %CacheString;
Property methods: BiasQueriesAsOutlierGet(), BiasQueriesAsOutlierIsValid(), BiasQueriesAsOutlierSet()
property ChildBlockCount as %CacheString;
Property methods: ChildBlockCountGet(), ChildBlockCountIsValid(), ChildBlockCountSet()
property ChildExtentSize as %CacheString;
Property methods: ChildExtentSizeGet(), ChildExtentSizeIsValid(), ChildExtentSizeSet()
property KeywordError as %Boolean;
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
property Name as %CacheString [ Required ];
Property methods: NameGet(), NameIsValid(), NameSet()
property OutlierSelectivity as %CacheString;
Property methods: OutlierSelectivityGet(), OutlierSelectivityIsValid(), OutlierSelectivitySet()
property Selectivity as %CacheString;
Property methods: SelectivityGet(), SelectivityIsValid(), SelectivitySet()
property StreamLocation as %CacheString;
Property methods: StreamLocationGet(), StreamLocationIsValid(), StreamLocationSet()
relationship parent as %Dictionary.CompiledStorage [ Required , Inverse = Properties , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()


classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Inherited description: Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
Inherited description: Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage.
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status


index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()


trigger OnDelete (BEFORE event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods