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
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
|
/* Copyright (c) 2019, 2025, Oracle and/or its affiliates.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License, version 2.0, for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
#ifndef UDF_EXTENSION_TEST_FUNCTIONS_INCLUDED
#define UDF_EXTENSION_TEST_FUNCTIONS_INCLUDED
#include <mysql/udf_registration_types.h>
/**
Initialize the UDF function that tests character set of return value.
It sets the charset of the return value in the UDF_INIT structure.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] message Error message set by the user in case something went
wrong.
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_result_charset_init(UDF_INIT *initid, UDF_ARGS *args, char *message);
/**
Executes the UDF function that returns the first argument but after
converting that in to the character set as specified during UDF
initialization time.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_result_charset(UDF_INIT *initid, UDF_ARGS *args, char *result,
unsigned long *length, unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_result_charset_deinit(UDF_INIT *initid);
/**
Initialize the UDF function that tests character set of arguments.
It changes the character set of first argument as of a character set
of second argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] message Error message set by the user in case something went
wrong.
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_args_charset_init(UDF_INIT *initid, UDF_ARGS *args, char *message);
/**
Executes the UDF function that returns the first argument of UDF as it is.
Server provides the converted first argument as that had been changed
during UDF inititialization.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_args_charset(UDF_INIT *initid, UDF_ARGS *args, char *result,
unsigned long *length, unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_args_charset_deinit(UDF_INIT *initid);
/**
Initialize the UDF function that tests collation of return value.
It fetches the charset from the collation of second argument and sets
that as character set of first argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] message Error message set by the user in case something went
wrong.
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_result_collation_init(UDF_INIT *initid, UDF_ARGS *args,
char *message);
/**
Executes the UDF function that picks the first argument, convert the value
into character set as specified during UDF inititlization abd return
the same.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_result_collation(UDF_INIT *initid, UDF_ARGS *args, char *result,
unsigned long *length, unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_result_collation_deinit(UDF_INIT *initid);
/**
Initialize the UDF function that tests collation of arguments.
It changes the charset of the first UDF argument. It fetches the
charset from the collation of second argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] message Error message set by the user in case something went
wrong.
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_args_collation_init(UDF_INIT *initid, UDF_ARGS *args, char *message);
/**
Executes the UDF function to check the charset conversion of UDF argument
performed by the server. It returns the first UDF argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_args_collation(UDF_INIT *initid, UDF_ARGS *args, char *result,
unsigned long *length, unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_args_collation_deinit(UDF_INIT *initid);
/**
Initialize the UDF function that tests character set of return value.
It sets the charset of first UDF argument as specified by the user in
the second UDF argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] message Error message set by the user in case something went
wrong.
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_result_charset_with_value_init(UDF_INIT *initid, UDF_ARGS *args,
char *message);
/**
Executes the UDF function that converts the first UDF argument into the
charset as specified by the user. It reads the charset of return value
set by the user during UDF preparation time, converts the first UDF
argument into that charset before returning the same.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_result_charset_with_value(UDF_INIT *initid, UDF_ARGS *args,
char *result, unsigned long *length,
unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_result_charset_with_value_deinit(UDF_INIT *initid);
/**
Initialize the UDF function that tests character set of arguments.
It sets the charset of the first UDF argument as specified by the user
in second argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] message Error message set by the user in case something went
wrong.
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_args_charset_with_value_init(UDF_INIT *initid, UDF_ARGS *args,
char *message);
/**
Executes the UDF function to check if server converted the value of
first UDF argument as it was specified by the user during UDF
preparation time. It returns the first UDF argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_args_charset_with_value(UDF_INIT *initid, UDF_ARGS *args,
char *result, unsigned long *length,
unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_args_charset_with_value_deinit(UDF_INIT *initid);
/**
Initializes the UDF function that tests character set of return value.
It detmines the charset of the return value from the collation of the
second argument and set the same in the extension argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] message Error message set by the user in case something went
wrong.
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_result_collation_with_value_init(UDF_INIT *initid, UDF_ARGS *args,
char *message);
/**
Executes the UDF function that converts the return value in to the
charset as determined during UDF preparation time. It returns the
converted first UDF argument.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_result_collation_with_value(UDF_INIT *initid, UDF_ARGS *args,
char *result, unsigned long *length,
unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_result_collation_with_value_deinit(UDF_INIT *initid);
/**
Initialize the UDF function that checks if server performs the charset
conversion of the UDF argument. It fetches the charset from collation name
as specified by the user in the second argument and sets the same for the
first UDF argument.
@param [in, out] initid Return value from xxxx_init
@param [in, out] args Array of arguments
@param [out] message Error message if there is any
@retval true If UDF initialization failed
@retval false Otherwise
*/
bool test_args_collation_with_value_init(UDF_INIT *initid, UDF_ARGS *args,
char *message);
/**
Executes the UDF function that reads the converted the value of the
firstUDF argument. Server must have converted the first argument as
it was specified during UDF preparation time. It returns the first
UDF argument as received.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_args_collation_with_value(UDF_INIT *initid, UDF_ARGS *args,
char *result, unsigned long *length,
unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_args_collation_with_value_deinit(UDF_INIT *initid);
/**
Tests the delebrate UDF initialization failure.
@param initid Return value from xxxx_init
@param args Array of arguments
@param[out] message error message set by the user in case something went
wrong.
*/
bool test_invalid_result_charset_init(UDF_INIT *initid, UDF_ARGS *args,
char *message);
/**
Tests the delebrate UDF initialization failure. Therefore, this method
will not execute at all.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_invalid_result_charset(UDF_INIT *initid, UDF_ARGS *args,
char *result, unsigned long *length,
unsigned char *is_null, unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_invalid_result_charset_deinit(UDF_INIT *initid);
/**
Initialize the UDF function that tests the delebrate UDF execution failure.
@param initid Return value from xxxx_init
@param args Array of arguments
@param[out] message error message set by the user in case something went
wrong.
*/
bool test_invalid_args_charset_init(UDF_INIT *initid, UDF_ARGS *args,
char *message);
/**
Tests the delebrate UDF execution failure.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_invalid_args_charset(UDF_INIT *initid, UDF_ARGS *args, char *result,
unsigned long *length, unsigned char *is_null,
unsigned char *error);
/**
Cleanups the resources acquired during UDF initialization.
@param [in,out] initid Return value from xxxx_init
*/
void test_invalid_args_charset_deinit(UDF_INIT *initid);
/**
Verifies that UDF can be executed without providing its init() and deinit()
methods. This udf takes an argument and returns the same as result.
@param [in,out] initid Return value from xxxx_init
@param [in,out] args Array of arguments
@param [out] result The result to be returned
@param [out] length Length of the result
@param [out] is_null Flag indicating if the result vale could be null.
@param [out] error Flag indicating if UDF execution returned error.
@retval true If UDF initialization failed
@retval false Otherwise
*/
char *test_args_without_init_deinit_methods(UDF_INIT *initid, UDF_ARGS *args,
char *result, unsigned long *length,
unsigned char *is_null,
unsigned char *error);
#endif // UDF_EXTENSION_TEST_FUNCTIONS_INCLUDED
|
