ClickHouse/dbms/include/DB/Dictionaries/MySQLDictionarySource.h

#pragma once

#include <DB/Dictionaries/IDictionarySource.h>
#include <DB/Dictionaries/MySQLBlockInputStream.h>
#include <ext/range.hpp>
#include <mysqlxx/Pool.h>
#include <Poco/Util/AbstractConfiguration.h>
#include "writeParenthesisedString.h"


namespace DB
{

/// Allows loading dictionaries from a MySQL database
class MySQLDictionarySource final : public IDictionarySource
{
	static const auto max_block_size = 8192;

public:
	MySQLDictionarySource(const DictionaryStructure & dict_struct,
		const Poco::Util::AbstractConfiguration & config, const std::string & config_prefix,
		const Block & sample_block)
		: dict_struct{dict_struct},
		  db{config.getString(config_prefix + ".db", "")},
		  table{config.getString(config_prefix + ".table")},
		  where{config.getString(config_prefix + ".where", "")},
		  dont_check_update_time{config.getBool(config_prefix + ".dont_check_update_time", false)},
		  sample_block{sample_block},
		  pool{config, config_prefix},
		  load_all_query{composeLoadAllQuery()}
	{}

	/// copy-constructor is provided in order to support cloneability
	MySQLDictionarySource(const MySQLDictionarySource & other)
		: dict_struct{other.dict_struct},
		  db{other.db},
		  table{other.table},
		  where{other.where},
		  dont_check_update_time{other.dont_check_update_time},
		  sample_block{other.sample_block},
		  pool{other.pool},
		  load_all_query{other.load_all_query}, last_modification{other.last_modification}
	{}

	BlockInputStreamPtr loadAll() override
	{
		last_modification = getLastModification();

		LOG_TRACE(log, load_all_query);
		return new MySQLBlockInputStream{pool.Get(), load_all_query, sample_block, max_block_size};
	}

	BlockInputStreamPtr loadIds(const std::vector<std::uint64_t> & ids) override
	{
		/// Здесь не логгируем и не обновляем время модификации, так как запрос может быть большим, и часто задаваться.

		const auto query = composeLoadIdsQuery(ids);
		return new MySQLBlockInputStream{pool.Get(), query, sample_block, max_block_size};
	}

	bool isModified() const override
	{
		if (dont_check_update_time)
			return true;

		return getLastModification() > last_modification;
	}

	bool supportsSelectiveLoad() const override { return true; }

	DictionarySourcePtr clone() const override { return std::make_unique<MySQLDictionarySource>(*this); }

	std::string toString() const override
	{
		return "MySQL: " + db + '.' + table + (where.empty() ? "" : ", where: " + where);
	}

private:
	Logger * log = &Logger::get("MySQLDictionarySource");

	static std::string quoteForLike(const std::string s)
	{
		std::string tmp;
		tmp.reserve(s.size());

		for (auto c : s)
		{
			if (c == '%' || c == '_' || c == '\\')
				tmp.push_back('\\');
			tmp.push_back(c);
		}

		std::string res;
		{
			WriteBufferFromString out(res);
			writeQuoted(tmp, out);
		}
		return res;
	}


	mysqlxx::DateTime getLastModification() const
	{
		mysqlxx::DateTime update_time{std::time(nullptr)};

		if (dont_check_update_time)
			return update_time;

		try
		{
			auto connection = pool.Get();
			auto query = connection->query("SHOW TABLE STATUS LIKE " + quoteForLike(table));

			LOG_TRACE(log, query.str());

			auto result = query.use();

			size_t fetched_rows = 0;
			if (auto row = result.fetch())
			{
				++fetched_rows;
				const auto UPDATE_TIME_IDX = 12;
				const auto & update_time_value = row[UPDATE_TIME_IDX];

				if (!update_time_value.isNull())
				{
					update_time = update_time_value.getDateTime();
					LOG_TRACE(log, "Got update time: " << update_time);
				}

				/// fetch remaining rows to avoid "commands out of sync" error
				while (auto row = result.fetch())
					++fetched_rows;
			}

			if (0 == fetched_rows)
				LOG_ERROR(log, "Cannot find table in SHOW TABLE STATUS result.");

			if (fetched_rows > 1)
				LOG_ERROR(log, "Found more than one table in SHOW TABLE STATUS result.");
		}
		catch (...)
		{
			tryLogCurrentException("MySQLDictionarySource");
		}

		/// we suppose failure to get modification time is not an error, therefore return current time
		return update_time;
	}

