prepared_stmt.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Database.
 *
 * StormByte-Database original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Database source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-Logger tree and
 * the PostgreSQL, MariaDB and SQLite trees), which remain under their own
 * licenses.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Database is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Database. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/database/rows.hxx>
#include <StormByte/database/telemetry.hxx>
#include <StormByte/database/value.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/size.hxx>
 
#include <memory>
#include <string>
#include <string_view>
#include <utility>
 
namespace StormByte {
    namespace Database {
        class STORMBYTE_DATABASE_PUBLIC PreparedSTMT {
            public:
                PreparedSTMT(std::string_view name, std::string_view query, const StormByte::Shared<Logger::Log>& logger);
 
                PreparedSTMT(std::string_view name, std::string_view query, const StormByte::Shared<Logger::Log>& logger,
                    const StormByte::Shared<Telemetry>& telemetry);
 
                PreparedSTMT(const PreparedSTMT &other) = delete;
 
                PreparedSTMT(PreparedSTMT &&other) noexcept;
 
                virtual ~PreparedSTMT() noexcept;
 
                PreparedSTMT &operator=(const PreparedSTMT &other) = delete;
 
                PreparedSTMT &operator=(PreparedSTMT &&other) noexcept;
 
                template <typename... Args>
                ExpectedRows Execute(Args &&...args) {
                    Reset();
                    StormByte::Size idx{};
                    (void)((Bind(idx++, std::forward<Args>(args))), ...);
                    ExpectedRows result = DoExecute();
                    Reset();
                    return result;
                }
 
                inline std::string_view Name() const noexcept {
                    return m_name;
                }
 
                inline std::string_view Query() const noexcept {
                    return m_query;
                }
 
            protected:
                StormByte::Shared<Logger::Log> m_logger;    
                StormByte::Shared<Telemetry> m_telemetry; 
 
                void RecordBackendEvent(BackendEvent event) noexcept {
                    if (m_telemetry)
                        m_telemetry->RecordEvent(event);
                }
 
                template <typename T>
                void Bind(StormByte::Size index, T &&value) noexcept {
                    Binder(index, Value(std::forward<T>(value)));
                }
 
                void Bind(StormByte::Size index, std::nullptr_t) noexcept {
                    Binder(index, Value());
                }
 
            private:
                                std::string m_name;         
                                std::string m_query;            
                virtual void Binder(StormByte::Size index, Value &&value) noexcept = 0;
 
                virtual void Reset() noexcept = 0;
 
                virtual ExpectedRows DoExecute() = 0;
        };
    }
}