IRISLIB database
SQL Class Reference

The Storage.SQL class contains a set of storage interface methods that use embedded SQL statements, as well as an advanced set of data mapping definition, to provide a way to layer objects on top of pre-existing InterSystems IRIS data structures. More...

Inheritance diagram for SQL:
Collaboration diagram for SQL:

Public Member Functions

_.Library.Status LoadData (_.Library.String id)
 Load object from persistent storage into memory. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() More...
 
- Public Member Functions inherited from Storage
_.Library.Status LoadData (_.Library.String id)
 LoadData() - loads an object from storage. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() - saves an object to disk, checks uniqueness and referential More...
 

Static Public Member Functions

_.Library.Status DeleteData (_.Library.String id, _.Library.Integer concurrency)
 DeleteData() More...
 
_.Library.Status KillExtentData (_.Library.Boolean killstreams)
 KillExtentData() - kills extent data in storage. More...
 
- Static Public Member Functions inherited from Storage
_.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...
 

Static Public Attributes

 OBJECTSPULLTRIGGERS = None
 The Storage.SQL class contains a set of storage interface methods that use embedded SQL statements, as well as an advanced set of data mapping definition, to provide a way to layer objects on top of pre-existing InterSystems IRIS data structures. More...
 
- Static Public Attributes inherited from Storage
 IDTYPE = None
 Physical Storage Base Class.
 
 STORAGEINTERFACE = None
 STORAGEINTERFACE defines the type of serialization implemented by this class. More...
 

Static Private Member Functions

_.Library.Boolean Exists (_.Library.ObjectIdentity oid)
 Exists() More...
 
_.Library.Status LockExtent (_.Library.Boolean shared)
 Acquire (s)hared or (e)xclusive locks based on locktype parameter.
 
_.Library.Status LockId (_.Library.String id, _.Library.Boolean shared, _.Library.Integer timeout)
 Acquire (s)hared or (e)xclusive locks based on locktype parameter.
 
_.Library.Status UnlockExtent (_.Library.Boolean shared, _.Library.Boolean immediate)
 Release (s)hared or (e)xclusive locks based on locktype parameter.
 
_.Library.Status UnlockId (_.Library.String id, _.Library.Boolean shared, _.Library.Boolean immediate)
 Release locks held on an object (identified by the id parameter). More...
 

Detailed Description

The Storage.SQL class contains a set of storage interface methods that use embedded SQL statements, as well as an advanced set of data mapping definition, to provide a way to layer objects on top of pre-existing InterSystems IRIS data structures.

The storage interface methods, which are implemented as method generators, work in conjunction with the persistent interface methods of the <class>Persistent</class> class to provide persistent behavior for objects.

The methods of Storage.SQL are not meant to be called directly. Use the methods of the <class>Persistent</class> class which, in turn, call the appropriate <class>Storage.Persistent</class> method.

Member Function Documentation

◆ DeleteData()

_.Library.Status DeleteData ( _.Library.String  id,
_.Library.Integer  concurrency 
)
static

DeleteData()

Delete object from persistent storage The caller is responsible for calling IdSet() Don't include class name with id in input parameter

◆ Exists()

_.Library.Boolean Exists ( _.Library.ObjectIdentity  oid)
staticprivate

Exists()

Check to see if an OID exists in the extent of this class...

◆ KillExtentData()

_.Library.Status KillExtentData ( _.Library.Boolean  killstreams)
static

KillExtentData() - kills extent data in storage.

This method is

implemented by the storage class. If killstreams is true (default is false) it will also kill the default stream storage global.

◆ LoadData()

Load object from persistent storage into memory.

The caller is responsible for calling IdSet() Don't include class name with id in input parameter

◆ SaveData()

SaveData()

Save the object to a persistent state (e.g. store it on disk) return: oid or "" if save fails

◆ UnlockId()

_.Library.Status UnlockId ( _.Library.String  id,
_.Library.Boolean  shared,
_.Library.Boolean  immediate 
)
staticprivate

Release locks held on an object (identified by the id parameter).

If shared is true then the lock released is a shared lock. If immediate is true then release the lock immediately (lock not held until completion of the current transaction)

Member Data Documentation

◆ OBJECTSPULLTRIGGERS

OBJECTSPULLTRIGGERS = None
static

The Storage.SQL class contains a set of storage interface methods that use embedded SQL statements, as well as an advanced set of data mapping definition, to provide a way to layer objects on top of pre-existing InterSystems IRIS data structures.

The storage interface methods, which are implemented as method generators, work in conjunction with the persistent interface methods of the <class>Persistent</class> class to provide persistent behavior for objects.

The methods of Storage.SQL are not meant to be called directly. Use the methods of the <class>Persistent</class> class which, in turn, call the appropriate <class>Storage.Persistent</class> method.