Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (1)
Properties (37)
Methods (4)
Indexes (1)
Triggers (2)
Inherited Members

Show private members

%Dictionary.CompiledStorage

persistent class %Dictionary.CompiledStorage extends %Library.Persistent, %Dictionary.CompiledStorageQuery

SQL Table Name: %Dictionary.CompiledStorage

Property Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property CompilerGenerated as %Boolean;

CompilerGenerated

Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()

property CounterLocation as %CacheString;

Specifies the base location of counters for properties with type is %Library.Counter. Normally this would be a global reference such as ^User.PersonC. The global reference can also include one or more leading subscripts.

Property methods: CounterLocationGet(), CounterLocationIsValid(), CounterLocationSet()

relationship Data as array of %Dictionary.CompiledStorageData [ InitialExpression = $listbuild("%Dictionary.CompiledStorageData","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];

Data

Property methods: DataGet(), DataGetObject(), DataGetObjectId(), DataGetSwizzled(), DataIsEmpty(), DataIsValid(), DataNewObject(), DataRClose(), DataRExec(), DataRFetch(), DataRelate(), DataSQLCompute(), DataSet(), DataUnRelate()

property DataLocation as %CacheString;

Specifies expression that is the location where data is stored for this class. Normally this would be a global reference such as ^User.PersonD. The global reference can also include one or more leading subscripts.

Property methods: DataLocationGet(), DataLocationIsValid(), DataLocationSet()

property DefaultData as %CacheString;

Specifies the name of the DATA definition that the Class Compiler Data Structure Generator uses to place any previously unstored properties. A property is unstored if it is storable, but is not listed in any DATA definition.

Property methods: DefaultDataGet(), DefaultDataIsValid(), DefaultDataSet()

property Deprecated as %Boolean;

True if this storage is deprecated.

Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()

property Description as %CacheString;

Specifies a description of the storage definition. This description is displayed by the online class reference.

Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()

property ExtentLocation as %CacheString;

Specifies the base location of globals used by the extent of this class.

Property methods: ExtentLocationGet(), ExtentLocationIsValid(), ExtentLocationSet()

property ExtentSize as %CacheString;

ExtentSize

Property methods: ExtentSizeGet(), ExtentSizeIsValid(), ExtentSizeSet()

property Final as %Boolean;

Specifies that the storage definition cannot be modified by subclasses.

Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()

property Id as %Integer;

Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()

property IdExpression as %CacheString;

IdExpression

Property methods: IdExpressionGet(), IdExpressionIsValid(), IdExpressionSet()

property IdFunction as %CacheString;

Specifies the system function used to allocate new id values.

Property methods: IdFunctionGet(), IdFunctionIsValid(), IdFunctionSet()

property IdLocation as %CacheString;

Specifies location of the ID Counter.

Property methods: IdLocationGet(), IdLocationIsValid(), IdLocationSet()

property IndexLocation as %CacheString;

Specifies the global used for indices for this class. If not specified, the index location is ^MyApp.MyClassI, where MyApp.MyClass is the classname.

Property methods: IndexLocationGet(), IndexLocationIsValid(), IndexLocationSet()

relationship Indices as array of %Dictionary.CompiledStorageIndex [ InitialExpression = $listbuild("%Dictionary.CompiledStorageIndex","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];

Index

Property methods: IndicesGet(), IndicesGetObject(), IndicesGetObjectId(), IndicesGetSwizzled(), IndicesIsEmpty(), IndicesIsValid(), IndicesNewObject(), IndicesRClose(), IndicesRExec(), IndicesRFetch(), IndicesRelate(), IndicesSQLCompute(), IndicesSet(), IndicesUnRelate()

property InheritedId as %Boolean;

InheritedId

Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()

property Internal as %Boolean;

If true then do not display this item in automatic documentation.

Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()

property KeywordError as %Boolean;

KeywordError

Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()

property KeywordModified as %Boolean;

KeywordModified

Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()

property Name as %CacheString [ Required ];

Specifies the name of the Storage definition. This name must be a valid class member name and must not conflict with any other class member names.

Property methods: NameGet(), NameIsValid(), NameSet()

property NotInheritable as %Boolean;

NotInheritable

Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()

property Origin as %CacheString;

Origin

Property methods: OriginGet(), OriginIsValid(), OriginSet()

relationship Properties as array of %Dictionary.CompiledStorageProperty [ InitialExpression = $listbuild("%Dictionary.CompiledStorageProperty","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];

Property

Property methods: PropertiesGet(), PropertiesGetObject(), PropertiesGetObjectId(), PropertiesGetSwizzled(), PropertiesIsEmpty(), PropertiesIsValid(), PropertiesNewObject(), PropertiesRClose(), PropertiesRExec(), PropertiesRFetch(), PropertiesRelate(), PropertiesSQLCompute(), PropertiesSet(), PropertiesUnRelate()

property RootClass as %Boolean;

RootClass

Property methods: RootClassDisplayToLogical(), RootClassGet(), RootClassIsValid(), RootClassLogicalToDisplay(), RootClassNormalize(), RootClassSet()

relationship SQLMaps as array of %Dictionary.CompiledStorageSQLMap [ InitialExpression = $listbuild("%Dictionary.CompiledStorageSQLMap","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];

SQLMap

Property methods: SQLMapsGet(), SQLMapsGetObject(), SQLMapsGetObjectId(), SQLMapsGetSwizzled(), SQLMapsIsEmpty(), SQLMapsIsValid(), SQLMapsNewObject(), SQLMapsRClose(), SQLMapsRExec(), SQLMapsRFetch(), SQLMapsRelate(), SQLMapsSQLCompute(), SQLMapsSet(), SQLMapsUnRelate()

property SequenceNumber as %Integer;

SequenceNumber

Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()

property SqlChildSub as %CacheString;

SqlChildSub

Property methods: SqlChildSubGet(), SqlChildSubIsValid(), SqlChildSubSet()

property SqlIdExpression as %CacheString;

SqlIdExpression

Property methods: SqlIdExpressionGet(), SqlIdExpressionIsValid(), SqlIdExpressionSet()

property SqlRowIdName as %CacheString;

Specifies the name of the Row ID column projected to SQL.

Property methods: SqlRowIdNameGet(), SqlRowIdNameIsValid(), SqlRowIdNameSet()

property SqlRowIdProperty as %CacheString;

Specifies the SQL RowId property. This keyword is only used by classes that have been migrated from earlier InterSystems products.

Property methods: SqlRowIdPropertyGet(), SqlRowIdPropertyIsValid(), SqlRowIdPropertySet()

property SqlTableNumber as %CacheString;

Specifies the internal SQL Table Number. This keyword is only used by classes that have been migrated from earlier InterSystems products.

Property methods: SqlTableNumberGet(), SqlTableNumberIsValid(), SqlTableNumberSet()

property State as %CacheString;

For a serial embedded class, this keyword specifies which Data definition is used to define the serialized state of the object. This is also the default DATA definition that unstored properties will be added to by the default structure generator.

Property methods: StateGet(), StateIsValid(), StateSet()

property StreamLocation as %CacheString;

Specifies the default global used to store any stream properties within this class. If not specified, the index location is ^MyApp.MyClassS, where MyApp.MyClass is the classname.

Property methods: StreamLocationGet(), StreamLocationIsValid(), StreamLocationSet()

property Type as %Dictionary.CacheClassname;

Specifies the Storage Class used to provide persistence for this class.

Property methods: TypeGet(), TypeIsValid(), TypeSet()

property VersionLocation as %CacheString;

Specifies location of the %Version Counter.

Property methods: VersionLocationGet(), VersionLocationIsValid(), VersionLocationSet()

relationship parent as %Dictionary.CompiledClass [ Required , Inverse = Storages , Cardinality = parent ];

Pointer to the containing parent object

Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

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

Indexes

index (IDKEY on Name) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Triggers

trigger OnDelete (BEFORE event DELETE);

trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

Feedback