aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/clickhouse/src/Storages/MergeTree/MergeSelector.h
blob: 2f17e1e965401070b17413fc7c2c4f0bd4538d1b (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
75
76
77
78
79
#pragma once

#include <cstddef>
#include <ctime>
#include <vector>
#include <functional>
#include <Storages/MergeTree/MergeTreeDataPartTTLInfo.h>
#include <Parsers/IAST_fwd.h>


namespace DB
{

class IMergeTreeDataPart;

/** Interface of algorithm to select data parts to merge
 *   (merge is also known as "compaction").
  * Following properties depend on it:
  *
  * 1. Number of data parts at some moment in time.
  *    If parts are merged frequently, then data will be represented by lower number of parts, in average,
  *     but with cost of higher write amplification.
  *
  * 2. Write amplification ratio: how much times, on average, source data was written
  *     (during initial writes and followed merges).
  *
  * Number of parallel merges are controlled outside of scope of this interface.
  */
class IMergeSelector
{
    using DataPartPtr = std::shared_ptr<const IMergeTreeDataPart>;
public:
    /// Information about data part relevant to merge selecting strategy.
    struct Part
    {
        /// Size of data part in bytes.
        size_t size = 0;

        /// How old this data part in seconds.
        time_t age = 0;

        /// Depth of tree of merges by which this part was created. New parts has zero level.
        unsigned level = 0;

        /// Opaque pointer to avoid dependencies (it is not possible to do forward declaration of typedef).
        const void * data = nullptr;

        /// Information about different TTLs for part. Can be used by
        /// TTLSelector to assign merges with TTL.
        const MergeTreeDataPartTTLInfos * ttl_infos = nullptr;

        /// Part compression codec definition.
        ASTPtr compression_codec_desc;

        bool shall_participate_in_merges = true;

        const DataPartPtr & getDataPartPtr() const
        {
            return *static_cast<const DataPartPtr *>(data);
        }
    };

    /// Parts are belong to partitions. Only parts within same partition could be merged.
    using PartsRange = std::vector<Part>;

    /// Parts are in some specific order. Parts could be merged only in contiguous ranges.
    using PartsRanges = std::vector<PartsRange>;

    /** Function could be called at any frequency and it must decide, should you do any merge at all.
      * If better not to do any merge, it returns empty result.
      */
    virtual PartsRange select(
        const PartsRanges & parts_ranges,
        size_t max_total_size_to_merge) = 0;

    virtual ~IMergeSelector() = default;
};

}