storagecommon.h

/*
 * LMDB Abstraction Layer.
 * Copyright (C) 2023  Yury Gubich <blue@macaw.me>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <string>
#include <string_view>
#include <cstdint>
 
#include <lmdb.h>
 
#include "base.h"
#include "transaction.h"
 
namespace LMDBAL {
 
class CursorCommon;
 
class StorageCommon {
    friend class Base;
    friend class CursorCommon;
public:
protected:
    StorageCommon(Base* parent, const std::string& name, bool duplicates = false);
    virtual ~ StorageCommon();

    virtual int open(MDB_txn * transaction) = 0;
    virtual void close();
    virtual void handleDrop();
 
    bool isDBOpened() const;
    const std::string& dbName() const;
 
    void ensureOpened(std::string_view methodName) const;
    void throwDuplicateOrUnknown(int rc, std::string_view key) const;
    void throwDuplicateOrUnknown(int rc, TransactionID txn, std::string_view key) const;
    void throwNotFoundOrUnknown(int rc, std::string_view key) const;
    void throwNotFoundOrUnknown(int rc, TransactionID txn, std::string_view key) const;
    void throwUnknown(int rc, TransactionID txn) const;
    void throwUnknown(int rc) const;
    void throwUnknown(std::string_view message) const;
    void throwDuplicate(std::string_view key) const;
    void throwNotFound(std::string_view key) const;
    void throwCursorNotReady(std::string_view method) const;
 
    TransactionID extractTransactionId(const Transaction& txn, std::string_view action = {}) const;
    TransactionID beginReadOnlyTransaction() const;
    TransactionID beginTransaction() const;
    void commitTransaction(TransactionID id);
    void abortTransaction(TransactionID id) const;
    virtual void transactionStarted(TransactionID txn, bool readOnly) const;
    virtual void transactionCommited(TransactionID txn);
    virtual void transactionAborted(TransactionID txn) const;
    virtual int drop(TransactionID transaction);
    virtual SizeType count(TransactionID txn) const;
 
    Transaction* getTransactionForCursor(MDB_cursor* cursor) const;
 
    void openCursorTransaction(MDB_cursor** cursor, bool renew = false) const;
    void closeCursorTransaction(MDB_cursor* cursor, bool closeCursor = false) const;
 
    int _mdbOpen(MDB_txn* txn, unsigned int flags = 0);
 
    int _mdbPut(MDB_txn* txn, MDB_val& key, MDB_val& data, unsigned int flags = 0);
    int _mdbGet(MDB_txn* txn, MDB_val& key, MDB_val& data) const;
    int _mdbDel(MDB_txn* txn, MDB_val& key);
    int _mdbDel(MDB_txn* txn, MDB_val& key, MDB_val& data);
 
    int _mdbStat(MDB_txn* txn, MDB_stat& stat) const;
    int _mdbFlags(MDB_txn* txn, uint32_t& flags) const;
 
    int _mdbCursorOpen(MDB_txn* txn, MDB_cursor** cursor) const;
    void _mdbCursorClose(MDB_cursor* cursor) const;
    int _mdbCursorGet(MDB_cursor* cursor, MDB_val& key, MDB_val& data, MDB_cursor_op operation) const;
    int _mdbCursorSet(MDB_cursor* cursor, MDB_val& key) const;
    int _mdbCursorDel(MDB_cursor* cursor, unsigned int flags = 0);
    int _mdbCursorPut(MDB_cursor* cursor, MDB_val& key, MDB_val& data, unsigned int flags = 0);
 
    int _mdbCursorRenew(MDB_txn* txn, MDB_cursor* cursor) const;
    MDB_txn* _mdbCursorTxn(MDB_cursor* cursor) const;
 
public:
    virtual void drop();
    virtual int drop(const WriteTransaction& txn);
    virtual SizeType count() const;
    virtual SizeType count(const Transaction& txn) const;
 
protected:
    MDB_dbi dbi;                
    Base* db;                   
    const std::string name;     
    const bool duplicates;      
 
    inline static constexpr std::string_view dropMethodName = "drop";                                    
    inline static constexpr std::string_view countMethodName = "count";                                  
    inline static constexpr std::string_view flagsMethodName = "flags";                                  
 
    inline static constexpr std::string_view addRecordMethodName = "addRecord";                          
    inline static constexpr std::string_view forceRecordMethodName = "forceRecord";                      
    inline static constexpr std::string_view changeRecordMethodName = "changeRecord";                    
    inline static constexpr std::string_view removeRecordMethodName = "removeRecord";                    
    inline static constexpr std::string_view checkRecordMethodName = "checkRecord";                      
    inline static constexpr std::string_view getRecordMethodName = "getRecord";                          
    inline static constexpr std::string_view readAllMethodName = "readAllRecord";                        
    inline static constexpr std::string_view replaceAllMethodName = "replaceAll";                        
    inline static constexpr std::string_view addRecordsMethodName = "addRecords";                        
    inline static constexpr std::string_view openCursorTransactionMethodName = "openCursorTransaction";  
 
protected:
    template <class K, class V>
    int makeStorage(MDB_txn* transaction, bool duplicates = false);
 
    template <class T>
    static std::string toString(const T& value);
};
 
}
 
#include "storagecommon.hpp"