Home > Class Reference > %SYS namespace > %Exception.SQL

%Exception.SQL

donotuse class %Exception.SQL extends %Exception.AbstractException

An SQL exception is instantiated using SQLCODE and %msg. It provides a convenient mechanism for reporting SQLCODE errors using exceptions. The resulting exception can be processed as a %Status value using the AsStatus() method or the original SQLCODE value along with the %msg value can be retrieved as Code and Data respectively. Authors of catch tException { } can test for an SQL exception using tException.%IsA("%Exception.SQL") to perform error handling and reporting specific to SQL.

Method Inventory (Including Private)

Methods (Including Private)

classmethod CreateFromSQLCODE(pSQLCODE As %Integer, pMessage As %String(MAXLEN="")) as %Exception.SQL [ Language = objectscript ]
Instantiate an exception from SQLCODE and %msg.
private method OnAsSQLCODE() as %Integer [ Language = objectscript ]
Override this method to provide a custom conversion of an exception to an SQLCODE value
private method OnAsStatus() as %Status [ Language = objectscript ]
Override this method to provide a custom conversion of an exception to a status SQL exceptions are converted to %Status values using $$$SQLCode as the status message id.
method SQLMessageString(pLevel As %Integer = 0) as %String [ Language = objectscript ]
This returns a string that represents the SQL %msg string. Users should feel free to modify the format and content in subclasses
Feedback