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

%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 %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.
Property methods: CounterLocationGet(), CounterLocationIsValid(), 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(), DataLocationIsValid(), DataLocationSet(), DataNewObject(), DataRClose(), DataRExec(), DataRFetch(), DataRelate(), DataSQLCompute(), DataSet(), DataUnRelate()
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 methods: DataLocationGet(), DataLocationIsValid(), DataLocationSet()
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 methods: DefaultDataGet(), DefaultDataIsValid(), DefaultDataSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this storage is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the storage definition. This description is displayed by the online class reference.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property ExtentLocation as %CacheString;
Specifies the base location of globals used by the extent of this class.
Property methods: ExtentLocationGet(), ExtentLocationIsValid(), ExtentLocationSet()
property ExtentSize as %CacheString;
ExtentSize
Property methods: ExtentSizeGet(), ExtentSizeIsValid(), ExtentSizeSet()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that the storage definition cannot be modified by subclasses.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property IdExpression as %CacheString;
IdExpression
Property methods: IdExpressionGet(), IdExpressionIsValid(), IdExpressionSet()
property IdFunction as %CacheString;
Specifies the system function used to allocate new id values.
Property methods: IdFunctionGet(), IdFunctionIsValid(), IdFunctionSet()
property IdLocation as %CacheString;
Specifies location of the ID Counter.
Property methods: IdLocationGet(), IdLocationIsValid(), IdLocationSet()
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.
Property methods: IndexLocationGet(), IndexLocationIsValid(), 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(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
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.
Property methods: NameGet(), NameIsValid(), 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(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property SqlChildSub as %CacheString;