e55a606423
Add metadata-only counterparts to ::database, ::keyspace, and ::table. Apart from being metadata-only objects suitable for the coordinator, the new types are also type-erased and so they can be mocked without being linked to ::database and friends. We use a single abstract class to mediate between data_dictionary objects and the objects they represent (data_dictionary::impl). This makes the data_dictionary objects very lightweight - they only contain a pointer to the impl object (of which only one needs to be instantiated), and a reference to the object that is represented. This allows these objects to be easily passed by value. The abstraction is leaky: in one place it is outright breached with data_dictionary::database::real_database() that returns a ::database reference. This is used so that we can perform the transition incrementally. Another place is that one of the methods returns a secondary_index_manager, which in turn grants access to the real objects. This will be addressed later, probably by type erasing as well. This patch only contains the interface, and no implementation. It is somewhat messy since it mimics the years-old evolution of the real objects, but maybe it will be easier to improve it now.
134 lines
4.5 KiB
C++
134 lines
4.5 KiB
C++
/*
|
|
* Copyright (C) 2021-present ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* This file is part of Scylla.
|
|
*
|
|
* Scylla is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Scylla 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 Scylla. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <optional>
|
|
#include <set>
|
|
#include <string_view>
|
|
#include <seastar/core/shared_ptr.hh>
|
|
#include "seastarx.hh"
|
|
#include "utils/UUID.hh"
|
|
|
|
class database; // For transition; remove
|
|
class schema;
|
|
using schema_ptr = lw_shared_ptr<const schema>;
|
|
class view_ptr;
|
|
|
|
namespace db {
|
|
class config;
|
|
class extensions;
|
|
}
|
|
|
|
namespace secondary_index {
|
|
class secondary_index_manager;
|
|
}
|
|
|
|
namespace gms {
|
|
class feature_service;
|
|
}
|
|
|
|
namespace locator {
|
|
class abstract_replication_strategy;
|
|
}
|
|
|
|
// Classes representing the overall schema, but without access to data.
|
|
// Useful on the coordinator side (where access to data is via storage_proxy).
|
|
//
|
|
// Everything here is type-erased to reduce dependencies. No references are
|
|
// kept, so lower-level objects like keyspaces and tables must not be held
|
|
// across continuations.
|
|
namespace data_dictionary {
|
|
|
|
// Used to forward all operations to the underlying backing store.
|
|
class impl;
|
|
|
|
class user_types_metadata;
|
|
class keyspace_metadata;
|
|
|
|
class no_such_keyspace : public std::runtime_error {
|
|
public:
|
|
no_such_keyspace(std::string_view ks_name);
|
|
};
|
|
|
|
class no_such_column_family : public std::runtime_error {
|
|
public:
|
|
no_such_column_family(const utils::UUID& uuid);
|
|
no_such_column_family(std::string_view ks_name, std::string_view cf_name);
|
|
no_such_column_family(std::string_view ks_name, const utils::UUID& uuid);
|
|
};
|
|
|
|
class table {
|
|
const impl* _ops;
|
|
const void* _table;
|
|
private:
|
|
friend class impl;
|
|
table(const impl* ops, const void* table);
|
|
public:
|
|
schema_ptr schema() const;
|
|
const std::vector<view_ptr>& views() const;
|
|
const secondary_index::secondary_index_manager& get_index_manager() const;
|
|
};
|
|
|
|
class keyspace {
|
|
const impl* _ops;
|
|
const void* _keyspace;
|
|
private:
|
|
friend class impl;
|
|
keyspace(const impl* ops, const void* keyspace);
|
|
public:
|
|
lw_shared_ptr<keyspace_metadata> metadata() const;
|
|
const user_types_metadata& user_types() const;
|
|
const locator::abstract_replication_strategy& get_replication_strategy() const;
|
|
};
|
|
|
|
class database {
|
|
const impl* _ops;
|
|
const void* _database;
|
|
private:
|
|
friend class impl;
|
|
database(const impl* ops, const void* database);
|
|
public:
|
|
keyspace find_keyspace(std::string_view name) const;
|
|
std::optional<keyspace> try_find_keyspace(std::string_view name) const;
|
|
bool has_keyspace(std::string_view name) const; // throws no_keyspace
|
|
table find_table(std::string_view ks, std::string_view table) const; // throws no_such_column_family
|
|
table find_column_family(utils::UUID uuid) const; // throws no_such_column_family
|
|
schema_ptr find_schema(std::string_view ks, std::string_view table) const; // throws no_such_column_family
|
|
schema_ptr find_schema(utils::UUID uuid) const; // throws no_such_column_family
|
|
table find_column_family(schema_ptr s) const;
|
|
bool has_schema(std::string_view ks_name, std::string_view cf_name) const;
|
|
std::optional<table> try_find_table(std::string_view ks, std::string_view table) const;
|
|
std::optional<table> try_find_table(utils::UUID id) const;
|
|
const db::config& get_config() const;
|
|
std::set<sstring> existing_index_names(std::string_view ks_name, std::string_view cf_to_exclude = sstring()) const;
|
|
schema_ptr find_indexed_table(std::string_view ks_name, std::string_view index_name) const;
|
|
sstring get_available_index_name(std::string_view ks_name, std::string_view table_name,
|
|
std::optional<sstring> index_name_root) const;
|
|
schema_ptr get_cdc_base_table(sstring_view ks_name, std::string_view table_name) const;
|
|
schema_ptr get_cdc_base_table(const schema&) const;
|
|
const db::extensions& extensions() const;
|
|
const gms::feature_service& features() const;
|
|
::database& real_database() const; // For transition; remove
|
|
};
|
|
|
|
}
|