MySQL 9.1.0
Source Code Documentation
udf_descriptor.h
Go to the documentation of this file.
1/* Copyright (c) 2018, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef PLUGIN_GR_INCLUDE_UDF_DESCRIPTOR_H
25#define PLUGIN_GR_INCLUDE_UDF_DESCRIPTOR_H
26
28
29/**
30 * Contains all the necessary data to register an UDF in MySQL.
31 */
33 char const *name;
38
39 udf_descriptor(char const *udf_name, enum Item_result udf_result_type,
40 Udf_func_any udf_function, Udf_func_init udf_init,
41 Udf_func_deinit udf_deinit)
42 : name(udf_name),
43 result_type(udf_result_type),
44 main_function(udf_function),
45 init_function(udf_init),
46 deinit_function(udf_deinit) {}
47 udf_descriptor(udf_descriptor const &) = delete;
48 udf_descriptor(udf_descriptor &&other) = default;
51};
52
53#endif /* PLUGIN_GR_INCLUDE_UDF_DESCRIPTOR_H */
Contains all the necessary data to register an UDF in MySQL.
Definition: udf_descriptor.h:32
Udf_func_any main_function
Definition: udf_descriptor.h:35
enum Item_result result_type
Definition: udf_descriptor.h:34
udf_descriptor(udf_descriptor &&other)=default
Udf_func_init init_function
Definition: udf_descriptor.h:36
char const * name
Definition: udf_descriptor.h:33
udf_descriptor(udf_descriptor const &)=delete
udf_descriptor & operator=(udf_descriptor &&other)=default
udf_descriptor & operator=(udf_descriptor const &)=delete
Udf_func_deinit deinit_function
Definition: udf_descriptor.h:37
udf_descriptor(char const *udf_name, enum Item_result udf_result_type, Udf_func_any udf_function, Udf_func_init udf_init, Udf_func_deinit udf_deinit)
Definition: udf_descriptor.h:39
void(* Udf_func_deinit)(UDF_INIT *)
Definition: udf_registration_types.h:80
Item_result
Type of the user defined function return slot and arguments.
Definition: udf_registration_types.h:39
bool(* Udf_func_init)(UDF_INIT *, UDF_ARGS *, char *)
Definition: udf_registration_types.h:81
void(* Udf_func_any)(void)
Definition: udf_registration_types.h:82