Package ortus.boxlang.runtime.types.exceptions

Class DatabaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

ortus.boxlang.runtime.types.exceptions.BoxLangException

ortus.boxlang.runtime.types.exceptions.DatabaseException

All Implemented Interfaces:

Serializable

public class DatabaseException
extends BoxLangException

This exception is the base exception for all database-related errors in the BoxLang runtime.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	nativeErrorCode	Native error code associated with exception.
static final Key	NativeErrorCodeKey
String	queryError	The error message as reported by the database driver.
static final Key	queryErrorKey
String	SQL	The SQL statement sent to the data source.
static final Key	SqlKey
String	SQLState	SQLState associated with exception.
static final Key	SQLStateKey
String	where	If the query uses the queryparam component, query parameter name-value pairs.
static final Key	whereKey

Fields inherited from class ortus.boxlang.runtime.types.exceptions.BoxLangException

detail, detailKey, messageKey, tagContextKey, type, typeKey

Constructor Summary

Constructors

Constructor	Description
DatabaseException(String message)	Constructor
DatabaseException(String message, String detail)	Constructor
DatabaseException(String message, String detail, String nativeErrorCode, String SQLState, String SQL, String queryError, String where, Throwable cause)	Constructor
DatabaseException(String message, Throwable cause)	Constructor

Method Summary

Modifier and Type	Method	Description
IStruct	dataAsStruct()	Additional data specific to this exception type (doesn't include message, stacktrace, tagcontext, etc)
String	getNativeErrorCode()	Get the native error code
String	getQueryError()	Get the query error
String	getSQL()	Get the SQL
String	getSQLState()	Get the SQL state
String	getWhere()	Get the where

Methods inherited from class ortus.boxlang.runtime.types.exceptions.BoxLangException

getDetail, getTagContext, getType

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NativeErrorCodeKey

public static final Key NativeErrorCodeKey

SQLStateKey

public static final Key SQLStateKey

SqlKey

public static final Key SqlKey

queryErrorKey

public static final Key queryErrorKey

whereKey

public static final Key whereKey

nativeErrorCode

public String nativeErrorCode

Native error code associated with exception. Database drivers typically provide error codes to diagnose failing database operations. Default value is -1.

SQLState

public String SQLState

SQLState associated with exception. Database drivers typically provide error codes to help diagnose failing database operations. Default value is 1.

SQL

public String SQL

The SQL statement sent to the data source.

queryError

public String queryError

The error message as reported by the database driver.

where

public String where

If the query uses the queryparam component, query parameter name-value pairs.

Constructor Details

DatabaseException

public DatabaseException(String message)

Constructor

Parameters:

message - The message

DatabaseException

public DatabaseException(String message,
 Throwable cause)

Constructor

Parameters:

message - The message

cause - The cause

DatabaseException

public DatabaseException(String message,
 String detail)

Constructor

Parameters:

message - The message

detail - The detail

DatabaseException

public DatabaseException(String message,
 String detail,
 String nativeErrorCode,
 String SQLState,
 String SQL,
 String queryError,
 String where,
 Throwable cause)

Constructor

Parameters:

message - The message

detail - The detail

nativeErrorCode - The native error code

SQLState - The SQL state

SQL - The SQL

queryError - The query error

where - The where

cause - The cause

Method Details

getNativeErrorCode

public String getNativeErrorCode()

Get the native error code

Returns:

The native error code

getSQLState

public String getSQLState()

Get the SQL state

Returns:

The SQL state

getSQL

public String getSQL()

Get the SQL

Returns:

The SQL

getQueryError

public String getQueryError()

Get the query error

Returns:

The query error

getWhere

public String getWhere()

Get the where

Returns:

The where

dataAsStruct

public IStruct dataAsStruct()

Description copied from class: BoxLangException

Additional data specific to this exception type (doesn't include message, stacktrace, tagcontext, etc)

Overrides:

dataAsStruct in class BoxLangException

Returns: