Skip to main content


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

SQL Table Name: %SYS_Journal.Marker

Journal marker related API

Property Inventory

Method Inventory


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.


property MID as %Integer [ Calculated ];
Marker ID (or Marker Type)
Property methods: MIDDisplayToLogical(), 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 Sequence as %Integer [ Calculated ];
Cluster journal sequence number of the marker on a clustered system or 0 otherwise
Property methods: SequenceDisplayToLogical(), SequenceIsValid(), SequenceLogicalToDisplay(), SequenceNormalize()
property Text as %VarString [ Calculated ];
Text string associated with the marker
Property methods: TextDisplayToLogical(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize()


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


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


Gray indicates storage defined by superclasses.

FeedbackOpens in a new tab