aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/clickhouse/src/Backups/RestoreCoordinationRemote.h
blob: eb0fcff9c2dacc9fde7a92943fc928d314596d14 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#pragma once

#include <Backups/IRestoreCoordination.h>
#include <Backups/BackupCoordinationStageSync.h>
#include <Backups/WithRetries.h>


namespace DB
{

/// Implementation of the IRestoreCoordination interface performing coordination via ZooKeeper. It's necessary for "RESTORE ON CLUSTER".
class RestoreCoordinationRemote : public IRestoreCoordination
{
public:
    using RestoreKeeperSettings = WithRetries::KeeperSettings;

    RestoreCoordinationRemote(
        zkutil::GetZooKeeper get_zookeeper_,
        const String & root_zookeeper_path_,
        const RestoreKeeperSettings & keeper_settings_,
        const String & restore_uuid_,
        const Strings & all_hosts_,
        const String & current_host_,
        bool is_internal_);

    ~RestoreCoordinationRemote() override;

    /// Sets the current stage and waits for other hosts to come to this stage too.
    void setStage(const String & new_stage, const String & message) override;
    void setError(const Exception & exception) override;
    Strings waitForStage(const String & stage_to_wait) override;
    Strings waitForStage(const String & stage_to_wait, std::chrono::milliseconds timeout) override;

    /// Starts creating a table in a replicated database. Returns false if there is another host which is already creating this table.
    bool acquireCreatingTableInReplicatedDatabase(const String & database_zk_path, const String & table_name) override;

    /// Sets that this replica is going to restore a partition in a replicated table.
    /// The function returns false if this partition is being already restored by another replica.
    bool acquireInsertingDataIntoReplicatedTable(const String & table_zk_path) override;

    /// Sets that this replica is going to restore a ReplicatedAccessStorage.
    /// The function returns false if this access storage is being already restored by another replica.
    bool acquireReplicatedAccessStorage(const String & access_storage_zk_path) override;

    /// Sets that this replica is going to restore replicated user-defined functions.
    /// The function returns false if user-defined function at a specified zk path are being already restored by another replica.
    bool acquireReplicatedSQLObjects(const String & loader_zk_path, UserDefinedSQLObjectType object_type) override;

    bool hasConcurrentRestores(const std::atomic<size_t> & num_active_restores) const override;

private:
    void createRootNodes();
    void removeAllNodes();

    class ReplicatedDatabasesMetadataSync;

    /// get_zookeeper will provide a zookeeper client without any fault injection
    const zkutil::GetZooKeeper get_zookeeper;
    const String root_zookeeper_path;
    const RestoreKeeperSettings keeper_settings;
    const String restore_uuid;
    const String zookeeper_path;
    const Strings all_hosts;
    const String current_host;
    const size_t current_host_index;
    const bool is_internal;
    Poco::Logger * const log;

    mutable WithRetries with_retries;
    std::optional<BackupCoordinationStageSync> stage_sync;
    mutable std::mutex mutex;
};

}