Moved commit "add tiering info to TTL in public api" from ydb repo

Author: swalrus1

include/ydb-cpp-sdk/client/table/table.h

@@ -28,9 +28,12 @@ class KMeansTreeSettings;
 class PartitioningSettings;
 class DateTypeColumnModeSettings;
 class TtlSettings;
+class TtlTier;
 class TableIndex;
 class TableIndexDescription;
 class ValueSinceUnixEpochModeSettings;
+class DateTypeColumnModeSettingsV1;
+class ValueSinceUnixEpochModeSettingsV1;
 
 } // namespace Table
 } // namespace Ydb
@@ -427,17 +430,46 @@ struct TPartitionStats {
     uint32_t LeaderNodeId = 0;
 };
 
+struct TTtlDeleteAction {};
+
+struct TTtlEvictToExternalStorageAction {
+    std::string StorageName;
+};
+
+class TTtlTierSettings {
+public:
+    using TAction = std::variant<
+        std::monostate,
+        TTtlDeleteAction,
+        TTtlEvictToExternalStorageAction
+    >;
+
+public:
+    explicit TTtlTierSettings(TDuration applyAfter, const TAction& action);
+    explicit TTtlTierSettings(const Ydb::Table::TtlTier& tier);
+    void SerializeTo(Ydb::Table::TtlTier& proto) const;
+
+    TDuration GetApplyAfter() const;
+    const TAction& GetAction() const;
+
+private:
+    TDuration ApplyAfter_;
+    TAction Action_;
+};
+
 class TDateTypeColumnModeSettings {
 public:
-    explicit TDateTypeColumnModeSettings(const std::string& columnName, const TDuration& expireAfter);
+    explicit TDateTypeColumnModeSettings(const std::string& columnName, const TDuration& deprecatedExpireAfter = TDuration::Max());
     void SerializeTo(Ydb::Table::DateTypeColumnModeSettings& proto) const;
+    void SerializeTo(Ydb::Table::DateTypeColumnModeSettingsV1& proto) const;
 
     const std::string& GetColumnName() const;
+    // Deprecated. Use TTtlSettings::GetExpireAfter()
     const TDuration& GetExpireAfter() const;
 
 private:
     std::string ColumnName_;
-    TDuration ExpireAfter_;
+    TDuration DeprecatedExpireAfter_;
 };
 
 class TValueSinceUnixEpochModeSettings {
@@ -452,8 +484,9 @@ class TValueSinceUnixEpochModeSettings {
     };
 
 public:
-    explicit TValueSinceUnixEpochModeSettings(const std::string& columnName, EUnit columnUnit, const TDuration& expireAfter);
+    explicit TValueSinceUnixEpochModeSettings(const std::string& columnName, EUnit columnUnit, const TDuration& deprecatedExpireAfter = TDuration::Max());
     void SerializeTo(Ydb::Table::ValueSinceUnixEpochModeSettings& proto) const;
+    void SerializeTo(Ydb::Table::ValueSinceUnixEpochModeSettingsV1& proto) const;
 
     const std::string& GetColumnName() const;
     EUnit GetColumnUnit() const;
@@ -466,11 +499,17 @@ class TValueSinceUnixEpochModeSettings {
 private:
     std::string ColumnName_;
     EUnit ColumnUnit_;
-    TDuration ExpireAfter_;
+    TDuration DeprecatedExpireAfter_;
 };
 
 //! Represents ttl settings
 class TTtlSettings {
+private:
+    using TMode = std::variant<
+        TDateTypeColumnModeSettings,
+        TValueSinceUnixEpochModeSettings
+    >;
+
 public:
     using EUnit = TValueSinceUnixEpochModeSettings::EUnit;
 
@@ -479,25 +518,35 @@ class TTtlSettings {
         ValueSinceUnixEpoch = 1,
     };
 
+    explicit TTtlSettings(const std::string& columnName, const std::vector<TTtlTierSettings>& tiers);
     explicit TTtlSettings(const std::string& columnName, const TDuration& expireAfter);
-    explicit TTtlSettings(const Ydb::Table::DateTypeColumnModeSettings& mode, uint32_t runIntervalSeconds);
     const TDateTypeColumnModeSettings& GetDateTypeColumn() const;
+    // Deprecated. Use FromProto()
+    explicit TTtlSettings(const Ydb::Table::DateTypeColumnModeSettings& mode, uint32_t runIntervalSeconds);
 
+    explicit TTtlSettings(const std::string& columnName, EUnit columnUnit, const std::vector<TTtlTierSettings>& tiers);
     explicit TTtlSettings(const std::string& columnName, EUnit columnUnit, const TDuration& expireAfter);
-    explicit TTtlSettings(const Ydb::Table::ValueSinceUnixEpochModeSettings& mode, uint32_t runIntervalSeconds);
     const TValueSinceUnixEpochModeSettings& GetValueSinceUnixEpoch() const;
+    // Deprecated. Use FromProto()
+    explicit TTtlSettings(const Ydb::Table::ValueSinceUnixEpochModeSettings& mode, uint32_t runIntervalSeconds);
 
+    static std::optional<TTtlSettings> FromProto(const Ydb::Table::TtlSettings& proto);
     void SerializeTo(Ydb::Table::TtlSettings& proto) const;
     EMode GetMode() const;
 
     TTtlSettings& SetRunInterval(const TDuration& value);
     const TDuration& GetRunInterval() const;
 
+    const std::vector<TTtlTierSettings>& GetTiers() const;
+    std::optional<TDuration> GetExpireAfter() const;
+
 private:
-    std::variant<
-        TDateTypeColumnModeSettings,
-        TValueSinceUnixEpochModeSettings
-    > Mode_;
+    explicit TTtlSettings(TMode mode, const std::vector<TTtlTierSettings>& tiers, ui32 runIntervalSeconds);
+    static std::optional<TDuration> GetExpireAfterFrom(const std::vector<TTtlTierSettings>& tiers);
+
+private:
+    TMode Mode_;
+    std::vector<TTtlTierSettings> Tiers_;
     TDuration RunInterval_ = TDuration::Zero();
 };
 

src/api/protos/ydb_table.proto

@@ -433,8 +433,46 @@ message ColumnMeta {
     }
 }
 
