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

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 (15)
Methods (38)
Indexes (1)
Triggers (2)
Inherited Members

Show private members

%Dictionary.StorageSQLMapDefinition

persistent class %Dictionary.StorageSQLMapDefinition extends %Library.Persistent

SQL Table Name: %Dictionary.StorageSQLMapDefinition

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property BlockCount as %Integer [ InitialExpression = 0 ];

BlockCount

Property methods: BlockCountDisplayToLogical(), BlockCountGet(), BlockCountIsValid(), BlockCountLogicalToDisplay(), BlockCountNormalize()

property Condition as %RawString;

Condition

Property methods: ConditionGet(), ConditionIsValid()

property ConditionFields as %RawString;

ConditionFields

Property methods: ConditionFieldsGet(), ConditionFieldsIsValid()

property ConditionalWithHostVars as %Boolean [ InitialExpression = 0 ];

ConditionalWithHostVars

Property methods: ConditionalWithHostVarsDisplayToLogical(), ConditionalWithHostVarsGet(), ConditionalWithHostVarsIsValid(), ConditionalWithHostVarsLogicalToDisplay(), ConditionalWithHostVarsNormalize()

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 %RawString [ SqlFieldName = _Global ];

Global

Property methods: GlobalGet(), GlobalIsValid()

property Name as %RawString [ Required ];

Name

Property methods: NameGet(), NameIsValid()

property PopulationPct as %RawString;

PopulationPct

Property methods: PopulationPctGet(), PopulationPctIsValid()

property PopulationType as %RawString;

PopulationType

Property methods: PopulationTypeGet(), PopulationTypeIsValid()

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 %RawString;

RowReference

Property methods: RowReferenceGet(), RowReferenceIsValid()

property Structure as %RawString;

Structure

Property methods: StructureGet(), StructureIsValid()

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 %RawString;

Specifies what kind of a map this is.

Property methods: TypeGet()

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 %Storage.Persistent or %Storage.SQL.

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 %Storage.Persistent or %Storage.SQL.

method BlockCountIsDefined() as %Boolean

method BlockCountReset()

method BlockCountSet(value As %String = "") as %Status

method ConditionFieldsIsDefined() as %Boolean

method ConditionFieldsReset()

method ConditionFieldsSet(value As %String = "") as %Status

method ConditionIsDefined() as %Boolean

method ConditionReset()

method ConditionSet(value As %String = "") as %Status

method ConditionalWithHostVarsIsDefined() as %Boolean

method ConditionalWithHostVarsReset()

method ConditionalWithHostVarsSet(value As %String = "") as %Status

method GlobalIsDefined() as %Boolean

method GlobalReset()

method GlobalSet(value As %String = "") as %Status

method NameIsDefined() as %Boolean

method NameReset()

method NameSet(value As %String = "") as %Status

method PopulationPctIsDefined() as %Boolean

method PopulationPctReset()

method PopulationPctSet(value As %String = "") as %Status

method PopulationTypeIsDefined() as %Boolean

method PopulationTypeReset()

method PopulationTypeSet(value As %String = "") as %Status

method RowReferenceIsDefined() as %Boolean

method RowReferenceReset()

method RowReferenceSet(value As %String = "") as %Status

method StructureIsDefined() as %Boolean

method StructureReset()

method StructureSet(value As %String = "") as %Status

method TypeIsDefined() as %Boolean

classmethod TypeIsValid(val As %String) as %Status

method TypeReset()

method TypeSet(value 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

Feedback