api/io.github.octaviusframework.db.api.exception

Package-level declarations

Types

class BadStatementException(val messageEnum: BadStatementExceptionMessage, val errorPosition: Int? = null, queryContext: QueryContext? = null, cause: Throwable?) : FatalDatabaseException

Exception thrown when a query is semantically or syntactically invalid.

BadStatementExceptionMessage

enum BadStatementExceptionMessage : Enum<BadStatementExceptionMessage>

Messages for BadStatementException categorized by their root cause.

ConnectionException

class ConnectionException(message: String, queryContext: QueryContext? = null, cause: Throwable?) : DatabaseException

Exception thrown when there are infrastructure or connectivity issues.

ConstraintViolationException

class ConstraintViolationException(val messageEnum: ConstraintViolationExceptionMessage, val tableName: String? = null, val columnName: String? = null, val constraintName: String? = null, queryContext: QueryContext?, cause: Throwable?) : DatabaseException

Exception thrown when a database operation violates data integrity constraints.

ConstraintViolationExceptionMessage

enum ConstraintViolationExceptionMessage : Enum<ConstraintViolationExceptionMessage>

Messages for ConstraintViolationException representing specific database integrity rules.

DatabaseException

sealed class DatabaseException(message: String, cause: Throwable? = null, queryContext: QueryContext? = null) : OctaviusException

Base exception for recoverable database errors that are returned within io.github.octaviusframework.db.api.DataResult.

DataOperationException

class DataOperationException(val messageEnum: DataOperationExceptionMessage, queryContext: QueryContext? = null, cause: Throwable? = null) : DatabaseException

Exception thrown during data operations that are syntactically correct but fail due to data content, result expectations, or permission issues.

DataOperationExceptionMessage

enum DataOperationExceptionMessage : Enum<DataOperationExceptionMessage>

Messages for DataOperationException related to data retrieval and permissions.

FatalDatabaseException

abstract class FatalDatabaseException(message: String, queryContext: QueryContext?, cause: Throwable?) : OctaviusException

Base class for non-recoverable database errors that are thrown immediately instead of being wrapped in io.github.octaviusframework.db.api.DataResult.

InitializationException

class InitializationException(val messageEnum: InitializationExceptionMessage, val details: String? = null, cause: Throwable? = null, queryContext: QueryContext? = null) : FatalDatabaseException

Exception thrown during the initialization phase of Octavius Database.

InitializationExceptionMessage

enum InitializationExceptionMessage : Enum<InitializationExceptionMessage>

OctaviusException

sealed class OctaviusException(message: String, cause: Throwable? = null, queryContext: QueryContext? = null) : RuntimeException

Base exception for all errors in Octavius Database.

QueryContext

data class QueryContext(val sql: String, val parameters: Map<String, Any?>, val dbSql: String? = null, val dbParameters: List<Any?>? = null, val transactionStepIndex: Int? = null)

Context of a database operation execution.

StepDependencyException

class StepDependencyException(val messageEnum: StepDependencyExceptionMessage, val referencedStepIndex: Int, val args: Any, cause: Throwable? = null) : FatalDatabaseException

Exception thrown when a reference to a result from a previous transaction step is invalid and cannot be resolved.

StepDependencyExceptionMessage

enum StepDependencyExceptionMessage : Enum<StepDependencyExceptionMessage>

TransactionException

class TransactionException(val messageEnum: TransactionExceptionMessage, queryContext: QueryContext?, cause: Throwable?) : DatabaseException

Exception thrown for concurrency-related issues and transaction lifecycle failures.

TransactionExceptionMessage

enum TransactionExceptionMessage : Enum<TransactionExceptionMessage>

Messages for TransactionException covering concurrency and transaction lifecycle errors.

TypeMappingException

class TypeMappingException(val messageEnum: TypeMappingExceptionMessage, val value: Any? = null, val targetType: String? = null, val rowData: Map<String, Any?>? = null, val propertyName: String? = null, cause: Throwable? = null) : FatalDatabaseException

Exception thrown when data cannot be mapped between the database and Kotlin objects.

TypeMappingExceptionMessage

enum TypeMappingExceptionMessage : Enum<TypeMappingExceptionMessage>

Messages for TypeMappingException occurring during conversion between Kotlin and PostgreSQL types.

TypeRegistryException

class TypeRegistryException(val messageEnum: TypeRegistryExceptionMessage, val typeName: String, val oid: Int? = null, val expectedCategory: String? = null, val details: String? = null, cause: Throwable? = null, queryContext: QueryContext? = null) : FatalDatabaseException

Exception thrown when there is a mismatch or missing definition in the type registry.

TypeRegistryExceptionMessage

enum TypeRegistryExceptionMessage : Enum<TypeRegistryExceptionMessage>

UnknownDatabaseException

class UnknownDatabaseException(message: String, queryContext: QueryContext? = null, cause: Throwable?) : DatabaseException

Exception thrown when an error occurs in the database that is not recognized or categorized into a more specific DatabaseException subtype.

Functions

checkStatement

fun checkStatement(value: Boolean, messageEnum: BadStatementExceptionMessage = BadStatementExceptionMessage.MISSING_CLAUSE, details: () -> String)

requireStatement

inline fun requireStatement(value: Boolean, messageEnum: BadStatementExceptionMessage = BadStatementExceptionMessage.MISSING_CLAUSE, details: () -> String)