Skip to content

Refactor CRUD operations to use Arrow's Raise for error handling #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nomisRev wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Refactor CRUD operations to use Arrow's Raise for error handling #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions ...row/src/commonMain/kotlin/io/github/smyrgeorge/sqlx4k/arrow/ArrowContextCrudRepository.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
package io.github.smyrgeorge.sqlx4k.arrow

import arrow.core.raise.Raise
import io.github.smyrgeorge.sqlx4k.CrudRepositoryHooks
import io.github.smyrgeorge.sqlx4k.QueryExecutor
import io.github.smyrgeorge.sqlx4k.SQLError
import io.github.smyrgeorge.sqlx4k.arrow.impl.extensions.DbResult

/**
* Interface defining a contract for basic CRUD (Create, Read, Update, Delete) operations on a data source.
*
* This interface abstracts common operations to be implemented for handling entities of type [T].
* Each operation is asynchronous and returns a [DbResult], encapsulating either the successful result
* or an error in case of failure.
* Each operation is asynchronous and returns [T], or lifts the [SQLError] into Arrow's [Raise] in case of failure.
*
* @param T The type of the entity managed by the repository.
*/
Expand All @@ -25,8 +26,8 @@ interface ArrowContextCrudRepository<T> : CrudRepositoryHooks<T> {
* @return A [DbResult] containing the inserted entity of type [T] if the operation is successful,
* or an error if the operation fails.
*/
context(context: QueryExecutor)
suspend fun insert(entity: T): DbResult<T>
context(context: QueryExecutor, raise: Raise<SQLError>)
suspend fun insert(entity: T): T

/**
* Updates the given entity in the data source using the specified driver context.
Expand All @@ -39,8 +40,8 @@ interface ArrowContextCrudRepository<T> : CrudRepositoryHooks<T> {
* @return A [DbResult] containing the updated entity of type [T] if the operation is successful,
* or an error if the operation fails.
*/
context(context: QueryExecutor)
suspend fun update(entity: T): DbResult<T>
context(context: QueryExecutor, raise: Raise<SQLError>)
suspend fun update(entity: T): T

/**
* Deletes the given entity from the data source using the specified driver context.
Expand All @@ -53,8 +54,8 @@ interface ArrowContextCrudRepository<T> : CrudRepositoryHooks<T> {
* @return A [DbResult] containing a [Unit] value if the operation is successful,
* or an error if the operation fails.
*/
context(context: QueryExecutor)
suspend fun delete(entity: T): DbResult<Unit>
context(context: QueryExecutor, raise: Raise<SQLError>)
suspend fun delete(entity: T)

/**
* Saves the given entity to the data source using the specified driver context.
Expand All @@ -67,6 +68,6 @@ interface ArrowContextCrudRepository<T> : CrudRepositoryHooks<T> {
* @return A [DbResult] containing the saved entity of type [T] if the operation is successful,
* or an error if the operation fails.
*/
context(context: QueryExecutor)
suspend fun save(entity: T): DbResult<T>
context(context: QueryExecutor, raise: Raise<SQLError>)
suspend fun save(entity: T): T
}