aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/clickhouse/src/Processors/TTL/ITTLAlgorithm.h
blob: 49cd2c46d9d9a8ad0de00a5003b1c52785f36715 (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
#pragma once

#include <Storages/TTLDescription.h>
#include <Storages/MergeTree/MergeTreeDataPartTTLInfo.h>
#include <Storages/MergeTree/IMergeTreeDataPart.h>
#include <Common/DateLUT.h>

namespace DB
{

/**
 * Represents the actions, which are required to do
 * with data, when TTL is expired: delete, aggregate, etc.
 */
class ITTLAlgorithm
{
public:
    using TTLInfo = IMergeTreeDataPart::TTLInfo;
    using MutableDataPartPtr = MergeTreeMutableDataPartPtr;

    ITTLAlgorithm(const TTLDescription & description_, const TTLInfo & old_ttl_info_, time_t current_time_, bool force_);
    virtual ~ITTLAlgorithm() = default;

    virtual void execute(Block & block) = 0;

    /// Updates TTL metadata of the data_part.
    virtual void finalize(const MutableDataPartPtr & data_part) const = 0;

    bool isMinTTLExpired() const { return force || isTTLExpired(old_ttl_info.min); }
    bool isMaxTTLExpired() const { return isTTLExpired(old_ttl_info.max); }

    /** This function is needed to avoid a conflict between already calculated columns and columns that needed to execute TTL.
      * If result column is absent in block, all required columns are copied to new block and expression is executed on new block.
      */
    static ColumnPtr executeExpressionAndGetColumn(
        const ExpressionActionsPtr & expression, const Block & block, const String & result_column);

protected:
    bool isTTLExpired(time_t ttl) const;
    UInt32 getTimestampByIndex(const IColumn * column, size_t index) const;

    const TTLDescription description;
    const TTLInfo old_ttl_info;
    const time_t current_time;
    const bool force;
    TTLInfo new_ttl_info;

private:
    const DateLUTImpl & date_lut;
};

using TTLAlgorithmPtr = std::unique_ptr<ITTLAlgorithm>;

}