mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-05 22:12:21 +00:00
900 lines
38 KiB
C++
900 lines
38 KiB
C++
#pragma once
|
|
|
|
#include <Core/Block.h>
|
|
#include <Core/NamesAndTypes.h>
|
|
#include <Core/Settings.h>
|
|
#include <Core/UUID.h>
|
|
#include <Interpreters/ClientInfo.h>
|
|
#include <Interpreters/Context_fwd.h>
|
|
#include <Interpreters/DatabaseCatalog.h>
|
|
#include <Parsers/IAST_fwd.h>
|
|
#include <Storages/IStorage_fwd.h>
|
|
#include <Common/MultiVersion.h>
|
|
#include <Common/OpenTelemetryTraceContext.h>
|
|
#include <Common/RemoteHostFilter.h>
|
|
#include <Common/isLocalAddress.h>
|
|
#include <base/types.h>
|
|
|
|
#include "config_core.h"
|
|
|
|
#include <boost/container/flat_set.hpp>
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <mutex>
|
|
#include <optional>
|
|
#include <exception>
|
|
|
|
|
|
namespace Poco::Net { class IPAddress; }
|
|
namespace zkutil { class ZooKeeper; }
|
|
|
|
|
|
namespace DB
|
|
{
|
|
|
|
struct ContextSharedPart;
|
|
class ContextAccess;
|
|
struct User;
|
|
using UserPtr = std::shared_ptr<const User>;
|
|
struct EnabledRolesInfo;
|
|
class EnabledRowPolicies;
|
|
class EnabledQuota;
|
|
struct QuotaUsage;
|
|
class AccessFlags;
|
|
struct AccessRightsElement;
|
|
class AccessRightsElements;
|
|
enum class RowPolicyFilterType;
|
|
class EmbeddedDictionaries;
|
|
class ExternalDictionariesLoader;
|
|
class ExternalModelsLoader;
|
|
class ExternalUserDefinedExecutableFunctionsLoader;
|
|
class InterserverCredentials;
|
|
using InterserverCredentialsPtr = std::shared_ptr<const InterserverCredentials>;
|
|
class InterserverIOHandler;
|
|
class BackgroundSchedulePool;
|
|
class MergeList;
|
|
class ReplicatedFetchList;
|
|
class Cluster;
|
|
class Compiler;
|
|
class MarkCache;
|
|
class MMappedFileCache;
|
|
class UncompressedCache;
|
|
class ProcessList;
|
|
class QueryStatus;
|
|
class Macros;
|
|
struct Progress;
|
|
struct FileProgress;
|
|
class Clusters;
|
|
class QueryLog;
|
|
class QueryThreadLog;
|
|
class QueryViewsLog;
|
|
class PartLog;
|
|
class TextLog;
|
|
class TraceLog;
|
|
class MetricLog;
|
|
class AsynchronousMetricLog;
|
|
class OpenTelemetrySpanLog;
|
|
class ZooKeeperLog;
|
|
class SessionLog;
|
|
struct MergeTreeSettings;
|
|
class StorageS3Settings;
|
|
class IDatabase;
|
|
class DDLWorker;
|
|
class ITableFunction;
|
|
class Block;
|
|
class ActionLocksManager;
|
|
using ActionLocksManagerPtr = std::shared_ptr<ActionLocksManager>;
|
|
class ShellCommand;
|
|
class ICompressionCodec;
|
|
class AccessControl;
|
|
class Credentials;
|
|
class GSSAcceptorContext;
|
|
struct SettingsConstraintsAndProfileIDs;
|
|
class RemoteHostFilter;
|
|
struct StorageID;
|
|
class IDisk;
|
|
using DiskPtr = std::shared_ptr<IDisk>;
|
|
class DiskSelector;
|
|
using DiskSelectorPtr = std::shared_ptr<const DiskSelector>;
|
|
using DisksMap = std::map<String, DiskPtr>;
|
|
class IStoragePolicy;
|
|
using StoragePolicyPtr = std::shared_ptr<const IStoragePolicy>;
|
|
using StoragePoliciesMap = std::map<String, StoragePolicyPtr>;
|
|
class StoragePolicySelector;
|
|
using StoragePolicySelectorPtr = std::shared_ptr<const StoragePolicySelector>;
|
|
template <class Queue>
|
|
class MergeTreeBackgroundExecutor;
|
|
class MergeMutateRuntimeQueue;
|
|
class OrdinaryRuntimeQueue;
|
|
using MergeMutateBackgroundExecutor = MergeTreeBackgroundExecutor<MergeMutateRuntimeQueue>;
|
|
using MergeMutateBackgroundExecutorPtr = std::shared_ptr<MergeMutateBackgroundExecutor>;
|
|
using OrdinaryBackgroundExecutor = MergeTreeBackgroundExecutor<OrdinaryRuntimeQueue>;
|
|
using OrdinaryBackgroundExecutorPtr = std::shared_ptr<OrdinaryBackgroundExecutor>;
|
|
struct PartUUIDs;
|
|
using PartUUIDsPtr = std::shared_ptr<PartUUIDs>;
|
|
class KeeperDispatcher;
|
|
class Session;
|
|
|
|
class IInputFormat;
|
|
class IOutputFormat;
|
|
using InputFormatPtr = std::shared_ptr<IInputFormat>;
|
|
using OutputFormatPtr = std::shared_ptr<IOutputFormat>;
|
|
class IVolume;
|
|
using VolumePtr = std::shared_ptr<IVolume>;
|
|
struct NamedSession;
|
|
struct BackgroundTaskSchedulingSettings;
|
|
|
|
#if USE_NLP
|
|
class SynonymsExtensions;
|
|
class Lemmatizers;
|
|
#endif
|
|
|
|
class Throttler;
|
|
using ThrottlerPtr = std::shared_ptr<Throttler>;
|
|
|
|
class ZooKeeperMetadataTransaction;
|
|
using ZooKeeperMetadataTransactionPtr = std::shared_ptr<ZooKeeperMetadataTransaction>;
|
|
|
|
class AsynchronousInsertQueue;
|
|
|
|
/// Callback for external tables initializer
|
|
using ExternalTablesInitializer = std::function<void(ContextPtr)>;
|
|
|
|
/// Callback for initialize input()
|
|
using InputInitializer = std::function<void(ContextPtr, const StoragePtr &)>;
|
|
/// Callback for reading blocks of data from client for function input()
|
|
using InputBlocksReader = std::function<Block(ContextPtr)>;
|
|
|
|
/// Used in distributed task processing
|
|
using ReadTaskCallback = std::function<String()>;
|
|
|
|
/// An empty interface for an arbitrary object that may be attached by a shared pointer
|
|
/// to query context, when using ClickHouse as a library.
|
|
struct IHostContext
|
|
{
|
|
virtual ~IHostContext() = default;
|
|
};
|
|
|
|
using IHostContextPtr = std::shared_ptr<IHostContext>;
|
|
|
|
/// A small class which owns ContextShared.
|
|
/// We don't use something like unique_ptr directly to allow ContextShared type to be incomplete.
|
|
struct SharedContextHolder
|
|
{
|
|
~SharedContextHolder();
|
|
SharedContextHolder();
|
|
explicit SharedContextHolder(std::unique_ptr<ContextSharedPart> shared_context);
|
|
SharedContextHolder(SharedContextHolder &&) noexcept;
|
|
|
|
SharedContextHolder & operator=(SharedContextHolder &&);
|
|
|
|
ContextSharedPart * get() const { return shared.get(); }
|
|
void reset();
|
|
|
|
private:
|
|
std::unique_ptr<ContextSharedPart> shared;
|
|
};
|
|
|
|
/** A set of known objects that can be used in the query.
|
|
* Consists of a shared part (always common to all sessions and queries)
|
|
* and copied part (which can be its own for each session or query).
|
|
*
|
|
* Everything is encapsulated for all sorts of checks and locks.
|
|
*/
|
|
class Context: public std::enable_shared_from_this<Context>
|
|
{
|
|
private:
|
|
ContextSharedPart * shared;
|
|
|
|
ClientInfo client_info;
|
|
ExternalTablesInitializer external_tables_initializer_callback;
|
|
|
|
InputInitializer input_initializer_callback;
|
|
InputBlocksReader input_blocks_reader;
|
|
|
|
std::optional<UUID> user_id;
|
|
std::shared_ptr<std::vector<UUID>> current_roles;
|
|
std::shared_ptr<const SettingsConstraintsAndProfileIDs> settings_constraints_and_current_profiles;
|
|
std::shared_ptr<const ContextAccess> access;
|
|
std::shared_ptr<const EnabledRowPolicies> row_policies_of_initial_user;
|
|
String current_database;
|
|
Settings settings; /// Setting for query execution.
|
|
|
|
using ProgressCallback = std::function<void(const Progress & progress)>;
|
|
ProgressCallback progress_callback; /// Callback for tracking progress of query execution.
|
|
|
|
using FileProgressCallback = std::function<void(const FileProgress & progress)>;
|
|
FileProgressCallback file_progress_callback; /// Callback for tracking progress of file loading.
|
|
|
|
QueryStatus * process_list_elem = nullptr; /// For tracking total resource usage for query.
|
|
StorageID insertion_table = StorageID::createEmpty(); /// Saved insertion table in query context
|
|
bool is_distributed = false; /// Whether the current context it used for distributed 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.
|
|
TemporaryTablesMapping external_tables_mapping;
|
|
Scalars scalars;
|
|
Scalars local_scalars;
|
|
|
|
/// Fields for distributed s3 function
|
|
std::optional<ReadTaskCallback> next_task_callback;
|
|
|
|
/// Record entities accessed by current query, and store this information in system.query_log.
|
|
struct QueryAccessInfo
|
|
{
|
|
QueryAccessInfo() = default;
|
|
|
|
QueryAccessInfo(const QueryAccessInfo & rhs)
|
|
{
|
|
std::lock_guard<std::mutex> lock(rhs.mutex);
|
|
databases = rhs.databases;
|
|
tables = rhs.tables;
|
|
columns = rhs.columns;
|
|
projections = rhs.projections;
|
|
views = rhs.views;
|
|
}
|
|
|
|
QueryAccessInfo(QueryAccessInfo && rhs) = delete;
|
|
|
|
QueryAccessInfo & operator=(QueryAccessInfo rhs)
|
|
{
|
|
swap(rhs);
|
|
return *this;
|
|
}
|
|
|
|
void swap(QueryAccessInfo & rhs)
|
|
{
|
|
std::swap(databases, rhs.databases);
|
|
std::swap(tables, rhs.tables);
|
|
std::swap(columns, rhs.columns);
|
|
std::swap(projections, rhs.projections);
|
|
std::swap(views, rhs.views);
|
|
}
|
|
|
|
/// To prevent a race between copy-constructor and other uses of this structure.
|
|
mutable std::mutex mutex{};
|
|
std::set<std::string> databases{};
|
|
std::set<std::string> tables{};
|
|
std::set<std::string> columns{};
|
|
std::set<std::string> projections{};
|
|
std::set<std::string> views{};
|
|
};
|
|
|
|
QueryAccessInfo query_access_info;
|
|
|
|
/// Record names of created objects of factories (for testing, etc)
|
|
struct QueryFactoriesInfo
|
|
{
|
|
std::unordered_set<std::string> aggregate_functions;
|
|
std::unordered_set<std::string> aggregate_function_combinators;
|
|
std::unordered_set<std::string> database_engines;
|
|
std::unordered_set<std::string> data_type_families;
|
|
std::unordered_set<std::string> dictionaries;
|
|
std::unordered_set<std::string> formats;
|
|
std::unordered_set<std::string> functions;
|
|
std::unordered_set<std::string> storages;
|
|
std::unordered_set<std::string> table_functions;
|
|
};
|
|
|
|
/// Needs to be chandged while having const context in factories methods
|
|
mutable QueryFactoriesInfo query_factories_info;
|
|
|
|
/// TODO: maybe replace with temporary tables?
|
|
StoragePtr view_source; /// Temporary StorageValues used to generate alias columns for materialized views
|
|
Tables table_function_results; /// Temporary tables obtained by execution of table functions. Keyed by AST tree id.
|
|
|
|
ContextWeakMutablePtr query_context;
|
|
ContextWeakMutablePtr session_context; /// Session context or nullptr. Could be equal to this.
|
|
ContextWeakMutablePtr global_context; /// Global context. Could be equal to this.
|
|
|
|
/// XXX: move this stuff to shared part instead.
|
|
ContextMutablePtr buffer_context; /// Buffer context. Could be equal to this.
|
|
|
|
/// A flag, used to distinguish between user query and internal query to a database engine (MaterializedPostgreSQL).
|
|
bool is_internal_query = false;
|
|
|
|
|
|
public:
|
|
// Top-level OpenTelemetry trace context for the query. Makes sense only for a query context.
|
|
OpenTelemetryTraceContext query_trace_context;
|
|
|
|
private:
|
|
using SampleBlockCache = std::unordered_map<std::string, Block>;
|
|
mutable SampleBlockCache sample_block_cache;
|
|
|
|
PartUUIDsPtr part_uuids; /// set of parts' uuids, is used for query parts deduplication
|
|
PartUUIDsPtr ignored_part_uuids; /// set of parts' uuids are meant to be excluded from query processing
|
|
|
|
NameToNameMap query_parameters; /// Dictionary with query parameters for prepared statements.
|
|
/// (key=name, value)
|
|
|
|
IHostContextPtr host_context; /// Arbitrary object that may used to attach some host specific information to query context,
|
|
/// when using ClickHouse as a library in some project. For example, it may contain host
|
|
/// logger, some query identification information, profiling guards, etc. This field is
|
|
/// to be customized in HTTP and TCP servers by overloading the customizeContext(DB::ContextPtr)
|
|
/// methods.
|
|
|
|
ZooKeeperMetadataTransactionPtr metadata_transaction; /// Distributed DDL context. I'm not sure if it's a suitable place for this,
|
|
/// but it's the easiest way to pass this through the whole stack from executeQuery(...)
|
|
/// to DatabaseOnDisk::commitCreateTable(...) or IStorage::alter(...) without changing
|
|
/// thousands of signatures.
|
|
/// And I hope it will be replaced with more common Transaction sometime.
|
|
|
|
Context();
|
|
Context(const Context &);
|
|
Context & operator=(const Context &);
|
|
|
|
public:
|
|
/// Create initial Context with ContextShared and etc.
|
|
static ContextMutablePtr createGlobal(ContextSharedPart * shared);
|
|
static ContextMutablePtr createCopy(const ContextWeakPtr & other);
|
|
static ContextMutablePtr createCopy(const ContextMutablePtr & other);
|
|
static ContextMutablePtr createCopy(const ContextPtr & other);
|
|
static SharedContextHolder createShared();
|
|
|
|
~Context();
|
|
|
|
String getPath() const;
|
|
String getFlagsPath() const;
|
|
String getUserFilesPath() const;
|
|
String getDictionariesLibPath() const;
|
|
String getUserScriptsPath() const;
|
|
|
|
/// A list of warnings about server configuration to place in `system.warnings` table.
|
|
Strings getWarnings() const;
|
|
|
|
VolumePtr getTemporaryVolume() const;
|
|
|
|
void setPath(const String & path);
|
|
void setFlagsPath(const String & path);
|
|
void setUserFilesPath(const String & path);
|
|
void setDictionariesLibPath(const String & path);
|
|
void setUserScriptsPath(const String & path);
|
|
|
|
void addWarningMessage(const String & msg);
|
|
|
|
VolumePtr setTemporaryStorage(const String & path, const String & policy_name = "");
|
|
|
|
using ConfigurationPtr = Poco::AutoPtr<Poco::Util::AbstractConfiguration>;
|
|
|
|
/// Global application configuration settings.
|
|
void setConfig(const ConfigurationPtr & config);
|
|
const Poco::Util::AbstractConfiguration & getConfigRef() const;
|
|
|
|
AccessControl & getAccessControl();
|
|
const AccessControl & getAccessControl() const;
|
|
|
|
/// Sets external authenticators config (LDAP, Kerberos).
|
|
void setExternalAuthenticatorsConfig(const Poco::Util::AbstractConfiguration & config);
|
|
|
|
/// Creates GSSAcceptorContext instance based on external authenticator params.
|
|
std::unique_ptr<GSSAcceptorContext> makeGSSAcceptorContext() const;
|
|
|
|
/** Take the list of users, quotas and configuration profiles from this config.
|
|
* The list of users is completely replaced.
|
|
* The accumulated quota values are not reset if the quota is not deleted.
|
|
*/
|
|
void setUsersConfig(const ConfigurationPtr & config);
|
|
ConfigurationPtr getUsersConfig();
|
|
|
|
/// Sets the current user assuming that he/she is already authenticated.
|
|
/// WARNING: This function doesn't check password!
|
|
void setUser(const UUID & user_id_);
|
|
|
|
UserPtr getUser() const;
|
|
String getUserName() const;
|
|
std::optional<UUID> getUserID() const;
|
|
|
|
void setQuotaKey(String quota_key_);
|
|
|
|
void setCurrentRoles(const std::vector<UUID> & current_roles_);
|
|
void setCurrentRolesDefault();
|
|
boost::container::flat_set<UUID> getCurrentRoles() const;
|
|
boost::container::flat_set<UUID> getEnabledRoles() const;
|
|
std::shared_ptr<const EnabledRolesInfo> getRolesInfo() const;
|
|
|
|
void setCurrentProfile(const String & profile_name);
|
|
void setCurrentProfile(const UUID & profile_id);
|
|
std::vector<UUID> getCurrentProfiles() const;
|
|
std::vector<UUID> getEnabledProfiles() const;
|
|
|
|
/// Checks access rights.
|
|
/// Empty database means the current database.
|
|
void checkAccess(const AccessFlags & flags) const;
|
|
void checkAccess(const AccessFlags & flags, const std::string_view & database) const;
|
|
void checkAccess(const AccessFlags & flags, const std::string_view & database, const std::string_view & table) const;
|
|
void checkAccess(const AccessFlags & flags, const std::string_view & database, const std::string_view & table, const std::string_view & column) const;
|
|
void checkAccess(const AccessFlags & flags, const std::string_view & database, const std::string_view & table, const std::vector<std::string_view> & columns) const;
|
|
void checkAccess(const AccessFlags & flags, const std::string_view & database, const std::string_view & table, const Strings & columns) const;
|
|
void checkAccess(const AccessFlags & flags, const StorageID & table_id) const;
|
|
void checkAccess(const AccessFlags & flags, const StorageID & table_id, const std::string_view & column) const;
|
|
void checkAccess(const AccessFlags & flags, const StorageID & table_id, const std::vector<std::string_view> & columns) const;
|
|
void checkAccess(const AccessFlags & flags, const StorageID & table_id, const Strings & columns) const;
|
|
void checkAccess(const AccessRightsElement & element) const;
|
|
void checkAccess(const AccessRightsElements & elements) const;
|
|
|
|
std::shared_ptr<const ContextAccess> getAccess() const;
|
|
|
|
ASTPtr getRowPolicyFilter(const String & database, const String & table_name, RowPolicyFilterType filter_type) const;
|
|
|
|
/// Finds and sets extra row policies to be used based on `client_info.initial_user`,
|
|
/// if the initial user exists.
|
|
/// TODO: we need a better solution here. It seems we should pass the initial row policy
|
|
/// because a shard is allowed to not have the initial user or it might be another user
|
|
/// with the same name.
|
|
void enableRowPoliciesOfInitialUser();
|
|
|
|
std::shared_ptr<const EnabledQuota> getQuota() const;
|
|
std::optional<QuotaUsage> getQuotaUsage() const;
|
|
|
|
/// We have to copy external tables inside executeQuery() to track limits. Therefore, set callback for it. Must set once.
|
|
void setExternalTablesInitializer(ExternalTablesInitializer && initializer);
|
|
/// This method is called in executeQuery() and will call the external tables initializer.
|
|
void initializeExternalTablesIfSet();
|
|
|
|
/// When input() is present we have to send columns structure to client
|
|
void setInputInitializer(InputInitializer && initializer);
|
|
/// This method is called in StorageInput::read while executing query
|
|
void initializeInput(const StoragePtr & input_storage);
|
|
|
|
/// Callback for read data blocks from client one by one for function input()
|
|
void setInputBlocksReaderCallback(InputBlocksReader && reader);
|
|
/// Get callback for reading data for input()
|
|
InputBlocksReader getInputBlocksReaderCallback() const;
|
|
void resetInputCallbacks();
|
|
|
|
ClientInfo & getClientInfo() { return client_info; }
|
|
const ClientInfo & getClientInfo() const { return client_info; }
|
|
|
|
enum StorageNamespace
|
|
{
|
|
ResolveGlobal = 1u, /// Database name must be specified
|
|
ResolveCurrentDatabase = 2u, /// Use current database
|
|
ResolveOrdinary = ResolveGlobal | ResolveCurrentDatabase, /// If database name is not specified, use current database
|
|
ResolveExternal = 4u, /// Try get external table
|
|
ResolveAll = ResolveExternal | ResolveOrdinary /// If database name is not specified, try get external table,
|
|
/// if external table not found use current database.
|
|
};
|
|
|
|
String resolveDatabase(const String & database_name) const;
|
|
StorageID resolveStorageID(StorageID storage_id, StorageNamespace where = StorageNamespace::ResolveAll) const;
|
|
StorageID tryResolveStorageID(StorageID storage_id, StorageNamespace where = StorageNamespace::ResolveAll) const;
|
|
StorageID resolveStorageIDImpl(StorageID storage_id, StorageNamespace where, std::optional<Exception> * exception) const;
|
|
|
|
Tables getExternalTables() const;
|
|
void addExternalTable(const String & table_name, TemporaryTableHolder && temporary_table);
|
|
std::shared_ptr<TemporaryTableHolder> removeExternalTable(const String & table_name);
|
|
|
|
const Scalars & getScalars() const;
|
|
const Block & getScalar(const String & name) const;
|
|
void addScalar(const String & name, const Block & block);
|
|
bool hasScalar(const String & name) const;
|
|
|
|
const Block * tryGetLocalScalar(const String & name) const;
|
|
void addLocalScalar(const String & name, const Block & block);
|
|
|
|
const QueryAccessInfo & getQueryAccessInfo() const { return query_access_info; }
|
|
void addQueryAccessInfo(
|
|
const String & quoted_database_name,
|
|
const String & full_quoted_table_name,
|
|
const Names & column_names,
|
|
const String & projection_name = {},
|
|
const String & view_name = {});
|
|
|
|
|
|
/// Supported factories for records in query_log
|
|
enum class QueryLogFactories
|
|
{
|
|
AggregateFunction,
|
|
AggregateFunctionCombinator,
|
|
Database,
|
|
DataType,
|
|
Dictionary,
|
|
Format,
|
|
Function,
|
|
Storage,
|
|
TableFunction
|
|
};
|
|
|
|
const QueryFactoriesInfo & getQueryFactoriesInfo() const { return query_factories_info; }
|
|
void addQueryFactoriesInfo(QueryLogFactories factory_type, const String & created_object) const;
|
|
|
|
StoragePtr executeTableFunction(const ASTPtr & table_expression);
|
|
|
|
void addViewSource(const StoragePtr & storage);
|
|
StoragePtr getViewSource() const;
|
|
|
|
String getCurrentDatabase() const;
|
|
String getCurrentQueryId() const { return client_info.current_query_id; }
|
|
|
|
/// Id of initiating query for distributed queries; or current query id if it's not a distributed query.
|
|
String getInitialQueryId() const;
|
|
|
|
void setCurrentDatabase(const String & name);
|
|
/// Set current_database for global context. We don't validate that database
|
|
/// exists because it should be set before databases loading.
|
|
void setCurrentDatabaseNameInGlobalContext(const String & name);
|
|
void setCurrentQueryId(const String & query_id);
|
|
|
|
void killCurrentQuery();
|
|
|
|
void setInsertionTable(StorageID db_and_table) { insertion_table = std::move(db_and_table); }
|
|
const StorageID & getInsertionTable() const { return insertion_table; }
|
|
|
|
void setDistributed(bool is_distributed_) { is_distributed = is_distributed_; }
|
|
bool isDistributed() const { return is_distributed; }
|
|
|
|
String getDefaultFormat() const; /// If default_format is not specified, some global default format is returned.
|
|
void setDefaultFormat(const String & name);
|
|
|
|
MultiVersion<Macros>::Version getMacros() const;
|
|
void setMacros(std::unique_ptr<Macros> && macros);
|
|
|
|
Settings getSettings() const;
|
|
void setSettings(const Settings & settings_);
|
|
|
|
/// Set settings by name.
|
|
void setSetting(const StringRef & name, const String & value);
|
|
void setSetting(const StringRef & name, const Field & value);
|
|
void applySettingChange(const SettingChange & change);
|
|
void applySettingsChanges(const SettingsChanges & changes);
|
|
|
|
/// Checks the constraints.
|
|
void checkSettingsConstraints(const SettingChange & change) const;
|
|
void checkSettingsConstraints(const SettingsChanges & changes) const;
|
|
void checkSettingsConstraints(SettingsChanges & changes) const;
|
|
void clampToSettingsConstraints(SettingsChanges & changes) const;
|
|
|
|
/// Returns the current constraints (can return null).
|
|
std::shared_ptr<const SettingsConstraintsAndProfileIDs> getSettingsConstraintsAndCurrentProfiles() const;
|
|
|
|
const EmbeddedDictionaries & getEmbeddedDictionaries() const;
|
|
const ExternalDictionariesLoader & getExternalDictionariesLoader() const;
|
|
const ExternalModelsLoader & getExternalModelsLoader() const;
|
|
const ExternalUserDefinedExecutableFunctionsLoader & getExternalUserDefinedExecutableFunctionsLoader() const;
|
|
EmbeddedDictionaries & getEmbeddedDictionaries();
|
|
ExternalDictionariesLoader & getExternalDictionariesLoader();
|
|
ExternalDictionariesLoader & getExternalDictionariesLoaderUnlocked();
|
|
ExternalUserDefinedExecutableFunctionsLoader & getExternalUserDefinedExecutableFunctionsLoader();
|
|
ExternalUserDefinedExecutableFunctionsLoader & getExternalUserDefinedExecutableFunctionsLoaderUnlocked();
|
|
ExternalModelsLoader & getExternalModelsLoader();
|
|
ExternalModelsLoader & getExternalModelsLoaderUnlocked();
|
|
void tryCreateEmbeddedDictionaries(const Poco::Util::AbstractConfiguration & config) const;
|
|
void loadOrReloadDictionaries(const Poco::Util::AbstractConfiguration & config);
|
|
void loadOrReloadUserDefinedExecutableFunctions(const Poco::Util::AbstractConfiguration & config);
|
|
void loadOrReloadModels(const Poco::Util::AbstractConfiguration & config);
|
|
|
|
#if USE_NLP
|
|
SynonymsExtensions & getSynonymsExtensions() const;
|
|
Lemmatizers & getLemmatizers() const;
|
|
#endif
|
|
|
|
/// I/O formats.
|
|
InputFormatPtr getInputFormat(const String & name, ReadBuffer & buf, const Block & sample, UInt64 max_block_size, const std::optional<FormatSettings> & format_settings = std::nullopt) const;
|
|
|
|
OutputFormatPtr getOutputFormat(const String & name, WriteBuffer & buf, const Block & sample) const;
|
|
OutputFormatPtr getOutputFormatParallelIfPossible(const String & name, WriteBuffer & buf, const Block & sample) const;
|
|
|
|
InterserverIOHandler & getInterserverIOHandler();
|
|
|
|
/// How other servers can access this for downloading replicated data.
|
|
void setInterserverIOAddress(const String & host, UInt16 port);
|
|
std::pair<String, UInt16> getInterserverIOAddress() const;
|
|
|
|
/// Credentials which server will use to communicate with others
|
|
void updateInterserverCredentials(const Poco::Util::AbstractConfiguration & config);
|
|
InterserverCredentialsPtr getInterserverCredentials();
|
|
|
|
/// Interserver requests scheme (http or https)
|
|
void setInterserverScheme(const String & scheme);
|
|
String getInterserverScheme() const;
|
|
|
|
/// Storage of allowed hosts from config.xml
|
|
void setRemoteHostFilter(const Poco::Util::AbstractConfiguration & config);
|
|
const RemoteHostFilter & getRemoteHostFilter() const;
|
|
|
|
/// The port that the server listens for executing SQL queries.
|
|
UInt16 getTCPPort() const;
|
|
|
|
std::optional<UInt16> getTCPPortSecure() const;
|
|
|
|
/// Register server ports during server starting up. No lock is held.
|
|
void registerServerPort(String port_name, UInt16 port);
|
|
|
|
UInt16 getServerPort(const String & port_name) const;
|
|
|
|
/// For methods below you may need to acquire the context lock by yourself.
|
|
|
|
ContextMutablePtr getQueryContext() const;
|
|
bool hasQueryContext() const { return !query_context.expired(); }
|
|
bool isInternalSubquery() const;
|
|
|
|
ContextMutablePtr getSessionContext() const;
|
|
bool hasSessionContext() const { return !session_context.expired(); }
|
|
|
|
ContextMutablePtr getGlobalContext() const;
|
|
|
|
bool hasGlobalContext() const { return !global_context.expired(); }
|
|
bool isGlobalContext() const
|
|
{
|
|
auto ptr = global_context.lock();
|
|
return ptr && ptr.get() == this;
|
|
}
|
|
|
|
ContextMutablePtr getBufferContext() const;
|
|
|
|
void setQueryContext(ContextMutablePtr context_) { query_context = context_; }
|
|
void setSessionContext(ContextMutablePtr context_) { session_context = context_; }
|
|
|
|
void makeQueryContext() { query_context = shared_from_this(); }
|
|
void makeSessionContext() { session_context = shared_from_this(); }
|
|
void makeGlobalContext() { initGlobal(); global_context = shared_from_this(); }
|
|
|
|
const Settings & getSettingsRef() const { return settings; }
|
|
|
|
void setProgressCallback(ProgressCallback callback);
|
|
/// Used in executeQuery() to pass it to the QueryPipeline.
|
|
ProgressCallback getProgressCallback() const;
|
|
|
|
void setFileProgressCallback(FileProgressCallback && callback) { file_progress_callback = callback; }
|
|
FileProgressCallback getFileProgressCallback() const { return file_progress_callback; }
|
|
|
|
/** Set in executeQuery and InterpreterSelectQuery. Then it is used in QueryPipeline,
|
|
* to update and monitor information about the total number of resources spent for the query.
|
|
*/
|
|
void setProcessListElement(QueryStatus * elem);
|
|
/// Can return nullptr if the query was not inserted into the ProcessList.
|
|
QueryStatus * getProcessListElement() const;
|
|
|
|
/// List all queries.
|
|
ProcessList & getProcessList();
|
|
const ProcessList & getProcessList() const;
|
|
|
|
MergeList & getMergeList();
|
|
const MergeList & getMergeList() const;
|
|
|
|
ReplicatedFetchList & getReplicatedFetchList();
|
|
const ReplicatedFetchList & getReplicatedFetchList() const;
|
|
|
|
/// If the current session is expired at the time of the call, synchronously creates and returns a new session with the startNewSession() call.
|
|
/// If no ZooKeeper configured, throws an exception.
|
|
std::shared_ptr<zkutil::ZooKeeper> getZooKeeper() const;
|
|
/// Same as above but return a zookeeper connection from auxiliary_zookeepers configuration entry.
|
|
std::shared_ptr<zkutil::ZooKeeper> getAuxiliaryZooKeeper(const String & name) const;
|
|
|
|
/// Try to connect to Keeper using get(Auxiliary)ZooKeeper. Useful for
|
|
/// internal Keeper start (check connection to some other node). Return true
|
|
/// if connected successfully (without exception) or our zookeeper client
|
|
/// connection configured for some other cluster without our node.
|
|
bool tryCheckClientConnectionToMyKeeperCluster() const;
|
|
|
|
UInt32 getZooKeeperSessionUptime() const;
|
|
|
|
#if USE_NURAFT
|
|
std::shared_ptr<KeeperDispatcher> & getKeeperDispatcher() const;
|
|
#endif
|
|
void initializeKeeperDispatcher(bool start_async) const;
|
|
void shutdownKeeperDispatcher() const;
|
|
void updateKeeperConfiguration(const Poco::Util::AbstractConfiguration & config);
|
|
|
|
/// Set auxiliary zookeepers configuration at server starting or configuration reloading.
|
|
void reloadAuxiliaryZooKeepersConfigIfChanged(const ConfigurationPtr & config);
|
|
/// Has ready or expired ZooKeeper
|
|
bool hasZooKeeper() const;
|
|
/// Has ready or expired auxiliary ZooKeeper
|
|
bool hasAuxiliaryZooKeeper(const String & name) const;
|
|
/// Reset current zookeeper session. Do not create a new one.
|
|
void resetZooKeeper() const;
|
|
// Reload Zookeeper
|
|
void reloadZooKeeperIfChanged(const ConfigurationPtr & config) const;
|
|
|
|
void setSystemZooKeeperLogAfterInitializationIfNeeded();
|
|
|
|
/// Create a cache of uncompressed blocks of specified size. This can be done only once.
|
|
void setUncompressedCache(size_t max_size_in_bytes);
|
|
std::shared_ptr<UncompressedCache> getUncompressedCache() const;
|
|
void dropUncompressedCache() const;
|
|
|
|
/// Create a cache of marks of specified size. This can be done only once.
|
|
void setMarkCache(size_t cache_size_in_bytes);
|
|
std::shared_ptr<MarkCache> getMarkCache() const;
|
|
void dropMarkCache() const;
|
|
|
|
/// Create a cache of index uncompressed blocks of specified size. This can be done only once.
|
|
void setIndexUncompressedCache(size_t max_size_in_bytes);
|
|
std::shared_ptr<UncompressedCache> getIndexUncompressedCache() const;
|
|
void dropIndexUncompressedCache() const;
|
|
|
|
/// Create a cache of index marks of specified size. This can be done only once.
|
|
void setIndexMarkCache(size_t cache_size_in_bytes);
|
|
std::shared_ptr<MarkCache> getIndexMarkCache() const;
|
|
void dropIndexMarkCache() const;
|
|
|
|
/// Create a cache of mapped files to avoid frequent open/map/unmap/close and to reuse from several threads.
|
|
void setMMappedFileCache(size_t cache_size_in_num_entries);
|
|
std::shared_ptr<MMappedFileCache> getMMappedFileCache() const;
|
|
void dropMMappedFileCache() const;
|
|
|
|
/** Clear the caches of the uncompressed blocks and marks.
|
|
* This is usually done when renaming tables, changing the type of columns, deleting a table.
|
|
* - since caches are linked to file names, and become incorrect.
|
|
* (when deleting a table - it is necessary, since in its place another can appear)
|
|
* const - because the change in the cache is not considered significant.
|
|
*/
|
|
void dropCaches() const;
|
|
|
|
/// Settings for MergeTree background tasks stored in config.xml
|
|
BackgroundTaskSchedulingSettings getBackgroundProcessingTaskSchedulingSettings() const;
|
|
BackgroundTaskSchedulingSettings getBackgroundMoveTaskSchedulingSettings() const;
|
|
|
|
BackgroundSchedulePool & getBufferFlushSchedulePool() const;
|
|
BackgroundSchedulePool & getSchedulePool() const;
|
|
BackgroundSchedulePool & getMessageBrokerSchedulePool() const;
|
|
BackgroundSchedulePool & getDistributedSchedulePool() const;
|
|
|
|
ThrottlerPtr getReplicatedFetchesThrottler() const;
|
|
ThrottlerPtr getReplicatedSendsThrottler() const;
|
|
|
|
/// Has distributed_ddl configuration or not.
|
|
bool hasDistributedDDL() const;
|
|
void setDDLWorker(std::unique_ptr<DDLWorker> ddl_worker);
|
|
DDLWorker & getDDLWorker() const;
|
|
|
|
std::shared_ptr<Clusters> getClusters() const;
|
|
std::shared_ptr<Cluster> getCluster(const std::string & cluster_name) const;
|
|
std::shared_ptr<Cluster> tryGetCluster(const std::string & cluster_name) const;
|
|
void setClustersConfig(const ConfigurationPtr & config, const String & config_name = "remote_servers");
|
|
/// Sets custom cluster, but doesn't update configuration
|
|
void setCluster(const String & cluster_name, const std::shared_ptr<Cluster> & cluster);
|
|
void reloadClusterConfig() const;
|
|
|
|
Compiler & getCompiler();
|
|
|
|
/// Call after initialization before using system logs. Call for global context.
|
|
void initializeSystemLogs();
|
|
|
|
/// Call after initialization before using trace collector.
|
|
void initializeTraceCollector();
|
|
|
|
bool hasTraceCollector() const;
|
|
|
|
/// Nullptr if the query log is not ready for this moment.
|
|
std::shared_ptr<QueryLog> getQueryLog() const;
|
|
std::shared_ptr<QueryThreadLog> getQueryThreadLog() const;
|
|
std::shared_ptr<QueryViewsLog> getQueryViewsLog() const;
|
|
std::shared_ptr<TraceLog> getTraceLog() const;
|
|
std::shared_ptr<TextLog> getTextLog() const;
|
|
std::shared_ptr<MetricLog> getMetricLog() const;
|
|
std::shared_ptr<AsynchronousMetricLog> getAsynchronousMetricLog() const;
|
|
std::shared_ptr<OpenTelemetrySpanLog> getOpenTelemetrySpanLog() const;
|
|
std::shared_ptr<ZooKeeperLog> getZooKeeperLog() const;
|
|
std::shared_ptr<SessionLog> getSessionLog() const;
|
|
|
|
/// Returns an object used to log operations with parts if it possible.
|
|
/// Provide table name to make required checks.
|
|
std::shared_ptr<PartLog> getPartLog(const String & part_database) const;
|
|
|
|
const MergeTreeSettings & getMergeTreeSettings() const;
|
|
const MergeTreeSettings & getReplicatedMergeTreeSettings() const;
|
|
const StorageS3Settings & getStorageS3Settings() const;
|
|
|
|
/// Prevents DROP TABLE if its size is greater than max_size (50GB by default, max_size=0 turn off this check)
|
|
void setMaxTableSizeToDrop(size_t max_size);
|
|
void checkTableCanBeDropped(const String & database, const String & table, const size_t & table_size) const;
|
|
|
|
/// Prevents DROP PARTITION if its size is greater than max_size (50GB by default, max_size=0 turn off this check)
|
|
void setMaxPartitionSizeToDrop(size_t max_size);
|
|
void checkPartitionCanBeDropped(const String & database, const String & table, const size_t & partition_size) const;
|
|
|
|
/// Lets you select the compression codec according to the conditions described in the configuration file.
|
|
std::shared_ptr<ICompressionCodec> chooseCompressionCodec(size_t part_size, double part_size_ratio) const;
|
|
|
|
|
|
/// Provides storage disks
|
|
DiskPtr getDisk(const String & name) const;
|
|
|
|
StoragePoliciesMap getPoliciesMap() const;
|
|
DisksMap getDisksMap() const;
|
|
void updateStorageConfiguration(const Poco::Util::AbstractConfiguration & config);
|
|
|
|
|
|
/// Provides storage politics schemes
|
|
StoragePolicyPtr getStoragePolicy(const String & name) const;
|
|
|
|
/// Get the server uptime in seconds.
|
|
time_t getUptimeSeconds() const;
|
|
|
|
using ConfigReloadCallback = std::function<void()>;
|
|
void setConfigReloadCallback(ConfigReloadCallback && callback);
|
|
void reloadConfig() const;
|
|
|
|
void shutdown();
|
|
|
|
bool isInternalQuery() const { return is_internal_query; }
|
|
void setInternalQuery(bool internal) { is_internal_query = internal; }
|
|
|
|
ActionLocksManagerPtr getActionLocksManager();
|
|
|
|
enum class ApplicationType
|
|
{
|
|
SERVER, /// The program is run as clickhouse-server daemon (default behavior)
|
|
CLIENT, /// clickhouse-client
|
|
LOCAL, /// clickhouse-local
|
|
KEEPER, /// clickhouse-keeper (also daemon)
|
|
};
|
|
|
|
ApplicationType getApplicationType() const;
|
|
void setApplicationType(ApplicationType type);
|
|
|
|
/// Sets default_profile and system_profile, must be called once during the initialization
|
|
void setDefaultProfiles(const Poco::Util::AbstractConfiguration & config);
|
|
String getDefaultProfileName() const;
|
|
String getSystemProfileName() const;
|
|
|
|
/// Base path for format schemas
|
|
String getFormatSchemaPath() const;
|
|
void setFormatSchemaPath(const String & path);
|
|
|
|
SampleBlockCache & getSampleBlockCache() const;
|
|
|
|
/// Query parameters for prepared statements.
|
|
bool hasQueryParameters() const;
|
|
const NameToNameMap & getQueryParameters() const;
|
|
void setQueryParameter(const String & name, const String & value);
|
|
void setQueryParameters(const NameToNameMap & parameters) { query_parameters = parameters; }
|
|
|
|
/// Add started bridge command. It will be killed after context destruction
|
|
void addBridgeCommand(std::unique_ptr<ShellCommand> cmd) const;
|
|
|
|
IHostContextPtr & getHostContext();
|
|
const IHostContextPtr & getHostContext() const;
|
|
|
|
/// Initialize context of distributed DDL query with Replicated database.
|
|
void initZooKeeperMetadataTransaction(ZooKeeperMetadataTransactionPtr txn, bool attach_existing = false);
|
|
/// Returns context of current distributed DDL query or nullptr.
|
|
ZooKeeperMetadataTransactionPtr getZooKeeperMetadataTransaction() const;
|
|
/// Removes context of current distributed DDL.
|
|
void resetZooKeeperMetadataTransaction();
|
|
|
|
PartUUIDsPtr getPartUUIDs() const;
|
|
PartUUIDsPtr getIgnoredPartUUIDs() const;
|
|
|
|
AsynchronousInsertQueue * getAsynchronousInsertQueue() const;
|
|
void setAsynchronousInsertQueue(const std::shared_ptr<AsynchronousInsertQueue> & ptr);
|
|
|
|
ReadTaskCallback getReadTaskCallback() const;
|
|
void setReadTaskCallback(ReadTaskCallback && callback);
|
|
|
|
/// Background executors related methods
|
|
void initializeBackgroundExecutorsIfNeeded();
|
|
|
|
MergeMutateBackgroundExecutorPtr getMergeMutateExecutor() const;
|
|
OrdinaryBackgroundExecutorPtr getMovesExecutor() const;
|
|
OrdinaryBackgroundExecutorPtr getFetchesExecutor() const;
|
|
OrdinaryBackgroundExecutorPtr getCommonExecutor() const;
|
|
|
|
/** Get settings for reading from filesystem. */
|
|
ReadSettings getReadSettings() const;
|
|
|
|
private:
|
|
std::unique_lock<std::recursive_mutex> getLock() const;
|
|
|
|
void initGlobal();
|
|
|
|
/// Compute and set actual user settings, client_info.current_user should be set
|
|
void calculateAccessRights();
|
|
|
|
template <typename... Args>
|
|
void checkAccessImpl(const Args &... args) const;
|
|
|
|
EmbeddedDictionaries & getEmbeddedDictionariesImpl(bool throw_on_error) const;
|
|
|
|
void checkCanBeDropped(const String & database, const String & table, const size_t & size, const size_t & max_size_to_drop) const;
|
|
|
|
StoragePolicySelectorPtr getStoragePolicySelector(std::lock_guard<std::mutex> & lock) const;
|
|
|
|
DiskSelectorPtr getDiskSelector(std::lock_guard<std::mutex> & /* lock */) const;
|
|
};
|
|
|
|
}
|