Class Reference
Cache for UNIX 2018.1.3
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage  

persistent class %Dictionary.StorageDefinition extends %Persistent, %Dictionary.StorageDefinitionQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 29 9 1 2


Summary

Properties
CounterLocation Data DataLocation DefaultData
Deprecated Description ExtentLocation ExtentSize
Final IdExpression IdFunction IdLocation
IndexLocation Indices Internal Name
Properties SQLMaps SequenceNumber SqlChildSub
SqlIdExpression SqlRowIdName SqlRowIdProperty SqlTableNumber
State StreamLocation Type VersionLocation
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 IdFunctionIsValid SummaryClose
SummaryExecute SummaryFetch parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property CounterLocation as %CacheString;
Specifies the base location of counters for properties with type is %Library.Counter. Normally this would be a global reference such as ^User.PersonC. The global reference can also include one or more leading subscripts.
• relationship Data as %Dictionary.StorageDataDefinition [ Inverse = parent,Cardinality = children ];
Data
• property DataLocation as %CacheString;
Specifies expression that is the location where data is stored for this class. Normally this would be a global reference such as ^User.PersonD. The global reference can also include one or more leading subscripts.
• property DefaultData as %CacheString;
Specifies the name of the DATA definition that the Class Compiler Data Structure Generator uses to place any previously unstored properties. A property is unstored if it is storable, but is not listed in any DATA definition.
• property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this storage is deprecated.
• property Description as %CacheString;
Specifies a description of the storage definition. This description is displayed by the online class reference.
• property ExtentLocation as %CacheString;
Specifies the base location of globals used by the extent of this class.
• property ExtentSize as %CacheString;
ExtentSize
• property Final as %Boolean [ InitialExpression = 0 ];
Specifies that the storage definition cannot be modified by subclasses.
• property IdExpression as %CacheString;
IdExpression
• property IdFunction as %CacheString;
Specifies the system function used to allocate new id values.
• property IdLocation as %CacheString;
Specifies location of the ID Counter.
• property IndexLocation as %CacheString;
Specifies the global used for indices for this class. If not specified, the index location is ^MyApp.MyClassI, where MyApp.MyClass is the classname.
• relationship Indices as %Dictionary.StorageIndexDefinition [ Inverse = parent,Cardinality = children ];
Index
• property Internal as %Boolean [ InitialExpression = 0 ];
If true then do not display this item in automatic documentation.
• property Name as %CacheString [ Required ];
Specifies the name of the Storage definition. This name must be a valid class member name and must not conflict with any other class member names.
• relationship Properties as %Dictionary.StoragePropertyDefinition [ Inverse = parent,Cardinality = children ];
Property
• relationship SQLMaps as %Dictionary.StorageSQLMapDefinition [ Inverse = parent,Cardinality = children ];
SQLMap
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• property SqlChildSub as %CacheString;
SqlChildSub
• property SqlIdExpression as %CacheString;
SqlIdExpression
• property SqlRowIdName as %CacheString;
Specifies the name of the Row ID column projected to SQL.
• property SqlRowIdProperty as %CacheString;
Specifies the SQL RowId property. This keyword is only used by classes that have been migrated from earlier InterSystems products.
• property SqlTableNumber as %CacheString;
Specifies the internal SQL Table Number. This keyword is only used by classes that have been migrated from earlier InterSystems products.
• property State as %CacheString;
For a serial embedded class, this keyword specifies which Data definition is used to define the serialized state of the object. This is also the default DATA definition that unstored properties will be added to by the default structure generator.
• property StreamLocation as %CacheString;
Specifies the default global used to store any stream properties within this class. If not specified, the index location is ^MyApp.MyClassS, where MyApp.MyClass is the classname.
• property Type as %Dictionary.CacheClassname;
Specifies the Storage Class used to provide persistence for this class.
• property VersionLocation as %CacheString;
Specifies location of the %Version Counter.
• relationship parent as %Dictionary.ClassDefinition [ Inverse = Storages,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 %Library.CacheStorage or %Library.CacheSQLStorage.
• 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 %Library.CacheStorage or %Library.CacheSQLStorage.
• classmethod IdFunctionIsValid(val As %String) as %Status
• 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 © 1997-2020, InterSystems Corporation