ClickHouse/dbms/include/DB/Core/Block.h

#pragma once

#include <vector>
#include <map>
#include <list>
#include <initializer_list>

#include <DB/Common/Exception.h>
#include <DB/Core/BlockInfo.h>
#include <DB/Core/ColumnWithTypeAndName.h>
#include <DB/Core/NamesAndTypes.h>
#include <DB/Core/ColumnsWithTypeAndName.h>
#include <DB/Core/ColumnNumbers.h>


namespace DB
{

/** Тип данных для представления подмножества строк и столбцов в оперативке.
  * Содержит также метаданные (типы) столбцов и их имена.
  * Позволяет вставлять, удалять столбцы в любом порядке, менять порядок столбцов.
  */

class Context;

class Block
{
public:
	using Container_t = std::list<ColumnWithTypeAndName>;
	using IndexByPosition_t = std::vector<Container_t::iterator>;
	using IndexByName_t = std::map<String, Container_t::iterator>;

private:
	Container_t data;
	IndexByPosition_t index_by_position;
	IndexByName_t index_by_name;

public:
	BlockInfo info;

	Block() = default;
	Block(std::initializer_list<ColumnWithTypeAndName> il) : data{il}
	{
		index_by_position.reserve(il.size());
		for (auto it = std::begin(data); it != std::end(data); ++it)
		{
			index_by_name[it->name] = it;
			index_by_position.push_back(it);
		}
	}

	/// нужны, чтобы правильно скопировались индексы
	Block(const Block & other);
	Block(Block && other) = default;
	Block & operator= (const Block & other);
	Block & operator= (Block && other) = default;

	/// вставить столбец в заданную позицию
	void insert(size_t position, const ColumnWithTypeAndName & elem);
	/// вставить столбец в конец
	void insert(const ColumnWithTypeAndName & elem);
	/// вставить столбец в конец, если столбца с таким именем ещё нет
	void insertUnique(const ColumnWithTypeAndName & elem);
	/// удалить столбец в заданной позиции
	void erase(size_t position);
	/// удалить столбец с заданным именем
	void erase(const String & name);
	/// Добавляет в блок недостающие столбцы со значениями по-умолчанию
	void addDefaults(const NamesAndTypesList & required_columns);

	ColumnWithTypeAndName & getByPosition(size_t position);
	const ColumnWithTypeAndName & getByPosition(size_t position) const;

	ColumnWithTypeAndName & unsafeGetByPosition(size_t position) { return *index_by_position[position]; }
	const ColumnWithTypeAndName & unsafeGetByPosition(size_t position) const { return *index_by_position[position]; }

	ColumnWithTypeAndName & getByName(const std::string & name);
	const ColumnWithTypeAndName & getByName(const std::string & name) const;

	bool has(const std::string & name) const;
	bool hasNullColumns(const ColumnNumbers & arguments) const;
	bool hasNullableColumns(const ColumnNumbers & arguments) const;
	bool supportsNullValues(const ColumnNumbers & arguments) const;

	size_t getPositionByName(const std::string & name) const;

	ColumnsWithTypeAndName getColumns() const;
	NamesAndTypesList getColumnsList() const;

	/** Возвращает количество строк в блоке.
	  * Заодно проверяет, что все столбцы содержат одинаковое число значений.
	  */
	size_t rows() const;

	/** То же самое, но без проверки - берёт количество строк из первого столбца, если он есть или возвращает 0.
	  */
	size_t rowsInFirstColumn() const;

	size_t columns() const { return index_by_position.size(); }

	/// Приблизительное количество байт в оперативке - для профайлинга.
	size_t bytes() const;

	operator bool() const { return !index_by_position.empty(); }
	bool operator!() const { return index_by_position.empty(); }

	/** Получить список имён столбцов через запятую. */
	std::string dumpNames() const;

	/** Список имен, типов и длин столбцов. Предназначен для отладки. */
	std::string dumpStructure() const;

	/** Получить такой же блок, но пустой. */
	Block cloneEmpty() const;

	/** Получить блок со столбцами, переставленными в порядке их имён. */
	Block sortColumns() const;

	/// Returns a block in which all the nullable columns are replaced by
	/// their non-nullable counterparts.
	Block extractNonNullableBlock(const ColumnNumbers & arguments) const;
	Block extractBlockWithoutNullValues(const ColumnNumbers & arguments) const;

	/** Заменяет столбцы смещений внутри вложенных таблиц на один общий для таблицы.
	 *  Кидает исключение, если эти смещения вдруг оказались неодинаковы.
	 */
	void optimizeNestedArraysOffsets();
	/** Тоже самое, только без замены смещений. */
	void checkNestedArraysOffsets() const;

	void clear();
	void swap(Block & other) noexcept;

	void reserve(size_t size);
};

using Blocks = std::vector<Block>;
using BlocksList = std::list<Block>;

/// Сравнить типы столбцов у блоков. Порядок столбцов имеет значение. Имена не имеют значения.
bool blocksHaveEqualStructure(const Block & lhs, const Block & rhs);

/** Дополнительные данные к блокам. Они пока нужны только для запроса
  * DESCRIBE TABLE с Distributed-таблицами.
  */
struct BlockExtraInfo
{
	BlockExtraInfo() {}
	operator bool() const { return is_valid; }
	bool operator!() const { return !is_valid; }

	std::string host;
	std::string resolved_address;
	std::string user;
	UInt16 port = 0;

	bool is_valid = false;
};

}