-
Notifications
You must be signed in to change notification settings - Fork 269
/
large_message.go
110 lines (96 loc) · 3.9 KB
/
large_message.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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
// Copyright 2023 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 config
import (
"github.com/pingcap/tiflow/pkg/compression"
cerror "github.com/pingcap/tiflow/pkg/errors"
)
const (
// LargeMessageHandleOptionNone means not handling large message.
LargeMessageHandleOptionNone string = "none"
// LargeMessageHandleOptionClaimCheck means handling large message by sending to the claim check storage.
LargeMessageHandleOptionClaimCheck string = "claim-check"
// LargeMessageHandleOptionHandleKeyOnly means handling large message by sending only handle key columns.
LargeMessageHandleOptionHandleKeyOnly string = "handle-key-only"
)
// LargeMessageHandleConfig is the configuration for handling large message.
type LargeMessageHandleConfig struct {
LargeMessageHandleOption string `toml:"large-message-handle-option" json:"large-message-handle-option"`
LargeMessageHandleCompression string `toml:"large-message-handle-compression" json:"large-message-handle-compression"`
ClaimCheckStorageURI string `toml:"claim-check-storage-uri" json:"claim-check-storage-uri"`
}
// NewDefaultLargeMessageHandleConfig return the default Config.
func NewDefaultLargeMessageHandleConfig() *LargeMessageHandleConfig {
return &LargeMessageHandleConfig{
LargeMessageHandleOption: LargeMessageHandleOptionNone,
LargeMessageHandleCompression: compression.None,
}
}
// AdjustAndValidate the Config.
func (c *LargeMessageHandleConfig) AdjustAndValidate(protocol Protocol, enableTiDBExtension bool) error {
if c.LargeMessageHandleOption == "" {
c.LargeMessageHandleOption = LargeMessageHandleOptionNone
}
if c.LargeMessageHandleCompression == "" {
c.LargeMessageHandleCompression = compression.None
}
// compression can be enabled independently
if !compression.Supported(c.LargeMessageHandleCompression) {
return cerror.ErrInvalidReplicaConfig.GenWithStack(
"large message handle compression is not supported, got %s", c.LargeMessageHandleCompression)
}
if c.LargeMessageHandleOption == LargeMessageHandleOptionNone {
return nil
}
switch protocol {
case ProtocolOpen, ProtocolSimple:
case ProtocolCanalJSON:
if !enableTiDBExtension {
return cerror.ErrInvalidReplicaConfig.GenWithStack(
"large message handle is set to %s, protocol is %s, but enable-tidb-extension is false",
c.LargeMessageHandleOption, protocol.String())
}
default:
return cerror.ErrInvalidReplicaConfig.GenWithStack(
"large message handle is set to %s, protocol is %s, it's not supported",
c.LargeMessageHandleOption, protocol.String())
}
if c.LargeMessageHandleOption == LargeMessageHandleOptionClaimCheck {
if c.ClaimCheckStorageURI == "" {
return cerror.ErrInvalidReplicaConfig.GenWithStack(
"large message handle is set to claim-check, but the claim-check-storage-uri is empty")
}
}
return nil
}
// HandleKeyOnly returns true if handle large message by encoding handle key only.
func (c *LargeMessageHandleConfig) HandleKeyOnly() bool {
if c == nil {
return false
}
return c.LargeMessageHandleOption == LargeMessageHandleOptionHandleKeyOnly
}
// EnableClaimCheck returns true if enable claim check.
func (c *LargeMessageHandleConfig) EnableClaimCheck() bool {
if c == nil {
return false
}
return c.LargeMessageHandleOption == LargeMessageHandleOptionClaimCheck
}
// Disabled returns true if disable large message handle.
func (c *LargeMessageHandleConfig) Disabled() bool {
if c == nil {
return false
}
return c.LargeMessageHandleOption == LargeMessageHandleOptionNone
}