This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %Dictionary.CompiledStorageSQLMap

%Dictionary.CompiledStorageSQLMap

persistent class %Dictionary.CompiledStorageSQLMap extends %Library.Persistent

SQL Table Name: %Dictionary.CompiledStorageSQLMap

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SQLENABLED = 1;

Properties (Including Private)

property BlockCount as %Integer;
BlockCount
Property methods: BlockCountDisplayToLogical(), BlockCountGet(), BlockCountIsValid(), BlockCountLogicalToDisplay(), BlockCountNormalize(), BlockCountSet()
property Condition as %CacheString;
Condition
Property methods: ConditionFieldsGet(), ConditionFieldsIsValid(), ConditionFieldsSet(), ConditionGet(), ConditionIsValid(), ConditionSet(), ConditionalWithHostVarsDisplayToLogical(), ConditionalWithHostVarsGet(), ConditionalWithHostVarsIsValid(), ConditionalWithHostVarsLogicalToDisplay(), ConditionalWithHostVarsNormalize(), ConditionalWithHostVarsSet()
property ConditionFields as %CacheString;
ConditionFields
Property methods: ConditionFieldsGet(), ConditionFieldsIsValid(), ConditionFieldsSet()
property ConditionalWithHostVars as %Boolean;
ConditionalWithHostVars
Property methods: ConditionalWithHostVarsDisplayToLogical(), ConditionalWithHostVarsGet(), ConditionalWithHostVarsIsValid(), ConditionalWithHostVarsLogicalToDisplay(), ConditionalWithHostVarsNormalize(), ConditionalWithHostVarsSet()
relationship Data as array of %Dictionary.CompiledStorageSQLMapData [ InitialExpression = $listbuild("%Dictionary.CompiledStorageSQLMapData","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 Global as %CacheString [ SqlFieldName = _Global ];
Global
Property methods: GlobalGet(), GlobalIsValid(), GlobalSet()
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 ];
Name
Property methods: NameGet(), NameIsValid(), NameSet()
property PopulationPct as %CacheString;
PopulationPct
Property methods: PopulationPctGet(), PopulationPctIsValid(), PopulationPctSet()
property PopulationType as %CacheString;
PopulationType
Property methods: PopulationTypeGet(), PopulationTypeIsValid(), PopulationTypeSet()
relationship RowIdSpecs as array of %Dictionary.CompiledStorageSQLMapRowIdSpec [ InitialExpression = $listbuild("%Dictionary.CompiledStorageSQLMapRowIdSpec","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
RowIdSpec
Property methods: RowIdSpecsGet(), RowIdSpecsGetObject(), RowIdSpecsGetObjectId(), RowIdSpecsGetSwizzled(), RowIdSpecsIsEmpty(), RowIdSpecsIsValid(), RowIdSpecsNewObject(), RowIdSpecsRClose(), RowIdSpecsRExec(), RowIdSpecsRFetch(), RowIdSpecsRelate(), RowIdSpecsSQLCompute(), RowIdSpecsSet(), RowIdSpecsUnRelate()
property RowReference as %CacheString;
RowReference
Property methods: RowReferenceGet(), RowReferenceIsValid(), RowReferenceSet()
property Structure as %CacheString;
Structure
Property methods: StructureGet(), StructureIsValid(), StructureSet()
relationship Subscripts as array of %Dictionary.CompiledStorageSQLMapSub [ InitialExpression = $listbuild("%Dictionary.CompiledStorageSQLMapSub","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Subscript
Property methods: SubscriptsGet(), SubscriptsGetObject(), SubscriptsGetObjectId(), SubscriptsGetSwizzled(), SubscriptsIsEmpty(), SubscriptsIsValid(), SubscriptsNewObject(), SubscriptsRClose(), SubscriptsRExec(), SubscriptsRFetch(), SubscriptsRelate(), SubscriptsSQLCompute(), SubscriptsSet(), SubscriptsUnRelate()
property Type as %CacheString;
Specifies what kind of a map this is.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
relationship parent as %Dictionary.CompiledStorage [ Required , Inverse = SQLMaps , 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()

Methods (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
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.

private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
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.
private method %OnNew(name As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

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

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
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 (Including Private)

FeedbackOpens in a new window