|
| 1 | +package connclickhouse |
| 2 | + |
| 3 | +import ( |
| 4 | + "maps" |
| 5 | + "slices" |
| 6 | + "strings" |
| 7 | + |
| 8 | + chproto "github.com/ClickHouse/clickhouse-go/v2/lib/proto" |
| 9 | +) |
| 10 | + |
| 11 | +// When adding a new clickhouse setting to this list, check when the setting is introduced to ClickHouse |
| 12 | +// and if applicable, add a corresponding minimum supported version below to ensure queries on older versions |
| 13 | +// of ClickHouse servers are not impacted. |
| 14 | +// Important: if the setting causes breaking changes to existing PeerDB flows (not just ClickHouse compatibility), |
| 15 | +// it must also be gated by PeerDB's internal version. |
| 16 | +const ( |
| 17 | + SettingAllowNullableKey CHSetting = "allow_nullable_key" |
| 18 | + SettingJsonTypeEscapeDotsInKeys CHSetting = "json_type_escape_dots_in_keys" |
| 19 | + SettingTypeJsonSkipDuplicatedPaths CHSetting = "type_json_skip_duplicated_paths" |
| 20 | + SettingThrowOnMaxPartitionsPerInsertBlock CHSetting = "throw_on_max_partitions_per_insert_block" |
| 21 | + SettingParallelDistributedInsertSelect CHSetting = "parallel_distributed_insert_select" |
| 22 | +) |
| 23 | + |
| 24 | +// CHSettingMinVersions maps setting names to their minimum required ClickHouse versions |
| 25 | +// If minimum version is not specified, we assume the setting is available to all ClickHouse versions |
| 26 | +var CHSettingMinVersions = map[CHSetting]chproto.Version{ |
| 27 | + SettingJsonTypeEscapeDotsInKeys: {Major: 25, Minor: 8, Patch: 0}, |
| 28 | + SettingTypeJsonSkipDuplicatedPaths: {Major: 24, Minor: 8, Patch: 0}, |
| 29 | +} |
| 30 | + |
| 31 | +type CHSetting string |
| 32 | + |
| 33 | +type CHSettings struct { |
| 34 | + settings map[CHSetting]string |
| 35 | + chVersion *chproto.Version |
| 36 | +} |
| 37 | + |
| 38 | +type CHSettingEntry struct { |
| 39 | + key CHSetting |
| 40 | + val string |
| 41 | +} |
| 42 | + |
| 43 | +func GetMinVersion(name CHSetting) (chproto.Version, bool) { |
| 44 | + if minVersion, exists := CHSettingMinVersions[name]; exists { |
| 45 | + return minVersion, true |
| 46 | + } |
| 47 | + return chproto.Version{}, false |
| 48 | +} |
| 49 | + |
| 50 | +// NewCHSettingsString is a one-liner method to generate an immutable settings string |
| 51 | +func NewCHSettingsString(version *chproto.Version, settings ...CHSettingEntry) string { |
| 52 | + sg := NewCHSettings(version) |
| 53 | + for _, setting := range settings { |
| 54 | + sg.Add(setting.key, setting.val) |
| 55 | + } |
| 56 | + return sg.String() |
| 57 | +} |
| 58 | + |
| 59 | +func NewCHSettings(version *chproto.Version, settings ...CHSettingEntry) *CHSettings { |
| 60 | + newSettings := make(map[CHSetting]string) |
| 61 | + for _, s := range settings { |
| 62 | + newSettings[s.key] = s.val |
| 63 | + } |
| 64 | + chSettings := &CHSettings{ |
| 65 | + settings: newSettings, |
| 66 | + chVersion: version, |
| 67 | + } |
| 68 | + return chSettings |
| 69 | +} |
| 70 | + |
| 71 | +func (sg *CHSettings) Add(key CHSetting, val string) *CHSettings { |
| 72 | + sg.settings[key] = val |
| 73 | + return sg |
| 74 | +} |
| 75 | + |
| 76 | +// String generates settings string ' SETTINGS <key1> = <val1>, <key2> = <val2>, ...'; |
| 77 | +// If ClickHouse version is set in the CHSettings, settings that do not meet CH version |
| 78 | +// requirement will be filtered out. Otherwise, all settings are included. |
| 79 | +func (sg *CHSettings) String() string { |
| 80 | + if len(sg.settings) == 0 { |
| 81 | + return "" |
| 82 | + } |
| 83 | + |
| 84 | + // sort keys alphabetically for consistent output |
| 85 | + names := slices.Collect(maps.Keys(sg.settings)) |
| 86 | + slices.SortFunc(names, func(a, b CHSetting) int { |
| 87 | + return strings.Compare(string(a), string(b)) |
| 88 | + }) |
| 89 | + |
| 90 | + first := true |
| 91 | + var sb strings.Builder |
| 92 | + for _, name := range names { |
| 93 | + if minVersion, exists := GetMinVersion(name); exists && sg.chVersion != nil { |
| 94 | + if !chproto.CheckMinVersion(minVersion, *sg.chVersion) { |
| 95 | + continue |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + if first { |
| 100 | + sb.WriteString(" SETTINGS ") |
| 101 | + first = false |
| 102 | + } else { |
| 103 | + sb.WriteString(", ") |
| 104 | + } |
| 105 | + sb.WriteString(string(name)) |
| 106 | + sb.WriteString("=") |
| 107 | + sb.WriteString(sg.settings[name]) |
| 108 | + } |
| 109 | + return sb.String() |
| 110 | +} |
0 commit comments