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

persistent class %Dictionary.StorageDataDefinition extends %Persistent

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 7 21 1 2


Summary

Properties
Attribute Name Structure Subscript Values
parent

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %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 AttributeIsDefined AttributeReset
AttributeSet NameIsDefined NameReset NameSet
StructureIsDefined StructureIsValid StructureReset StructureSet
SubscriptIsDefined SubscriptReset SubscriptSet parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Attribute as %RawString;
Attribute
• property Name as %RawString [ Required ];
Specifies the name of the StorageData definition. This name must be a valid storage member name and must not conflict with any other StorageData names.
• property Structure as %RawString [ InitialExpression = "listnode" ];
Specifies how the data is stored into a global node.
• property Subscript as %RawString;
Subscript
• relationship Values as %Dictionary.StorageDataValueDefinition [ Inverse = parent,Cardinality = children ];
Value
• relationship parent as %Dictionary.StorageDefinition [ Inverse = Data,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 AttributeIsDefined() as %Boolean
• method AttributeReset()
• method AttributeSet(value As %String = "") as %Status
This is a Set accessor method for the Attribute 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 StructureIsDefined() as %Boolean
• classmethod StructureIsValid(val As %String) as %Status
• method StructureReset()
• method StructureSet(value As %String = "") as %Status
This is a Set accessor method for the Structure property.
• method SubscriptIsDefined() as %Boolean
• method SubscriptReset()
• method SubscriptSet(value As %String = "") as %Status
This is a Set accessor method for the Subscript 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.