InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > %TSQL.sys.log

%TSQL.sys.log

class %TSQL.sys.log extends %Library.RegisteredObject

Property Inventory

Method Inventory

Properties

property logFile as %String;
Property methods: logFileDisplayToLogical(), logFileGet(), logFileIsValid(), logFileLogicalToDisplay(), logFileLogicalToOdbc(), logFileNormalize(), logFileSet()

Methods

method logError(error As %SYSTEM.Error) [ Language = objectscript ]

Report an error from a %SYSTEM.Error object

  • error - an instance of %SYSTEM.Error

method logHeader() as %Status [ Language = objectscript ]
method logResults(context As %Library.ProcedureContext, displyRowCount As %Boolean = 0, timeStart As %String = "", startgloref As %String = "", rowcount As %BigInt = "", dumpresults As %Boolean = 1) as %Status [ Language = objectscript ]
method logStatus(StatusCode As %Status, Message As %String, ByRef Outcome) [ Language = objectscript ]

Report a status message from a trace

  • sc - pass as status code

  • message - pass a message to be written both to the current device and to the log (or "") (optional)

  • outcome - pass an array of stats (optional)

method logStream(stream As %Stream.Object, pNumbered As %Integer = 0) [ Language = objectscript ]

Copy the contents of a stream to the log

  • stream - stream to copy to the file.

classmethod startLog(logFile As %RawString = "", initialize As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod stopLog() as %Status [ Language = objectscript ]
classmethod traceContext(context As %Library.ProcedureContext) as %Status [ Language = objectscript ]
classmethod traceDeferredStatement(statementType, sql) as %Status [ Language = objectscript ]
classmethod traceEmbeddedStatement(statementType, sql) as %Status [ Language = objectscript ]
classmethod traceError(pError As %SYSTEM.Error) as %Status [ Language = objectscript ]

Report an error from a %SYSTEM.Error object

  • error - an instance of %SYSTEM.Error

classmethod traceMessage(message As %String(MAXLEN="")) as %Status [ Language = objectscript ]
classmethod traceResult(pContext As %Library.ProcedureContext, displyRowCount As %Boolean = 0, timeStart As %String = "", startgloref As %String = "", rowcount As %BigInt = "", dumpresults As %Boolean = 1) as %Status [ Language = objectscript ]
classmethod traceStatus(StatusCode As %Status, Message As %String, ByRef Outcome) [ Language = objectscript ]

Report a status message from a trace

  • sc - pass as status code

  • message - pass a message to be written both to the current device and to the log (or "") (optional)

  • outcome - pass an array of stats (optional)

method write(message As %String(MAXLEN=""), linesBefore As %Integer = 0, linesAfter As %Integer = 1) as %Status [ Language = objectscript ]
write() - write a message to the current log file

Inherited Members

Inherited Methods

Feedback