Class %Dictionary.StorageSQLMapDefinition

persistent class %Dictionary.StorageSQLMapDefinition extends %Persistent

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	15	8		1		2

Summary

Properties
BlockCount	Condition	ConditionFields	ConditionalWithHostVars
Data	Global	Name	PopulationPct
PopulationType	RowIdSpecs	RowReference	Structure
Subscripts	Type	parent

Methods
%%OIDGet	%AddToSaveSet	%AddToSyncSet	%BuildIndices
%CheckUnique	%ClassIsLatestVersion	%ClassName	%ComposeOid
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GUID	%GUIDSet
%GetLock	%GetParameter	%GetSwizzleObject	%Id
%IsA	%IsModified	%KillExtent	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDetermineClass	%Open
%OpenId	%OriginalNamespace	%PackageName	%PurgeIndices
%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack
%Save	%SaveDirect	%SerializeObject	%SetModified
%SortBegin	%SortEnd	%SyncObjectIn	%SyncTransport
%UnlockExtent	%UnlockId	%ValidateObject	TypeIsValid

Parameters

• parameter SQLENABLED = 1;

Properties

• property BlockCount as %Integer [ InitialExpression = 0 ];

BlockCount

• property Condition as %CacheString;

Condition

• property ConditionFields as %CacheString;

ConditionFields

• property ConditionalWithHostVars as %Boolean [ InitialExpression = 0 ];

ConditionalWithHostVars

• relationship Data as %Dictionary.StorageSQLMapDataDefinition [ Inverse = parent,Cardinality = children ];

Data

• property Global as %CacheString [ SqlFieldName = _Global ];

Global

• property Name as %Dictionary.SQLIdentifier;

Name

• property PopulationPct as %CacheString;

PopulationPct

• property PopulationType as %CacheString;

PopulationType

• relationship RowIdSpecs as %Dictionary.StorageSQLMapRowIdSpecDefinition [ Inverse = parent,Cardinality = children ];

RowIdSpec

• property RowReference as %CacheString;

RowReference

• property Structure as %CacheString;

Structure

• relationship Subscripts as %Dictionary.StorageSQLMapSubDefinition [ Inverse = parent,Cardinality = children ];

Subscript

• property Type as %CacheString;

Specifies what kind of a map this is.

• relationship parent as %Dictionary.StorageDefinition [ Inverse = SQLMaps,Cardinality = parent ];

Pointer to the containing parent object

Methods

• classmethod %Exists(oid As %ObjectIdentity) as %Boolean

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) as %Status

%LockId() 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

%UnlockId() 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

Indices

• index (IDKEY on Name) [IdKey];

Triggers

• trigger OnDelete (AFTER event DELETE)

• trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


[BASEXML] > [%Dictionary] > [StorageSQLMapDefinition]		Private Storage