IRISLIB database
StorageDefinition Class Reference
Inheritance diagram for StorageDefinition:
Collaboration diagram for StorageDefinition:

Public Attributes

 CounterLocation
 Specifies the base location of counters for properties with type is Library.Counter. More...
 
 Data
 Data. More...
 
 DataLocation
 Specifies expression that is the location where data is stored for this class. More...
 
 DefaultData
 Specifies the name of the DATA definition that the Class Compiler Data Structure Generator uses to place any previously unstored properties. More...
 
 Deprecated
 True if this storage is deprecated. More...
 
 Description
 Specifies a description of the storage definition. More...
 
 ExtentLocation
 Specifies the base location of globals used by the extent of this class. More...
 
 ExtentSize
 ExtentSize. More...
 
 Final
 Specifies that the storage definition cannot be modified by subclasses. More...
 
 IdExpression
 IdExpression. More...
 
 IdFunction
 Specifies the system function used to allocate new id values. More...
 
 IdLocation
 Specifies location of the ID Counter. More...
 
 IndexLocation
 Specifies the global used for indices for this class. More...
 
 Indices
 Index. More...
 
 Internal
 If true then do not display this item in automatic documentation. More...
 
 Name
 Specifies the name of the Storage definition. More...
 
 Properties
 Property. More...
 
 SQLMaps
 SQLMap. More...
 
 SequenceNumber
 SequenceNumber. More...
 
 ShardKeies
 ShardKey. More...
 
 ShardLocalClassName
 Specifies the name of the shard-local class. More...
 
 ShardLocalTableName
 Specifies the name of the shard-local table. More...
 
 Sharded
 Value of the Sharded keyword. More...
 
 SqlChildSub
 SqlChildSub. More...
 
 SqlIdExpression
 SqlIdExpression. More...
 
 SqlRowIdName
 Specifies the name of the Row ID column projected to SQL. More...
 
 SqlRowIdProperty
 Specifies the SQL RowId property. More...
 
 SqlTableNumber
 Specifies the internal SQL Table Number. More...
 
 State
 For a serial embedded class, this keyword specifies which Data definition is used to define the serialized state of the object. More...
 
 StreamLocation
 Specifies the default global used to store any stream properties within this class. More...
 
 Type
 Specifies the Storage Class used to provide persistence for this class. More...
 
 VersionLocation
 Specifies location of the Version Counter. More...
 
 parent
 Pointer to the containing parent object. More...
 

Additional Inherited Members

- Public Member Functions inherited from Persistent
_.Library.Status AcquireLock (_.Library.String locktype)
 Acquires a lock for the current instance. More...
 
_.Library.Status LoadData (_.Library.String id)
 LoadData() - loads an object from storage. More...
 
_.Library.Status OnAfterSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnOpen ()
 This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
 
_.Library.Status OnReload ()
 This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
 
_.Library.Status OnRollBack ()
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status ReleaseLock (_.Library.String locktype)
 Releases a lock for the current instance. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() - saves an object to disk, checks uniqueness and referential More...
 
- Public Member Functions inherited from SwizzleObject
_.Library.Status OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
 This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Member Functions inherited from Persistent
_.Library.Status DeleteData (_.Library.String id, _.Library.Integer concurrency)
 This method is normally generated by the storage class for persistent classes using. More...
 
_.Library.Status KillExtentData (_.Library.Boolean killstreams)
 KillExtentData() - kills extent data in storage. More...
 
_.Library.Status OnAfterBuildIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnAfterDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
_.Library.Status OnAfterPurgeIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnBeforeBuildIndices (_.Library.String indexlist)
 
_.Library.Status OnBeforePurgeIndices (_.Library.String indexlist)
 
_.Library.Status OnDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
- Static Public Attributes inherited from Persistent
 XCOMPACTANCESTRY
 XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
 
 DATALOCATIONGLOBAL = None
 Global name containing master map data for this class. More...
 
 DEFAULTGLOBAL = None
 
 DSCONDITION = None
 DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
 
 DSINTERVAL = None
 DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
 
 DSTIME = None
 If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
 
 EXTENTQUERYSPEC = None
 The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
 
 EXTENTSIZE = None
 The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
 
 GUIDENABLED = None
 If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
 
 IDENTIFIEDBY = None
 The IDENTIFIEDBY parameter can optionally be set to the name. More...
 
 MANAGEDEXTENT = None
 The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
 
 READONLY = None
 READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
 
 ROWLEVELSECURITY = None
 ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
 
 SQLPREVENTFULLSCAN = None
 SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
 
 STORAGEDEFAULT = None
 STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
 
 USEEXTENTSET = None
 
 VERSIONCLIENTNAME = None
 VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
 
 VERSIONPROPERTY = None
 VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
 
- Static Public Attributes inherited from SwizzleObject
 DEFAULTCONCURRENCY = None
 DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
 
 JOURNALSTREAM = None
 If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
 
 OBJJOURNAL = None
 if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Member Data Documentation

◆ CounterLocation

CounterLocation

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.

 

◆ Data

Data

Data.

 

◆ DataLocation

DataLocation

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.

 

◆ DefaultData

DefaultData

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.

 

◆ Deprecated

Deprecated

True if this storage is deprecated.

 

◆ Description

Description

Specifies a description of the storage definition.

This description is displayed by the online class reference.

 

◆ ExtentLocation

ExtentLocation

Specifies the base location of globals used by the extent of this class.

 

◆ ExtentSize

ExtentSize

ExtentSize.

 

◆ Final

Final

Specifies that the storage definition cannot be modified by subclasses.

 

◆ IdExpression

IdExpression

IdExpression.

 

◆ IdFunction

IdFunction

Specifies the system function used to allocate new id values.

 

◆ IdLocation

IdLocation

Specifies location of the ID Counter.

 

◆ IndexLocation

IndexLocation

Specifies the global used for indices for this class.

If not specified, the index location is ^MyApp.MyClassI, where MyApp.MyClass is the classname.

 

◆ Indices

Indices

Index.

 

◆ Internal

Internal

If true then do not display this item in automatic documentation.

 

◆ Name

Name

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.

 

◆ Properties

Properties

Property.

 

◆ SQLMaps

SQLMaps

SQLMap.

 

◆ SequenceNumber

SequenceNumber

SequenceNumber.

 

◆ ShardKeies

ShardKeies

ShardKey.

 

◆ ShardLocalClassName

ShardLocalClassName

Specifies the name of the shard-local class.

 

◆ ShardLocalTableName

ShardLocalTableName

Specifies the name of the shard-local table.

 

◆ Sharded

Sharded

Value of the Sharded keyword.

 

◆ SqlChildSub

SqlChildSub

SqlChildSub.

 

◆ SqlIdExpression

SqlIdExpression

SqlIdExpression.

 

◆ SqlRowIdName

SqlRowIdName

Specifies the name of the Row ID column projected to SQL.

 

◆ SqlRowIdProperty

SqlRowIdProperty

Specifies the SQL RowId property.

This keyword is only used by classes that have been migrated from earlier InterSystems products.

 

◆ SqlTableNumber

SqlTableNumber

Specifies the internal SQL Table Number.

This keyword is only used by classes that have been migrated from earlier InterSystems products.

 

◆ State

State

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.

 

◆ StreamLocation

StreamLocation

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.

 

◆ Type

Type

Specifies the Storage Class used to provide persistence for this class.

 

◆ VersionLocation

VersionLocation

Specifies location of the Version Counter.

 

◆ parent

parent

Pointer to the containing parent object.