database.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/prepared_stmt.hxx>
#include <StormByte/database/rows.hxx>
#include <StormByte/database/telemetry.hxx>
#include <StormByte/database/transaction.hxx>
#include <StormByte/database/typedefs.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/safe_pointers.hxx>
 
#include <memory>
#include <mutex>
#include <string>
#include <string_view>
#include <unordered_map>
 
namespace StormByte {
    namespace Database {
        class STORMBYTE_DATABASE_PUBLIC Database {
            public:
                Database(const StormByte::Shared<Logger::Log>& logger);
 
                Database(const Database &) = delete;
 
                Database(Database &&other) noexcept;
 
                Database &operator=(const Database &) = delete;
 
                Database &operator=(Database &&other) noexcept;
 
                virtual ~Database() noexcept;
 
                StormByte::Shared<Telemetry> GetTelemetry() const noexcept;
 
                bool Connect() noexcept;
 
                void Disconnect() noexcept;
 
                bool IsConnected() const noexcept {
                    std::lock_guard<std::recursive_mutex> lock(*m_operation_mutex);
                    return m_connected;
                }
 
                void SetSslMode(SslMode mode) noexcept {
                    std::lock_guard<std::recursive_mutex> lock(*m_operation_mutex);
                    m_ssl_mode = mode;
                }
 
                SslMode GetSslMode() const noexcept {
                    std::lock_guard<std::recursive_mutex> lock(*m_operation_mutex);
                    return m_ssl_mode;
                }
 
                template <typename... Args>
                ExpectedRows ExecuteSTMT(std::string_view name, Args &&...args) {
                    auto telemetry = TrackOperation(Operation::PreparedStatement);
                    std::lock_guard<std::recursive_mutex> lock(*m_operation_mutex);
                    PreparedSTMT *statement = FindPreparedSTMT(name);
                    if (!statement)
                        return Unexpected<UnknownSTMT>(name);
                    ExpectedRows result = statement->Execute(std::forward<Args>(args)...);
                    telemetry.Complete(result.has_value(), result ? static_cast<std::uint64_t>(result->Count()) : std::uint64_t{0});
                    return result;
                }
 
                virtual ExpectedRows Query(std::string_view query) = 0;
 
                virtual bool SilentQuery(std::string_view query) noexcept = 0;
 
                Expected<Transaction, TransactionError> BeginTransaction(IsolationLevel level = IsolationLevel::Default);
 
                void CommitTransaction();
 
                void RollbackTransaction();
 
            protected:
                friend class Transaction;
                StormByte::Shared<std::recursive_mutex> m_operation_mutex; 
                StormByte::Shared<Telemetry> m_telemetry; 
 
                void SetTelemetry(StormByte::Shared<Telemetry> telemetry) noexcept;
 
                void RecordBackendEvent(BackendEvent event) noexcept {
                    m_telemetry->RecordEvent(event);
                }
 
                Telemetry::OperationScope TrackOperation(Operation operation) const noexcept {
                    return Telemetry::OperationScope{m_telemetry, operation};
                }
 
                bool m_connected;                                                                
                SslMode m_ssl_mode;                                                              
 
                StormByte::Shared<Logger::Log> m_logger;    
 
                void ClearPreparedSTMTs() noexcept;
 
                virtual void DoPreConnect() noexcept {}
 
                virtual bool DoConnect() noexcept = 0;
 
                virtual void DoPostConnect() noexcept {}
 
                virtual void DoPreDisconnect() noexcept {}
 
                virtual void DoDisconnect() noexcept = 0;
 
                virtual void DoPostDisconnect() noexcept {}
 
                virtual StormByte::Unique<PreparedSTMT> CreatePreparedSTMT(std::string_view name, std::string_view query) noexcept = 0;
 
                void PrepareSTMT(std::string_view name, std::string_view query) noexcept;
 
                void DoPrepareSTMT(std::string_view name, std::string_view query) noexcept;
 
                virtual void DoBeginTransaction(IsolationLevel level) = 0;
 
                virtual bool DoSilentQuery(std::string_view query) noexcept = 0;
 
            private:
                std::unordered_map<std::string, StormByte::Unique<PreparedSTMT>> m_prepared_stmts; 
 
                PreparedSTMT *FindPreparedSTMT(std::string_view name);
        };
    }
}