#pragma once #include #include #include #include #include #include #include #include #include namespace zkutil { class ZooKeeper; } namespace DB { struct ContextShared; class QuotaForIntervals; class TableFunctionFactory; class AggregateFunctionFactory; class Dictionaries; class ExternalDictionaries; class InterserverIOHandler; class BackgroundProcessingPool; class ReshardingWorker; class MergeList; class Cluster; class Compiler; class MarkCache; class UncompressedCache; class ProcessList; struct ProcessListElement; class Macros; struct Progress; class Clusters; class QueryLog; struct MergeTreeSettings; class IDatabase; class DDLGuard; /// (имя базы данных, имя таблицы) using DatabaseAndTableName = std::pair; /// Таблица -> множество таблиц-представлений, которые деляют SELECT из неё. using ViewDependencies = std::map>; using Dependencies = std::vector; /** Набор известных объектов, которые могут быть использованы в запросе. * Состоит из разделяемой части (всегда общей для всех сессий и запросов) * и копируемой части (которая может быть своей для каждой сессии или запроса). * * Всё инкапсулировано для всяких проверок и блокировок. */ class Context { private: using Shared = std::shared_ptr; Shared shared; ClientInfo client_info; std::shared_ptr quota; /// Current quota. By default - empty quota, that have no limits. String current_database; Settings settings; /// Setting for query execution. using ProgressCallback = std::function; ProgressCallback progress_callback; /// Callback for tracking progress of query execution. ProcessListElement * process_list_elem = nullptr; /// For tracking total resource usage for query. String default_format; /// Format, used when server formats data by itself and if query does not have FORMAT specification. /// Thus, used in HTTP interface. If not specified - then some globally default format is used. Tables external_tables; /// Temporary tables. Context * session_context = nullptr; /// Session context or nullptr. Could be equal to this. Context * global_context = nullptr; /// Global context or nullptr. Could be equal to this. using DatabasePtr = std::shared_ptr; using Databases = std::map>; public: Context(); ~Context(); String getPath() const; String getTemporaryPath() const; String getFlagsPath() const; void setPath(const String & path); void setTemporaryPath(const String & path); void setFlagsPath(const String & path); using ConfigurationPtr = Poco::AutoPtr; /** Забрать список пользователей, квот и профилей настроек из этого конфига. * Список пользователей полностью заменяется. * Накопленные значения у квоты не сбрасываются, если квота не удалена. */ void setUsersConfig(const ConfigurationPtr & config); ConfigurationPtr getUsersConfig(); /// Must be called before getClientInfo. void setUser(const String & name, const String & password, const Poco::Net::SocketAddress & address, const String & quota_key); ClientInfo & getClientInfo() { return client_info; }; const ClientInfo & getClientInfo() const { return client_info; }; void setQuota(const String & name, const String & quota_key, const String & user_name, const Poco::Net::IPAddress & address); QuotaForIntervals & getQuota(); void addDependency(const DatabaseAndTableName & from, const DatabaseAndTableName & where); void removeDependency(const DatabaseAndTableName & from, const DatabaseAndTableName & where); Dependencies getDependencies(const String & database_name, const String & table_name) const; /// Проверка существования таблицы/БД. database может быть пустой - в этом случае используется текущая БД. bool isTableExist(const String & database_name, const String & table_name) const; bool isDatabaseExist(const String & database_name) const; void assertTableExists(const String & database_name, const String & table_name) const; /** Параметр check_database_access_rights существует, чтобы не проверить повторно права доступа к БД, * когда assertTableDoesnExist или assertDatabaseExists вызывается внутри другой функции, которая уже * сделала эту проверку. */ void assertTableDoesntExist(const String & database_name, const String & table_name, bool check_database_acccess_rights = true) const; void assertDatabaseExists(const String & database_name, bool check_database_acccess_rights = true) const; void assertDatabaseDoesntExist(const String & database_name) const; Tables getExternalTables() const; StoragePtr tryGetExternalTable(const String & table_name) const; StoragePtr getTable(const String & database_name, const String & table_name) const; StoragePtr tryGetTable(const String & database_name, const String & table_name) const; void addExternalTable(const String & table_name, StoragePtr storage); void addDatabase(const String & database_name, const DatabasePtr & database); DatabasePtr detachDatabase(const String & database_name); /// Получить объект, который защищает таблицу от одновременного выполнения нескольких DDL операций. /// Если такой объект уже есть - кидается исключение. std::unique_ptr getDDLGuard(const String & database, const String & table, const String & message) const; /// Если таблица уже есть - возвращается nullptr, иначе создаётся guard. std::unique_ptr getDDLGuardIfTableDoesntExist(const String & database, const String & table, const String & message) const; String getCurrentDatabase() const; String getCurrentQueryId() const; void setCurrentDatabase(const String & name); void setCurrentQueryId(const String & query_id); String getDefaultFormat() const; /// Если default_format не задан - возвращается некоторый глобальный формат по-умолчанию. void setDefaultFormat(const String & name); const Macros & getMacros() const; void setMacros(Macros && macros); Settings getSettings() const; void setSettings(const Settings & settings_); Limits getLimits() const; /// Установить настройку по имени. void setSetting(const String & name, const Field & value); /// Установить настройку по имени. Прочитать значение в текстовом виде из строки (например, из конфига, или из параметра URL). void setSetting(const String & name, const std::string & value); const TableFunctionFactory & getTableFunctionFactory() const; const AggregateFunctionFactory & getAggregateFunctionFactory() const; const Dictionaries & getDictionaries() const; const ExternalDictionaries & getExternalDictionaries() const; void tryCreateDictionaries() const; void tryCreateExternalDictionaries() const; /// Форматы ввода-вывода. BlockInputStreamPtr getInputFormat(const String & name, ReadBuffer & buf, const Block & sample, size_t max_block_size) const; BlockOutputStreamPtr getOutputFormat(const String & name, WriteBuffer & buf, const Block & sample) const; InterserverIOHandler & getInterserverIOHandler(); /// Как другие серверы могут обратиться к этому для скачивания реплицируемых данных. void setInterserverIOAddress(const String & host, UInt16 port); std::pair getInterserverIOAddress() const; /// Порт, который сервер слушает для выполнения SQL-запросов. UInt16 getTCPPort() const; /// Получить запрос на CREATE таблицы. ASTPtr getCreateQuery(const String & database_name, const String & table_name) const; const DatabasePtr getDatabase(const String & database_name) const; DatabasePtr getDatabase(const String & database_name); const DatabasePtr tryGetDatabase(const String & database_name) const; DatabasePtr tryGetDatabase(const String & database_name); const Databases getDatabases() const; Databases getDatabases(); /// Для методов ниже может быть необходимо захватывать блокировку самостоятельно. std::unique_lock getLock() const; const Context & getSessionContext() const; Context & getSessionContext(); const Context & getGlobalContext() const; Context & getGlobalContext(); void setSessionContext(Context & context_) { session_context = &context_; } void setGlobalContext(Context & context_) { global_context = &context_; } const Settings & getSettingsRef() const { return settings; }; Settings & getSettingsRef() { return settings; }; void setProgressCallback(ProgressCallback callback); /// Используется в InterpreterSelectQuery, чтобы передать его в IProfilingBlockInputStream. ProgressCallback getProgressCallback() const; /** Устанавливается в executeQuery и InterpreterSelectQuery. Затем используется в IProfilingBlockInputStream, * чтобы обновлять и контролировать информацию об общем количестве потраченных на запрос ресурсов. */ void setProcessListElement(ProcessListElement * elem); /// Может вернуть nullptr, если запрос не был вставлен в ProcessList. ProcessListElement * getProcessListElement(); /// Список всех запросов. ProcessList & getProcessList(); const ProcessList & getProcessList() const; MergeList & getMergeList(); const MergeList & getMergeList() const; /// Создать кэш разжатых блоков указанного размера. Это можно сделать только один раз. void setUncompressedCache(size_t max_size_in_bytes); std::shared_ptr getUncompressedCache() const; void setZooKeeper(std::shared_ptr zookeeper); /// Если в момент вызова текущая сессия просрочена, синхронно создает и возвращает новую вызовом startNewSession(). std::shared_ptr getZooKeeper() const; /// Создать кэш засечек указанного размера. Это можно сделать только один раз. void setMarkCache(size_t cache_size_in_bytes); std::shared_ptr getMarkCache() const; BackgroundProcessingPool & getBackgroundPool(); void setReshardingWorker(std::shared_ptr resharding_worker); ReshardingWorker & getReshardingWorker(); /** Очистить кэши разжатых блоков и засечек. * Обычно это делается при переименовании таблиц, изменении типа столбцов, удалении таблицы. * - так как кэши привязаны к именам файлов, и становятся некорректными. * (при удалении таблицы - нужно, так как на её месте может появиться другая) * const - потому что изменение кэша не считается существенным. */ void resetCaches() const; Clusters & getClusters() const; std::shared_ptr getCluster(const std::string & cluster_name) const; std::shared_ptr tryGetCluster(const std::string & cluster_name) const; void setClustersConfig(const ConfigurationPtr & config); Compiler & getCompiler(); QueryLog & getQueryLog(); const MergeTreeSettings & getMergeTreeSettings(); /// Позволяет выбрать метод сжатия по условиям, описанным в конфигурационном файле. CompressionMethod chooseCompressionMethod(size_t part_size, double part_size_ratio) const; /// Получить аптайм сервера в секундах. time_t getUptimeSeconds() const; void shutdown(); enum class ApplicationType { SERVER, /// The program is run as clickhouse-server daemon (default behavior) CLIENT, /// clickhouse-client LOCAL_SERVER /// clickhouse-local }; ApplicationType getApplicationType() const; void setApplicationType(ApplicationType type); private: /** Проверить, имеет ли текущий клиент доступ к заданной базе данных. * Если доступ запрещён, кинуть исключение. * NOTE: Этот метод надо всегда вызывать при захваченном мьютексе shared->mutex. */ void checkDatabaseAccessRights(const std::string & database_name) const; const Dictionaries & getDictionariesImpl(bool throw_on_error) const; const ExternalDictionaries & getExternalDictionariesImpl(bool throw_on_error) const; StoragePtr getTableImpl(const String & database_name, const String & table_name, Exception * exception) const; }; /** Кладёт элемент в map, в деструкторе - удаляет. * Если элемент уже есть - кидает исключение. */ class DDLGuard { /// Имя объекта -> сообщение. using Map = std::unordered_map; Map & map; Map::iterator it; std::mutex & mutex; public: DDLGuard(Map & map_, std::mutex & mutex_, std::unique_lock && lock, const String & elem, const String & message); ~DDLGuard(); }; }