#pragma once #include #include #include #include #include namespace DB { /// Cluster contains connection pools to each node /// With the local nodes, the connection is not established, but the request is executed directly. /// Therefore we store only the number of local nodes /// In the config, the cluster includes nodes or class Cluster { public: Cluster(const Poco::Util::AbstractConfiguration & config, const Settings & settings, const String & cluster_name); /// Construct a cluster by the names of shards and replicas. /// Local are treated as well as remote ones if treat_local_as_remote is true. /// 'clickhouse_port' - port that this server instance listen for queries. /// This parameter is needed only to check that some address is local (points to ourself). Cluster(const Settings & settings, const std::vector> & names, const String & username, const String & password, UInt16 clickhouse_port, bool treat_local_as_remote, bool secure = false); Cluster(const Cluster &) = delete; Cluster & operator=(const Cluster &) = delete; /// is used to set a limit on the size of the timeout static Poco::Timespan saturate(const Poco::Timespan & v, const Poco::Timespan & limit); public: struct Address { /** In configuration file, * addresses are located either in elements: * * example01-01-1 * 9000 * * * ... * or in and inside in elements: * * * example01-01-1 * 9000 * * * */ String host_name; UInt16 port; String user; String password; /// This database is selected when no database is specified for Distributed table String default_database; /// The locality is determined at the initialization, and is not changed even if DNS is changed bool is_local = false; bool user_specified = false; Protocol::Compression compression = Protocol::Compression::Enable; Protocol::Secure secure = Protocol::Secure::Disable; Address() = default; Address(const Poco::Util::AbstractConfiguration & config, const String & config_prefix); Address(const String & host_port_, const String & user_, const String & password_, UInt16 clickhouse_port, bool secure_ = false); /// Returns 'escaped_host_name:port' String toString() const; /// Returns 'host_name:port' String readableString() const; static String toString(const String & host_name, UInt16 port); static std::pair fromString(const String & host_port_string); /// Retrurns escaped user:password@resolved_host_address:resolved_host_port#default_database String toFullString() const; static Address fromFullString(const String & address_full_string); /// Returns resolved address if it does resolve. std::optional getResolvedAddress() const; auto tuple() const { return std::tie(host_name, port, secure, user, password, default_database); } bool operator==(const Address & other) const { return tuple() == other.tuple(); } private: bool isLocal(UInt16 clickhouse_port) const; }; using Addresses = std::vector
; using AddressesWithFailover = std::vector; struct ShardInfo { public: bool isLocal() const { return !local_addresses.empty(); } bool hasRemoteConnections() const { return local_addresses.size() != per_replica_pools.size(); } size_t getLocalNodeCount() const { return local_addresses.size(); } bool hasInternalReplication() const { return has_internal_replication; } public: /// Name of directory for asynchronous write to StorageDistributed if has_internal_replication std::string dir_name_for_internal_replication; /// Number of the shard, the indexation begins with 1 UInt32 shard_num = 0; UInt32 weight = 1; Addresses local_addresses; /// nullptr if there are no remote addresses ConnectionPoolWithFailoverPtr pool; /// Connection pool for each replica, contains nullptr for local replicas ConnectionPoolPtrs per_replica_pools; bool has_internal_replication = false; }; using ShardsInfo = std::vector; String getHashOfAddresses() const { return hash_of_addresses; } const ShardsInfo & getShardsInfo() const { return shards_info; } const AddressesWithFailover & getShardsAddresses() const { return addresses_with_failover; } const ShardInfo & getAnyShardInfo() const { if (shards_info.empty()) throw Exception("Cluster is empty", ErrorCodes::LOGICAL_ERROR); return shards_info.front(); } /// The number of remote shards. size_t getRemoteShardCount() const { return remote_shard_count; } /// The number of clickhouse nodes located locally /// we access the local nodes directly. size_t getLocalShardCount() const { return local_shard_count; } /// The number of all shards. size_t getShardCount() const { return shards_info.size(); } /// Get a subcluster consisting of one shard - index by count (from 0) of the shard of this cluster. std::unique_ptr getClusterWithSingleShard(size_t index) const; /// Get a subcluster consisting of one or multiple shards - indexes by count (from 0) of the shard of this cluster. std::unique_ptr getClusterWithMultipleShards(const std::vector & indices) const; private: using SlotToShard = std::vector; SlotToShard slot_to_shard; public: const SlotToShard & getSlotToShard() const { return slot_to_shard; } private: void initMisc(); /// For getClusterWithMultipleShards implementation. Cluster(const Cluster & from, const std::vector & indices); String hash_of_addresses; /// Description of the cluster shards. ShardsInfo shards_info; /// Any remote shard. ShardInfo * any_remote_shard_info = nullptr; /// Non-empty is either addresses or addresses_with_failover. /// The size and order of the elements in the corresponding array corresponds to shards_info. /// An array of shards. For each shard, an array of replica addresses (servers that are considered identical). AddressesWithFailover addresses_with_failover; size_t remote_shard_count = 0; size_t local_shard_count = 0; }; using ClusterPtr = std::shared_ptr; class Clusters { public: Clusters(const Poco::Util::AbstractConfiguration & config, const Settings & settings, const String & config_name = "remote_servers"); Clusters(const Clusters &) = delete; Clusters & operator=(const Clusters &) = delete; ClusterPtr getCluster(const std::string & cluster_name) const; void setCluster(const String & cluster_name, const ClusterPtr & cluster); void updateClusters(const Poco::Util::AbstractConfiguration & config, const Settings & settings, const String & config_name); public: using Impl = std::map; Impl getContainer() const; protected: Impl impl; mutable std::mutex mutex; }; using ClustersPtr = std::shared_ptr; }