driver/io.github.octaviusframework.driver.message/ServerErrorMessage

ServerErrorMessage

data class ServerErrorMessage(val severity: String, val localizedSeverity: String, val code: String, val message: String, val detail: String?, val hint: String?, val position: Int?, val internalPosition: Int?, val internalQuery: String?, val where: String?, val schema: String?, val table: String?, val column: String?, val datatype: String?, val constraint: String?, val file: String?, val line: Int?, val routine: String?)

A publicly exposed data class containing all detailed fields provided by the PostgreSQL backend when an error occurs.

Reachable as OctaviusException.serverErrorMessage on any exception the server raised, and the place to look when the driver's own categorization is not specific enough

Constructors

ServerErrorMessage

constructor(severity: String, localizedSeverity: String, code: String, message: String, detail: String?, hint: String?, position: Int?, internalPosition: Int?, internalQuery: String?, where: String?, schema: String?, table: String?, column: String?, datatype: String?, constraint: String?, file: String?, line: Int?, routine: String?)

Types

Companion

internal object Companion

Properties

code

val code: String

The five-character SQLSTATE.

column

val column: String?

The column at fault.

constraint

val constraint: String?

The constraint that was violated.

datatype

val datatype: String?

The data type at fault.

detail

val detail: String?

Secondary detail carrying more about the problem.

file

val file: String?

The PostgreSQL source file that reported it - server internals, not your SQL.

hint

val hint: String?

A suggestion of what to do about it.

internalPosition

val internalPosition: Int?

The equivalent position within internalQuery, for an error raised inside a statement the server generated itself.

internalQuery

val internalQuery: String?

The server-generated statement the error arose in, such as the body of a PL/pgSQL function.

line

val line: Int?

The line in that source file.

localizedSeverity

val localizedSeverity: String

The same severity as the server translated it, which is what a non-English lc_messages changes. Fit for showing to a person, not for comparing against.

message

val message: String

The primary human-readable message.

position

val position: Int?

The 1-based character position of the error in the submitted statement.

routine

val routine: String?

The PostgreSQL C function that reported it.

schema

val schema: String?

The schema of the object at fault, for the errors that name one.

severity

val severity: String

ERROR, FATAL or PANIC, always in English: it is read from the non-localized field, which every server the driver will talk to sends. Safe to compare against as a string.

table

val table: String?

The table of the object at fault.

where

val where: String?

The call stack the error arose in.