Skip to main content

%Dictionary.CompiledStorageShardKey

persistent class %Dictionary.CompiledStorageShardKey extends %Library.Persistent

SQL Table Name: %Dictionary.CompiledStorageShardKey

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property CoshardWith as %RawString;
Specifies the class with which to coshard this class
Property methods: CoshardWithGet(), CoshardWithIsValid()
property KeywordError as %Boolean;
KeywordError
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
KeywordModified
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
property Name as %RawString [ Required ];
Specifies the name of the shard key
Property methods: NameGet(), NameIsValid()
property Properties as %RawString;
Specifies the properties of the shard key
Property methods: PropertiesGet(), PropertiesIsValid()
relationship parent as %Dictionary.CompiledStorage [ Required , Inverse = ShardKeies , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Inherited description: Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
Inherited description: Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
method CoshardWithIsDefined() as %Boolean
method CoshardWithReset()
method CoshardWithSet(value As %String = "") as %Status
method NameIsDefined() as %Boolean
method NameReset()
method NameSet(value As %String = "") as %Status
method PropertiesIsDefined() as %Boolean
method PropertiesReset()
method PropertiesSet(value As %String = "") as %Status
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indexes

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

Triggers

trigger OnDelete (BEFORE event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new tab