Skip to main content

%SYS.Journal.VectorSetKillRecord

Class %SYS.Journal.VectorSetKillRecord Extends %SYS.Journal.SetKillRecord [ System = 4 ]

Journal Vector SET/Vector KILL record related API

Parameters​

READONLY​

Parameter READONLY = 1;

Properties​

ClusterSequence​

Property ClusterSequence As %Integer [ Calculated ];

Cluster journal sequence number of the record on a clustered system or 0 otherwise

DatabaseName​

Property DatabaseName As %SysPath [ Calculated ];

Directory path of the database updated by the vector operation

MirrorDatabaseName​

Property MirrorDatabaseName As %String [ Calculated ];

Mirror database name of the database updated by the vector operation if it is a mirrored database

GlobalReference​

Property GlobalReference As %VarString [ Calculated ];

Extended global reference of the global holding the node which is the target of the vector operation

GlobalNode​

Property GlobalNode As %VarString [ Calculated ];

Global node holding the vector which is the target of the vector operation (GlobalReference minus the namespace)

NumberOfValues​

Property NumberOfValues As %Integer [ Calculated ];

Number of data values stored in the record. It can be 0, 1 or 2 depending on whether the record is a Vector SET or Vector KILL and whether it is in a transaction.

NewValue​

Property NewValue As %VarString [ Calculated ];

(For Vector SET record only) The value the vector element was set to

OldValue​

Property OldValue As %VarString [ Calculated ];

(For InTransaction record only) The value of the vector element prior to the vector operation

Collation​

Property Collation As %Integer [ Calculated ];

The collation of the subscripts in GlobalNode

VecIndex​

Property VecIndex As %Integer [ Calculated ];

The index into the vector for set $vector(gref, index, type)=value or kill $vector(gref, index)

VecType​

Property VecType As %String [ Calculated ];

The string value representing the type of the vector which is the target of the vector operation

Methods​

%LoadData​

Method %LoadData(Offset As %String, flag As %Boolean) As %Status [ Private ]

VecIndexGet​

Method VecIndexGet() As %Integer

VecTypeGet​

Method VecTypeGet() As %String

ClusterSequenceGet​

Method ClusterSequenceGet() As %Integer

DatabaseNameGet​

Method DatabaseNameGet() As %String

MirrorDatabaseNameGet​

Method MirrorDatabaseNameGet() As %String [ CodeMode = expression ]

GlobalReferenceGet​

Method GlobalReferenceGet() As %String

GlobalNodeGet​

Method GlobalNodeGet() As %String

NumberOfValuesGet​

Method NumberOfValuesGet() As %Integer [ CodeMode = expression ]

ExistsNewValue​

Method ExistsNewValue() As %Boolean [ CodeMode = expression ]

TRUE if there is a NewValue (including "") in the record

ExistsOldValue​

Method ExistsOldValue() As %Boolean [ CodeMode = expression ]

TRUE if there is an OldValue (including "") in the record

NewValueGet​

Method NewValueGet() As %String [ CodeMode = expression ]

OldValueGet​

Method OldValueGet() As %String [ CodeMode = expression ]

CollationGet​

Method CollationGet() As %Integer

Restore​

Method Restore(Detail As %Integer) As %Status

Restore a Vector SET or a Vector KILL

Fetch​

Method Fetch(ByRef Row As %List, ByRef Columns As %String, Match As %List = "") As %Boolean [ Internal, PublicList = (col, match, Row, Columns) ]