driver/io.github.octaviusframework.driver.exception

Package-level declarations

Types

Represents the action (encoding or decoding) during which a codec error occurred.

class CodecException(val action: CodecAction, val value: Any?, val name: String, val schema: String = "", val oid: Int? = null, val kotlinClass: KClass<*>? = null, cause: Exception) : OctaviusException

Exception thrown when encoding or decoding a value to/from a PostgreSQL representation fails.

ConcurrencyException

class ConcurrencyException(val reason: ConcurrencyExceptionReason, sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when a transaction fails due to concurrency issues like deadlocks, lock unavailability, or serialization failures.

ConcurrencyExceptionReason

enum ConcurrencyExceptionReason : Enum<ConcurrencyExceptionReason>

Categorizes the specific reason why a ConcurrencyException was thrown.

ConstraintViolationException

class ConstraintViolationException(val reason: ConstraintViolationExceptionReason, sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when a database operation violates a defined constraint (e.g., unique index, foreign key, check constraint).

ConstraintViolationExceptionReason

enum ConstraintViolationExceptionReason : Enum<ConstraintViolationExceptionReason>

Represents specific types of database constraint violations that can occur during query execution.

DatabaseSystemException

class DatabaseSystemException(val details: String, sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when a generic database system error occurs.

DataException

class DataException(val reason: DataExceptionReason, sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when an operation fails due to invalid data values during execution.

DataExceptionReason

enum DataExceptionReason : Enum<DataExceptionReason>

Categorizes the specific reason why a DataException was thrown.

ExecutionAbortedException

class ExecutionAbortedException(sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when the server stops a statement before it finishes - a statement_timeout, or a cancel request such as session.cancelQuery() (57014).

InitializationException

class InitializationException(val reason: InitializationExceptionReason, val details: String? = null, cause: Throwable? = null, sqlState: String? = null, serverErrorMessage: ServerErrorMessage? = null) : OctaviusException

Exception thrown when the driver fails to establish a connection or authenticate with the database server.

InitializationExceptionReason

enum InitializationExceptionReason : Enum<InitializationExceptionReason>

Represents the specific reason for an initialization failure during database connection or authentication.

InvalidOperationException

class InvalidOperationException(val reason: InvalidOperationExceptionReason, val details: String? = null) : OctaviusException

Exception thrown when the driver attempts an operation that is not allowed in the current state or context.

InvalidOperationExceptionReason

enum InvalidOperationExceptionReason : Enum<InvalidOperationExceptionReason>

Represents the specific reason for an invalid operation.

MappingException

class MappingException(val reason: MappingExceptionReason, val details: String, cause: Throwable? = null, path: MutableList<String> = mutableListOf()) : OctaviusException

Exception thrown when a type conversion or data mapping operation fails.

MappingExceptionReason

enum MappingExceptionReason : Enum<MappingExceptionReason>

Represents the specific reason for a mapping failure.

NetworkException

class NetworkException(val reason: NetworkExceptionReason, val details: String? = null, cause: Throwable? = null, sqlState: String? = "08006", serverErrorMessage: ServerErrorMessage? = null) : OctaviusException

Exception thrown when a network error disrupts communication with the database server.

NetworkExceptionReason

enum NetworkExceptionReason : Enum<NetworkExceptionReason>

Represents specific types of network-related errors that can occur during database communication.

OctaviusException

abstract class OctaviusException(message: String, val sqlState: String? = null, val serverErrorMessage: ServerErrorMessage? = null, cause: Throwable? = null, val path: MutableList<String> = mutableListOf()) : RuntimeException

Base exception for all errors in the Octavius JDBC driver.

PermissionDeniedException

class PermissionDeniedException(sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when the current database user lacks the required privileges to execute a statement or access an object.

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.

RoutineAssertionExceptionReason

enum RoutineAssertionExceptionReason : Enum<RoutineAssertionExceptionReason>

Represents which assertion a PL/pgSQL routine made and the data then falsified.

RoutineRaiseException

class RoutineRaiseException(sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when a PL/pgSQL routine raises an error of its own, through RAISE EXCEPTION.

SessionTerminatedException

class SessionTerminatedException(val reason: SessionTerminatedExceptionReason, sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when the server ends the session: it sent a FATAL or a PANIC, and closed the connection behind it.

SessionTerminatedExceptionReason

enum SessionTerminatedExceptionReason : Enum<SessionTerminatedExceptionReason>

Why the server ended the session.

SQLExceptionWrapper

class SQLExceptionWrapper(val wrappedException: OctaviusException) : SQLException

A wrapper class that adapts an OctaviusException into a standard java.sql.SQLException.

StatementException

class StatementException(val reason: StatementExceptionReason, val details: String? = null, val position: Int? = null, sqlState: String? = null, serverErrorMessage: ServerErrorMessage? = null) : OctaviusException

Exception thrown when an error occurs during the parsing, planning, or execution of a SQL statement.

StatementExceptionReason

enum StatementExceptionReason : Enum<StatementExceptionReason>

Represents specific reasons for a SQL statement execution failure.

TransactionStateException

class TransactionStateException(val reason: TransactionStateExceptionReason, sqlState: String, serverErrorMessage: ServerErrorMessage) : OctaviusException

Exception thrown when the statement itself is fine and the transaction it arrived in is not.

TransactionStateExceptionReason

enum TransactionStateExceptionReason : Enum<TransactionStateExceptionReason>

Represents the transaction state that made a statement inadmissible.

TypeException

class TypeException(val reason: TypeExceptionReason, val oid: Int? = null, val typeName: String? = null, val details: String? = null) : OctaviusException

Exception thrown when type resolution or validation fails within the driver's type registry.

TypeExceptionReason

enum TypeExceptionReason : Enum<TypeExceptionReason>

Represents the reason for a type resolution or validation failure.

UncategorizedDatabaseException

class UncategorizedDatabaseException(val details: String, sqlState: String? = null, serverErrorMessage: ServerErrorMessage? = null) : OctaviusException

Exception thrown for generic or unknown database errors that cannot be mapped to a specific OctaviusException subclass.

Functions

findOctaviusCause

fun Throwable.findOctaviusCause(): OctaviusException?

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

wrapSqlException

internal inline fun <T> wrapSqlException(block: () -> T): T

Runs block, restating any of the driver's exceptions it raises in a SQLExceptionWrapper - how every method the JDBC surface implements fails, where what it does not implement throws the driver's exception as it is.