	std::string composeLoadAllQuery() const
	{
		std::string query;

		{
			WriteBufferFromString out{query};
			writeString("SELECT ", out);

			if (!dict_struct.id.expression.empty())
			{
				writeParenthesisedString(dict_struct.id.expression, out);
				writeString(" AS ", out);
			}

			writeProbablyBackQuotedString(dict_struct.id.name, out);

			if (dict_struct.range_min && dict_struct.range_max)
			{
				writeString(", ", out);

				if (!dict_struct.range_min->expression.empty())
				{
					writeParenthesisedString(dict_struct.range_min->expression, out);
					writeString(" AS ", out);
				}

				writeProbablyBackQuotedString(dict_struct.range_min->name, out);

				writeString(", ", out);

				if (!dict_struct.range_max->expression.empty())
				{
					writeParenthesisedString(dict_struct.range_max->expression, out);
					writeString(" AS ", out);
				}

				writeProbablyBackQuotedString(dict_struct.range_max->name, out);
			}

			for (const auto & attr : dict_struct.attributes)
			{
				writeString(", ", out);

				if (!attr.expression.empty())
				{
					writeParenthesisedString(attr.expression, out);
					writeString(" AS ", out);
				}

				writeProbablyBackQuotedString(attr.name, out);
			}

			writeString(" FROM ", out);
			if (!db.empty())
			{
				writeProbablyBackQuotedString(db, out);
				writeChar('.', out);
			}
			writeProbablyBackQuotedString(table, out);

			if (!where.empty())
			{
				writeString(" WHERE ", out);
				writeString(where, out);
			}

			writeChar(';', out);
		}

		return query;
	}

	std::string composeLoadIdsQuery(const std::vector<std::uint64_t> & ids)
	{
		std::string query;

		{
			WriteBufferFromString out{query};
			writeString("SELECT ", out);

			if (!dict_struct.id.expression.empty())
			{
				writeParenthesisedString(dict_struct.id.expression, out);
				writeString(" AS ", out);
			}

			writeProbablyBackQuotedString(dict_struct.id.name, out);

			for (const auto & attr : dict_struct.attributes)
			{
				writeString(", ", out);

				if (!attr.expression.empty())
				{
					writeParenthesisedString(attr.expression, out);
					writeString(" AS ", out);
				}

				writeProbablyBackQuotedString(attr.name, out);
			}

			writeString(" FROM ", out);
			if (!db.empty())
			{
				writeProbablyBackQuotedString(db, out);
				writeChar('.', out);
			}
			writeProbablyBackQuotedString(table, out);

			writeString(" WHERE ", out);

			if (!where.empty())
			{
				writeString(where, out);
				writeString(" AND ", out);
			}

			writeProbablyBackQuotedString(dict_struct.id.name, out);
			writeString(" IN (", out);

			auto first = true;
			for (const auto id : ids)
			{
				if (!first)
					writeString(", ", out);

				first = false;
				writeString(DB::toString(id), out);
			}

			writeString(");", out);
		}

		return query;
	}

	const DictionaryStructure dict_struct;
	const std::string db;
	const std::string table;
	const std::string where;
	const bool dont_check_update_time;
	Block sample_block;
	mutable mysqlxx::PoolWithFailover pool;
	const std::string load_all_query;
	mysqlxx::DateTime last_modification;
};

}