本节介绍如何编写服务器端
INFORMATION_SCHEMA
表格插件。有关实现此类插件的示例代码,请参阅
sql/sql_show.cc
MySQL 源代码分发文件。您还可以查看InnoDB
源代码中的示例插件。查看源代码树中的
handler/i_s.cc
和
handler/ha_innodb.cc
文件
InnoDB
(在
storage/innobase
目录中)。
要编写INFORMATION_SCHEMA
表格插件,请在插件源文件中包含以下头文件。根据插件功能和要求,可能还需要其他 MySQL 或通用头文件。
#include <sql_class.h>
#include <table.h>
这些头文件位于sql
MySQL 源代码分发目录中。它们包含 C++ 结构,因此
INFORMATION_SCHEMA
插件的源文件必须编译为 C++(而非 C)代码。
此处开发的示例插件的源文件名为
simple_i_s_table.cc
. 它创建一个
INFORMATION_SCHEMA
名为的简单表
SIMPLE_I_S_TABLE
,其中有两列名为
NAME
和VALUE
。实现该表的插件库的一般描述符如下所示:
mysql_declare_plugin(simple_i_s_library)
{
MYSQL_INFORMATION_SCHEMA_PLUGIN,
&simple_table_info, /* type-specific descriptor */
"SIMPLE_I_S_TABLE", /* table name */
"Author Name", /* author */
"Simple INFORMATION_SCHEMA table", /* description */
PLUGIN_LICENSE_GPL, /* license type */
simple_table_init, /* init function */
NULL,
0x0100, /* version = 1.0 */
NULL, /* no status variables */
NULL, /* no system variables */
NULL, /* no reserved information */
0 /* no flags */
}
mysql_declare_plugin_end;
name
成员 ( ) 表示在or
SIMPLE_I_S_TABLE
等语句中用于引用插件的
名称。这也是或
显示的名称。
INSTALL PLUGIN
UNINSTALL PLUGIN
SHOW
PLUGINS
INFORMATION_SCHEMA.PLUGINS
通用描述符的simple_table_info
成员指向特定类型的描述符,它只包含特定类型的 API 版本号:
static struct st_mysql_information_schema simple_table_info =
{ MYSQL_INFORMATION_SCHEMA_INTERFACE_VERSION };
通用描述符指向初始化和反初始化函数:
初始化函数提供有关表结构的信息和填充表的函数。
去初始化函数执行任何需要的清理。如果不需要清理,则可以使用此描述符成员
NULL
(如示例所示)。
初始化函数应返回 0 表示成功,如果发生错误则返回 1。该函数接收一个通用指针,它应该解释为指向表结构的指针:
static int table_init(void *ptr)
{
ST_SCHEMA_TABLE *schema_table= (ST_SCHEMA_TABLE*)ptr;
schema_table->fields_info= simple_table_fields;
schema_table->fill_table= simple_fill_table;
return 0;
}
该函数应该设置表结构的这两个成员:
fields_info
:ST_FIELD_INFO
包含有关每一列的信息的结构数组。fill_table
:填充表的函数。
指向的数组fields_info
应包含每列一个元素
INFORMATION_SCHEMA
加上一个终止元素。示例插件的以下simple_table_fields
数组表示它
SIMPLE_I_S_TABLE
有两列。
NAME
是长度为 10 的字符串值和VALUE
显示宽度为 20 的整数值。最后一个结构标记数组的结尾。
static ST_FIELD_INFO simple_table_fields[]=
{
{"NAME", 10, MYSQL_TYPE_STRING, 0, 0 0, 0},
{"VALUE", 6, MYSQL_TYPE_LONG, 0, MY_I_S_UNSIGNED, 0, 0},
{0, 0, MYSQL_TYPE_NULL, 0, 0, 0, 0}
};
关于列信息结构的更多信息,请参见头文件ST_FIELD_INFO
中
的定义。table.h
允许的
类型值是 C API 中使用的值;请参阅
C API 基本数据结构。
MYSQL_TYPE_
xxx
该fill_table
成员应设置为填充表并返回 0 表示成功的函数,如果发生错误则返回 1。对于示例插件,
simple_fill_table()
函数如下所示:
static int simple_fill_table(THD *thd, TABLE_LIST *tables, Item *cond)
{
TABLE *table= tables->table;
table->field[0]->store("Name 1", 6, system_charset_info);
table->field[1]->store(1);
if (schema_table_store_record(thd, table))
return 1;
table->field[0]->store("Name 2", 6, system_charset_info);
table->field[1]->store(2);
if (schema_table_store_record(thd, table))
return 1;
return 0;
}
对于INFORMATION_SCHEMA
表的每一行,此函数初始化每一列,然后调用
schema_table_store_record()
安装行。store()
方法参数取决于要存储的值的类型。对于第 0 列(NAME
,一个字符串),
store()
获取一个指向字符串的指针、它的长度以及有关字符串字符集的信息:
store(const char *to, uint length, CHARSET_INFO *cs);
对于第 1 列(VALUE
,一个整数),
store()
采用值和一个指示它是否无符号的标志:
store(longlong nr, bool unsigned_value);
有关如何填充
INFORMATION_SCHEMA
表的其他示例,请搜索schema_table_store_record()
in
的实例sql_show.cc
。
要编译和安装插件库文件,请使用第 4.4.3 节“编译和安装插件库”中的说明。要使库文件可用,请将其安装在插件目录(由
plugin_dir
系统变量命名的目录)中。
要测试插件,请安装它:
mysql> INSTALL PLUGIN SIMPLE_I_S_TABLE SONAME 'simple_i_s_table.so';
验证表是否存在:
mysql> SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
-> WHERE TABLE_NAME = 'SIMPLE_I_S_TABLE';
+------------------+
| TABLE_NAME |
+------------------+
| SIMPLE_I_S_TABLE |
+------------------+
尝试从中选择:
mysql> SELECT * FROM INFORMATION_SCHEMA.SIMPLE_I_S_TABLE;
+--------+-------+
| NAME | VALUE |
+--------+-------+
| Name 1 | 1 |
| Name 2 | 2 |
+--------+-------+
卸载它:
mysql> UNINSTALL PLUGIN SIMPLE_I_S_TABLE;