QwParitySchemaRow.h

Go to the documentation of this file.

/*
 * QwParitySchemaRow.h
 *
 *  Created on: Sept 19, 2025
 *      Author: wdconinc
 */
 
#ifndef QWPARITYSCHEMAROW_H_
#define QWPARITYSCHEMAROW_H_
 
/*
 * QwParitySchemaRow.h
 *
 * Template-based row structures that automatically generate from sqlpp11 schema definitions.
 * This eliminates the need to manually duplicate field names and types while providing
 * clean, type-safe access using the schema column definitions.
 *
 * Usage:
 *   QwParitySchema::beam_optics table;
 *   QwParitySchema::beam_optics_row row;
 *
 *   // Clean syntax using schema columns
 *   row[table.analysis_id] = analysis_id_value;
 *   row[table.monitor_id] = monitor_id_value;
 *
 *   // Or method-based access
 *   row.set(table.amplitude, amplitude_value);
 *   auto amplitude = row.get(table.amplitude);
 *
 *   // Generate insert query automatically
 *   auto query = row.insert_query();
 */
 
// System headers
#include <tuple>
#include <type_traits>
#include <utility>
 
// Qweak headers
#ifdef __USE_DATABASE__
// Prefer the generated schema header from the build include path.
#include <QwParitySchema.h>
#ifdef __USE_SQLPP11__
#include <sqlpp11/sqlpp11.h>
#endif // __USE_SQLPP11__
#ifdef __USE_SQLPP23__
#include <sqlpp23/sqlpp23.h>
#endif // __USE_SQLPP23__
#endif // __USE_DATABASE__
 
#ifdef __USE_DATABASE__
 
namespace QwParitySchema {
 
namespace detail {
    // Helper to extract C++ value types - version specific
#ifdef __USE_SQLPP11__
    template<typename Column>
    using column_value_t = sqlpp::cpp_value_type_of<typename Column::_traits::_value_type>;
#endif // __USE_SQLPP11__
 
#ifdef __USE_SQLPP23__
    template<typename Column>
    using column_value_t = sqlpp::parameter_value_t<sqlpp::data_type_of_t<Column>>;
#endif // __USE_SQLPP23__
 
    // Extract all column value types into a tuple
    template<typename Tuple>
    struct extract_value_types;
 
    template<typename... Columns>
    struct extract_value_types<std::tuple<Columns...>> {
        using type = std::tuple<column_value_t<Columns>...>;
    };
 
    // Recursive helper to find column index - base case
    template<typename Target>
    constexpr std::size_t find_index_impl() {
        static_assert(sizeof(Target) == 0, "Column type not found in table");
        return 0; // This should never be reached due to static_assert
    }
 
    // Recursive helper to find column index - recursive case
    template<typename Target, typename First, typename... Rest>
    constexpr std::size_t find_index_impl() {
        if constexpr (std::is_same_v<Target, First>) {
            return 0;
        } else {
            return 1 + find_index_impl<Target, Rest...>();
        }
    }
 
    // Helper to find the index of a specific column type in the tuple
    template<typename TargetColumn, typename Tuple>
    struct column_index;
 
    template<typename TargetColumn, typename... Columns>
    struct column_index<TargetColumn, std::tuple<Columns...>> {
        static constexpr std::size_t value = find_index_impl<TargetColumn, Columns...>();
    };
 
    // Helper to check if a column/column spec is insertable (doesn't have must_not_insert trait)
    template<typename ColumnOrColumnSpec>
    constexpr bool is_insertable_column() {
#ifdef __USE_SQLPP11__
        using traits = typename ColumnOrColumnSpec::_traits;
        using tags = typename traits::_tags;
        return !sqlpp::detail::is_element_of<sqlpp::tag::must_not_insert, tags>::value;
#endif // __USE_SQLPP11__
#ifdef __USE_SQLPP23__
        // In sqlpp23, check if column has default value (auto-increment typically has has_default)
        return !sqlpp::has_default<ColumnOrColumnSpec>::value;
#endif // __USE_SQLPP23__
    }
 
