ClickHouse/dbms/include/DB/DataStreams/CollapsingSortedBlockInputStream.h

#pragma once

#include <common/logger_useful.h>

#include <DB/DataStreams/MergingSortedBlockInputStream.h>


namespace DB
{

/** Соединяет несколько сортированных потоков в один.
  * При этом, для каждой группы идущих подряд одинаковых значений первичного ключа (столбцов, по которым сортируются данные),
  *  оставляет не более одной строки со значением столбца sign_column = -1 ("отрицательной строки")
  *  и не более одиной строки со значением столбца sign_column = 1 ("положительной строки").
  * То есть - производит схлопывание записей из лога изменений.
  *
  * Если количество положительных и отрицательных строк совпадает, и последняя строка положительная - то пишет первую отрицательную и последнюю положительную строку.
  * Если количество положительных и отрицательных строк совпадает, и последняя строка отрицательная - то ничего не пишет.
  * Если положительных на 1 больше, чем отрицательных - то пишет только последнюю положительную строку.
  * Если отрицательных на 1 больше, чем положительных - то пишет только первую отрицательную строку.
  * Иначе - логическая ошибка.
  */
class CollapsingSortedBlockInputStream : public MergingSortedBlockInputStream
{
public:
	CollapsingSortedBlockInputStream(BlockInputStreams inputs_, const SortDescription & description_,
		const String & sign_column_, size_t max_block_size_, MergedRowSources * out_row_sources_ = nullptr)
		: MergingSortedBlockInputStream(inputs_, description_, max_block_size_, 0, out_row_sources_),
		sign_column(sign_column_)
	{
	}

	String getName() const override { return "CollapsingSorted"; }

	String getID() const override
	{
		std::stringstream res;
		res << "CollapsingSorted(inputs";

		for (size_t i = 0; i < children.size(); ++i)
			res << ", " << children[i]->getID();

		res << ", description";

		for (size_t i = 0; i < description.size(); ++i)
			res << ", " << description[i].getID();

		res << ", sign_column, " << sign_column << ")";
		return res.str();
	}

protected:
	/// Может возвращаться на 1 больше записей, чем max_block_size.
	Block readImpl() override;

private:
	String sign_column;
	size_t sign_column_number = 0;

	Logger * log = &Logger::get("CollapsingSortedBlockInputStream");

	/// Прочитали до конца.
	bool finished = false;

	RowRef current_key;			/// Текущий первичный ключ.
	RowRef next_key;			/// Первичный ключ следующей строки.

	RowRef first_negative;		/// Первая отрицательная строка для текущего первичного ключа.
	RowRef last_positive;		/// Последняя положительная строка для текущего первичного ключа.
	RowRef last_negative;		/// Последняя отрицательная. Сорраняется только если ни одной строки в ответ еще не выписано.

	size_t count_positive = 0;	/// Количество положительных строк для текущего первичного ключа.
	size_t count_negative = 0;	/// Количество отрицательных строк для текущего первичного ключа.
	bool last_is_positive = false;  /// true, если последняя строка для текущего первичного ключа положительная.

	size_t count_incorrect_data = 0;	/// Чтобы не писать в лог слишком много сообщений об ошибке.

	size_t blocks_written = 0;

	/// Fields specific for VERTICAL merge algorithm
	size_t current_pos = 0;			/// Global row number of current key
	size_t first_negative_pos = 0;	/// Global row number of first_negative
	size_t last_positive_pos = 0;	/// Global row number of last_positive
	size_t last_negative_pos = 0;	/// Global row number of last_negative

	/** Делаем поддержку двух разных курсоров - с Collation и без.
	 *  Шаблоны используем вместо полиморфных SortCursor'ов и вызовов виртуальных функций.
	 */
	template<class TSortCursor>
	void merge(ColumnPlainPtrs & merged_columns, std::priority_queue<TSortCursor> & queue);

	/// Вставить в результат строки для текущего первичного ключа.
	void insertRows(ColumnPlainPtrs & merged_columns, size_t & merged_rows, bool last_in_stream = false);

	void reportIncorrectData();
};

}