catalog_set.h

Go to the documentation of this file.

#pragma once
 
#include <mutex>
 
#include "catalog_entry.h"
#include "case_insensitive_map.h"
 
namespace kuzu {
namespace binder {
struct BoundAlterInfo;
} // namespace binder
 
namespace storage {
class UndoBuffer;
} // namespace storage
 
namespace transaction {
class Transaction;
} // namespace transaction
 
using CatalogEntrySet = common::case_insensitive_map_t<catalog::CatalogEntry*>;
 
namespace catalog {
class CatalogSet {
    friend class storage::UndoBuffer;
 
public:
    //===--------------------------------------------------------------------===//
    // getters & setters
    //===--------------------------------------------------------------------===//
    bool containsEntry(transaction::Transaction* transaction, const std::string& name);
    CatalogEntry* getEntry(transaction::Transaction* transaction, const std::string& name);
    KUZU_API void createEntry(transaction::Transaction* transaction,
        std::unique_ptr<CatalogEntry> entry);
    void dropEntry(transaction::Transaction* transaction, const std::string& name);
    void alterEntry(transaction::Transaction* transaction, const binder::BoundAlterInfo& alterInfo);
    CatalogEntrySet getEntries(transaction::Transaction* transaction);
 
    uint64_t assignNextOID() {
        std::lock_guard lck{mtx};
        return nextOID++;
    }
 
    //===--------------------------------------------------------------------===//
    // serialization & deserialization
    //===--------------------------------------------------------------------===//
    void serialize(common::Serializer serializer) const;
    static std::unique_ptr<CatalogSet> deserialize(common::Deserializer& deserializer);
 
private:
    bool containsEntryNoLock(transaction::Transaction* transaction, const std::string& name) const;
    CatalogEntry* getEntryNoLock(transaction::Transaction* transaction, const std::string& name);
    CatalogEntry* createEntryNoLock(transaction::Transaction* transaction,
        std::unique_ptr<CatalogEntry> entry);
    CatalogEntry* dropEntryNoLock(transaction::Transaction* transaction, const std::string& name);
 
    void validateExistNoLock(transaction::Transaction* transaction, const std::string& name) const;
    void validateNotExistNoLock(transaction::Transaction* transaction,
        const std::string& name) const;
 
    void emplaceNoLock(std::unique_ptr<CatalogEntry> entry);
    void eraseNoLock(const std::string& name);
 
    std::unique_ptr<CatalogEntry> createDummyEntryNoLock(std::string name) const;
 
    CatalogEntry* traverseVersionChainsForTransactionNoLock(transaction::Transaction* transaction,
        CatalogEntry* currentEntry) const;
    CatalogEntry* getCommittedEntryNoLock(CatalogEntry* entry) const;
 
private:
    std::mutex mtx;
    uint64_t nextOID = 0;
    common::case_insensitive_map_t<std::unique_ptr<CatalogEntry>> entries;
};
 
} // namespace catalog
} // namespace kuzu