    // Proxy class for column access that prevents assignment to auto-increment fields
    template<typename ColumnSpec, typename ValueType>
    class column_proxy {
    private:
        ValueType& value_ref;
 
    public:
        column_proxy(ValueType& ref) : value_ref(ref) {}
 
        // Implicit conversion to the value type for reading
        operator const ValueType&() const {
            return value_ref;
        }
 
        // Assignment operator with compile-time check
        template<typename T>
        column_proxy& operator=(T&& val) {
            static_assert(is_insertable_column<ColumnSpec>(),
                         "Cannot assign to auto-increment field (has must_not_insert trait). "
                         "Auto-increment fields are generated by the database.");
            value_ref = std::forward<T>(val);
            return *this;
        }
 
        // Special assignment operator for null values - version specific
#ifdef __USE_SQLPP11__
        column_proxy& operator=(const sqlpp::null_t& /*null_val*/) {
            static_assert(is_insertable_column<ColumnSpec>(),
                         "Cannot assign to auto-increment field (has must_not_insert trait). "
                         "Auto-increment fields are generated by the database.");
 
            // Check if column can be null at compile time
            using traits = typename ColumnSpec::_traits;
            using tags = typename traits::_tags;
            static_assert(sqlpp::detail::is_element_of<sqlpp::tag::can_be_null, tags>::value,
                         "Cannot assign null to non-nullable column");
 
            // For nullable columns, set to default-constructed value (representing null)
            value_ref = ValueType{};
            return *this;
        }
#endif // __USE_SQLPP11__
 
#ifdef __USE_SQLPP23__
        // Helper trait to check if a type is std::optional
        template<typename T>
        struct is_optional_type : std::false_type {};
        template<typename T>
        struct is_optional_type<std::optional<T>> : std::true_type {};
 
        column_proxy& operator=(const std::nullopt_t& /*null_val*/) {
            static_assert(is_insertable_column<ColumnSpec>(),
                         "Cannot assign to auto-increment field (has has_default trait). "
                         "Auto-increment fields are generated by the database.");
 
            // Check if ValueType is optional (i.e., nullable) at compile time
            static_assert(is_optional_type<ValueType>::value,
                         "Cannot assign null to non-nullable column");
 
            // For nullable columns, set to default-constructed value (representing null)
            value_ref = ValueType{};
            return *this;
        }
#endif // __USE_SQLPP23__
 
        // Get the actual reference (for reading)
        const ValueType& get() const {
            return value_ref;
        }
    };
 
    // Template helper to extract column spec from column types
    template<typename T>
    struct column_spec_of {
        using type = T;  // Default: assume T is already the column spec
    };
 
    // Both sqlpp11 and sqlpp23 use the same column_t<Table, ColumnSpec> structure
    template<typename Table, typename ColumnSpec>
    struct column_spec_of<sqlpp::column_t<Table, ColumnSpec>> {
        using type = ColumnSpec;
    };
 
    template<typename T>
    using column_spec_of_t = typename column_spec_of<T>::type;
 
