ClickHouse/src/Backups/BackupInDirectory.h

#pragma once

#include <Backups/BackupImpl.h>


namespace DB
{
class IDisk;
using DiskPtr = std::shared_ptr<IDisk>;

/// Represents a backup stored on a disk.
/// A backup is stored as a directory, each entry is stored as a file in that directory.
class BackupInDirectory : public BackupImpl
{
public:
    /// `disk`_ is allowed to be nullptr and that means the `path_` is a path in the local filesystem.
    BackupInDirectory(
        const String & backup_name_,
        OpenMode open_mode_,
        const DiskPtr & disk_,
        const String & path_,
        const ContextPtr & context_,
        const std::optional<BackupInfo> & base_backup_info_ = {});
    ~BackupInDirectory() override;

private:
    bool backupExists() const override;
    void startWriting() override;
    void removeAllFilesAfterFailure() override;
    std::unique_ptr<ReadBuffer> readFileImpl(const String & file_name) const override;
    std::unique_ptr<WriteBuffer> addFileImpl(const String & file_name) override;

    DiskPtr disk;
    String path;
    String dir_path; /// `path` without terminating slash
};

}