Skip to main content

%Dictionary.StorageDefinition

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

SQL Table Name: %Dictionary.StorageDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

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(), CounterLocationIsValid()
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(), 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(), DataLocationIsValid()
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(), DefaultDataIsValid()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this storage is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize()
property Description as %RawString;
Specifies a description of the storage definition. This description is displayed by the online class reference.
Property methods: DescriptionGet(), DescriptionIsValid()
property ExtentLocation as %RawString;
Specifies the base location of globals used by the extent of this class.
Property methods: ExtentLocationGet(), ExtentLocationIsValid()
property ExtentSize as %RawString;
ExtentSize
Property methods: ExtentSizeGet(), ExtentSizeIsValid()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that the storage definition cannot be modified by subclasses.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize()
property IdExpression as %RawString;
IdExpression
Property methods: IdExpressionGet(), IdExpressionIsValid()
property IdFunction as %RawString;
Specifies the system function used to allocate new id values.
Property methods: IdFunctionGet()
property IdLocation as %RawString;
Specifies location of the ID Counter.
Property methods: IdLocationGet(), IdLocationIsValid()
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(), IndexLocationIsValid()
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(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize()
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(), NameIsValid()
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(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize()
relationship ShardKeies as array of %Dictionary.StorageShardKeyDefinition [ InitialExpression = $listbuild("%Dictionary.StorageShardKeyDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
ShardKey
Property methods: ShardKeiesGet(), ShardKeiesGetObject(), ShardKeiesGetObjectId(), ShardKeiesGetSwizzled(), ShardKeiesIsEmpty(), ShardKeiesIsValid(), ShardKeiesNewObject(), ShardKeiesRClose(), ShardKeiesRExec(), ShardKeiesRFetch(), ShardKeiesRelate(), ShardKeiesSQLCompute(), ShardKeiesSet(), ShardKeiesUnRelate()
property ShardLocalClassName as %RawString;
Specifies the name of the shard-local class
Property methods: ShardLocalClassNameGet(), ShardLocalClassNameIsValid()
property ShardLocalTableName as %RawString;
Specifies the name of the shard-local table
Property methods: ShardLocalTableNameGet(), ShardLocalTableNameIsValid()
property Sharded as %RawString;
Value of the Sharded keyword
Property methods: ShardedGet(), ShardedIsValid()
property SqlChildSub as %RawString;
SqlChildSub
Property methods: SqlChildSubGet(), SqlChildSubIsValid()
property SqlIdExpression as %RawString;
SqlIdExpression
Property methods: SqlIdExpressionGet(), SqlIdExpressionIsValid()
property SqlRowIdName as %RawString;
Specifies the name of the Row ID column projected to SQL.
Property methods: SqlRowIdNameGet(), SqlRowIdNameIsValid()
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(), SqlRowIdPropertyIsValid()
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(), SqlTableNumberIsValid()
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(), StateIsValid()
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(), StreamLocationIsValid()
property Type as %Dictionary.Classname;
Specifies the Storage Class used to provide persistence for this class.
Property methods: TypeGet(), TypeIsValid()
property VersionLocation as %RawString;
Specifies location of the %Version Counter.
Property methods: VersionLocationGet(), VersionLocationIsValid()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = Storages , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

classmethod %Exists(oid As %ObjectIdentity) as %Boolean
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.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
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.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
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
method CounterLocationReset()
method CounterLocationSet(value As %String = "") as %Status
method DataLocationIsDefined() as %Boolean
method DataLocationReset()
method DataLocationSet(value As %String = "") as %Status
method DefaultDataIsDefined() as %Boolean
method DefaultDataReset()
method DefaultDataSet(value As %String = "") as %Status
method DeprecatedIsDefined() as %Boolean
method DeprecatedReset()
method DeprecatedSet(value As %String = "") as %Status
method DescriptionIsDefined() as %Boolean
method DescriptionReset()
method DescriptionSet(value As %String = "") as %Status
method ExtentLocationIsDefined() as %Boolean
method ExtentLocationReset()
method ExtentLocationSet(value As %String = "") as %Status
method ExtentSizeIsDefined() as %Boolean
method ExtentSizeReset()
method ExtentSizeSet(value As %String = "") as %Status
method FinalIsDefined() as %Boolean
method FinalReset()
method FinalSet(value As %String = "") as %Status
method IdExpressionIsDefined() as %Boolean
method IdExpressionReset()
method IdExpressionSet(value As %String = "") as %Status
method IdFunctionIsDefined() as %Boolean
classmethod IdFunctionIsValid(val As %String) as %Status
method IdFunctionReset()
method IdFunctionSet(value As %String = "") as %Status
method IdLocationIsDefined() as %Boolean
method IdLocationReset()
method IdLocationSet(value As %String = "") as %Status
method IndexLocationIsDefined() as %Boolean
method IndexLocationReset()
method IndexLocationSet(value As %String = "") as %Status
method InternalIsDefined() as %Boolean
method InternalReset()
method InternalSet(value As %String = "") as %Status
method NameIsDefined() as %Boolean
method NameReset()
method NameSet(value As %String = "") as %Status
method SequenceNumberIsDefined() as %Boolean
method SequenceNumberReset()
method SequenceNumberSet(value As %String = "") as %Status
method ShardLocalClassNameIsDefined() as %Boolean
method ShardLocalClassNameReset()
method ShardLocalClassNameSet(value As %String = "") as %Status
method ShardLocalTableNameIsDefined() as %Boolean
method ShardLocalTableNameReset()
method ShardLocalTableNameSet(value As %String = "") as %Status
method ShardedIsDefined() as %Boolean
method ShardedReset()
method ShardedSet(value As %String = "") as %Status
method SqlChildSubIsDefined() as %Boolean
method SqlChildSubReset()
method SqlChildSubSet(value As %String = "") as %Status
method SqlIdExpressionIsDefined() as %Boolean
method SqlIdExpressionReset()
method SqlIdExpressionSet(value As %String = "") as %Status
method SqlRowIdNameIsDefined() as %Boolean
method SqlRowIdNameReset()
method SqlRowIdNameSet(value As %String = "") as %Status
method SqlRowIdPropertyIsDefined() as %Boolean
method SqlRowIdPropertyReset()
method SqlRowIdPropertySet(value As %String = "") as %Status
method SqlTableNumberIsDefined() as %Boolean
method SqlTableNumberReset()
method SqlTableNumberSet(value As %String = "") as %Status
method StateIsDefined() as %Boolean
method StateReset()
method StateSet(value As %String = "") as %Status
method StreamLocationIsDefined() as %Boolean
method StreamLocationReset()
method StreamLocationSet(value As %String = "") as %Status
method TypeIsDefined() as %Boolean
method TypeReset()
method TypeSet(value As %String = "") as %Status
method VersionLocationIsDefined() as %Boolean
method VersionLocationReset()
method VersionLocationSet(value As %String = "") as %Status
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

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

FeedbackOpens in a new tab