schema_catalog.hpp

Go to the documentation of this file.

#pragma once

 
#include <cstddef>
#include <cstdint>
#include <filesystem>
#include <span>
#include <string_view>
#include <vector>
 
#include <wowlib/core/client_version.hpp>
#include <wowlib/core/error.hpp>
#include <wowlib/db/schema.hpp>
 
#ifndef WOWLIB_DB_SCHEMA_EMBEDDED
#define WOWLIB_DB_SCHEMA_EMBEDDED 1
#endif
#ifndef WOWLIB_DB_SCHEMA_RUNTIME
#define WOWLIB_DB_SCHEMA_RUNTIME 1
#endif
 
namespace wowlib::db {
  struct TableSchema {
    std::string_view name; 
    std::string_view diskName; 
    std::span<const Column> columns; 
  };

  class SchemaCatalog {
  public:
#if WOWLIB_DB_SCHEMA_EMBEDDED
    static const SchemaCatalog& embedded();
#endif
 
#if WOWLIB_DB_SCHEMA_RUNTIME
    static Result<SchemaCatalog> fromBlob(std::vector<unsigned char> bytes);

    static Result<SchemaCatalog> fromBlobFile(const std::filesystem::path& path);

    static Result<SchemaCatalog> fromDbdDir(const std::filesystem::path& definitions);
#endif
 
    SchemaCatalog(SchemaCatalog&&) noexcept = default;
    SchemaCatalog& operator=(SchemaCatalog&&) noexcept = default;
    SchemaCatalog(const SchemaCatalog&) = delete;
    SchemaCatalog& operator=(const SchemaCatalog&) = delete;

    Result<TableSchema> lookup(std::string_view table, ClientVersion version) const;

    std::size_t tableCount() const { return _tables.size(); }

    std::string_view tableName(std::size_t i) const { return _tables[i].name; }

    std::span<const ClientVersion> eras() const { return _eras; }
 
  private:
    SchemaCatalog() = default;

    struct RangeIndex {
      std::uint32_t firstColumn = 0; 
      std::uint32_t columnCount = 0; 
      std::uint16_t eraMask = 0; 
    };

    struct TableIndex {
      std::string_view name; 
      std::string_view diskName; 
      std::uint32_t firstRange = 0; 
      std::uint32_t rangeCount = 0; 
    };

    static SchemaCatalog _materialize(std::span<const unsigned char> bytes, std::vector<unsigned char> owned);

    Result<std::size_t> _eraIndexOf(ClientVersion version) const;
 
    std::vector<unsigned char> _owned; 
    std::vector<ClientVersion> _eras; 
    std::vector<TableIndex> _tables; 
    std::vector<RangeIndex> _ranges; 
    std::vector<Column> _columns; 
  };
}