This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


persistent class %Library.StorageSQLMapSubscriptDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.StorageSQLMapSubscriptDefinition

Contains SQL subscript information for a storage definition for a class within the Caché Dictionary.

Property Inventory (Including Private)

Method Inventory (Including Private)


property AccessType as %CacheString;
Property methods: AccessTypeGet(), AccessTypeIsValid(), AccessTypeSet()
property ClassName as %CacheString;
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Delimiter as %CacheString;
Property methods: DelimiterGet(), DelimiterIsValid(), DelimiterSet()
property Expression as %CacheString;
Property methods: ExpressionGet(), ExpressionIsValid(), ExpressionSet()
property InvalidCondition as %ListOfPersistentChildObjects (CLASSNAME = 1);
Property methods: InvalidConditionGet(), InvalidConditionGetObject(), InvalidConditionGetObjectId(), InvalidConditionGetSwizzled(), InvalidConditionIsValid(), InvalidConditionNewObject(), InvalidConditionSet(), InvalidConditionSetObject(), InvalidConditionSetObjectId(), InvalidConditionUnSwizzle()
property MapName as %CacheString;
Property methods: MapNameGet(), MapNameIsValid(), MapNameSet()
property Name as %CacheString;
Property methods: NameGet(), NameIsValid(), NameSet()
property NextCode as %CacheString;
Property methods: NextCodeGet(), NextCodeIsValid(), NextCodeSet()
property StartValue as %CacheString;
Property methods: StartValueGet(), StartValueIsValid(), StartValueSet()
property StopExpression as %CacheString;
Property methods: StopExpressionGet(), StopExpressionIsValid(), StopExpressionSet()
property StopValue as %CacheString;
Property methods: StopValueGet(), StopValueIsValid(), StopValueSet()
property StorageName as %CacheString;
Property methods: StorageNameGet(), StorageNameIsValid(), StorageNameSet()


private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
private method %OnNew(initvalue As %String) as %Status
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 %OnValidateObject() as %Status
Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

private method %SaveData(id As %String) as %Status
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.


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)


Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (%Library.AbstractDefinition)