ttl: A demo

domain/domain.go

@@ -59,6 +59,7 @@ import (
 	"github.com/pingcap/tidb/sessionctx/variable"
 	"github.com/pingcap/tidb/statistics/handle"
 	"github.com/pingcap/tidb/telemetry"
+	"github.com/pingcap/tidb/ttl/ttlworker"
 	"github.com/pingcap/tidb/types"
 	"github.com/pingcap/tidb/util"
 	"github.com/pingcap/tidb/util/dbterror"
@@ -1057,6 +1058,7 @@ func (do *Domain) Init(
 		return err
 	}
 
+	ttlworker.NewJobManager(do.ddl.GetID(), do.sysSessionPool).Start()
 	return nil
 }
 

kv/option.go

@@ -165,4 +165,6 @@ const (
 	InternalTxnBR = InternalTxnTools
 	// InternalTxnTrace handles the trace statement.
 	InternalTxnTrace = "Trace"
+	// InternalTxnTTL handles the TTL jobs
+	InternalTxnTTL = "TTL"
 )

ttl/BUILD.bazel

@@ -0,0 +1,41 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+
+go_library(
+    name = "ttl",
+    srcs = [
+        "sql.go",
+        "table.go",
+    ],
+    importpath = "github.com/pingcap/tidb/ttl",
+    visibility = ["//visibility:public"],
+    deps = [
+        "//parser/ast",
+        "//parser/format",
+        "//parser/model",
+        "//parser/mysql",
+        "//types",
+        "//util/sqlexec",
+        "@com_github_pingcap_errors//:errors",
+        "@com_github_pkg_errors//:errors",
+    ],
+)
+
+go_test(
+    name = "ttl_test",
+    srcs = [
+        "main_test.go",
+        "sql_test.go",
+    ],
+    deps = [
+        ":ttl",
+        "//kv",
+        "//parser/model",
+        "//parser/mysql",
+        "//testkit",
+        "//testkit/testsetup",
+        "//types",
+        "//util/sqlexec",
+        "@com_github_stretchr_testify//require",
+        "@org_uber_go_goleak//:goleak",
+    ],
+)

ttl/error.go

@@ -0,0 +1,15 @@
+// Copyright 2022 PingCAP, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package ttl

ttl/main_test.go

@@ -0,0 +1,33 @@
+// Copyright 2022 PingCAP, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package ttl_test
+
+import (
+	"testing"
+
+	"github.com/pingcap/tidb/testkit/testsetup"
+	"go.uber.org/goleak"
+)
+
+func TestMain(m *testing.M) {
+	testsetup.SetupForCommonTest()
+	opts := []goleak.Option{
+		goleak.IgnoreTopFunction("github.com/golang/glog.(*loggingT).flushDaemon"),
+		goleak.IgnoreTopFunction("github.com/lestrrat-go/httprc.runFetchWorker"),
+		goleak.IgnoreTopFunction("go.etcd.io/etcd/client/pkg/v3/logutil.(*MergeLogger).outputLoop"),
+		goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"),
+	}
+	goleak.VerifyTestMain(m, opts...)
+}

ttl/session.go

@@ -0,0 +1,115 @@
+// Copyright 2022 PingCAP, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package ttl
+
+import (
+	"context"
+
+	"github.com/pingcap/tidb/infoschema"
+	"github.com/pingcap/tidb/kv"
+	"github.com/pingcap/tidb/parser/terror"
+	"github.com/pingcap/tidb/sessionctx"
+	"github.com/pingcap/tidb/types"
+	"github.com/pingcap/tidb/util/chunk"
+	"github.com/pingcap/tidb/util/sqlexec"
+)
+
+type Session struct {
+	Sctx     sessionctx.Context
+	Executor sqlexec.SQLExecutor
+	CloseFn  func()
+}
+
+func (s *Session) GetDomainInfoSchema() infoschema.InfoSchema {
+	is, ok := s.Sctx.GetDomainInfoSchema().(infoschema.InfoSchema)
+	if !ok {
+		return nil
+	}
+
+	if ext, ok := is.(*infoschema.SessionExtendedInfoSchema); ok {
+		return ext.InfoSchema
+	}
+
+	return is
+}
+
+func (s *Session) ExecuteSQL(ctx context.Context, sql string, args ...interface{}) ([]chunk.Row, error) {
+	ctx = kv.WithInternalSourceType(ctx, kv.InternalTxnTTL)
+	rs, err := s.Executor.ExecuteInternal(ctx, sql, args...)
+	if err != nil {
+		return nil, err
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	if rs == nil {
+		return nil, nil
+	}
+
+	defer func() {
+		terror.Log(rs.Close())
+	}()
+
+	return sqlexec.DrainRecordSet(ctx, rs, 8)
+}
+
+func (s *Session) RunInTxn(ctx context.Context, fn func() error) (err error) {
+	if _, err = s.ExecuteSQL(ctx, "BEGIN"); err != nil {
+		return err
+	}
+
+	success := false
+	defer func() {
+		if !success {
+			_, err = s.ExecuteSQL(ctx, "ROLLBACK")
+			terror.Log(err)
+		}
+	}()
+
+	if err = fn(); err != nil {
+		return err
+	}
+
+	success = true
+	return nil
+}
+
+func (s *Session) ExecuteSQLWithTTLCheck(ctx context.Context, tbl *PhysicalTable, sql string) (result [][]types.Datum, retryable bool, err error) {
+	err = s.RunInTxn(ctx, func() error {
+		// TODO: check schema
+		rows, execErr := s.ExecuteSQL(ctx, sql)
+		// TODO: check retryable err
+		if execErr != nil {
+			return execErr
+		}
+
+		result = make([][]types.Datum, len(rows))
+		for i, row := range rows {
+			result[i] = row.GetDatumRow(tbl.KeyFieldTypes)
+		}
+
+		return nil
+	})
+
+	return
+}
+
+func (s *Session) Close() {
+	if s.CloseFn != nil {
+		s.CloseFn()
+	}
+}