aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/clickhouse/src/Storages/MergeTree/localBackup.h
blob: 89906bf1d7515110959c8fa534ba0cc35c127933 (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
#pragma once

#include <optional>
#include <base/types.h>
#include <Disks/IDisk.h>

namespace DB
{

/** Creates a local (at the same mount point) backup (snapshot) directory.
  *
  * In the specified destination directory, it creates hard links on all source-directory files
  *  and in all nested directories, with saving (creating) all relative paths;
  *  and also `chown`, removing the write permission.
  *
  * This protects data from accidental deletion or modification,
  *  and is intended to be used as a simple means of protection against a human or program error,
  *  but not from a hardware failure.
  *
  * If max_level is specified, than only files with depth relative source_path less or equal max_level will be copied.
  *  So, if max_level=0 than only direct file child are copied.
  *
  * If `transaction` is provided, the changes will be added to it instead of performend on disk.
  */
    void localBackup(const DiskPtr & disk, const String & source_path, const String & destination_path, bool make_source_readonly = true, std::optional<size_t> max_level = {}, bool copy_instead_of_hardlinks = false, const NameSet & files_to_copy_intead_of_hardlinks = {}, DiskTransactionPtr disk_transaction = nullptr);

}