base_repository.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#define PACS_STORAGE_BASE_REPOSITORY_HPP_INCLUDED
 
#include <kcenon/pacs/storage/pacs_database_adapter.h>
 
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#ifdef PACS_WITH_DATABASE_SYSTEM
 
#include <database/core/database_backend.h>
#include <database/database_types.h>
 
namespace kcenon::pacs::storage {
 
using database_value = database::core::database_value;
 
template <typename Entity, typename PrimaryKey = int64_t>
class base_repository {
public:
    using entity_type = Entity;
 
    using pk_type = PrimaryKey;
 
    using result_type = Result<Entity>;
 
    using list_result_type = Result<std::vector<Entity>>;
 
    explicit base_repository(std::shared_ptr<pacs_database_adapter> db,
                             std::string table_name,
                             std::string pk_column = "id");
 
    virtual ~base_repository() = default;
 
    // Non-copyable
    base_repository(const base_repository&) = delete;
    auto operator=(const base_repository&) -> base_repository& = delete;
 
    // Movable
    base_repository(base_repository&&) noexcept = default;
    auto operator=(base_repository&&) noexcept -> base_repository& = default;
 
    // ========================================================================
    // Read Operations
    // ========================================================================
 
    [[nodiscard]] virtual auto find_by_id(PrimaryKey id) -> result_type;
 
    [[nodiscard]] virtual auto find_all(std::optional<size_t> limit = std::nullopt)
        -> list_result_type;
 
    [[nodiscard]] virtual auto find_where(const std::string& column,
                                          const std::string& op,
                                          const database_value& value)
        -> list_result_type;
 
    [[nodiscard]] virtual auto exists(PrimaryKey id) -> Result<bool>;
 
    [[nodiscard]] virtual auto count() -> Result<size_t>;
 
    // ========================================================================
    // Write Operations
    // ========================================================================
 
    [[nodiscard]] virtual auto save(const Entity& entity)
        -> Result<PrimaryKey>;
 
    [[nodiscard]] virtual auto insert(const Entity& entity)
        -> Result<PrimaryKey>;
 
    [[nodiscard]] virtual auto update(const Entity& entity) -> VoidResult;
 
    [[nodiscard]] virtual auto remove(PrimaryKey id) -> VoidResult;
 
    [[nodiscard]] virtual auto remove_where(const std::string& column,
                                            const std::string& op,
                                            const database_value& value)
        -> Result<size_t>;
 
    // ========================================================================
    // Batch Operations
    // ========================================================================
 
    [[nodiscard]] virtual auto insert_batch(const std::vector<Entity>& entities)
        -> Result<std::vector<PrimaryKey>>;
 
    template <typename Func>
    [[nodiscard]] auto in_transaction(Func&& func)
        -> std::invoke_result_t<Func>;
 
protected:
    // ========================================================================
    // Abstract Methods - Subclass Must Implement
    // ========================================================================
 
    [[nodiscard]] virtual auto map_row_to_entity(const database_row& row) const
        -> Entity = 0;
 
    [[nodiscard]] virtual auto entity_to_row(const Entity& entity) const
        -> std::map<std::string, database_value> = 0;
 
    [[nodiscard]] virtual auto get_pk(const Entity& entity) const
        -> PrimaryKey = 0;
 
    [[nodiscard]] virtual auto has_pk(const Entity& entity) const -> bool = 0;
 
    [[nodiscard]] virtual auto select_columns() const
        -> std::vector<std::string>;
 
    // ========================================================================
    // Utility Methods for Subclasses
    // ========================================================================
 
    [[nodiscard]] auto query_builder() -> database::query_builder;
 
    [[nodiscard]] auto storage_session() -> pacs_storage_session;
 
    [[nodiscard]] auto db() -> std::shared_ptr<pacs_database_adapter>;
 
    [[nodiscard]] auto table_name() const -> const std::string&;
 
    [[nodiscard]] auto pk_column() const -> const std::string&;
 
private:
    std::shared_ptr<pacs_database_adapter> db_;
 
    std::string table_name_;
 
    std::string pk_column_;
};
 
}  // namespace kcenon::pacs::storage
 
// Include template implementation
#include "base_repository_impl.h"
 
#endif  // PACS_WITH_DATABASE_SYSTEM