서버 플러그인을 포함하는 모든 플러그인 라이브러리는 파일 내의 각 서버 플러그인의 일반 플러그인 기술자가 포함되어있는 라이브러리 디스크립터가 포함되어 있어야합니다. 이 섹션에서는 서버 플러그인 라이브러리 및 일반 기술자를 작성하는 방법에 대해 설명합니다.

라이브러리 디스크립터는 2 개의 심볼을 정의해야합니다.

서버가 라이브러리에서이 두 기호를 찾을 수없는 경우, 서버는이를 정당한 플러그인 라이브러리로 받아들이지 않고 거부하고 오류를 발생시킵니다. 그러면 라이브러리를 플러그인 라이브러리로 특별히 빌드하지 않는 한, 플러그인 라이브러리를 사용할 수 없습니다.

필수 2 개의 심볼을 정의하는 일반적인 방법은 plugin.h 파일에서 mysql_declare_plugin() 매크로 및 mysql_declare_plugin_end 매크로를 사용하는 것입니다.

mysql_declare_plugin(name)
 ... one or more server plugin descriptors here ...
mysql_declare_plugin_end;

각 서버 플러그인은 서버 플러그인 API에 정보를 제공하는 일반 기술자가 필요합니다. 일반 기술자의 구조는 모든 플러그인 타입으로 동일합니다. plugin.h 파일의 st_mysql_plugin 구조에 의해이 기술자가 정의됩니다.

struct st_mysql_plugin
{
  int type;             /* the plugin type (a MYSQL_XXX_PLUGIN value)   */
  void *info;           /* pointer to type-specific plugin descriptor   */
  const char *name;     /* plugin name                                  */
  const char *author;   /* plugin author (for I_S.PLUGINS)              */
  const char *descr;    /* general descriptive text (for I_S.PLUGINS)   */
  int license;          /* the plugin license (PLUGIN_LICENSE_XXX)      */
  int (*init)(void *);  /* the function to invoke when plugin is loaded */
  int (*deinit)(void *);/* the function to invoke when plugin is unloaded */
  unsigned int version; /* plugin version (for I_S.PLUGINS)             */
  struct st_mysql_show_var *status_vars;
  struct st_mysql_sys_var **system_vars;
  void * __reserved1;   /* reserved for dependency checking             */
  unsigned long flags;  /* flags for plugin */
};

st_mysql_plugin 디스크립터 구조체의 멤버는 다음과 같이 사용합니다. char * 멤버는 NULL로 끝나는 문자열로 지정하십시오.

서버는 플러그인을로드 및 언로드 할 경우에만 일반 플러그인 디스크립터의 init 함수 및 deinit 함수를 호출합니다. 이들은 SQL 문에 의해 플러그인이 시작 된 경우 등의 플러그인 사용시에는 관계가 없습니다.

예를 들어, simple_parser 라는 단일 전문 파서 플러그 인을 포함한 라이브러리 디스크립터 정보는 다음과 같이됩니다.

mysql_declare_plugin(ftexample)
{
  MYSQL_FTPARSER_PLUGIN,      /* type                            */
  &simple_parser_descriptor,  /* descriptor                      */
  "simple_parser",            /* name                            */
  "Oracle Corporation",       /* author                          */
  "Simple Full-Text Parser",  /* description                     */
  PLUGIN_LICENSE_GPL,         /* plugin license                  */
  simple_parser_plugin_init,  /* init function (when loaded)     */
  simple_parser_plugin_deinit,/* deinit function (when unloaded) */
  0x0001,                     /* version                         */
  simple_status,              /* status variables                */
  simple_system_variables,    /* system variables                */
  NULL,
  0
}
mysql_declare_plugin_end;

전체 파서 플러그인의 경우 유형은 MYSQL_FTPARSER_PLUGIN 이어야합니다. 이것은 FULLTEXT 인덱스를 만들 때 WITH PARSER 절에서 사용하는 경우 플러그인이 합법적임을 식별하는 값입니다. (다른 플러그인 타입이 어구에 대해서도 유효하지 않습니다.)

