/
doc.go
70 lines (69 loc) · 5.72 KB
/
doc.go
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
// Copyright 2021 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,
// See the License for the specific language governing permissions and
// limitations under the License.
// Package gc privodes TiDB GC related utilities.
//
// Following graph shows how TiCDC manipulates GC safepoints.
//
// ```
//
// ┌───┐ ┌───┐ ┌──┐ ┌─────┐
// │CLI│ │API│ │PD│ │Owner│
// └─┬─┘ └─┬─┘ └┬─┘ └──┬──┘
// │ │ │ │
// ╔═══════════╪═════╤════════╪═════════════╪════════════════════════╪════════════╗
// ║ "CLI OR API?" │ CLI │ │ │ ║
// ╟─────────────────┘ │ │ │ ║
// ║ │ service GC safepoint │ │ ║
// ║ │ "cdc-creating-<ID>" │ │ ║
// ║ │──────────────────────────>┌┴┐ │ ║
// ║ │ │ │ │ │ ║
// ║ │ Create changefeed │ │ │ ║
// ║ │──────────────────────────>│ │ │ ║
// ╠═══════════╪══════════════╪════════════╪═╪═══════════════════════╪════════════╣
// ║ API │ │ │ │ │ ║
// ║ │ │ Create changefeed API │ ║
// ║ │ │─────────────────────────────────────>│ ║
// ║ │ │ │ │ │ ║
// ║ │ │ │ │ service GC safepoint│ ║
// ║ │ │ │ │ "cdc-creating-<ID>" │ ║
// ║ │ │ │ ┌─┐ <──────────────────── ║
// ║ │ │ │ │ │ │ ║
// ║ │ │ │ │ │ Create changefeed │ ║
// ║ │ │ │ │ │ <──────────────────── ║
// ╚═══════════╪══════════════╪════════════╪═╪═╪═════════════════════╪════════════╝
// │ │ │ │ │ │
// │ │ │ │ │ │ ╔═════════════════╗
// │ │ │ │ │ GC safepoint "ticdc"│ ║using the minimal║
// │ │ │ │ │ <──────────────────── ║checkpoint among ║
// │ │ │ │ │ │ ║all changefeeds ║
// │ │ │ │ │ │ ╚═════════════════╝
// │ │ │ │ │Remove GC safepoint │
// │ │ │ │ │"cdc-creating-<ID>" │
// │ │ └┬└─┘ <────────────────────
// │ │ │ │
// │ │ │ │────┐
// │ │ │ │ │ Start changefeed
// │ │ │ │<───┘
// ┌─┴─┐ ┌─┴─┐ ┌┴─┐ ┌──┴──┐
// │CLI│ │API│ │PD│ │Owner│
// └───┘ └───┘ └──┘ └─────┘
//
// ```
//
// When CLI/API creates a changefeed, it registers a service GC safepoint
// "ticdc-creating-<ID>" to cover the gap between creating changefeed and
// handling changefeed.
//
// TiCDC Owner removes the service GC safepoint after new changefeed checkpoint
// is included in the "ticdc" service GC safepoint.
package gc