Schema.h

Go to the documentation of this file.

/* -*- c++ -*-
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable 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; version 3 of the
 * License, or any later version.
 *
 * Hypertable 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */


#ifndef Hypertable_Lib_Schema_h
#define Hypertable_Lib_Schema_h

#include <Common/Properties.h>
#include "Common/PageArenaAllocator.h"
#include <Common/StringExt.h>

#include <Hypertable/Lib/AccessGroupSpec.h>
#include <Hypertable/Lib/ColumnFamilySpec.h>
#include <Hypertable/Lib/TableParts.h>

#include <expat.h>

#include <bitset>
#include <list>
#include <memory>
#include <unordered_map>
#include <vector>

namespace Hypertable {


  class Schema {
  public:

    Schema() : m_arena(1024), m_counter_mask(256) {
      m_access_group_map = CstrAccessGroupMap(LtCstr(), CstrAlloc(m_arena));
      m_column_family_map = CstrColumnFamilyMap(LtCstr(), CstrAlloc(m_arena));
    }

    Schema(const Schema &other);

    ~Schema();

    void clear_generation();

    bool clear_generation_if_changed(Schema &original);

    void update_generation(int64_t generation);

    const std::string render_xml(bool with_ids=false);

    const std::string render_hql(const std::string &table_name);

    int64_t get_generation() const { return m_generation; }

    void set_generation(int64_t generation) { m_generation = generation; }

    int32_t get_version() const { return m_version; }

    void set_version(int32_t version) { m_version = version; }

    int32_t get_max_column_family_id();

    TableParts get_table_parts();

    AccessGroupSpecs &get_access_groups() { return m_access_groups; }

    AccessGroupSpec *get_access_group(const std::string &name) {
      return get_access_group(name.c_str());
    }
    AccessGroupSpec *get_access_group(const char* name) {
      auto iter = m_access_group_map.find(name);
      if (iter != m_access_group_map.end())
        return iter->second;
      return nullptr;
    }

    ColumnFamilySpecs &get_column_families() { return m_column_families; }

    ColumnFamilySpec *get_column_family(const std::string &name) {
      return get_column_family(name.c_str());
    }
    ColumnFamilySpec *get_column_family(const char* name) {
      auto iter = m_column_family_map.find(name);
      if (iter != m_column_family_map.end())
        return iter->second;
      return nullptr;
    }

    ColumnFamilySpec *remove_column_family(const std::string &name);

    ColumnFamilySpec *get_column_family(int32_t id, bool get_deleted=false) {
      auto iter = m_column_family_id_map.find(id);
      if (iter != m_column_family_id_map.end()) {
        if (get_deleted || iter->second->get_deleted() == false)
          return (iter->second);
      }
      return nullptr;
    }

    void add_access_group(AccessGroupSpec *ag);

    AccessGroupSpec *replace_access_group(AccessGroupSpec *new_ag);

    bool access_group_exists(const std::string &name) const;

    bool column_family_exists(int32_t id, bool get_deleted = false) const;

    void drop_column_family(const String& name);

    void rename_column_family(const String& old_name, const String& new_name);

    bool column_is_counter(int id) {
      return m_counter_mask[id];
    }

    void set_group_commit_interval(int32_t interval) {
      m_group_commit_interval = interval;
    }

    int32_t get_group_commit_interval() { return m_group_commit_interval; }

    void set_access_group_defaults(const AccessGroupOptions &defaults) {
      m_ag_defaults = defaults;
    }

    AccessGroupOptions &access_group_defaults() { return m_ag_defaults; }

    void set_column_family_defaults(const ColumnFamilyOptions &defaults) {
      m_cf_defaults = defaults;
    }

    ColumnFamilyOptions &column_family_defaults() { return m_cf_defaults; }

    void validate();

    static Schema *new_instance(const std::string &buf);

  private:

    void merge_table_defaults(ColumnFamilySpec *cf_spec);

    void merge_table_defaults(AccessGroupSpec *ag_spec);

    //  Page arena allocator
    typedef PageArenaAllocator<const char*> CstrAlloc;
    CharArena m_arena;

    int64_t m_generation {};

    int32_t m_version {};

    int32_t m_group_commit_interval {};

    AccessGroupOptions m_ag_defaults;

    ColumnFamilyOptions m_cf_defaults;

    AccessGroupSpecs m_access_groups;

    typedef std::map<const char*, AccessGroupSpec*, LtCstr, CstrAlloc> CstrAccessGroupMap;
    CstrAccessGroupMap m_access_group_map;

    ColumnFamilySpecs m_column_families;

    typedef std::map<const char*, ColumnFamilySpec*, LtCstr, CstrAlloc> CstrColumnFamilyMap;
    CstrColumnFamilyMap m_column_family_map;

    std::map<int32_t, ColumnFamilySpec *> m_column_family_id_map;

    std::vector<bool> m_counter_mask;
  };

  typedef std::shared_ptr<Schema> SchemaPtr;


}

#endif // Hypertable_Lib_Schema_h