Skip to main content

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?

%Dictionary.StorageSQLMapDefinition

persistent class %Dictionary.StorageSQLMapDefinition extends %Library.Persistent

SQL Table Name: %Dictionary.StorageSQLMapDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property BlockCount as %Integer [ InitialExpression = 0 ];
BlockCount
Property methods: BlockCountDisplayToLogical(), BlockCountGet(), BlockCountIsValid(), BlockCountLogicalToDisplay(), BlockCountNormalize(), BlockCountSet()
property Condition as %CacheString;
Condition
Property methods: ConditionGet(), ConditionIsValid(), ConditionSet()
property ConditionFields as %CacheString;
ConditionFields
Property methods: ConditionFieldsGet(), ConditionFieldsIsValid(), ConditionFieldsSet()
property ConditionalWithHostVars as %Boolean [ InitialExpression = 0 ];
ConditionalWithHostVars
Property methods: ConditionalWithHostVarsDisplayToLogical(), ConditionalWithHostVarsGet(), ConditionalWithHostVarsIsValid(), ConditionalWithHostVarsLogicalToDisplay(), ConditionalWithHostVarsNormalize(), ConditionalWithHostVarsSet()
relationship Data as array of %Dictionary.StorageSQLMapDataDefinition [ InitialExpression = $listbuild("%Dictionary.StorageSQLMapDataDefinition","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 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.StorageSQLMapRowIdSpecDefinition [ InitialExpression = $listbuild("%Dictionary.StorageSQLMapRowIdSpecDefinition","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.StorageSQLMapSubDefinition [ InitialExpression = $listbuild("%Dictionary.StorageSQLMapSubDefinition","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(), TypeSet()
relationship parent as %Dictionary.StorageDefinition [ Required , Inverse = SQLMaps , 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 TypeIsValid(val As %String) as %Status
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 (AFTER event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new tab