plugin.h 는 mysql_declare_plugin() 매크로 및 mysql_declare_plugin_end 매크로를 다음과 같이 정의합니다.

#ifndef MYSQL_DYNAMIC_PLUGIN
#define __MYSQL_DECLARE_PLUGIN(NAME, VERSION, PSIZE, DECLS) \
MYSQL_PLUGIN_EXPORT int VERSION= MYSQL_PLUGIN_INTERFACE_VERSION; \
MYSQL_PLUGIN_EXPORT int PSIZE= sizeof(struct st_mysql_plugin); \
MYSQL_PLUGIN_EXPORT struct st_mysql_plugin DECLS[]= {
#else
#define __MYSQL_DECLARE_PLUGIN(NAME, VERSION, PSIZE, DECLS) \
MYSQL_PLUGIN_EXPORT int _mysql_plugin_interface_version_= MYSQL_PLUGIN_INTERFACE_VERSION; \
MYSQL_PLUGIN_EXPORT int _mysql_sizeof_struct_st_plugin_= sizeof(struct st_mysql_plugin); \
MYSQL_PLUGIN_EXPORT struct st_mysql_plugin _mysql_plugin_declarations_[]= {
#endif

#define mysql_declare_plugin(NAME) \
__MYSQL_DECLARE_PLUGIN(NAME, \
                 builtin_ ## NAME ## _plugin_interface_version, \
                 builtin_ ## NAME ## _sizeof_struct_st_plugin, \
                 builtin_ ## NAME ## _plugin)

#define mysql_declare_plugin_end ,{0,0,0,0,0,0,0,0,0,0,0,0,0}}

위와 같이 매크로가 사용 된 경우에는 다음 코드가 전개되고 필요한 기호 ( _mysql_plugin_interface_version_ 및 _mysql_plugin_declarations_ )이 정의됩니다.

int _mysql_plugin_interface_version_= MYSQL_PLUGIN_INTERFACE_VERSION;
int _mysql_sizeof_struct_st_plugin_= sizeof(struct st_mysql_plugin);
struct st_mysql_plugin _mysql_plugin_declarations_[]= {
{
  MYSQL_FTPARSER_PLUGIN,      /* type                            */
  &simple_parser_descriptor,  /* descriptor                      */
  "simple_parser",            /* name                            */
  "Oracle Corporation",       /* author                          */
  "Simple Full-Text Parser",  /* description                     */
  PLUGIN_LICENSE_GPL,         /* plugin license                  */
  simple_parser_plugin_init,  /* init function (when loaded)     */
  simple_parser_plugin_deinit,/* deinit function (when unloaded) */
  0x0001,                     /* version                         */
  simple_status,              /* status variables                */
  simple_system_variables,    /* system variables                */
  NULL,
  0
}
  ,{0,0,0,0,0,0,0,0,0,0,0,0}}
};

앞의 예에서는 일반 기술자에 단일 플러그 인을 선언했지만 여러 플러그인을 선언 할 수 있습니다. mysql_declare_plugin() 와 mysql_declare_plugin_end 사이에 선언을 쉼표로 구분하여 순서대로 나열합니다.

MySQL 서버 플러그인은 C 또는 C ++ (또는 C 호출 규칙을 사용할 수있는 다른 언어)로 작성할 수 있습니다. C ++ 플러그인을 작성하는 경우에 사용해서는 안 C ++ 기능은 전역 구조체를 초기화하기위한 상수가 아닌 변수입니다. st_mysql_plugin 구조 등의 구조체의 멤버는 상수 변수 만 초기화하십시오. 앞에서 언급 한 simple_parser 기술자는이 요구 사항을 충족하기 위해 C ++ 플러그인으로 허용됩니다.

mysql_declare_plugin(ftexample)
{
  MYSQL_FTPARSER_PLUGIN,      /* type                            */
  &simple_parser_descriptor,  /* descriptor                      */
  "simple_parser",            /* name                            */
  "Oracle Corporation",       /* author                          */
  "Simple Full-Text Parser",  /* description                     */
  PLUGIN_LICENSE_GPL,         /* plugin license                  */
  simple_parser_plugin_init,  /* init function (when loaded)     */
  simple_parser_plugin_deinit,/* deinit function (when unloaded) */
  0x0001,                     /* version                         */
  simple_status,              /* status variables                */
  simple_system_variables,    /* system variables                */
  NULL,
  0
}
mysql_declare_plugin_end;

일반 기술자를 설명하는 다른 효과적인 방법을 보여줍니다. 여기에서는 플러그인 이름, 작성자 및 설명을 지정하는 상수 변수가 사용되고 있습니다.

const char *simple_parser_name = "simple_parser";
const char *simple_parser_author = "Oracle Corporation";
const char *simple_parser_description = "Simple Full-Text Parser";

mysql_declare_plugin(ftexample)
{
  MYSQL_FTPARSER_PLUGIN,      /* type                            */
  &simple_parser_descriptor,  /* descriptor                      */
  simple_parser_name,         /* name                            */
  simple_parser_author,       /* author                          */
  simple_parser_description,  /* description                     */
  PLUGIN_LICENSE_GPL,         /* plugin license                  */
  simple_parser_plugin_init,  /* init function (when loaded)     */
  simple_parser_plugin_deinit,/* deinit function (when unloaded) */
  0x0001,                     /* version                         */
  simple_status,              /* status variables                */
  simple_system_variables,    /* system variables                */
  NULL,
  0
}
mysql_declare_plugin_end;

그러나 다음의 일반 기술자는 무효입니다. 여기에 플러그인 이름, 작성자 및 설명을 지정하기 위해 구조체 멤버가 사용되고 있습니다 만, C ++ 구조 상수 이니셜 라이저로 간주되지 않습니다.

typedef struct
{
  const char *name;
  const char *author;
  const char *description;
} plugin_info;

plugin_info parser_info = {
  "simple_parser",
  "Oracle Corporation",
  "Simple Full-Text Parser"
};

mysql_declare_plugin(ftexample)
{
  MYSQL_FTPARSER_PLUGIN,      /* type                            */
  &simple_parser_descriptor,  /* descriptor                      */
  parser_info.name,           /* name                            */
  parser_info.author,         /* author                          */
  parser_info.description,    /* description                     */
  PLUGIN_LICENSE_GPL,         /* plugin license                  */
  simple_parser_plugin_init,  /* init function (when loaded)     */
  simple_parser_plugin_deinit,/* deinit function (when unloaded) */
  0x0001,                     /* version                         */
  simple_status,              /* status variables                */
  simple_system_variables,    /* system variables                */
  NULL,
  0
}
mysql_declare_plugin_end;

서버 플러그인 인터페이스를 사용하면 플러그인이 일반 플러그인 디스크립터의 status_vars 회원 및 system_vars 멤버를 사용하여 상태 변수 및 시스템 변수를 노출 할 수 있습니다.

일반 플러그인 디스크립터의 status_vars 멤버는 0이 아닌 경우 st_mysql_show_var 구조체의 배열을 의미하며 각 구조는 하나의 상태 변수가 설명되어 있고, 모든 구성원이 0으로 설정된 구조가 뒤에 계속됩니다. st_mysql_show_var 구조체의 정의는 다음과 같습니다.

struct st_mysql_show_var {
  const char *name;
  char *value;
  enum enum_mysql_show_type type;
};

플러그인이 설치되면 플러그인 이름과 name 값이 밑줄로 결합되어 SHOW STATUS 에 표시되는 이름이 형성됩니다.

다음 표는 허용되는 상태 변수의 type 값 및 해당 변수를 보여줍니다.

SHOW_FUNC 유형의 경우 함수가 호출되면 함수는 out 매개 변수에 값을 설정하고 표시되는 변수에 대한 정보를이 매개 변수에 의해 제공됩니다. 함수의 시그니처는 다음과 같이됩니다.

#define SHOW_VAR_FUNC_BUFF_SIZE 1024

typedef int (*mysql_show_var_func) (void *thd,
                                    struct st_mysql_show_var *out,
                                    char *buf);

system_vars 멤버는 0이 아닌 경우 st_mysql_sys_var 구조체의 배열을 의미하며 각 구조는 하나의 시스템 변수가 설명되어 있고 (이것은 명령 행 또는 구성 파일에서 설정할 수 있습니다) 모든 멤버가 0으로 설정 된 구조가 후에 계속됩니다. st_mysql_sys_var 구조는 다음과 같이 정의합니다.

struct st_mysql_sys_var {
 int flags;
 const char *name, *comment;
 int (*check)(THD*, struct st_mysql_sys_var *, void*, st_mysql_value*);
 void (*update)(THD*, struct st_mysql_sys_var *, void*, const void*);
};

플래그에 의해 추가 필드가 필요에 따라 부가됩니다.

편의를 위해 플러그인의 새 시스템 변수의 생성을보다 쉽게​​하기위한 다수의 매크로가 정의되어 있습니다.

매크로는 다음 필드를 사용할 수 있습니다.

시스템 변수는 정적 변수를 사용하여 직접 방문하거나 SYSVAR() 액세스 기능 매크로를 사용하여 액세스 할 수 있습니다. 완전성을 기하기 위하여 SYSVAR() 매크로가 제공되고 있습니다. 일반적으로 코드 기반이되는 변수에 직접 액세스 할 수없는 경우에만 사용하십시오.

예 :

static int my_foo;
static MYSQL_SYSVAR_INT(foo_var, my_foo, 
                        PLUGIN_VAR_RQCMDARG, "foo comment", 
                        NULL, NULL, 0, 0, INT_MAX, 0);
 ...
   SYSVAR(foo_var)= value;
   value= SYSVAR(foo_var);
   my_foo= value; 
   value= my_foo;

세션 변수는 THDVAR() 액세스 기능 매크로를 통해서만 액세스 할 수 있습니다. 예 :

static MYSQL_THDVAR_BOOL(some_flag, 
                         PLUGIN_VAR_NOCMDARG, "flag comment",
                         NULL, NULL, FALSE);
 ...
   if (THDVAR(thd, some_flag))
   {
     do_something();
     THDVAR(thd, some_flag)= FALSE;
   }

모든 글로벌 시스템 변수 및 세션 시스템 변수는 사용하기 전에 mysqld에 공개해야합니다. 이것은 NULL 로 끝나는 변수의 배열을 만들고 플러그인 퍼블릭 인터페이스에서 그것에 연결하여 할 수 있습니다. 예 :

static struct st_mysql_sys_var *my_plugin_vars[]= {
  MYSQL_SYSVAR(foo_var),
  MYSQL_SYSVAR(some_flag),
  NULL
};
mysql_declare_plugin(fooplug)
{
  MYSQL_..._PLUGIN,
  &plugin_data,
  "fooplug",
  "foo author",
  "This does foo!",
  PLUGIN_LICENSE_GPL,
  foo_init,
  foo_fini,
  0x0001,
  NULL,
  my_plugin_vars,
  NULL,
  0
}
mysql_declare_plugin_end;

다음의 지원 매크로를 사용하면 다양한 종류의 시스템 변수를 선언 할 수 있습니다.

내부적으로 변경 될 수있는 모든 플러그인 시스템 변수는 HASH 구조에 저장됩니다.

서버의 명령 줄에서 도움말 텍스트 표시는 명령 행 옵션에 관련된 모든 변수 DYNAMIC_ARRAY 을 컴파일 순서대로 정렬하고 그것을 반복 옵션을 표시함으로써 처리됩니다.

명령 행 옵션이 처리되면 handle_option() 함수 ( my_getopt.c )에 의해 argv 로부터 제거되고 실질적으로 그 역할이 끝납니다.

서버 플러그인의 설치 과정 (플러그인이로드 된 직후하며 플러그인 초기화 함수를 호출하기 전에)에 명령 행 옵션을 처리합니다.

런타임에로드되는 플러그인은 구성 옵션을 사용할 수 없기 때문에 사용 가능한 기본값이 있어야합니다. 플러그인을 설치하면 mysqld의 초기화시에로드 된 구성 옵션을 명령 행 또는 my.cnf 에서 설정할 수 있습니다.

플러그인 thd 매개 변수를 읽기 전용으로하는 것을 고려하십시오.

각 클라이언트 플러그인은 클라이언트 플러그인 API에 정보를 제공하는 기술자가 필요합니다.기술자의 구조는 모든 클라이언트 플러그인에 공통되는 고정 된 일련의 멤버로 시작 플러그인 유형별 멤버가 후에 계속됩니다.

client_plugin.h 파일의 st_mysql_client_plugin 구조는 일반 멤버가 포함되어있는 " 일반적인 " 디스크립터를 정의합니다.

struct st_mysql_client_plugin
{
  int type;
  unsigned int interface_version;
  const char *name;
  const char *author;
  const char *desc;
  unsigned int version[3];
  const char *license;
  void *mysql_api;
  int (*init)(char *, size_t, int, va_list);
  int (*deinit)();
  int (*options)(const char *option, const void *);
};

st_mysql_client_plugin 디스크립터 구조의 일반 회원은 다음과 같이 사용합니다. char * 멤버는 NULL로 끝나는 문자열로 지정하십시오.

특정 클라이언트 플러그인 타입은 일반적인 기술자 멤버의 뒤에 해당 유형의 플러그인을 구현하는 데 필요한 추가 멤버가 따를 수 있습니다. 예를 들어, 인증 플러그인 st_mysql_client_plugin_AUTHENTICATION 구조는 인증을 수행하기 위해 클라이언트 라이브러리가 호출하는 함수가 마지막에 있습니다.

플러그인을 선언하려면 mysql_declare_client_plugin () 매크로 및 mysql_end_client_plugin 매크로를 사용합니다

mysql_declare_client_plugin(plugin_type)
   ... members common to all client plugins ...
   ... type-specific extra members ...
mysql_end_client_plugin;

type 또는 interface_version 멤버를 명시 적으로 지정하지 마십시오. mysql_declare_client_plugin () 매크로는 plugin_type 인수를 사용하여 이러한 값을 자동으로 생성합니다. 예를 들어, 인증 클라이언트 플러그인은 다음과 같이 선언합니다.

mysql_declare_client_plugin(AUTHENTICATION)
  "my_auth_plugin",
  "Author Name",
  "My Client Authentication Plugin",
  {1,0,0},
  "GPL",
  NULL,
  my_auth_init,
  my_auth_deinit,
  my_auth_options,
  my_auth_main
mysql_end_client_plugin;

이 선언은 AUTHENTICATION 인수를 사용하여 type 및 interface_version 회원 MYSQL_CLIENT_AUTHENTICATION_PLUGIN 및 MYSQL_CLIENT_AUTHENTICATION_PLUGIN_INTERFACE_VERSION 을 설정하고 있습니다.

플러그인 유형에 따라 기술자의 공통 멤버에 이어 다른 멤버가있을 수 있습니다. 예를 들어, 인증 플러그인의 경우, 서버와의 통신을 처리하는 함수 (위의 기술자가 my_auth_main () )가 있습니다. 섹션 24.2.4.9 "인증 플러그인 만들기" 를 참조하십시오.

일반적으로 인증 플러그인의 사용을 지원하는 클라이언트 프로그램은 mysql_options () 를 호출 MYSQL_DEFAULT_AUTH 옵션 및 MYSQL_PLUGIN_DIR 옵션을 설정하여 플러그인을로드합니다.

char *plugin_dir = "path_to_plugin_dir";
char *default_auth = "plugin_name";

/* ... process command-line options ... */

mysql_options(&mysql, MYSQL_PLUGIN_DIR, plugin_dir);
mysql_options(&mysql, MYSQL_DEFAULT_AUTH, default_auth);

일반적으로 프로그램은 사용자가 기본값을 대체 할 수있는 --plugin-dir 및 --default-auth 옵션도 사용할 수 있습니다.

클라이언트 프로그램에서 낮은 수준의 플러그인 관리가 필요한 경우 클라이언트 라이브러리에 st_mysql_client_plugin 인수를 함수를 포함합니다. 섹션 23.8.14 "C API 클라이언트 플러그인 함수" 를 참조하십시오.