    // Helper to make assignment only for insertable columns
    template<std::size_t I, typename Columns, typename Values>
    auto make_assignment_if_insertable(const Columns& columns, const Values& values) {
        auto column = std::get<I>(columns);
        using column_type = std::decay_t<decltype(column)>;
        using column_spec = column_spec_of_t<column_type>;
        if constexpr (is_insertable_column<column_spec>()) {
            return std::make_tuple(column = std::get<I>(values));
        } else {
            return std::make_tuple(); // Empty tuple for non-insertable columns
        }
    }
} // namespace detail
 
/**
 * @brief Template-based row generator that automatically extracts column information
 *        from sqlpp11 table definitions.
 *
 * This class provides a type-safe, schema-synchronized way to create row structures
 * without manually duplicating field names. It uses template metaprogramming to
 * extract column types and provides clean access syntax using the schema column
 * definitions.
 *
 * Usage Examples:
 *
 * Basic Usage:
 * @code
 * QwParitySchema::beam_optics_row row;
 * QwParitySchema::beam_optics table;
 *
 * // Set values using the table column references
 * row[table.run_number] = 12345;
 * row[table.beam_energy] = 2.2;
 *
 * // Generate insert query
 * auto query = row.insert_into();
 * connection(query);
 * @endcode
 *
 * @tparam Table The sqlpp11 table type (e.g., QwParitySchema::beam_optics)
 */
template<typename Table>
class row {
private:
    // Extract the column tuple type from the table - both libraries use the same _column_tuple_t member
    using column_tuple_t = typename Table::_column_tuple_t;
    using values_tuple_t = typename detail::extract_value_types<column_tuple_t>::type;
 
public:
    using table_type = Table;
 
    /**
     * @brief Storage for all column values as a tuple
     *
     * The tuple contains one element for each column in the table,
     * with types matching the sqlpp11 column value types.
     */
    values_tuple_t values;
 
    /**
     * @brief Default constructor
     */
    row() = default;
 
    /**
     * @brief Copy constructor
     */
    row(const row&) = default;
 
    /**
     * @brief Move constructor
     */
    row(row&&) = default;
 
    /**
     * @brief Copy assignment operator
     */
    row& operator=(const row&) = default;
 
    /**
     * @brief Move assignment operator
     */
    row& operator=(row&&) = default;
 
    /**
     * @brief Destructor
     */
    ~row() = default;
 
    /**
     * @brief Set a column value using the column specification type
     *
     * @tparam ColumnSpec The column specification type from the schema
     * @tparam T The value type
     * @param value The value to set
     */
    template<typename ColumnSpec, typename T>
    void set(T&& value) {
        static_assert(detail::is_insertable_column<ColumnSpec>(),
                     "Cannot set auto-increment field (has must_not_insert trait). "
                     "Auto-increment fields are generated by the database.");
        using column_t = sqlpp::column_t<Table, ColumnSpec>;
        constexpr auto idx = detail::column_index<column_t, column_tuple_t>::value;
        std::get<idx>(values) = std::forward<T>(value);
    }
 
    /**
     * @brief Get a column value using the column specification type
     *
     * @tparam ColumnSpec The column specification type from the schema
     * @return const reference to the column value
     */
    template<typename ColumnSpec>
    const auto& get() const {
        using column_t = sqlpp::column_t<Table, ColumnSpec>;
        constexpr auto idx = detail::column_index<column_t, column_tuple_t>::value;
        return std::get<idx>(values);
    }
 
    /**
     * @brief Get a mutable column value using the column specification type
     *
     * @tparam ColumnSpec The column specification type from the schema
     * @return mutable reference to the column value
     */
    template<typename ColumnSpec>
    auto& get() {
        using column_t = sqlpp::column_t<Table, ColumnSpec>;
        constexpr auto idx = detail::column_index<column_t, column_tuple_t>::value;
        return std::get<idx>(values);
    }
 
    /**
     * @brief Set a column value using a table column instance (auto-deducing)
     *
     * @tparam Column The column type (auto-deduced from parameter)
     * @tparam T The value type
     * @param column The table column instance
     * @param value The value to set
     */
    template<typename ColumnType, typename T>
    void set(const ColumnType& /*column*/, T&& value) {
        using column_spec = detail::column_spec_of_t<ColumnType>;
        static_assert(detail::is_insertable_column<column_spec>(),
                     "Cannot set auto-increment field. "
                     "Auto-increment fields are generated by the database.");
        set<column_spec>(std::forward<T>(value));
    }
 
