%SYS.Journal.Marker

persistent class %SYS.Journal.Marker extends %SYS.Journal.Record

SQL Table Name: %SYS_Journal.Marker

Journal marker related API

Property Inventory

Method Inventory

Parameters

parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

property MID as %Integer [ Calculated ];
Marker ID (or Marker Type)
Property methods: MIDDisplayToLogical(), MIDGet(), MIDIsValid(), MIDLogicalToDisplay(), MIDNormalize()
property PrevMarker as %SYS.Journal.Marker [ Calculated ];
Object reference to the previous marker in the journal file or NULLOREF if this is the first marker
Property methods: PrevMarkerGet()
property Sequence as %Integer [ Calculated ];
Cluster journal sequence number of the marker on a clustered system or 0 otherwise
Property methods: SequenceDisplayToLogical(), SequenceGet(), SequenceIsValid(), SequenceLogicalToDisplay(), SequenceNormalize()
property Text as %VarString [ Calculated ];
Text string associated with the marker
Property methods: TextDisplayToLogical(), TextGet(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize()

Methods

method MIDGet() as %Integer [ Language = objectscript ]
classmethod MarkerListClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod MarkerListExecute(ByRef qHandle As %Binary, FileName As %SysPath = "", Offset As %Integer = 0) as %Status [ Language = objectscript ]
classmethod MarkerListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
method PrevMarkerGet() as %SYS.Journal.Marker [ Language = objectscript ]
method SequenceGet() as %Integer [ Language = objectscript ]
method TextGet() as %String [ Language = objectscript ]
classmethod TranslateType(ID As %Integer) as %String [ Language = objectscript ]
Translate the numeric marker type (MID) to the string form

Queries

query MarkerList(FileName As %SysPath, Offset As %Integer)
Selects File Offset As %Integer, Cluster Sequence Number As %Integer, Type As %Integer, Text As %String, Time As %TimeStamp
Returns a list of journal markers

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Feedback