driver/io.github.octaviusframework.driver.exception/RoutineAssertionException

RoutineAssertionException

class RoutineAssertionException(val reason: RoutineAssertionExceptionReason, sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when an assertion inside a PL/pgSQL routine turns out to be false.

INTO STRICT states that the query matches exactly one row, and ASSERT states its condition holds. A run that finds otherwise has falsified something the routine claimed, which makes this a defect in the database code rather than an outcome of the call - the same reading that has fetch*Strict finding no row raise InvalidOperationException with INCORRECT_RESULT_SIZE instead of returning null. This is that failure one level down, asserted in PL/pgSQL rather than in Kotlin.

A routine saying no on purpose is RoutineRaiseException and is deliberately a different type.

Parameters

sqlState

The SQL state code returned by the database.

serverErrorMessage

The original error message from the database server.

Constructors

RoutineAssertionException

constructor(reason: RoutineAssertionExceptionReason, sqlState: String, serverErrorMessage: ServerErrorMessage)

Properties

open val cause: Throwable?

val dbDetail: String?

Explicit DETAIL field provided by PostgreSQL.

val dbMessage: String

The primary error message the routine raised (the PostgreSQL MESSAGE field).

val hint: String?

Explicit HINT field provided by PostgreSQL.

open val message: String?

var queryContext: QueryContext?

The context of the query that resulted in this exception, if applicable.

val reason: RoutineAssertionExceptionReason

Which assertion failed.

serverErrorMessage

val serverErrorMessage: ServerErrorMessage?

The raw error message received from the database, if applicable.

val sqlState: String?

The SQL state code associated with the error, if applicable.

val where: String?

Call stack or context (WHERE field) of the PL/pgSQL execution.

Functions

findOctaviusCause

fun Throwable.findOctaviusCause(): OctaviusException?

Finds the Octavius failure behind this throwable, if there is one.

getDetailedMessage

open override fun getDetailedMessage(): String

Provides a detailed, human-readable description of the error.

open override fun toString(): String