    /**
     * @brief Get a column value using a table column instance (auto-deducing)
     *
     * @tparam Column The column type (auto-deduced from parameter)
     * @param column The table column instance
     * @return const reference to the column value
     */
    template<typename ColumnType>
    const auto& get(const ColumnType& /*column*/) const {
        using column_spec = detail::column_spec_of_t<ColumnType>;
        return get<column_spec>();
    }
 
    /**
     * @brief Get a mutable column value using a table column instance (auto-deducing)
     *
     * @tparam Column The column type (auto-deduced from parameter)
     * @param column The table column instance
     * @return mutable reference to the column value
     */
    template<typename ColumnType>
    auto& get(const ColumnType& /*column*/) {
        using column_spec = detail::column_spec_of_t<ColumnType>;
        return get<column_spec>();
    }
 
    /**
     * @brief Array-style access operator for setting/getting column values
     *
     * Returns a proxy object that allows reading and provides compile-time
     * protection against assignment to auto-increment fields.
     *
     * @tparam Column The column type (auto-deduced from parameter)
     * @param column The table column instance
     * @return proxy object for safe column access
     */
    template<typename ColumnType>
    auto operator[](const ColumnType& /*column*/) {
        using column_spec = detail::column_spec_of_t<ColumnType>;
        constexpr auto idx = detail::column_index<ColumnType, column_tuple_t>::value;
        using value_type = std::tuple_element_t<idx, values_tuple_t>;
        return detail::column_proxy<column_spec, value_type>(std::get<idx>(values));
    }
 
    /**
     * @brief Const array-style access operator for getting column values
     *
     * @tparam Column The column type (auto-deduced from parameter)
     * @param column The table column instance
     * @return const reference to the column value
     */
    template<typename ColumnType>
    const auto& operator[](const ColumnType& column) const {
        return get(column);
    }
 
    /**
     * @brief Generate an sqlpp11 insert query from the row data
     *
     * This method automatically maps all row values to their corresponding
     * table columns and creates a properly typed insert statement.
     *
     * @return sqlpp11 insert query object
     */
    auto insert_into() const {
        Table table;
        return generate_insert_impl(table, std::make_index_sequence<std::tuple_size_v<values_tuple_t>>{});
    }
 
    /**
     * @brief Reset all column values to their default-constructed state
     */
    void reset() {
        values = values_tuple_t{};
    }
 
    /**
     * @brief Get the number of columns in this row
     *
     * @return number of columns
     */
    static constexpr std::size_t column_count() {
        return std::tuple_size_v<values_tuple_t>;
    }
 
private:
    /**
     * @brief Implementation helper for generating insert queries
     *
     * Uses index sequences to map tuple elements to table columns,
     * but skips columns with must_not_insert trait (like auto-increment fields).
     *
     * @tparam Is Index sequence for the tuple elements
     * @param table The table instance
     * @param Index sequence (unused parameter)
     * @return sqlpp11 insert query
     */
    template<std::size_t... Is>
    auto generate_insert_impl(Table& table, std::index_sequence<Is...>) const {
        auto columns = sqlpp::all_of(table);
 
        // Create a tuple of all assignments (including empty tuples for non-insertable columns)
        auto assignments = std::tuple_cat(
            detail::make_assignment_if_insertable<Is>(columns, values)...
        );
 
        // Apply the assignments to the insert query using tuple unpacking
        return std::apply([&table](auto&&... args) {
            return sqlpp::insert_into(table).set(args...);
        }, assignments);
    }
};
 
// Convenience type aliases for common tables
using beam_optics_row = row<beam_optics>;
using md_data_row = row<md_data>;
using lumi_data_row = row<lumi_data>;
using beam_row = row<beam>;
using beam_errors_row = row<beam_errors>;
using lumi_errors_row = row<lumi_errors>;
using md_errors_row = row<md_errors>;
using general_errors_row = row<general_errors>;
 
} // namespace QwParitySchema
 
#endif // __USE_DATABASE__
 
#endif // QWPARITYSCHEMAROW_H_