+message EvictionToExternalStorageSettings {
+    // Path to external data source
+    string storage_name = 1;
+}
+
+message TtlTier {
+    uint32 apply_after_seconds = 1;
+
+    oneof action {
+        google.protobuf.Empty delete = 2;
+        EvictionToExternalStorageSettings evict_to_external_storage = 3;
+    }
+}
+
+message DateTypeColumnModeSettingsV1 {
+    // The row will be assigned a tier at the moment of time, when the value
+    // stored in <column_name> is less than or equal to the current time (in epoch
+    // time format), and <tier.apply_after_seconds> has passed since that moment;
+    // i.e. the eviction threshold is the value of <column_name> plus <tier.apply_after_seconds>.
+
+    // The column type must be a date type
+    string column_name = 1;
+}
+
+message ValueSinceUnixEpochModeSettingsV1 {
+    // Same as DateTypeColumnModeSettings (above), but useful when type of the
+    // value stored in <column_name> is not a date type.
+
+    // The column type must be one of:
+    // - Uint32
+    // - Uint64
+    // - DyNumber
+    string column_name = 1;
+
+    // Interpretation of the value stored in <column_name>
+    ValueSinceUnixEpochModeSettings.Unit column_unit = 2;
+}
+
 message DateTypeColumnModeSettings {
-    // The row will be considered as expired at the moment of time, when the value
+    // The row will be assigned a tier at the moment of time, when the value
     // stored in <column_name> is less than or equal to the current time (in epoch
     // time format), and <expire_after_seconds> has passed since that moment;
     // i.e. the expiration threshold is the value of <column_name> plus <expire_after_seconds>.
@@ -473,8 +511,10 @@ message ValueSinceUnixEpochModeSettings {
 
 message TtlSettings {
     oneof mode {
-        DateTypeColumnModeSettings date_type_column = 1;
-        ValueSinceUnixEpochModeSettings value_since_unix_epoch = 2;
+        DateTypeColumnModeSettings date_type_column = 1 [deprecated = true];
+        ValueSinceUnixEpochModeSettings value_since_unix_epoch = 2 [deprecated = true];
+        DateTypeColumnModeSettingsV1 date_type_column_v1 = 4;
+        ValueSinceUnixEpochModeSettingsV1 value_since_unix_epoch_v1 = 5;
     }
 
     // There is no guarantee that expired row will be deleted immediately upon
@@ -490,6 +530,8 @@ message TtlSettings {
     // How often to run BRO on the same partition.
     // BRO will not be started more often, but may be started less often.
     uint32 run_interval_seconds = 3;
+
+    repeated TtlTier tiers = 6;
 }
 
 message StorageSettings {