ClickHouse/dbms/include/DB/Storages/ITableDeclaration.h

108 lines
4.0 KiB
C++
Raw Normal View History

2014-03-09 17:36:01 +00:00
#pragma once
#include <DB/Core/Names.h>
#include <DB/Core/NamesAndTypes.h>
2015-10-05 01:35:28 +00:00
#include <DB/Common/Exception.h>
2014-03-09 17:36:01 +00:00
#include <DB/Core/Block.h>
#include <DB/Storages/ColumnDefault.h>
2014-03-09 17:36:01 +00:00
#include <boost/range/iterator_range.hpp>
#include <boost/range/join.hpp>
2014-03-09 17:36:01 +00:00
namespace DB
{
class Context;
/** Описание таблицы.
* Не thread safe. См. IStorage::lockStructure().
2014-03-09 17:36:01 +00:00
*/
class ITableDeclaration
2014-03-09 17:36:01 +00:00
{
public:
/** Имя таблицы.
*/
virtual std::string getTableName() const = 0;
2014-03-09 17:36:01 +00:00
/** Получить список имён и типов столбцов таблицы, только невиртуальные.
*/
NamesAndTypesList getColumnsList() const;
const NamesAndTypesList & getColumnsListNonMaterialized() const { return getColumnsListImpl(); }
2014-03-09 17:36:01 +00:00
/** Получить список имён столбцов таблицы, только невиртуальные.
*/
virtual Names getColumnNamesList() const;
2014-03-09 17:36:01 +00:00
/** Получить описание реального (невиртуального) столбца по его имени.
*/
virtual NameAndTypePair getRealColumn(const String & column_name) const;
/** Присутствует ли реальный (невиртуальный) столбец с таким именем.
*/
virtual bool hasRealColumn(const String & column_name) const;
NameAndTypePair getMaterializedColumn(const String & column_name) const;
bool hasMaterializedColumn(const String & column_name) const;
2014-03-09 17:36:01 +00:00
/** Получить описание любого столбца по его имени.
*/
virtual NameAndTypePair getColumn(const String & column_name) const;
/** Присутствует ли столбец с таким именем.
*/
virtual bool hasColumn(const String & column_name) const;
const DataTypePtr getDataTypeByName(const String & column_name) const;
/** То же самое, но в виде блока-образца.
*/
Block getSampleBlock() const;
Block getSampleBlockNonMaterialized() const;
2014-03-09 17:36:01 +00:00
/** Проверить, что все запрошенные имена есть в таблице и заданы корректно.
* (список имён не пустой и имена не повторяются)
*/
void check(const Names & column_names) const;
2014-03-09 17:36:01 +00:00
2014-07-14 14:07:47 +00:00
/** Проверить, что все запрошенные имена есть в таблице и имеют правильные типы.
*/
void check(const NamesAndTypesList & columns) const;
2014-07-14 14:07:47 +00:00
/** Проверить, что все имена из пересечения names и columns есть в таблице и имеют одинаковые типы.
*/
void check(const NamesAndTypesList & columns, const Names & column_names) const;
2014-07-14 14:07:47 +00:00
2014-03-09 17:36:01 +00:00
/** Проверить, что блок с данными для записи содержит все столбцы таблицы с правильными типами,
* содержит только столбцы таблицы, и все столбцы различны.
* Если need_all, еще проверяет, что все столбцы таблицы есть в блоке.
*/
void check(const Block & block, bool need_all = false) const;
2014-03-09 17:36:01 +00:00
virtual ~ITableDeclaration() = default;
ITableDeclaration() = default;
ITableDeclaration(
const NamesAndTypesList & materialized_columns,
const NamesAndTypesList & alias_columns,
const ColumnDefaults & column_defaults)
: materialized_columns{materialized_columns},
alias_columns{alias_columns},
column_defaults{column_defaults}
{}
NamesAndTypesList materialized_columns{};
NamesAndTypesList alias_columns{};
ColumnDefaults column_defaults{};
private:
virtual const NamesAndTypesList & getColumnsListImpl() const = 0;
using ColumnsListRange = boost::range::joined_range<const NamesAndTypesList, const NamesAndTypesList>;
/// Returns a lazily joined range of table's ordinary and materialized columns, without unnecessary copying
ColumnsListRange getColumnsListRange() const;
2014-03-09 17:36:01 +00:00
};
}