28.2.4.6 编写 INFORMATION_SCHEMA 插件

本节介绍如何编写服务器端INFORMATION_SCHEMAtable 插件。有关实现此类插件的示例代码,请参见 MySQL 源代码分发的sql/sql_show.cc文件。您还可以查看InnoDB源代码中的示例插件。请参见InnoDB源树(在storage/innobase目录中)中的handler/i_s.cchandler/ha_innodb.cc文件。

要编写INFORMATION_SCHEMAtable 插件,请在插件源文件中包含以下头文件。根据插件的功能和要求,可能还需要其他 MySQL 或常规头文件。

#include <sql_class.h>
#include <table.h>

这些头文件位于 MySQL 源代码发行版本的sql目录中。它们包含 C 结构,因此INFORMATION_SCHEMA插件的源文件必须编译为 C(而非 C)代码。

这里开发的示例插件的源文件名为simple_i_s_table.cc。它创建了一个简单的INFORMATION_SCHEMAtableSIMPLE_I_S_TABLE,该 table 具有两列NAMEVALUE。实现该 table 的插件库的常规 Descriptors 如下所示:

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成员(SIMPLE_I_S_TABLE)table 示在诸如INSTALL PLUGINUNINSTALL PLUGIN之类的语句中用于引用插件的名称。这也是SHOW PLUGINSINFORMATION_SCHEMA.PLUGINS显示的名称。

常规 Descriptors 的simple_table_info成员指向特定类型的 Descriptors,该 Descriptors 仅由特定类型的 API 版本号组成:

static struct st_mysql_information_schema simple_table_info =
{ MYSQL_INFORMATION_SCHEMA_INTERFACE_VERSION };

通用 Descriptors 指向初始化和反初始化函数:

  • 初始化函数提供有关 table 结构的信息以及填充 table 的函数。

  • 反初始化功能执行任何必需的清除。如果不需要清除,则此 Descriptors 成员可以为NULL(如所示示例)。

初始化函数成功返回 0,如果发生错误则返回 1.该函数接收一个通用指针,该通用指针应将其解释为指向 table 结构的指针:

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;
}

该函数应设置 table 结构的以下两个成员:

  • fields_infoST_FIELD_INFO结构的数组,其中包含有关每一列的信息。

  • fill_table:填充 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}
};

有关列信息结构的更多信息,请参见table.h头文件中的ST_FIELD_INFO的定义。允许的MYSQL_TYPE_xxx类型值是 C API 中使用的值;参见第 27.7.4 节“ C API 数据结构”

fill_table成员应设置为可填充 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_SCHEMAtable 的每一行,此函数将初始化每一列,然后调用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_SCHEMAtable 的其他示例,请在sql_show.cc中搜索schema_table_store_record()的实例。

要编译和安装插件库文件,请使用第 28.2.4.3 节“编译和安装插件库”中的说明。要使该库文件可供使用,请将其安装在插件目录(由plugin_dir系统变量命名的目录)中。

要测试插件,请安装它:

mysql> INSTALL PLUGIN SIMPLE_I_S_TABLE SONAME 'simple_i_s_table.so';

验证 table 是否存在:

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 |
+--------+-------+

Uninstall it:

mysql> UNINSTALL PLUGIN SIMPLE_I_S_TABLE;