Class: MysqlPR::Charset

Inherits:
Object
  • Object
show all
Defined in:
lib/mysql-pr/charset.rb

Overview

MySQL character set and collation handling

Constant Summary collapse

CHARSETS =
[charset_number, charset_name, collation_name, default], …
[
  [1, "big5",     "big5_chinese_ci",       true],
  [2, "latin2",   "latin2_czech_cs",       false],
  [3, "dec8",     "dec8_swedish_ci",       true],
  [4, "cp850",    "cp850_general_ci",      true],
  [5, "latin1",   "latin1_german1_ci",     false],
  [6, "hp8",      "hp8_english_ci",        true],
  [7, "koi8r",    "koi8r_general_ci",      true],
  [8, "latin1",   "latin1_swedish_ci",     true],
  [9, "latin2",   "latin2_general_ci",     true],
  [10, "swe7",     "swe7_swedish_ci",       true],
  [11, "ascii",    "ascii_general_ci",      true],
  [12, "ujis",     "ujis_japanese_ci",      true],
  [13, "sjis",     "sjis_japanese_ci",      true],
  [14, "cp1251",   "cp1251_bulgarian_ci",   false],
  [15, "latin1",   "latin1_danish_ci",      false],
  [16, "hebrew",   "hebrew_general_ci",     true],
  [17, "filename", "filename",              true],
  [18, "tis620",   "tis620_thai_ci",        true],
  [19, "euckr",    "euckr_korean_ci",       true],
  [20, "latin7",   "latin7_estonian_cs",    false],
  [21, "latin2",   "latin2_hungarian_ci",   false],
  [22, "koi8u",    "koi8u_general_ci",      true],
  [23, "cp1251",   "cp1251_ukrainian_ci",   false],
  [24, "gb2312",   "gb2312_chinese_ci",     true],
  [25, "greek",    "greek_general_ci",      true],
  [26, "cp1250",   "cp1250_general_ci",     true],
  [27, "latin2",   "latin2_croatian_ci",    false],
  [28, "gbk",      "gbk_chinese_ci",        true],
  [29, "cp1257",   "cp1257_lithuanian_ci",  false],
  [30, "latin5",   "latin5_turkish_ci",     true],
  [31, "latin1",   "latin1_german2_ci",     false],
  [32, "armscii8", "armscii8_general_ci",   true],
  [33, "utf8",     "utf8_general_ci",       true],
  [34, "cp1250",   "cp1250_czech_cs",       false],
  [35, "ucs2",     "ucs2_general_ci",       true],
  [36, "cp866",    "cp866_general_ci",      true],
  [37, "keybcs2",  "keybcs2_general_ci",    true],
  [38, "macce",    "macce_general_ci",      true],
  [39, "macroman", "macroman_general_ci",   true],
  [40, "cp852",    "cp852_general_ci",      true],
  [41, "latin7",   "latin7_general_ci",     true],
  [42, "latin7",   "latin7_general_cs",     false],
  [43, "macce",    "macce_bin",             false],
  [44, "cp1250",   "cp1250_croatian_ci",    false],
  [45, "utf8mb4",  "utf8mb4_general_ci",    true],
  [46, "utf8mb4",  "utf8mb4_bin",           false],
  [47, "latin1",   "latin1_bin",            false],
  [48, "latin1",   "latin1_general_ci",     false],
  [49, "latin1",   "latin1_general_cs",     false],
  [50, "cp1251",   "cp1251_bin",            false],
  [51, "cp1251",   "cp1251_general_ci",     true],
  [52, "cp1251",   "cp1251_general_cs",     false],
  [53, "macroman", "macroman_bin",          false],
  [57, "cp1256",   "cp1256_general_ci",     true],
  [58, "cp1257",   "cp1257_bin",            false],
  [59, "cp1257",   "cp1257_general_ci",     true],
  [63, "binary",   "binary",                true],
  [64, "armscii8", "armscii8_bin",          false],
  [65, "ascii",    "ascii_bin",             false],
  [66, "cp1250",   "cp1250_bin",            false],
  [67, "cp1256",   "cp1256_bin",            false],
  [68, "cp866",    "cp866_bin",             false],
  [69, "dec8",     "dec8_bin",              false],
  [70, "greek",    "greek_bin",             false],
  [71, "hebrew",   "hebrew_bin",            false],
  [72, "hp8",      "hp8_bin",               false],
  [73, "keybcs2",  "keybcs2_bin",           false],
  [74, "koi8r",    "koi8r_bin",             false],
  [75, "koi8u",    "koi8u_bin",             false],
  [77, "latin2",   "latin2_bin",            false],
  [78, "latin5",   "latin5_bin",            false],
  [79, "latin7",   "latin7_bin",            false],
  [80, "cp850",    "cp850_bin",             false],
  [81, "cp852",    "cp852_bin",             false],
  [82, "swe7",     "swe7_bin",              false],
  [83, "utf8",     "utf8_bin",              false],
  [84, "big5",     "big5_bin",              false],
  [85, "euckr",    "euckr_bin",             false],
  [86, "gb2312",   "gb2312_bin",            false],
  [87, "gbk",      "gbk_bin",               false],
  [88, "sjis",     "sjis_bin",              false],
  [89, "tis620",   "tis620_bin",            false],
  [90, "ucs2",     "ucs2_bin",              false],
  [91, "ujis",     "ujis_bin",              false],
  [92, "geostd8",  "geostd8_general_ci",    true],
  [93, "geostd8",  "geostd8_bin",           false],
  [94, "latin1",   "latin1_spanish_ci",     false],
  [95, "cp932",    "cp932_japanese_ci",     true],
  [96, "cp932",    "cp932_bin",             false],
  [97, "eucjpms",  "eucjpms_japanese_ci",   true],
  [98, "eucjpms",  "eucjpms_bin",           false],
  [99, "cp1250",   "cp1250_polish_ci",      false],
  [128, "ucs2",     "ucs2_unicode_ci",       false],
  [129, "ucs2",     "ucs2_icelandic_ci",     false],
  [130, "ucs2",     "ucs2_latvian_ci",       false],
  [131, "ucs2",     "ucs2_romanian_ci",      false],
  [132, "ucs2",     "ucs2_slovenian_ci",     false],
  [133, "ucs2",     "ucs2_polish_ci",        false],
  [134, "ucs2",     "ucs2_estonian_ci",      false],
  [135, "ucs2",     "ucs2_spanish_ci",       false],
  [136, "ucs2",     "ucs2_swedish_ci",       false],
  [137, "ucs2",     "ucs2_turkish_ci",       false],
  [138, "ucs2",     "ucs2_czech_ci",         false],
  [139, "ucs2",     "ucs2_danish_ci",        false],
  [140, "ucs2",     "ucs2_lithuanian_ci",    false],
  [141, "ucs2",     "ucs2_slovak_ci",        false],
  [142, "ucs2",     "ucs2_spanish2_ci",      false],
  [143, "ucs2",     "ucs2_roman_ci",         false],
  [144, "ucs2",     "ucs2_persian_ci",       false],
  [145, "ucs2",     "ucs2_esperanto_ci",     false],
  [146, "ucs2",     "ucs2_hungarian_ci",     false],
  [192, "utf8",     "utf8_unicode_ci",       false],
  [193, "utf8",     "utf8_icelandic_ci",     false],
  [194, "utf8",     "utf8_latvian_ci",       false],
  [195, "utf8",     "utf8_romanian_ci",      false],
  [196, "utf8",     "utf8_slovenian_ci",     false],
  [197, "utf8",     "utf8_polish_ci",        false],
  [198, "utf8",     "utf8_estonian_ci",      false],
  [199, "utf8",     "utf8_spanish_ci",       false],
  [200, "utf8",     "utf8_swedish_ci",       false],
  [201, "utf8",     "utf8_turkish_ci",       false],
  [202, "utf8",     "utf8_czech_ci",         false],
  [203, "utf8",     "utf8_danish_ci",        false],
  [204, "utf8",     "utf8_lithuanian_ci",    false],
  [205, "utf8",     "utf8_slovak_ci",        false],
  [206, "utf8",     "utf8_spanish2_ci",      false],
  [207, "utf8",     "utf8_roman_ci",         false],
  [208, "utf8",     "utf8_persian_ci",       false],
  [209, "utf8",     "utf8_esperanto_ci",     false],
  [210, "utf8",     "utf8_hungarian_ci",     false],
  [211, "utf8",     "utf8_sinhala_ci",       false],
  [224, "utf8mb4",  "utf8mb4_unicode_ci",    false],
  [225, "utf8mb4",  "utf8mb4_icelandic_ci",  false],
  [226, "utf8mb4",  "utf8mb4_latvian_ci",    false],
  [227, "utf8mb4",  "utf8mb4_romanian_ci",   false],
  [228, "utf8mb4",  "utf8mb4_slovenian_ci",  false],
  [229, "utf8mb4",  "utf8mb4_polish_ci",     false],
  [230, "utf8mb4",  "utf8mb4_estonian_ci",   false],
  [231, "utf8mb4",  "utf8mb4_spanish_ci",    false],
  [232, "utf8mb4",  "utf8mb4_swedish_ci",    false],
  [233, "utf8mb4",  "utf8mb4_turkish_ci",    false],
  [234, "utf8mb4",  "utf8mb4_czech_ci",      false],
  [235, "utf8mb4",  "utf8mb4_danish_ci",     false],
  [236, "utf8mb4",  "utf8mb4_lithuanian_ci", false],
  [237, "utf8mb4",  "utf8mb4_slovak_ci",     false],
  [238, "utf8mb4",  "utf8mb4_spanish2_ci",   false],
  [239, "utf8mb4",  "utf8mb4_roman_ci",      false],
  [240, "utf8mb4",  "utf8mb4_persian_ci",    false],
  [241, "utf8mb4",  "utf8mb4_esperanto_ci",  false],
  [242, "utf8mb4",  "utf8mb4_hungarian_ci",  false],
  [243, "utf8mb4",  "utf8mb4_sinhala_ci",    false],
  [254, "utf8",     "utf8_general_cs",       false],
  [255, "utf8mb4",  "utf8mb4_0900_ai_ci",    false]
].freeze
UNSAFE_CHARSET =
%w[big5 sjis filename gbk ucs2 cp932].freeze
NUMBER_TO_CHARSET =

