Home > Class Reference > %SYS namespace > %Dictionary.StorageDefinition

%Dictionary.StorageDefinition

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

SQL Table Name: %Dictionary.StorageDefinition

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SQLENABLED = 1;

Properties (Including Private)

property %isDefined as %RawString [ Private , MultiDimensional , Transient ];
Stores the DEFINED state of each attribute.
Property methods: %isDefinedGet(), %isDefinedIsValid(), %isDefinedSet()
property CounterLocation as %RawString;
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.
Property methods: CounterLocationGet(), CounterLocationIsDefined(), CounterLocationIsValid(), CounterLocationReset(), CounterLocationSet()
relationship Data as array of %Dictionary.StorageDataDefinition [ InitialExpression = $listbuild("%Dictionary.StorageDataDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Data
Property methods: DataGet(), DataGetObject(), DataGetObjectId(), DataGetSwizzled(), DataIsEmpty(), DataIsValid(), DataLocationGet(), DataLocationIsDefined(), DataLocationIsValid(), DataLocationReset(), DataLocationSet(), DataNewObject(), DataRClose(), DataRExec(), DataRFetch(), DataRelate(), DataSQLCompute(), DataSet(), DataUnRelate()
property DataLocation as %RawString;
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 methods: DataLocationGet(), DataLocationIsDefined(), DataLocationIsValid(), DataLocationReset(), DataLocationSet()
property DefaultData as %RawString;
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 methods: DefaultDataGet(), DefaultDataIsDefined(), DefaultDataIsValid(), DefaultDataReset(), DefaultDataSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this storage is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %RawString;
Specifies a description of the storage definition. This description is displayed by the online class reference.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), DescriptionSet()
property ExtentLocation as %RawString;
Specifies the base location of globals used by the extent of this class.
Property methods: ExtentLocationGet(), ExtentLocationIsDefined(), ExtentLocationIsValid(), ExtentLocationReset(), ExtentLocationSet()
property ExtentSize as %RawString;
ExtentSize
Property methods: ExtentSizeGet(), ExtentSizeIsDefined(), ExtentSizeIsValid(), ExtentSizeReset(), ExtentSizeSet()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that the storage definition cannot be modified by subclasses.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsDefined(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalReset(), FinalSet()
property IdExpression as %RawString;
IdExpression
Property methods: IdExpressionGet(), IdExpressionIsDefined(), IdExpressionIsValid(), IdExpressionReset(), IdExpressionSet()
property IdFunction as %RawString;
Specifies the system function used to allocate new id values.
Property methods: IdFunctionGet(), IdFunctionIsDefined(), IdFunctionIsValid(), IdFunctionReset(), IdFunctionSet()
property IdLocation as %RawString;
Specifies location of the ID Counter.
Property methods: IdLocationGet(), IdLocationIsDefined(), IdLocationIsValid(), IdLocationReset(), IdLocationSet()
property IndexLocation as %RawString;
Specifies the global used for indices for this class. If not specified, the index location is ^MyApp.MyClassI, where MyApp.MyClass is the classname.
Property methods: IndexLocationGet(), IndexLocationIsDefined(), IndexLocationIsValid(), IndexLocationReset(), IndexLocationSet()
relationship Indices as array of %Dictionary.StorageIndexDefinition [ InitialExpression = $listbuild("%Dictionary.StorageIndexDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Index
Property methods: IndicesGet(), IndicesGetObject(), IndicesGetObjectId(), IndicesGetSwizzled(), IndicesIsEmpty(), IndicesIsValid(), IndicesNewObject(), IndicesRClose(), IndicesRExec(), IndicesRFetch(), IndicesRelate(), IndicesSQLCompute(), IndicesSet(), IndicesUnRelate()
property Internal as %Boolean [ InitialExpression = 0 ];
If true then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsDefined(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalReset(), InternalSet()
property Name as %RawString [ 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.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
relationship Properties as array of %Dictionary.StoragePropertyDefinition [ InitialExpression = $listbuild("%Dictionary.StoragePropertyDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property
Property methods: PropertiesGet(), PropertiesGetObject(), PropertiesGetObjectId(), PropertiesGetSwizzled(), PropertiesIsEmpty(), PropertiesIsValid(), PropertiesNewObject(), PropertiesRClose(), PropertiesRExec(), PropertiesRFetch(), PropertiesRelate(), PropertiesSQLCompute(), PropertiesSet(), PropertiesUnRelate()
relationship SQLMaps as array of %Dictionary.StorageSQLMapDefinition [ InitialExpression = $listbuild("%Dictionary.StorageSQLMapDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
SQLMap
Property methods: SQLMapsGet(), SQLMapsGetObject(), SQLMapsGetObjectId(), SQLMapsGetSwizzled(), SQLMapsIsEmpty(), SQLMapsIsValid(), SQLMapsNewObject(), SQLMapsRClose(), SQLMapsRExec(), SQLMapsRFetch(), SQLMapsRelate(), SQLMapsSQLCompute(), SQLMapsSet(), SQLMapsUnRelate()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsDefined(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberReset(), SequenceNumberSet()
property SqlChildSub as %RawString;
SqlChildSub
Property methods: SqlChildSubGet(), SqlChildSubIsDefined(), SqlChildSubIsValid(), SqlChildSubReset(), SqlChildSubSet()
property SqlIdExpression as %RawString;
SqlIdExpression
Property methods: SqlIdExpressionGet(), SqlIdExpressionIsDefined(), SqlIdExpressionIsValid(), SqlIdExpressionReset(), SqlIdExpressionSet()
property SqlRowIdName as %RawString;
Specifies the name of the Row ID column projected to SQL.
Property methods: SqlRowIdNameGet(), SqlRowIdNameIsDefined(), SqlRowIdNameIsValid(), SqlRowIdNameReset(), SqlRowIdNameSet()
property SqlRowIdProperty as %RawString;
Specifies the SQL RowId property. This keyword is only used by classes that have been migrated from earlier InterSystems products.
Property methods: SqlRowIdPropertyGet(), SqlRowIdPropertyIsDefined(), SqlRowIdPropertyIsValid(), SqlRowIdPropertyReset(), SqlRowIdPropertySet()
property SqlTableNumber as %RawString;
Specifies the internal SQL Table Number. This keyword is only used by classes that have been migrated from earlier InterSystems products.
Property methods: SqlTableNumberGet(), SqlTableNumberIsDefined(), SqlTableNumberIsValid(), SqlTableNumberReset(), SqlTableNumberSet()
property State as %RawString;
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 methods: StateGet(), StateIsDefined(), StateIsValid(), StateReset(), StateSet()
property StreamLocation as %RawString;
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 methods: StreamLocationGet(), StreamLocationIsDefined(), StreamLocationIsValid(), StreamLocationReset(), StreamLocationSet()
property Type as %Dictionary.Classname;
Specifies the Storage Class used to provide persistence for this class.
Property methods: TypeGet(), TypeIsDefined(), TypeIsValid(), TypeReset(), TypeSet()
property VersionLocation as %RawString;
Specifies location of the %Version Counter.
Property methods: VersionLocationGet(), VersionLocationIsDefined(), VersionLocationIsValid(), VersionLocationReset(), VersionLocationSet()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = Storages , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]
Inherited description: This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
classmethod %Exists(oid As %ObjectIdentity) as %Boolean [ Language = objectscript ]
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.

private method %LoadData(id As %String) as %Status [ Language = objectscript ]
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status [ Language = objectscript ]
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.
private method %OnNew(name As %String) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %SaveData(id As %String) as %Status [ Language = objectscript ]
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status [ Language = objectscript ]
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 CounterLocationIsDefined() as %Boolean [ Language = objectscript ]
method CounterLocationReset() [ Language = objectscript ]
method CounterLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method DataLocationIsDefined() as %Boolean [ Language = objectscript ]
method DataLocationReset() [ Language = objectscript ]
method DataLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method DefaultDataIsDefined() as %Boolean [ Language = objectscript ]
method DefaultDataReset() [ Language = objectscript ]
method DefaultDataSet(value As %String = "") as %Status [ Language = objectscript ]
method DeprecatedIsDefined() as %Boolean [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method ExtentLocationIsDefined() as %Boolean [ Language = objectscript ]
method ExtentLocationReset() [ Language = objectscript ]
method ExtentLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method ExtentSizeIsDefined() as %Boolean [ Language = objectscript ]
method ExtentSizeReset() [ Language = objectscript ]
method ExtentSizeSet(value As %String = "") as %Status [ Language = objectscript ]
method FinalIsDefined() as %Boolean [ Language = objectscript ]
method FinalReset() [ Language = objectscript ]
method FinalSet(value As %String = "") as %Status [ Language = objectscript ]
method IdExpressionIsDefined() as %Boolean [ Language = objectscript ]
method IdExpressionReset() [ Language = objectscript ]
method IdExpressionSet(value As %String = "") as %Status [ Language = objectscript ]
method IdFunctionIsDefined() as %Boolean [ Language = objectscript ]
classmethod IdFunctionIsValid(val As %String) as %Status [ Language = objectscript ]
method IdFunctionReset() [ Language = objectscript ]
method IdFunctionSet(value As %String = "") as %Status [ Language = objectscript ]
method IdLocationIsDefined() as %Boolean [ Language = objectscript ]
method IdLocationReset() [ Language = objectscript ]
method IdLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method IndexLocationIsDefined() as %Boolean [ Language = objectscript ]
method IndexLocationReset() [ Language = objectscript ]
method IndexLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method InternalIsDefined() as %Boolean [ Language = objectscript ]
method InternalReset() [ Language = objectscript ]
method InternalSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlChildSubIsDefined() as %Boolean [ Language = objectscript ]
method SqlChildSubReset() [ Language = objectscript ]
method SqlChildSubSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlIdExpressionIsDefined() as %Boolean [ Language = objectscript ]
method SqlIdExpressionReset() [ Language = objectscript ]
method SqlIdExpressionSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRowIdNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlRowIdNameReset() [ Language = objectscript ]
method SqlRowIdNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRowIdPropertyIsDefined() as %Boolean [ Language = objectscript ]
method SqlRowIdPropertyReset() [ Language = objectscript ]
method SqlRowIdPropertySet(value As %String = "") as %Status [ Language = objectscript ]
method SqlTableNumberIsDefined() as %Boolean [ Language = objectscript ]
method SqlTableNumberReset() [ Language = objectscript ]
method SqlTableNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method StateIsDefined() as %Boolean [ Language = objectscript ]
method StateReset() [ Language = objectscript ]
method StateSet(value As %String = "") as %Status [ Language = objectscript ]
method StreamLocationIsDefined() as %Boolean [ Language = objectscript ]
method StreamLocationReset() [ Language = objectscript ]
method StreamLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeIsDefined() as %Boolean [ Language = objectscript ]
method TypeReset() [ Language = objectscript ]
method TypeSet(value As %String = "") as %Status [ Language = objectscript ]
method VersionLocationIsDefined() as %Boolean [ Language = objectscript ]
method VersionLocationReset() [ Language = objectscript ]
method VersionLocationSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]

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 (Including Private)