Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage   

persistent class %Dictionary.StorageSQLMapDefinition extends %Persistent

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 16 42 1 2


Summary

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

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %CheckConstraints
%CheckConstraintsForExtent %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 %IsNull
%KillExtent %LockExtent %LockId
%New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect
%SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices
%ValidateObject BlockCountIsDefined BlockCountReset
BlockCountSet ConditionFieldsIsDefined ConditionFieldsReset
ConditionFieldsSet ConditionIsDefined ConditionReset
ConditionSet ConditionalWithHostVarsIsDefined ConditionalWithHostVarsReset
ConditionalWithHostVarsSet GlobalIsDefined GlobalReset
GlobalSet NameIsDefined NameReset
NameSet PopulationPctIsDefined PopulationPctReset
PopulationPctSet PopulationTypeIsDefined PopulationTypeReset
PopulationTypeSet RowReferenceIsDefined RowReferenceReset
RowReferenceSet StructureIsDefined StructureReset
StructureSet TypeIsDefined TypeIsValid
TypeReset TypeSet parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property BlockCount as %Integer [ InitialExpression = 0 ];
BlockCount
• property Condition as %RawString;
Condition
• property ConditionFields as %RawString;
ConditionFields
• property ConditionalWithHostVars as %Boolean [ InitialExpression = 0 ];
ConditionalWithHostVars
• relationship Data as %Dictionary.StorageSQLMapDataDefinition [ Inverse = parent,Cardinality = children ];
Data
• property Global as %RawString [ SqlFieldName = _Global ];
Global
• property Name as %RawString [ Required ];
Name
• property PopulationPct as %RawString;
PopulationPct
• property PopulationType as %RawString;
PopulationType
• relationship RowIdSpecs as %Dictionary.StorageSQLMapRowIdSpecDefinition [ Inverse = parent,Cardinality = children ];
RowIdSpec
• property RowReference as %RawString;
RowReference
• property Structure as %RawString;
Structure
• relationship Subscripts as %Dictionary.StorageSQLMapSubDefinition [ Inverse = parent,Cardinality = children ];
Subscript
• property Type as %RawString;
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, timeout As %Integer) as %Status
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
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
This is a Set accessor method for the BlockCount property.
• method ConditionFieldsIsDefined() as %Boolean
• method ConditionFieldsReset()
• method ConditionFieldsSet(value As %String = "") as %Status
This is a Set accessor method for the ConditionFields property.
• method ConditionIsDefined() as %Boolean
• method ConditionReset()
• method ConditionSet(value As %String = "") as %Status
This is a Set accessor method for the Condition property.
• method ConditionalWithHostVarsIsDefined() as %Boolean
• method ConditionalWithHostVarsReset()
• method ConditionalWithHostVarsSet(value As %String = "") as %Status
This is a Set accessor method for the ConditionalWithHostVars property.
• method GlobalIsDefined() as %Boolean
• method GlobalReset()
• method GlobalSet(value As %String = "") as %Status
This is a Set accessor method for the Global property.
• method NameIsDefined() as %Boolean
• method NameReset()
• method NameSet(value As %String = "") as %Status
This is a Set accessor method for the Name property.
• method PopulationPctIsDefined() as %Boolean
• method PopulationPctReset()
• method PopulationPctSet(value As %String = "") as %Status
This is a Set accessor method for the PopulationPct property.
• method PopulationTypeIsDefined() as %Boolean
• method PopulationTypeReset()
• method PopulationTypeSet(value As %String = "") as %Status
This is a Set accessor method for the PopulationType property.
• method RowReferenceIsDefined() as %Boolean
• method RowReferenceReset()
• method RowReferenceSet(value As %String = "") as %Status
This is a Set accessor method for the RowReference property.
• method StructureIsDefined() as %Boolean
• method StructureReset()
• method StructureSet(value As %String = "") as %Status
This is a Set accessor method for the Structure property.
• method TypeIsDefined() as %Boolean
• classmethod TypeIsValid(val As %String) as %Status
• method TypeReset()
• method TypeSet(value As %String = "") as %Status
This is a Set accessor method for the Type property.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

•index (IDKEY on Name) [IdKey];

Triggers

•trigger OnDelete (AFTER event DELETE)
•trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.