Shard Class Reference

This class contains a set of storage interface methods for use in sharded environments. More...

Inheritance diagram for Shard:

Collaboration diagram for Shard:

Public Member Functions
_.Library.Status	LoadData (_.Library.String id)
	Load object from persistent storage into memory. More...
_.Library.Status	SaveData (_.Library.String id)
	SaveData() - Save the object to a persistent state (e.g. 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...
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
	STORAGECOMPILERCLASS = None
	This class contains a set of storage interface methods for use in sharded environments. More...
	STORAGEINTERFACE = None
	STORAGEINTERFACE defines the type of serialization implemented by this class. 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.Status	BuildDeferredIndices (_.Library.Integer pLockFlag, _.Library.Integer pJournalFlag)
	Intercept calls to BuildDeferredIndices and cause them to be executed on all the shards.
_.Library.Status	BuildIndices (_.Library.RawString pIndexList, _.Library.Integer pAutoPurge, _.Library.Integer pLockFlag, _.Library.Integer pJournalFlag, _.Library.RawString pStartID, _.Library.RawString pEndID, _.Library.RawString pIgnoreIndexList, _.Library.Integer pKeepSelectability)
	Intercept calls to BuildIndices and cause them to be executed on all the shards.
_.Library.Status	LockExtent (_.Library.Boolean shared)
	LockExtent acquires a lock on the entire extent of the class. More...
_.Library.Status	PurgeIndices (_.Library.List idxlist, _.Library.Boolean lockExtent, _.Library.RawString pIgnoreIndexList)
	Intercept calls to PurgeIndices and cause them to be executed on all the shards.
_.Library.String	ShardKey (_.Library.String args)
	Generate the shard key from the fields that make up the key. More...
_.Library.Status	UnlockExtent (_.Library.Boolean shared, _.Library.Boolean immediate)
	UnlockExtent releases a lock on the entire extent of the class. More...

Detailed Description

This class contains a set of storage interface methods for use in sharded environments.

It is not for customer use.

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

LoadData()

_.Library.Status LoadData

(

_.Library.String

id

)

Load object from persistent storage into memory.

The caller is responsible for calling IdSet()

Don't include class name with id in input parameter

LockExtent()

_.Library.Status LockExtent ( _.Library.Boolean  shared )

staticprivate

LockExtent acquires a lock on the entire extent of the class.

If shared is true then a shared lock

is acquired, otherwise an exclusive lock is acquired. If the requested lock cannot be acquired then a failure Status value is returned. The default implementation returns an error indicating that the method is not implemented. This method is automatically generated for persistent classes using <class>Storage.Persistent</class> or <class>Storage.SQL</class>.

SaveData()

_.Library.Status SaveData

(

_.Library.String

id

)

SaveData() - Save the object to a persistent state (e.g.

store it on disk).

Returns: oid or "" if save fails

ShardKey()

_.Library.String ShardKey ( _.Library.String  args )

staticprivate

Generate the shard key from the fields that make up the key.

Not used currently.

UnlockExtent()

_.Library.Status UnlockExtent ( _.Library.Boolean  shared, _.Library.Boolean  immediate  )

staticprivate

UnlockExtent releases a lock on the entire extent of the class.

If shared is true then a shared lock

is acquired, otherwise an exclusive lock is acquired. If the requested lock cannot be acquired then a failure Status value is returned. The default implementation returns an error indicating that the method is not implemented. This method is automatically generated for persistent classes using <class>Storage.Persistent</class> or <class>Storage.SQL</class>.

Member Data Documentation

STORAGECOMPILERCLASS

STORAGECOMPILERCLASS = None

static

This class contains a set of storage interface methods for use in sharded environments.

It is not for customer use.

STORAGEINTERFACE

STORAGEINTERFACE = None

static

STORAGEINTERFACE defines the type of serialization implemented by this class.

The value has to match the classtype of the class that is inheriting the serialization interface.