add tiering info to TTL in public api (#11390)

ydb-platform · Nov 27, 2024 · 225bab2 · 225bab2
1 parent f54668a
commit 225bab2
Show file tree

Hide file tree

Showing 22 changed files with 700 additions and 161 deletions.
diff --git a/ydb/core/grpc_services/rpc_log_store.cpp b/ydb/core/grpc_services/rpc_log_store.cpp
@@ -509,29 +509,8 @@ class TDescribeLogTableRPC : public TRpcSchemeRequestActor<TDescribeLogTableRPC,
                 }
 
                 if (tableDescription.HasTtlSettings() && tableDescription.GetTtlSettings().HasEnabled()) {
-                    const auto& inTTL = tableDescription.GetTtlSettings().GetEnabled();
-
-                    switch (inTTL.GetColumnUnit()) {
-                    case NKikimrSchemeOp::TTTLSettings::UNIT_AUTO: {
-                        auto& outTTL = *describeLogTableResult.mutable_ttl_settings()->mutable_date_type_column();
-                        outTTL.set_column_name(inTTL.GetColumnName());
-                        outTTL.set_expire_after_seconds(inTTL.GetExpireAfterSeconds());
-                        break;
-                    }
-
-                    case NKikimrSchemeOp::TTTLSettings::UNIT_SECONDS:
-                    case NKikimrSchemeOp::TTTLSettings::UNIT_MILLISECONDS:
-                    case NKikimrSchemeOp::TTTLSettings::UNIT_MICROSECONDS:
-                    case NKikimrSchemeOp::TTTLSettings::UNIT_NANOSECONDS: {
-                        auto& outTTL = *describeLogTableResult.mutable_ttl_settings()->mutable_value_since_unix_epoch();
-                        outTTL.set_column_name(inTTL.GetColumnName());
-                        outTTL.set_column_unit(static_cast<Ydb::Table::ValueSinceUnixEpochModeSettings::Unit>(inTTL.GetColumnUnit()));
-                        outTTL.set_expire_after_seconds(inTTL.GetExpireAfterSeconds());
-                        break;
-                    }
-
-                    default:
-                        break;
+                    if (!FillTtlSettings(*describeLogTableResult.mutable_ttl_settings(), tableDescription.GetTtlSettings().GetEnabled(), status, error)) {
+                        return Reply(status, error, NKikimrIssues::TIssuesIds::DEFAULT_ERROR, ctx);
                     }
                 }
 

diff --git a/ydb/core/kqp/provider/yql_kikimr_gateway.cpp b/ydb/core/kqp/provider/yql_kikimr_gateway.cpp
@@ -311,15 +311,16 @@ bool ConvertReadReplicasSettingsToProto(const TString settings, Ydb::Table::Read
 
 void ConvertTtlSettingsToProto(const NYql::TTtlSettings& settings, Ydb::Table::TtlSettings& proto) {
     if (!settings.ColumnUnit) {
-        auto& opts = *proto.mutable_date_type_column();
+        auto& opts = *proto.mutable_date_type_column_v1();
         opts.set_column_name(settings.ColumnName);
-        opts.set_expire_after_seconds(settings.ExpireAfter.Seconds());
     } else {
-        auto& opts = *proto.mutable_value_since_unix_epoch();
+        auto& opts = *proto.mutable_value_since_unix_epoch_v1();
         opts.set_column_name(settings.ColumnName);
         opts.set_column_unit(static_cast<Ydb::Table::ValueSinceUnixEpochModeSettings::Unit>(*settings.ColumnUnit));
-        opts.set_expire_after_seconds(settings.ExpireAfter.Seconds());
     }
+    auto* deleteTier = proto.add_tiers();
+    deleteTier->set_apply_after_seconds(settings.ExpireAfter.Seconds());
+    deleteTier->mutable_delete_();
 }
 
 Ydb::FeatureFlag::Status GetFlagValue(const TMaybe<bool>& value) {

diff --git a/ydb/core/kqp/proxy_service/kqp_script_executions_ut.cpp b/ydb/core/kqp/proxy_service/kqp_script_executions_ut.cpp
@@ -35,6 +35,9 @@ NKikimrSchemeOp::TColumnDescription Col(const TString& columnName, NScheme::TTyp
 
 [[maybe_unused]] NKikimrSchemeOp::TTTLSettings TtlCol(const TString& columnName) {
     NKikimrSchemeOp::TTTLSettings settings;
+    auto* deleteTier = settings.MutableEnabled()->AddTiers();
+    deleteTier->MutableDelete();
+    deleteTier->SetApplyAfterSeconds(TDuration::Minutes(20).Seconds());
     settings.MutableEnabled()->SetExpireAfterSeconds(TDuration::Minutes(20).Seconds());
     settings.MutableEnabled()->SetColumnName(columnName);
     settings.MutableEnabled()->MutableSysSettings()->SetRunInterval(TDuration::Minutes(60).MicroSeconds());

diff --git a/ydb/core/protos/flat_scheme_op.proto b/ydb/core/protos/flat_scheme_op.proto
@@ -222,11 +222,24 @@ message TTTLSettings {
         optional uint32 MaxShardsInFlight = 6 [default = 0]; // zero means no limit
     }
 
+    message TEvictionToExternalStorageSettings {
+        optional string StorageName = 1;
+    }
+
+    message TTier {
+        optional uint32 ApplyAfterSeconds = 1;
+        oneof Action {
+            google.protobuf.Empty Delete = 2;
+            TEvictionToExternalStorageSettings EvictToExternalStorage = 3;
+        }
+    }
+
     message TEnabled {
         optional string ColumnName = 1;
-        optional uint32 ExpireAfterSeconds = 2;
+        optional uint32 ExpireAfterSeconds = 2 [deprecated = true];
         optional EUnit ColumnUnit = 3;
         optional TSysSettings SysSettings = 4;
+        repeated TTier Tiers = 5;
     }
 
     message TDisabled {
@@ -581,10 +594,11 @@ message TColumnDataLifeCycle {
     message TTtl {
         optional string ColumnName = 1;
         oneof Expire {
-            uint32 ExpireAfterSeconds = 2;
+            uint32 ExpireAfterSeconds = 2 [deprecated = true]; // ignored if Tiers are not empty
             uint64 ExpireAfterBytes = 4;
         }
         optional TTTLSettings.EUnit ColumnUnit = 3;
+        repeated TTTLSettings.TTier Tiers = 5;
     }
 
     message TDisabled {

diff --git a/ydb/core/tx/schemeshard/common/validation.cpp b/ydb/core/tx/schemeshard/common/validation.cpp
@@ -57,4 +57,14 @@ bool TTTLValidator::ValidateUnit(const NScheme::TTypeInfo columnType, NKikimrSch
     return true;
 }
 
-}
+bool TTTLValidator::ValidateTiers(const NKikimrSchemeOp::TTTLSettings::TEnabled ttlSettings, TString& errStr) {
+    for (ui64 i = 0; i < ttlSettings.TiersSize(); ++i) {
+        if (ttlSettings.GetTiers(i).HasDelete() && i + 1 != ttlSettings.TiersSize()) {
+            errStr = "Only the last tier in TTL settings can have Delete action";
+            return false;
+        }
+    }
+    return true;
+}
+
+}
diff --git a/ydb/core/tx/schemeshard/common/validation.h b/ydb/core/tx/schemeshard/common/validation.h
@@ -9,5 +9,6 @@ namespace NKikimr::NSchemeShard::NValidation {
 class TTTLValidator {
 public:
     static bool ValidateUnit(const NScheme::TTypeInfo columnType, NKikimrSchemeOp::TTTLSettings::EUnit unit, TString& errStr);
+    static bool ValidateTiers(const NKikimrSchemeOp::TTTLSettings::TEnabled ttlSettings, TString& errStr);
 };
-}
+}
diff --git a/ydb/core/tx/schemeshard/olap/operations/alter/abstract/converter.h b/ydb/core/tx/schemeshard/olap/operations/alter/abstract/converter.h
@@ -26,6 +26,9 @@ class TConverterModifyToAlter {
                 if (enabled.HasColumnUnit()) {
                     alterEnabled->SetColumnUnit(enabled.GetColumnUnit());
                 }
+                for (const auto& tier : enabled.GetTiers()) {
+                    alterEnabled->AddTiers()->CopyFrom(tier);
+                }
             } else if (tableTtl.HasDisabled()) {
                 alterTtl->MutableDisabled();
             }

diff --git a/ydb/core/tx/schemeshard/schemeshard__conditional_erase.cpp b/ydb/core/tx/schemeshard/schemeshard__conditional_erase.cpp
@@ -141,8 +141,16 @@ struct TSchemeShard::TTxRunConditionalErase: public TSchemeShard::TRwTxBase {
         }
 
         const auto& settings = tableInfo->TTLSettings().GetEnabled();
-        const TDuration expireAfter = TDuration::Seconds(settings.GetExpireAfterSeconds());
-        const TInstant wallClock = ctx.Now() - expireAfter;
+
+        auto expireAfter = GetExpireAfter(settings, true);
+        if (expireAfter.IsFail()) {
+            LOG_WARN_S(ctx, NKikimrServices::FLAT_TX_SCHEMESHARD,
+                "Invalid TTL settings: " << expireAfter.GetErrorMessage()
+                    << ": shardIdx: " << tableShardInfo.ShardIdx << ": pathId: " << shardInfo.PathId
+                    << ", at schemeshard: " << Self->TabletID());
+            return false;
+        }
+        const TInstant wallClock = ctx.Now() - *expireAfter;
 
         NKikimrTxDataShard::TEvConditionalEraseRowsRequest request;
         request.SetTableId(shardInfo.PathId.LocalPathId);

diff --git a/ydb/core/tx/schemeshard/schemeshard_info_types.h b/ydb/core/tx/schemeshard/schemeshard_info_types.h
@@ -3623,6 +3623,8 @@ bool ValidateTtlSettings(const NKikimrSchemeOp::TTTLSettings& ttl,
     const THashMap<TString, ui32>& colName2Id,
     const TSubDomainInfo& subDomain, TString& errStr);
 
+TConclusion<TDuration> GetExpireAfter(const NKikimrSchemeOp::TTTLSettings::TEnabled& settings, const bool allowNonDeleteTiers);
+
 std::optional<std::pair<i64, i64>> ValidateSequenceType(const TString& sequenceName, const TString& dataType,
     const NKikimr::NScheme::TTypeRegistry& typeRegistry, bool pgTypesEnabled, TString& errStr);
 

diff --git a/ydb/core/tx/schemeshard/schemeshard_validate_ttl.cpp b/ydb/core/tx/schemeshard/schemeshard_validate_ttl.cpp
@@ -1,7 +1,6 @@
 #include "schemeshard_info_types.h"
 
 #include "common/validation.h"
-#include "olap/columns/schema.h"
 
 #include <ydb/core/protos/flat_scheme_op.pb.h>
 
@@ -58,8 +57,18 @@ bool ValidateTtlSettings(const NKikimrSchemeOp::TTTLSettings& ttl,
             return false;
         }
 
+        if (!NValidation::TTTLValidator::ValidateTiers(enabled, errStr)) {
+            return false;
+        }
+
+        const auto expireAfter = GetExpireAfter(enabled, false);
+        if (expireAfter.IsFail()) {
+            errStr = expireAfter.GetErrorMessage();
+            return false;
+        }
+
         const TInstant now = TInstant::Now();
-        if (enabled.GetExpireAfterSeconds() > now.Seconds()) {
+        if (expireAfter->Seconds() > now.Seconds()) {
             errStr = Sprintf("TTL should be less than %" PRIu64 " seconds (%" PRIu64 " days, %" PRIu64 " years). The ttl behaviour is undefined before 1970.", now.Seconds(), now.Days(), now.Days() / 365);
             return false;            
         }
@@ -85,4 +94,20 @@ bool ValidateTtlSettings(const NKikimrSchemeOp::TTTLSettings& ttl,
     return true;
 }
 
+TConclusion<TDuration> GetExpireAfter(const NKikimrSchemeOp::TTTLSettings::TEnabled& settings, const bool allowNonDeleteTiers) {
+    if (settings.TiersSize()) {
+        for (const auto& tier : settings.GetTiers()) {
+            if (tier.HasDelete()) {
+                return TDuration::Seconds(tier.GetApplyAfterSeconds());
+            } else if (!allowNonDeleteTiers) {
+                return TConclusionStatus::Fail("Only DELETE via TTL is allowed for row-oriented tables");
+            }
+        }
+        return TConclusionStatus::Fail("TTL settings does not contain DELETE action");
+    } else {
+        // legacy format
+        return TDuration::Seconds(settings.GetExpireAfterSeconds());
+    }
+}
+
 }}
diff --git a/ydb/core/tx/schemeshard/ut_helpers/ls_checks.cpp b/ydb/core/tx/schemeshard/ut_helpers/ls_checks.cpp
@@ -1142,6 +1142,9 @@ TCheckFunc HasTtlEnabled(const TString& columnName, const TDuration& expireAfter
         UNIT_ASSERT_VALUES_EQUAL(ttl.GetEnabled().GetColumnName(), columnName);
         UNIT_ASSERT_VALUES_EQUAL(ttl.GetEnabled().GetColumnUnit(), columnUnit);
         UNIT_ASSERT_VALUES_EQUAL(ttl.GetEnabled().GetExpireAfterSeconds(), expireAfter.Seconds());
+        UNIT_ASSERT_VALUES_EQUAL(ttl.GetEnabled().TiersSize(), 1);
+        UNIT_ASSERT(ttl.GetEnabled().GetTiers(0).HasDelete());
+        UNIT_ASSERT_VALUES_EQUAL(ttl.GetEnabled().GetTiers(0).GetApplyAfterSeconds(), expireAfter.Seconds());
     };
 }