rubocop:disable Style/MutableConstant

{}
COLLATION_TO_CHARSET =

rubocop:disable Style/MutableConstant

{}
CHARSET_DEFAULT =

rubocop:disable Style/MutableConstant

{}
BINARY_CHARSET_NUMBER =
CHARSET_DEFAULT["binary"].number
CHARSET_ENCODING =

MySQL Charset -> Ruby Encoding mapping

{
  "armscii8" => nil,
  "ascii" => Encoding::US_ASCII,
  "big5" => Encoding::Big5,
  "binary" => Encoding::ASCII_8BIT,
  "cp1250" => Encoding::Windows_1250,
  "cp1251" => Encoding::Windows_1251,
  "cp1256" => Encoding::Windows_1256,
  "cp1257" => Encoding::Windows_1257,
  "cp850" => Encoding::CP850,
  "cp852" => Encoding::CP852,
  "cp866" => Encoding::IBM866,
  "cp932" => Encoding::Windows_31J,
  "dec8" => nil,
  "eucjpms" => Encoding::EucJP_ms,
  "euckr" => Encoding::EUC_KR,
  "gb2312" => Encoding::EUC_CN,
  "gbk" => Encoding::GBK,
  "geostd8" => nil,
  "greek" => Encoding::ISO_8859_7,
  "hebrew" => Encoding::ISO_8859_8,
  "hp8" => nil,
  "keybcs2" => nil,
  "koi8r" => Encoding::KOI8_R,
  "koi8u" => Encoding::KOI8_U,
  "latin1" => Encoding::ISO_8859_1,
  "latin2" => Encoding::ISO_8859_2,
  "latin5" => Encoding::ISO_8859_9,
  "latin7" => Encoding::ISO_8859_13,
  "macce" => Encoding::MacCentEuro,
  "macroman" => Encoding::MacRoman,
  "sjis" => Encoding::SHIFT_JIS,
  "swe7" => nil,
  "tis620" => Encoding::TIS_620,
  "ucs2" => Encoding::UTF_16BE,
  "ujis" => Encoding::EucJP_ms,
  "utf8" => Encoding::UTF_8,
  "utf8mb4" => Encoding::UTF_8
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(number, name, csname) ⇒ Charset



18
19
20
21
22
23
# File 'lib/mysql-pr/charset.rb', line 18

def initialize(number, name, csname)
  @number = number
  @name = name
  @csname = csname
  @unsafe = false
end

Instance Attribute Details

#csnameString (readonly)



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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/mysql-pr/charset.rb', line 14

class Charset
  # @param [Integer] number
  # @param [String] name
  # @param [String] csname
  def initialize(number, name, csname)
    @number = number
    @name = name
    @csname = csname
    @unsafe = false
  end

  attr_reader :number, :name, :csname
  attr_accessor :unsafe

  # [[charset_number, charset_name, collation_name, default], ...]
  CHARSETS = [
    [1, "big5",     "big5_chinese_ci",       true],
    [2, "latin2",   "latin2_czech_cs",       false],
    [3, "dec8",     "dec8_swedish_ci",       true],
    [4, "cp850",    "cp850_general_ci",      true],
    [5, "latin1",   "latin1_german1_ci",     false],
    [6, "hp8",      "hp8_english_ci",        true],
    [7, "koi8r",    "koi8r_general_ci",      true],
    [8, "latin1",   "latin1_swedish_ci",     true],
    [9, "latin2",   "latin2_general_ci",     true],
    [10, "swe7",     "swe7_swedish_ci",       true],
    [11, "ascii",    "ascii_general_ci",      true],
    [12, "ujis",     "ujis_japanese_ci",      true],
    [13, "sjis",     "sjis_japanese_ci",      true],
    [14, "cp1251",   "cp1251_bulgarian_ci",   false],
    [15, "latin1",   "latin1_danish_ci",      false],
    [16, "hebrew",   "hebrew_general_ci",     true],
    [17, "filename", "filename",              true],
    [18, "tis620",   "tis620_thai_ci",        true],
    [19, "euckr",    "euckr_korean_ci",       true],
    [20, "latin7",   "latin7_estonian_cs",    false],
    [21, "latin2",   "latin2_hungarian_ci",   false],
    [22, "koi8u",    "koi8u_general_ci",      true],
    [23, "cp1251",   "cp1251_ukrainian_ci",   false],
    [24, "gb2312",   "gb2312_chinese_ci",     true],
    [25, "greek",    "greek_general_ci",      true],
    [26, "cp1250",   "cp1250_general_ci",     true],
    [27, "latin2",   "latin2_croatian_ci",    false],
    [28, "gbk",      "gbk_chinese_ci",        true],
    [29, "cp1257",   "cp1257_lithuanian_ci",  false],
    [30, "latin5",   "latin5_turkish_ci",     true],
    [31, "latin1",   "latin1_german2_ci",     false],
    [32, "armscii8", "armscii8_general_ci",   true],
    [33, "utf8",     "utf8_general_ci",       true],
    [34, "cp1250",   "cp1250_czech_cs",       false],
    [35, "ucs2",     "ucs2_general_ci",       true],
    [36, "cp866",    "cp866_general_ci",      true],
    [37, "keybcs2",  "keybcs2_general_ci",    true],
    [38, "macce",    "macce_general_ci",      true],
    [39, "macroman", "macroman_general_ci",   true],
    [40, "cp852",    "cp852_general_ci",      true],
    [41, "latin7",   "latin7_general_ci",     true],
    [42, "latin7",   "latin7_general_cs",     false],
    [43, "macce",    "macce_bin",             false],
    [44, "cp1250",   "cp1250_croatian_ci",    false],
    [45, "utf8mb4",  "utf8mb4_general_ci",    true],
    [46, "utf8mb4",  "utf8mb4_bin",           false],
    [47, "latin1",   "latin1_bin",            false],
    [48, "latin1",   "latin1_general_ci",     false],
    [49, "latin1",   "latin1_general_cs",     false],
    [50, "cp1251",   "cp1251_bin",            false],
    [51, "cp1251",   "cp1251_general_ci",     true],
    [52, "cp1251",   "cp1251_general_cs",     false],
    [53, "macroman", "macroman_bin",          false],
    [57, "cp1256",   "cp1256_general_ci",     true],
    [58, "cp1257",   "cp1257_bin",            false],
    [59, "cp1257",   "cp1257_general_ci",     true],
    [63, "binary",   "binary",                true],
    [64, "armscii8", "armscii8_bin",          false],
    [65, "ascii",    "ascii_bin",             false],
    [66, "cp1250",   "cp1250_bin",            false],
    [67, "cp1256",   "cp1256_bin",            false],
    [68, "cp866",    "cp866_bin",             false],
    [69, "dec8",     "dec8_bin",              false],
    [70, "greek",    "greek_bin",             false],
    [71, "hebrew",   "hebrew_bin",            false],
    [72, "hp8",      "hp8_bin",               false],
    [73, "keybcs2",  "keybcs2_bin",           false],
    [74, "koi8r",    "koi8r_bin",             false],
    [75, "koi8u",    "koi8u_bin",             false],
    [77, "latin2",   "latin2_bin",            false],
    [78, "latin5",   "latin5_bin",            false],
    [79, "latin7",   "latin7_bin",            false],
    [80, "cp850",    "cp850_bin",             false],
    [81, "cp852",    "cp852_bin",             false],
    [82, "swe7",     "swe7_bin",              false],
    [83, "utf8",     "utf8_bin",              false],
    [84, "big5",     "big5_bin",              false],
    [85, "euckr",    "euckr_bin",             false],
    [86, "gb2312",   "gb2312_bin",            false],
    [87, "gbk",      "gbk_bin",               false],
    [88, "sjis",     "sjis_bin",              false],
    [89, "tis620",   "tis620_bin",            false],
    [90, "ucs2",     "ucs2_bin",              false],
    [91, "ujis",     "ujis_bin",              false],
    [92, "geostd8",  "geostd8_general_ci",    true],
    [93, "geostd8",  "geostd8_bin",           false],
    [94, "latin1",   "latin1_spanish_ci",     false],
    [95, "cp932",    "cp932_japanese_ci",     true],
    [96, "cp932",    "cp932_bin",             false],
    [97, "eucjpms",  "eucjpms_japanese_ci",   true],
    [98, "eucjpms",  "eucjpms_bin",           false],
    [99, "cp1250",   "cp1250_polish_ci",      false],
    [128, "ucs2",     "ucs2_unicode_ci",       false],
    [129, "ucs2",     "ucs2_icelandic_ci",     false],
    [130, "ucs2",     "ucs2_latvian_ci",       false],
    [131, "ucs2",     "ucs2_romanian_ci",      false],
    [132, "ucs2",     "ucs2_slovenian_ci",     false],
    [133, "ucs2",     "ucs2_polish_ci",        false],
    [134, "ucs2",     "ucs2_estonian_ci",      false],
    [135, "ucs2",     "ucs2_spanish_ci",       false],
    [136, "ucs2",     "ucs2_swedish_ci",       false],
    [137, "ucs2",     "ucs2_turkish_ci",       false],
    [138, "ucs2",     "ucs2_czech_ci",         false],
    [139, "ucs2",     "ucs2_danish_ci",        false],
    [140, "ucs2",     "ucs2_lithuanian_ci",    false],
    [141, "ucs2",     "ucs2_slovak_ci",        false],
    [142, "ucs2",     "ucs2_spanish2_ci",      false],
    [143, "ucs2",     "ucs2_roman_ci",         false],
    [144, "ucs2",     "ucs2_persian_ci",       false],
    [145, "ucs2",     "ucs2_esperanto_ci",     false],
    [146, "ucs2",     "ucs2_hungarian_ci",     false],
    [192, "utf8",     "utf8_unicode_ci",       false],
    [193, "utf8",     "utf8_icelandic_ci",     false],
    [194, "utf8",     "utf8_latvian_ci",       false],
    [195, "utf8",     "utf8_romanian_ci",      false],
    [196, "utf8",     "utf8_slovenian_ci",     false],
    [197, "utf8",     "utf8_polish_ci",        false],
    [198, "utf8",     "utf8_estonian_ci",      false],
    [199, "utf8",     "utf8_spanish_ci",       false],
    [200, "utf8",     "utf8_swedish_ci",       false],
    [201, "utf8",     "utf8_turkish_ci",       false],
    [202, "utf8",     "utf8_czech_ci",         false],
    [203, "utf8",     "utf8_danish_ci",        false],
    [204, "utf8",     "utf8_lithuanian_ci",    false],
    [205, "utf8",     "utf8_slovak_ci",        false],
    [206, "utf8",     "utf8_spanish2_ci",      false],
    [207, "utf8",     "utf8_roman_ci",         false],
    [208, "utf8",     "utf8_persian_ci",       false],
    [209, "utf8",     "utf8_esperanto_ci",     false],
    [210, "utf8",     "utf8_hungarian_ci",     false],
    [211, "utf8",     "utf8_sinhala_ci",       false],
    [224, "utf8mb4",  "utf8mb4_unicode_ci",    false],
    [225, "utf8mb4",  "utf8mb4_icelandic_ci",  false],
    [226, "utf8mb4",  "utf8mb4_latvian_ci",    false],
    [227, "utf8mb4",  "utf8mb4_romanian_ci",   false],
    [228, "utf8mb4",  "utf8mb4_slovenian_ci",  false],
    [229, "utf8mb4",  "utf8mb4_polish_ci",     false],
    [230, "utf8mb4",  "utf8mb4_estonian_ci",   false],
    [231, "utf8mb4",  "utf8mb4_spanish_ci",    false],
    [232, "utf8mb4",  "utf8mb4_swedish_ci",    false],
    [233, "utf8mb4",  "utf8mb4_turkish_ci",    false],
    [234, "utf8mb4",  "utf8mb4_czech_ci",      false],
    [235, "utf8mb4",  "utf8mb4_danish_ci",     false],
    [236, "utf8mb4",  "utf8mb4_lithuanian_ci", false],
    [237, "utf8mb4",  "utf8mb4_slovak_ci",     false],
    [238, "utf8mb4",  "utf8mb4_spanish2_ci",   false],
    [239, "utf8mb4",  "utf8mb4_roman_ci",      false],
    [240, "utf8mb4",  "utf8mb4_persian_ci",    false],
    [241, "utf8mb4",  "utf8mb4_esperanto_ci",  false],
    [242, "utf8mb4",  "utf8mb4_hungarian_ci",  false],
    [243, "utf8mb4",  "utf8mb4_sinhala_ci",    false],
    [254, "utf8",     "utf8_general_cs",       false],
    [255, "utf8mb4",  "utf8mb4_0900_ai_ci",    false]
  ].freeze

  UNSAFE_CHARSET = %w[big5 sjis filename gbk ucs2 cp932].freeze

  NUMBER_TO_CHARSET = {} # rubocop:disable Style/MutableConstant
  COLLATION_TO_CHARSET = {} # rubocop:disable Style/MutableConstant
  CHARSET_DEFAULT = {} # rubocop:disable Style/MutableConstant

  CHARSETS.each do |number, csname, clname, default|
    cs = Charset.new(number, csname, clname)
    cs.unsafe = true if UNSAFE_CHARSET.include?(csname)
    NUMBER_TO_CHARSET[number] = cs
    COLLATION_TO_CHARSET[clname] = cs
    CHARSET_DEFAULT[csname] = cs if default
  end

  NUMBER_TO_CHARSET.freeze
  COLLATION_TO_CHARSET.freeze
  CHARSET_DEFAULT.freeze

  BINARY_CHARSET_NUMBER = CHARSET_DEFAULT["binary"].number

  # MySQL Charset -> Ruby Encoding mapping
  CHARSET_ENCODING = {
    "armscii8" => nil,
    "ascii" => Encoding::US_ASCII,
    "big5" => Encoding::Big5,
    "binary" => Encoding::ASCII_8BIT,
    "cp1250" => Encoding::Windows_1250,
    "cp1251" => Encoding::Windows_1251,
    "cp1256" => Encoding::Windows_1256,
    "cp1257" => Encoding::Windows_1257,
    "cp850" => Encoding::CP850,
    "cp852" => Encoding::CP852,
    "cp866" => Encoding::IBM866,
    "cp932" => Encoding::Windows_31J,
    "dec8" => nil,
    "eucjpms" => Encoding::EucJP_ms,
    "euckr" => Encoding::EUC_KR,
    "gb2312" => Encoding::EUC_CN,
    "gbk" => Encoding::GBK,
    "geostd8" => nil,
    "greek" => Encoding::ISO_8859_7,
    "hebrew" => Encoding::ISO_8859_8,
    "hp8" => nil,
    "keybcs2" => nil,
    "koi8r" => Encoding::KOI8_R,
    "koi8u" => Encoding::KOI8_U,
    "latin1" => Encoding::ISO_8859_1,
    "latin2" => Encoding::ISO_8859_2,
    "latin5" => Encoding::ISO_8859_9,
    "latin7" => Encoding::ISO_8859_13,
    "macce" => Encoding::MacCentEuro,
    "macroman" => Encoding::MacRoman,
    "sjis" => Encoding::SHIFT_JIS,
    "swe7" => nil,
    "tis620" => Encoding::TIS_620,
    "ucs2" => Encoding::UTF_16BE,
    "ujis" => Encoding::EucJP_ms,
    "utf8" => Encoding::UTF_8,
    "utf8mb4" => Encoding::UTF_8
  }.freeze

  # @param [Integer] n charset number
  # @return [MysqlPR::Charset]
  def self.by_number(n)
    raise ClientError, "unknown charset number: #{n}" unless NUMBER_TO_CHARSET.key?(n)

    NUMBER_TO_CHARSET[n]
  end

  # @param [String] str charset or collation name
  # @return [MysqlPR::Charset]
  def self.by_name(str)
    ret = COLLATION_TO_CHARSET[str] || CHARSET_DEFAULT[str]
    raise ClientError, "unknown charset: #{str}" unless ret

    ret
  end

  # @param [String] value
  # @return [String] value with binary encoding
  def self.to_binary(value)
    value.dup.force_encoding(Encoding::ASCII_8BIT)
  end

  # Convert raw bytes to encoding and then to Encoding.default_internal
  # @param [String] raw
  # @param [Encoding] encoding
  # @return [String]
  def self.convert_encoding(raw, encoding)
    raw.force_encoding(encoding).encode
  end

  # @return [Encoding] corresponding Ruby encoding
  def encoding
    enc = CHARSET_ENCODING[@name.downcase]
    raise MysqlPR::ClientError, "unsupported charset: #{@name}" unless enc

    enc
  end

  # Convert value encoding to match MySQL charset
  # @param [String] value
  # @return [String]
  def convert(value)
    value = value.encode(encoding) if value.is_a?(String) && value.encoding != Encoding::ASCII_8BIT
    value
  end
end

#nameString (readonly)



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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/mysql-pr/charset.rb', line 14

class Charset
  # @param [Integer] number
  # @param [String] name
  # @param [String] csname
  def initialize(number, name, csname)
    @number = number
    @name = name
    @csname = csname
    @unsafe = false
  end

  attr_reader :number, :name, :csname
  attr_accessor :unsafe

  # [[charset_number, charset_name, collation_name, default], ...]
  CHARSETS = [
    [1, "big5",     "big5_chinese_ci",       true],
    [2, "latin2",   "latin2_czech_cs",       false],
    [3, "dec8",     "dec8_swedish_ci",       true],
    [4, "cp850",    "cp850_general_ci",      true],
    [5, "latin1",   "latin1_german1_ci",     false],
    [6, "hp8",      "hp8_english_ci",        true],
    [7, "koi8r",    "koi8r_general_ci",      true],
    [8, "latin1",   "latin1_swedish_ci",     true],
    [9, "latin2",   "latin2_general_ci",     true],
    [10, "swe7",     "swe7_swedish_ci",       true],
    [11, "ascii",    "ascii_general_ci",      true],
    [12, "ujis",     "ujis_japanese_ci",      true],
    [13, "sjis",     "sjis_japanese_ci",      true],
    [14, "cp1251",   "cp1251_bulgarian_ci",   false],
    [15, "latin1",   "latin1_danish_ci",      false],
    [16, "hebrew",   "hebrew_general_ci",     true],
    [17, "filename", "filename",              true],
    [18, "tis620",   "tis620_thai_ci",        true],
    [19, "euckr",    "euckr_korean_ci",       true],
    [20, "latin7",   "latin7_estonian_cs",    false],
    [21, "latin2",   "latin2_hungarian_ci",   false],
    [22, "koi8u",    "koi8u_general_ci",      true],
    [23, "cp1251",   "cp1251_ukrainian_ci",   false],
    [24, "gb2312",   "gb2312_chinese_ci",     true],
    [25, "greek",    "greek_general_ci",      true],
    [26, "cp1250",   "cp1250_general_ci",     true],
    [27, "latin2",   "latin2_croatian_ci",    false],
    [28, "gbk",      "gbk_chinese_ci",        true],
    [29, "cp1257",   "cp1257_lithuanian_ci",  false],
    [30, "latin5",   "latin5_turkish_ci",     true],
    [31, "latin1",   "latin1_german2_ci",     false],
    [32, "armscii8", "armscii8_general_ci",   true],
    [33, "utf8",     "utf8_general_ci",       true],
    [34, "cp1250",   "cp1250_czech_cs",       false],
    [35, "ucs2",     "ucs2_general_ci",       true],
    [36, "cp866",    "cp866_general_ci",      true],
    [37, "keybcs2",  "keybcs2_general_ci",    true],
    [38, "macce",    "macce_general_ci",      true],
    [39, "macroman", "macroman_general_ci",   true],
    [40, "cp852",    "cp852_general_ci",      true],
    [41, "latin7",   "latin7_general_ci",     true],
    [42, "latin7",   "latin7_general_cs",     false],
    [43, "macce",    "macce_bin",             false],
    [44, "cp1250",   "cp1250_croatian_ci",    false],
    [45, "utf8mb4",  "utf8mb4_general_ci",    true],
    [46, "utf8mb4",  "utf8mb4_bin",           false],
    [47, "latin1",   "latin1_bin",            false],
    [48, "latin1",   "latin1_general_ci",     false],
    [49, "latin1",   "latin1_general_cs",     false],
    [50, "cp1251",   "cp1251_bin",            false],
    [51, "cp1251",   "cp1251_general_ci",     true],
    [52, "cp1251",   "cp1251_general_cs",     false],
    [53, "macroman", "macroman_bin",          false],
    [57, "cp1256",   "cp1256_general_ci",     true],
    [58, "cp1257",   "cp1257_bin",            false],
    [59, "cp1257",   "cp1257_general_ci",     true],
    [63, "binary",   "binary",                true],
    [64, "armscii8", "armscii8_bin",          false],
    [65, "ascii",    "ascii_bin",             false],
    [66, "cp1250",   "cp1250_bin",            false],
    [67, "cp1256",   "cp1256_bin",            false],
    [68, "cp866",    "cp866_bin",             false],
    [69, "dec8",     "dec8_bin",              false],
    [70, "greek",    "greek_bin",             false],
    [71, "hebrew",   "hebrew_bin",            false],
    [72, "hp8",      "hp8_bin",               false],
    [73, "keybcs2",  "keybcs2_bin",           false],
    [74, "koi8r",    "koi8r_bin",             false],
    [75, "koi8u",    "koi8u_bin",             false],
    [77, "latin2",   "latin2_bin",            false],
    [78, "latin5",   "latin5_bin",            false],
    [79, "latin7",   "latin7_bin",            false],
    [80, "cp850",    "cp850_bin",             false],
    [81, "cp852",    "cp852_bin",             false],
    [82, "swe7",     "swe7_bin",              false],
    [83, "utf8",     "utf8_bin",              false],
    [84, "big5",     "big5_bin",              false],
    [85, "euckr",    "euckr_bin",             false],
    [86, "gb2312",   "gb2312_bin",            false],
    [87, "gbk",      "gbk_bin",               false],
    [88, "sjis",     "sjis_bin",              false],
    [89, "tis620",   "tis620_bin",            false],
    [90, "ucs2",     "ucs2_bin",              false],
    [91, "ujis",     "ujis_bin",              false],
    [92, "geostd8",  "geostd8_general_ci",    true],
    [93, "geostd8",  "geostd8_bin",           false],
    [94, "latin1",   "latin1_spanish_ci",     false],
    [95, "cp932",    "cp932_japanese_ci",     true],
    [96, "cp932",    "cp932_bin",             false],
    [97, "eucjpms",  "eucjpms_japanese_ci",   true],
    [98, "eucjpms",  "eucjpms_bin",           false],
    [99, "cp1250",   "cp1250_polish_ci",      false],
    [128, "ucs2",     "ucs2_unicode_ci",       false],
    [129, "ucs2",     "ucs2_icelandic_ci",     false],
    [130, "ucs2",     "ucs2_latvian_ci",       false],
    [131, "ucs2",     "ucs2_romanian_ci",      false],
    [132, "ucs2",     "ucs2_slovenian_ci",     false],
    [133, "ucs2",     "ucs2_polish_ci",        false],
    [134, "ucs2",     "ucs2_estonian_ci",      false],
    [135, "ucs2",     "ucs2_spanish_ci",       false],
    [136, "ucs2",     "ucs2_swedish_ci",       false],
    [137, "ucs2",     "ucs2_turkish_ci",       false],
    [138, "ucs2",     "ucs2_czech_ci",         false],
    [139, "ucs2",     "ucs2_danish_ci",        false],
    [140, "ucs2",     "ucs2_lithuanian_ci",    false],
    [141, "ucs2",     "ucs2_slovak_ci",        false],
    [142, "ucs2",     "ucs2_spanish2_ci",      false],
    [143, "ucs2",     "ucs2_roman_ci",         false],
    [144, "ucs2",     "ucs2_persian_ci",       false],
    [145, "ucs2",     "ucs2_esperanto_ci",     false],
    [146, "ucs2",     "ucs2_hungarian_ci",     false],
    [192, "utf8",     "utf8_unicode_ci",       false],
    [193, "utf8",     "utf8_icelandic_ci",     false],
    [194, "utf8",     "utf8_latvian_ci",       false],
    [195, "utf8",     "utf8_romanian_ci",      false],
    [196, "utf8",     "utf8_slovenian_ci",     false],
    [197, "utf8",     "utf8_polish_ci",        false],
    [198, "utf8",     "utf8_estonian_ci",      false],
    [199, "utf8",     "utf8_spanish_ci",       false],
    [200, "utf8",     "utf8_swedish_ci",       false],
    [201, "utf8",     "utf8_turkish_ci",       false],
    [202, "utf8",     "utf8_czech_ci",         false],
    [203, "utf8",     "utf8_danish_ci",        false],
    [204, "utf8",     "utf8_lithuanian_ci",    false],
    [205, "utf8",     "utf8_slovak_ci",        false],
    [206, "utf8",     "utf8_spanish2_ci",      false],
    [207, "utf8",     "utf8_roman_ci",         false],
    [208, "utf8",     "utf8_persian_ci",       false],
    [209, "utf8",     "utf8_esperanto_ci",     false],
    [210, "utf8",     "utf8_hungarian_ci",     false],
    [211, "utf8",     "utf8_sinhala_ci",       false],
    [224, "utf8mb4",  "utf8mb4_unicode_ci",    false],
    [225, "utf8mb4",  "utf8mb4_icelandic_ci",  false],
    [226, "utf8mb4",  "utf8mb4_latvian_ci",    false],
    [227, "utf8mb4",  "utf8mb4_romanian_ci",   false],
    [228, "utf8mb4",  "utf8mb4_slovenian_ci",  false],
    [229, "utf8mb4",  "utf8mb4_polish_ci",     false],
    [230, "utf8mb4",  "utf8mb4_estonian_ci",   false],
    [231, "utf8mb4",  "utf8mb4_spanish_ci",    false],
    [232, "utf8mb4",  "utf8mb4_swedish_ci",    false],
    [233, "utf8mb4",  "utf8mb4_turkish_ci",    false],
    [234, "utf8mb4",  "utf8mb4_czech_ci",      false],
    [235, "utf8mb4",  "utf8mb4_danish_ci",     false],
    [236, "utf8mb4",  "utf8mb4_lithuanian_ci", false],
    [237, "utf8mb4",  "utf8mb4_slovak_ci",     false],
    [238, "utf8mb4",  "utf8mb4_spanish2_ci",   false],
    [239, "utf8mb4",  "utf8mb4_roman_ci",      false],
    [240, "utf8mb4",  "utf8mb4_persian_ci",    false],
    [241, "utf8mb4",  "utf8mb4_esperanto_ci",  false],
    [242, "utf8mb4",  "utf8mb4_hungarian_ci",  false],
    [243, "utf8mb4",  "utf8mb4_sinhala_ci",    false],
    [254, "utf8",     "utf8_general_cs",       false],
    [255, "utf8mb4",  "utf8mb4_0900_ai_ci",    false]
  ].freeze

  UNSAFE_CHARSET = %w[big5 sjis filename gbk ucs2 cp932].freeze

  NUMBER_TO_CHARSET = {} # rubocop:disable Style/MutableConstant
  COLLATION_TO_CHARSET = {} # rubocop:disable Style/MutableConstant
  CHARSET_DEFAULT = {} # rubocop:disable Style/MutableConstant

  CHARSETS.each do |number, csname, clname, default|
    cs = Charset.new(number, csname, clname)
    cs.unsafe = true if UNSAFE_CHARSET.include?(csname)
    NUMBER_TO_CHARSET[number] = cs
    COLLATION_TO_CHARSET[clname] = cs
    CHARSET_DEFAULT[csname] = cs if default
  end

  NUMBER_TO_CHARSET.freeze
  COLLATION_TO_CHARSET.freeze
  CHARSET_DEFAULT.freeze

  BINARY_CHARSET_NUMBER = CHARSET_DEFAULT["binary"].number

  # MySQL Charset -> Ruby Encoding mapping
  CHARSET_ENCODING = {
    "armscii8" => nil,
    "ascii" => Encoding::US_ASCII,
    "big5" => Encoding::Big5,
    "binary" => Encoding::ASCII_8BIT,
    "cp1250" => Encoding::Windows_1250,
    "cp1251" => Encoding::Windows_1251,
    "cp1256" => Encoding::Windows_1256,
    "cp1257" => Encoding::Windows_1257,
    "cp850" => Encoding::CP850,
    "cp852" => Encoding::CP852,
    "cp866" => Encoding::IBM866,
    "cp932" => Encoding::Windows_31J,
    "dec8" => nil,
    "eucjpms" => Encoding::EucJP_ms,
    "euckr" => Encoding::EUC_KR,
    "gb2312" => Encoding::EUC_CN,
    "gbk" => Encoding::GBK,
    "geostd8" => nil,
    "greek" => Encoding::ISO_8859_7,
    "hebrew" => Encoding::ISO_8859_8,
    "hp8" => nil,
    "keybcs2" => nil,
    "koi8r" => Encoding::KOI8_R,
    "koi8u" => Encoding::KOI8_U,
    "latin1" => Encoding::ISO_8859_1,
    "latin2" => Encoding::ISO_8859_2,
    "latin5" => Encoding::ISO_8859_9,
    "latin7" => Encoding::ISO_8859_13,
    "macce" => Encoding::MacCentEuro,
    "macroman" => Encoding::MacRoman,
    "sjis" => Encoding::SHIFT_JIS,
    "swe7" => nil,
    "tis620" => Encoding::TIS_620,
    "ucs2" => Encoding::UTF_16BE,
    "ujis" => Encoding::EucJP_ms,
    "utf8" => Encoding::UTF_8,
    "utf8mb4" => Encoding::UTF_8
  }.freeze

  # @param [Integer] n charset number
  # @return [MysqlPR::Charset]
  def self.by_number(n)
    raise ClientError, "unknown charset number: #{n}" unless NUMBER_TO_CHARSET.key?(n)

    NUMBER_TO_CHARSET[n]
  end

  # @param [String] str charset or collation name
  # @return [MysqlPR::Charset]
  def self.by_name(str)
    ret = COLLATION_TO_CHARSET[str] || CHARSET_DEFAULT[str]
    raise ClientError, "unknown charset: #{str}" unless ret

    ret
  end

  # @param [String] value
  # @return [String] value with binary encoding
  def self.to_binary(value)
    value.dup.force_encoding(Encoding::ASCII_8BIT)
  end

  # Convert raw bytes to encoding and then to Encoding.default_internal
  # @param [String] raw
  # @param [Encoding] encoding
  # @return [String]
  def self.convert_encoding(raw, encoding)
    raw.force_encoding(encoding).encode
  end

  # @return [Encoding] corresponding Ruby encoding
  def encoding
    enc = CHARSET_ENCODING[@name.downcase]
    raise MysqlPR::ClientError, "unsupported charset: #{@name}" unless enc

    enc
  end

  # Convert value encoding to match MySQL charset
  # @param [String] value
  # @return [String]
  def convert(value)
    value = value.encode(encoding) if value.is_a?(String) && value.encoding != Encoding::ASCII_8BIT
    value
  end
end

#numberInteger (readonly)



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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/mysql-pr/charset.rb', line 14

class Charset
  # @param [Integer] number
  # @param [String] name
  # @param [String] csname
  def initialize(number, name, csname)
    @number = number
    @name = name
    @csname = csname
    @unsafe = false
  end

  attr_reader :number, :name, :csname
  attr_accessor :unsafe

  # [[charset_number, charset_name, collation_name, default], ...]
  CHARSETS = [
    [1, "big5",     "big5_chinese_ci",       true],
    [2, "latin2",   "latin2_czech_cs",       false],
    [3, "dec8",     "dec8_swedish_ci",       true],
    [4, "cp850",    "cp850_general_ci",      true],
    [5, "latin1",   "latin1_german1_ci",     false],
    [6, "hp8",      "hp8_english_ci",        true],
    [7, "koi8r",    "koi8r_general_ci",      true],
    [8, "latin1",   "latin1_swedish_ci",     true],
    [9, "latin2",   "latin2_general_ci",     true],
    [10, "swe7",     "swe7_swedish_ci",       true],
    [11, "ascii",    "ascii_general_ci",      true],
    [12, "ujis",     "ujis_japanese_ci",      true],
    [13, "sjis",     "sjis_japanese_ci",      true],
    [14, "cp1251",   "cp1251_bulgarian_ci",   false],
    [15, "latin1",   "latin1_danish_ci",      false],
    [16, "hebrew",   "hebrew_general_ci",     true],
    [17, "filename", "filename",              true],
    [18, "tis620",   "tis620_thai_ci",        true],
    [19, "euckr",    "euckr_korean_ci",       true],
    [20, "latin7",   "latin7_estonian_cs",    false],
    [21, "latin2",   "latin2_hungarian_ci",   false],
    [22, "koi8u",    "koi8u_general_ci",      true],
    [23, "cp1251",   "cp1251_ukrainian_ci",   false],
    [24, "gb2312",   "gb2312_chinese_ci",     true],
    [25, "greek",    "greek_general_ci",      true],
    [26, "cp1250",   "cp1250_general_ci",     true],
    [27, "latin2",   "latin2_croatian_ci",    false],
    [28, "gbk",      "gbk_chinese_ci",        true],
    [29, "cp1257",   "cp1257_lithuanian_ci",  false],
    [30, "latin5",   "latin5_turkish_ci",     true],
    [31, "latin1",   "latin1_german2_ci",     false],
    [32, "armscii8", "armscii8_general_ci",   true],
    [33, "utf8",     "utf8_general_ci",       true],
    [34, "cp1250",   "cp1250_czech_cs",       false],
    [35, "ucs2",     "ucs2_general_ci",       true],
    [36, "cp866",    "cp866_general_ci",      true],
    [37, "keybcs2",  "keybcs2_general_ci",    true],
    [38, "macce",    "macce_general_ci",      true],
    [39, "macroman", "macroman_general_ci",   true],
    [40, "cp852",    "cp852_general_ci",      true],
    [41, "latin7",   "latin7_general_ci",     true],
    [42, "latin7",   "latin7_general_cs",     false],
    [43, "macce",    "macce_bin",             false],
    [44, "cp1250",   "cp1250_croatian_ci",    false],
    [45, "utf8mb4",  "utf8mb4_general_ci",    true],
    [46, "utf8mb4",  "utf8mb4_bin",           false],
    [47, "latin1",   "latin1_bin",            false],
    [48, "latin1",   "latin1_general_ci",     false],
    [49, "latin1",   "latin1_general_cs",     false],
    [50, "cp1251",   "cp1251_bin",            false],
    [51, "cp1251",   "cp1251_general_ci",     true],
    [52, "cp1251",   "cp1251_general_cs",     false],
    [53, "macroman", "macroman_bin",          false],
    [57, "cp1256",   "cp1256_general_ci",     true],
    [58, "cp1257",   "cp1257_bin",            false],
    [59, "cp1257",   "cp1257_general_ci",     true],
    [63, "binary",   "binary",                true],
    [64, "armscii8", "armscii8_bin",          false],
    [65, "ascii",    "ascii_bin",             false],
    [66, "cp1250",   "cp1250_bin",            false],
    [67, "cp1256",   "cp1256_bin",            false],
    [68, "cp866",    "cp866_bin",             false],
    [69, "dec8",     "dec8_bin",              false],
    [70, "greek",    "greek_bin",             false],
    [71, "hebrew",   "hebrew_bin",            false],
    [72, "hp8",      "hp8_bin",               false],
    [73, "keybcs2",  "keybcs2_bin",           false],
    [74, "koi8r",    "koi8r_bin",             false],
    [75, "koi8u",    "koi8u_bin",             false],
    [77, "latin2",   "latin2_bin",            false],
    [78, "latin5",   "latin5_bin",            false],
    [79, "latin7",   "latin7_bin",            false],
    [80, "cp850",    "cp850_bin",             false],
    [81, "cp852",    "cp852_bin",             false],
    [82, "swe7",     "swe7_bin",              false],
    [83, "utf8",     "utf8_bin",              false],
    [84, "big5",     "big5_bin",              false],
    [85, "euckr",    "euckr_bin",             false],
    [86, "gb2312",   "gb2312_bin",            false],
    [87, "gbk",      "gbk_bin",               false],
    [88, "sjis",     "sjis_bin",              false],
    [89, "tis620",   "tis620_bin",            false],
    [90, "ucs2",     "ucs2_bin",              false],
    [91, "ujis",     "ujis_bin",              false],
    [92, "geostd8",  "geostd8_general_ci",    true],
    [93, "geostd8",  "geostd8_bin",           false],
    [94, "latin1",   "latin1_spanish_ci",     false],
    [95, "cp932",    "cp932_japanese_ci",     true],
    [96, "cp932",    "cp932_bin",             false],
    [97, "eucjpms",  "eucjpms_japanese_ci",   true],
    [98, "eucjpms",  "eucjpms_bin",           false],
    [99, "cp1250",   "cp1250_polish_ci",      false],
    [128, "ucs2",     "ucs2_unicode_ci",       false],
    [129, "ucs2",     "ucs2_icelandic_ci",     false],
    [130, "ucs2",     "ucs2_latvian_ci",       false],
    [131, "ucs2",     "ucs2_romanian_ci",      false],
    [132, "ucs2",     "ucs2_slovenian_ci",     false],
    [133, "ucs2",     "ucs2_polish_ci",        false],
    [134, "ucs2",     "ucs2_estonian_ci",      false],
    [135, "ucs2",     "ucs2_spanish_ci",       false],
    [136, "ucs2",     "ucs2_swedish_ci",       false],
    [137, "ucs2",     "ucs2_turkish_ci",       false],
    [138, "ucs2",     "ucs2_czech_ci",         false],
    [139, "ucs2",     "ucs2_danish_ci",        false],
    [140, "ucs2",     "ucs2_lithuanian_ci",    false],
    [141, "ucs2",     "ucs2_slovak_ci",        false],
    [142, "ucs2",     "ucs2_spanish2_ci",      false],
    [143, "ucs2",     "ucs2_roman_ci",         false],
    [144, "ucs2",     "ucs2_persian_ci",       false],
    [145, "ucs2",     "ucs2_esperanto_ci",     false],
    [146, "ucs2",     "ucs2_hungarian_ci",     false],
    [192, "utf8",     "utf8_unicode_ci",       false],
    [193, "utf8",     "utf8_icelandic_ci",     false],
    [194, "utf8",     "utf8_latvian_ci",       false],
    [195, "utf8",     "utf8_romanian_ci",      false],
    [196, "utf8",     "utf8_slovenian_ci",     false],
    [197, "utf8",     "utf8_polish_ci",        false],
    [198, "utf8",     "utf8_estonian_ci",      false],
    [199, "utf8",     "utf8_spanish_ci",       false],
    [200, "utf8",     "utf8_swedish_ci",       false],
    [201, "utf8",     "utf8_turkish_ci",       false],
    [202, "utf8",     "utf8_czech_ci",         false],
    [203, "utf8",     "utf8_danish_ci",        false],
    [204, "utf8",     "utf8_lithuanian_ci",    false],
    [205, "utf8",     "utf8_slovak_ci",        false],
    [206, "utf8",     "utf8_spanish2_ci",      false],
    [207, "utf8",     "utf8_roman_ci",         false],
    [208, "utf8",     "utf8_persian_ci",       false],
    [209, "utf8",     "utf8_esperanto_ci",     false],
    [210, "utf8",     "utf8_hungarian_ci",     false],
    [211, "utf8",     "utf8_sinhala_ci",       false],
    [224, "utf8mb4",  "utf8mb4_unicode_ci",    false],
    [225, "utf8mb4",  "utf8mb4_icelandic_ci",  false],
    [226, "utf8mb4",  "utf8mb4_latvian_ci",    false],
    [227, "utf8mb4",  "utf8mb4_romanian_ci",   false],
    [228, "utf8mb4",  "utf8mb4_slovenian_ci",  false],
    [229, "utf8mb4",  "utf8mb4_polish_ci",     false],
    [230, "utf8mb4",  "utf8mb4_estonian_ci",   false],
    [231, "utf8mb4",  "utf8mb4_spanish_ci",    false],
    [232, "utf8mb4",  "utf8mb4_swedish_ci",    false],
    [233, "utf8mb4",  "utf8mb4_turkish_ci",    false],
    [234, "utf8mb4",  "utf8mb4_czech_ci",      false],
    [235, "utf8mb4",  "utf8mb4_danish_ci",     false],
    [236, "utf8mb4",  "utf8mb4_lithuanian_ci", false],
    [237, "utf8mb4",  "utf8mb4_slovak_ci",     false],
    [238, "utf8mb4",  "utf8mb4_spanish2_ci",   false],
    [239, "utf8mb4",  "utf8mb4_roman_ci",      false],
    [240, "utf8mb4",  "utf8mb4_persian_ci",    false],
    [241, "utf8mb4",  "utf8mb4_esperanto_ci",  false],
    [242, "utf8mb4",  "utf8mb4_hungarian_ci",  false],
    [243, "utf8mb4",  "utf8mb4_sinhala_ci",    false],
    [254, "utf8",     "utf8_general_cs",       false],
    [255, "utf8mb4",  "utf8mb4_0900_ai_ci",    false]
  ].freeze

  UNSAFE_CHARSET = %w[big5 sjis filename gbk ucs2 cp932].freeze

  NUMBER_TO_CHARSET = {} # rubocop:disable Style/MutableConstant
  COLLATION_TO_CHARSET = {} # rubocop:disable Style/MutableConstant
  CHARSET_DEFAULT = {} # rubocop:disable Style/MutableConstant

  CHARSETS.each do |number, csname, clname, default|
    cs = Charset.new(number, csname, clname)
    cs.unsafe = true if UNSAFE_CHARSET.include?(csname)
    NUMBER_TO_CHARSET[number] = cs
    COLLATION_TO_CHARSET[clname] = cs
    CHARSET_DEFAULT[csname] = cs if default
  end

  NUMBER_TO_CHARSET.freeze
  COLLATION_TO_CHARSET.freeze
  CHARSET_DEFAULT.freeze

  BINARY_CHARSET_NUMBER = CHARSET_DEFAULT["binary"].number

  # MySQL Charset -> Ruby Encoding mapping
  CHARSET_ENCODING = {
    "armscii8" => nil,
    "ascii" => Encoding::US_ASCII,
    "big5" => Encoding::Big5,
    "binary" => Encoding::ASCII_8BIT,
    "cp1250" => Encoding::Windows_1250,
    "cp1251" => Encoding::Windows_1251,
    "cp1256" => Encoding::Windows_1256,
    "cp1257" => Encoding::Windows_1257,
    "cp850" => Encoding::CP850,
    "cp852" => Encoding::CP852,
    "cp866" => Encoding::IBM866,
    "cp932" => Encoding::Windows_31J,
    "dec8" => nil,
    "eucjpms" => Encoding::EucJP_ms,
    "euckr" => Encoding::EUC_KR,
    "gb2312" => Encoding::EUC_CN,
    "gbk" => Encoding::GBK,
    "geostd8" => nil,
    "greek" => Encoding::ISO_8859_7,
    "hebrew" => Encoding::ISO_8859_8,
    "hp8" => nil,
    "keybcs2" => nil,
    "koi8r" => Encoding::KOI8_R,
    "koi8u" => Encoding::KOI8_U,
    "latin1" => Encoding::ISO_8859_1,
    "latin2" => Encoding::ISO_8859_2,
    "latin5" => Encoding::ISO_8859_9,
    "latin7" => Encoding::ISO_8859_13,
    "macce" => Encoding::MacCentEuro,
    "macroman" => Encoding::MacRoman,
    "sjis" => Encoding::SHIFT_JIS,
    "swe7" => nil,
    "tis620" => Encoding::TIS_620,
    "ucs2" => Encoding::UTF_16BE,
    "ujis" => Encoding::EucJP_ms,
    "utf8" => Encoding::UTF_8,
    "utf8mb4" => Encoding::UTF_8
  }.freeze

  # @param [Integer] n charset number
  # @return [MysqlPR::Charset]
  def self.by_number(n)
    raise ClientError, "unknown charset number: #{n}" unless NUMBER_TO_CHARSET.key?(n)

    NUMBER_TO_CHARSET[n]
  end

  # @param [String] str charset or collation name
  # @return [MysqlPR::Charset]
  def self.by_name(str)
    ret = COLLATION_TO_CHARSET[str] || CHARSET_DEFAULT[str]
    raise ClientError, "unknown charset: #{str}" unless ret

    ret
  end

  # @param [String] value
  # @return [String] value with binary encoding
  def self.to_binary(value)
    value.dup.force_encoding(Encoding::ASCII_8BIT)
  end

  # Convert raw bytes to encoding and then to Encoding.default_internal
  # @param [String] raw
  # @param [Encoding] encoding
  # @return [String]
  def self.convert_encoding(raw, encoding)
    raw.force_encoding(encoding).encode
  end

  # @return [Encoding] corresponding Ruby encoding
  def encoding
    enc = CHARSET_ENCODING[@name.downcase]
    raise MysqlPR::ClientError, "unsupported charset: #{@name}" unless enc

    enc
  end

  # Convert value encoding to match MySQL charset
  # @param [String] value
  # @return [String]
  def convert(value)
    value = value.encode(encoding) if value.is_a?(String) && value.encoding != Encoding::ASCII_8BIT
    value
  end
end

#unsafeObject

Returns the value of attribute unsafe.



26
27
28
# File 'lib/mysql-pr/charset.rb', line 26

def unsafe
  @unsafe
end

Class Method Details

.by_name(str) ⇒ MysqlPR::Charset

Raises:



256
257
258
259
260
261
# File 'lib/mysql-pr/charset.rb', line 256

def self.by_name(str)
  ret = COLLATION_TO_CHARSET[str] || CHARSET_DEFAULT[str]
  raise ClientError, "unknown charset: #{str}" unless ret

  ret
end

.by_number(n) ⇒ MysqlPR::Charset

Raises:



248
249
250
251
252
# File 'lib/mysql-pr/charset.rb', line 248

def self.by_number(n)
  raise ClientError, "unknown charset number: #{n}" unless NUMBER_TO_CHARSET.key?(n)

  NUMBER_TO_CHARSET[n]
end

.convert_encoding(raw, encoding) ⇒ String

Convert raw bytes to encoding and then to Encoding.default_internal



273
274
275
# File 'lib/mysql-pr/charset.rb', line 273

def self.convert_encoding(raw, encoding)
  raw.force_encoding(encoding).encode
end

.to_binary(value) ⇒ String



265
266
267
# File 'lib/mysql-pr/charset.rb', line 265

def self.to_binary(value)
  value.dup.force_encoding(Encoding::ASCII_8BIT)
end

Instance Method Details

#convert(value) ⇒ String

Convert value encoding to match MySQL charset



288
289
290
291
# File 'lib/mysql-pr/charset.rb', line 288

def convert(value)
  value = value.encode(encoding) if value.is_a?(String) && value.encoding != Encoding::ASCII_8BIT
  value
end

#encodingEncoding

Returns corresponding Ruby encoding.



278
279
280
281
282
283
# File 'lib/mysql-pr/charset.rb', line 278

def encoding
  enc = CHARSET_ENCODING[@name.downcase]
  raise MysqlPR::ClientError, "unsupported charset: #{@name}" unless enc

  enc
end