전체 파서 플러그인을 설명하기 위해 플러그인 소스 파일에서 다음의 헤더 파일을 포함합니다. 플러그인의 기능 및 요구 사항에 따라 다른 MySQL의 헤더 파일이나 일반적인 헤더 파일이 필요할 수도 있습니다.

#include <mysql/plugin.h>

plugin.h 은 MYSQL_FTPARSER_PLUGIN 서버 플러그인 유형 및 플러그인을 선언하는 데 필요한 데이터 구조를 정의합니다.

플러그인 라이브러리 파일의 라이브러리 디스크립터를 설치합니다.

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

예를 들어, 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;

name 멤버 ( simple_parser )는 INSTALL PLUGIN , UNINSTALL PLUGIN 등의 문에서 플러그인을 참조하는 데 사용하는 이름을 보여줍니다. 이것은 SHOW PLUGINS 또는 INFORMATION_SCHEMA.PLUGINS 에 의해 표시되는 이름이기도합니다.

자세한 내용은 섹션 24.2.4.2.1 "서버 플러그인 라이브러리 및 플러그인 기술자" 를 참조하십시오.

유형별 플러그인 디스크립터를 설치합니다.

라이브러리 디스크립터의 각 일반 플러그인 디스크립터는 유형별 디스크립터를 가리 킵니다. 전체 파서 플러그인의 경우 유형별 기술자는 plugin.h 파일의 st_mysql_ftparser 구조체의 인스턴스입니다.

struct st_mysql_ftparser
{
  int interface_version;
  int (*parse)(MYSQL_FTPARSER_PARAM *param);
  int (*init)(MYSQL_FTPARSER_PARAM *param);
  int (*deinit)(MYSQL_FTPARSER_PARAM *param);
};

구조체 정의에 표시된대로 디스크립터는 인터페이스 버전 번호가 3 개의 함수 포인터가 포함되어 있습니다.

인터페이스의 버전 번호는 기호를 사용하여 지정하고 MYSQL_ xxx _INTERFACE_VERSION 형식입니다. 전체 파서 플러그인의 경우, 기호는 " MYSQL_FTPARSER_INTERFACE_VERSION "입니다. 소스 코드는 include/mysql/plugin_ftparser.h 에 정의되어있는 전문 파서 플러그인의 실제 인터페이스 버전 번호가 있습니다.

init 회원 및 deinit 멤버 함수를 가리 키도록하거나 함수가 불필요한 경우는 0으로 설정합니다. parse 멤버는 구문 분석을 수행하는 함수를 가리키는해야합니다.

simple_parser 선언은 그 기술자는 &simple_parser_descriptor 로 표시되어 있습니다. 기술자는 전문 플러그인 인터페이스의 버전 번호 ( MYSQL_FTPARSER_INTERFACE_VERSION 의해 지정됩니다) 플러그인의 구문 분석 함수 초기화 함수 및 초기화 해제 함수를 지정합니다.

static struct st_mysql_ftparser simple_parser_descriptor=
{
  MYSQL_FTPARSER_INTERFACE_VERSION, /* interface version      */
  simple_parser_parse,              /* parsing function       */
  simple_parser_init,               /* parser init function   */
  simple_parser_deinit              /* parser deinit function */
};

전체 파서 서버 플러그인에는 인덱싱 및 검색의 두 가지 맥락에서 사용됩니다. 모두의 컨텍스트에서 서버 플러그인을 호출 한 각 SQL 문 처리의 시작과 종료시에 초기화 함수 및 초기화 해제 함수를 호출합니다. 그러나 문을 처리하는 동안 서버 컨텍스트에 고유의 방법으로 주요 구문 분석 함수를 호출합니다.

일반 플러그인 기술자 플러그인 선언에는 초기화 함수 및 초기화 해제 함수를 가리키는 init 회원 및 deinit 멤버가 있고, 가리키는 대상 유형별 플러그인 디스크립터에도이 있습니다. 그러나 이러한 함수 쌍 목적이 다릅니다 다른 이유로 호출됩니다.

플러그인 디스크립터에 지정되어있는 각 인터페이스 함수는 성공의 경우는 제로, 그리고 실패의 경우는 0이 아닌 리턴 구문 분석하는 컨텍스트가 포함되어있는 MYSQL_FTPARSER_PARAM 구조체를 가리키는 인수를받습니다. 이 구조체의 정의는 다음과 같습니다.

typedef struct st_mysql_ftparser_param
{
  int (*mysql_parse)(struct st_mysql_ftparser_param *,
                     char *doc, int doc_len);
  int (*mysql_add_word)(struct st_mysql_ftparser_param *,
                        char *word, int word_len,
                        MYSQL_FTPARSER_BOOLEAN_INFO *boolean_info);
  void *ftparser_state;
  void *mysql_ftparam;
  struct charset_info_st *cs;
  char *doc;
  int length;
  int flags;
  enum enum_ftparser_mode mode;
} MYSQL_FTPARSER_PARAM;

구조체 멤버는 다음과 같이 사용됩니다.

파서가 boolean 모드로 불려 갔을 경우 param->mode 값은 MYSQL_FTPARSER_FULL_BOOLEAN_INFO 됩니다. 서버에 토큰 정보를 전달하는 파서가 사용하는 MYSQL_FTPARSER_BOOLEAN_INFO 구조는 다음과 같습니다.

typedef struct st_mysql_ftparser_boolean_info
{
  enum enum_ft_token_type type;
  int yesno;
  int weight_adjust;
  char wasign;
  char trunc;
  /* These are parser state and must be removed. */
  char prev;
  char *quot;
} MYSQL_FTPARSER_BOOLEAN_INFO;

파서는 구조체 멤버에 다음과 같이 값을 설정합니다.

플러그인 MYSQL_FTPARSER_BOOLEAN_INFO 구조 prev 회원 및 quot 멤버를 사용하지 마십시오.

플러그인 인터페이스 함수를 설정합니다.

라이브러리 디스크립터의 일반 플러그인 디스크립터는 서버가 플러그인을로드 및 언로드 할 때 호출 초기화 함수 및 초기화 해제 함수를 지정합니다. simple_parser 의 경우,이 함수는 아무것도 실시하지 않지만 성공한 것을 나타 내기 위해 제로를 돌려줍니다.

static int simple_parser_plugin_init(void *arg __attribute__((unused)))
{
  return(0);
}

static int simple_parser_plugin_deinit(void *arg __attribute__((unused)))
{
  return(0);
}

이 함수는 실제로 아무것도하지 않기 때문에 이들을 생략하여 플러그인 선언에서 각각 0을 지정할 수 있습니다.

simple_parser 의 유형별 플러그인 디스크립터는 플러그인이 사용되는 경우 서버가 호출 초기화 함수 초기화 해제 함수 및 구문 분석 함수를 지정합니다. simple_parser 의 경우 초기화 함수 및 초기화 해제 함수는 아무것도 실시하지 않습니다.

static int simple_parser_init(MYSQL_FTPARSER_PARAM *param
                              __attribute__((unused)))
{
  return(0);
}

static int simple_parser_deinit(MYSQL_FTPARSER_PARAM *param
                                __attribute__((unused)))
{
  return(0);
}

다시 말하지만,이 함수는 아무것도하지 않기 때문에 이들을 생략하여 플러그인 기술자 각각에 0을 지정할 수 있습니다.

주요 구문 분석 함수 simple_parser_parse() 은 내장 전체 파서 대신 작동하기 때문에 텍스트를 단어로 분할하여 각 단어를 서버에 전달해야합니다. 구문 분석 함수의 첫 번째 인수는 구문 분석하는 컨텍스트가 포함 된 구조체에 대한 포인터입니다. 이 구조체는 구문 분석되는 텍스트를 가리키는 doc 멤버 및 텍스트의 길이를 나타내는 length 멤버가 있습니다. 이 플러그인에 의해 실행되는 간단한 구문 분석에서는 공백이없는 문자열을 단어로 간주하므로 다음과 같이 단어를 식별합니다.

static int simple_parser_parse(MYSQL_FTPARSER_PARAM *param)
{
  char *end, *start, *docend= param->doc + param->length;

  for (end= start= param->doc;; end++)
  {
    if (end == docend)
    {
      if (end > start)
        add_word(param, start, end - start);
      break;
    }
    else if (isspace(*end))
    {
      if (end > start)
        add_word(param, start, end - start);
      start= end + 1;
    }
  }
  return(0);
}

파서는 단어를 검색 할 때마다 함수 add_word() 를 호출하여 단어를 서버에 전달합니다. add_word() 헬퍼 함수에 불과해 플러그인 인터페이스의 일부가 아닙니다. 파서는 구문 분석되는 컨텍스트에 대한 포인터 단어 포인터 및 길이 값을 add_word() 에 전달합니다.

static void add_word(MYSQL_FTPARSER_PARAM *param, char *word, size_t len)
{
  MYSQL_FTPARSER_BOOLEAN_INFO bool_info=
    { FT_TOKEN_WORD, 0, 0, 0, 0, ' ', 0 };

  param->mysql_add_word(param, word, len, &bool_info);
}

boolean 모드 구문 분석의 경우 앞에 st_mysql_ftparser_boolean_info 구조의 설명에 나타낸 바와 같이, add_word() 는 bool_info 구조체 멤버에 값을 설정합니다.

상태 변수를 설정합니다. simple_parser 플러그인의 경우 다음 상태 변수의 배열은 하나의 상태 변수를 정적 텍스트 값으로 설정하고 다른 상태 변수를 long 정수 변수에 저장되어있는 값으로 설정하고 있습니다.

long number_of_calls= 0;

struct st_mysql_show_var simple_status[]=
{
  {"static", (char *)"just a static text", SHOW_CHAR},
  {"called", (char *)&number_of_calls,     SHOW_LONG},
  {0,0,0}
};

플러그인이 설치되면 플러그인 이름과 name 값이 밑줄로 결합되어 SHOW STATUS 에 표시되는 이름이 형성됩니다. 위의 배열의 경우 생성 된 상태 변수 이름은 simple_parser_static 및 simple_parser_called 입니다. 이 규칙은 플러그인의 변수를 플러그인 이름을 사용하여 쉽게 볼 수 있다는 것을 의미합니다.

mysql> SHOW STATUS LIKE 'simple_parser%';
+----------------------+--------------------+
| Variable_name        | Value              |
+----------------------+--------------------+
| simple_parser_static | just a static text |
| simple_parser_called | 0                  |
+----------------------+--------------------+

플러그인 라이브러리의 오브젝트 파일을 컴파일 및 설치하려면 섹션 24.2.4.3 "플러그인 라이브러리의 컴파일 및 설치" 단계를 사용합니다. 라이브러리 파일을 사용하려면 라이브러리 파일이 플러그인 디렉토리 ( plugin_dir 시스템 변수에 지정된 디렉토리)에 설치되어 있어야합니다. simple_parser 플러그인의 경우 소스에서 MySQL을 빌드 할 때 컴파일 및 설치됩니다. 이것은 바이너리 배포판에 포함됩니다. 빌드 프로세스에서는 mypluglib.so 라는 공유 객체 라이브러리가 생성됩니다 (접미사는 플랫폼에 따라 달라질 수 있습니다.)

플러그인을 사용하려면 플러그인을 서버에 등록합니다. 예를 들어, 플러그인을 실행시에 등록하려면 다음 문을 사용합니다 (필요에 따라 접미사를 변경합니다).

mysql> INSTALL PLUGIN simple_parser SONAME 'mypluglib.so';

플러그인 로딩에 대한 추가 정보는 섹션 5.1.8.1 "플러그인 설치 및 제거" 를 참조하십시오.

플러그인의 설치를 확인하려면 INFORMATION_SCHEMA.PLUGINS 테이블을 조사하거나 SHOW PLUGINS 문을 사용합니다.

플러그인을 테스트하여 올바르게 작동하는지 확인합니다.

문자열 컬럼을 포함하는 테이블을 만들고 파서 플러그 인을 그 컬럼의 FULLTEXT 인덱스에 연결합니다.

mysql> CREATE TABLE t (c VARCHAR(255),
    ->   FULLTEXT (c) WITH PARSER simple_parser
    -> ) ENGINE=MyISAM;
Query OK, 0 rows affected (0.01 sec)

이 테이블에 일부 텍스트를 삽입하여 검색을 실행합니다. 이에 따라 파서 플러그인은 공백이 아닌 모든 문자를 단어 문자로 처리하는 것이 확인됩니다.

mysql> INSERT INTO t VALUES
    ->   ('latin1_general_cs is a case-sensitive collation'),
    ->   ('I\'d like a case of oranges'),
    ->   ('this is sensitive information'),
    ->   ('another row'),
    ->   ('yet another row');
Query OK, 5 rows affected (0.02 sec)
Records: 5  Duplicates: 0  Warnings: 0

mysql> SELECT c FROM t;
+-------------------------------------------------+
| c                                               |
+-------------------------------------------------+
| latin1_general_cs is a case-sensitive collation |
| I'd like a case of oranges                      |
| this is sensitive information                   |
| another row                                     |
| yet another row                                 |
+-------------------------------------------------+
5 rows in set (0.00 sec)

mysql> SELECT MATCH(c) AGAINST('case') FROM t;
+--------------------------+
| MATCH(c) AGAINST('case') |
+--------------------------+
|                        0 |
|          1.2968142032623 |
|                        0 |
|                        0 |
|                        0 |
+--------------------------+
5 rows in set (0.00 sec)

mysql> SELECT MATCH(c) AGAINST('sensitive') FROM t;
+-------------------------------+
| MATCH(c) AGAINST('sensitive') |
+-------------------------------+
|                             0 |
|                             0 |
|               1.3253291845322 |
|                             0 |
|                             0 |
+-------------------------------+
5 rows in set (0.01 sec)

mysql> SELECT MATCH(c) AGAINST('case-sensitive') FROM t;
+------------------------------------+
| MATCH(c) AGAINST('case-sensitive') |
+------------------------------------+
|                    1.3109166622162 |
|                                  0 |
|                                  0 |
|                                  0 |
|                                  0 |
+------------------------------------+
5 rows in set (0.01 sec)

mysql> SELECT MATCH(c) AGAINST('I\'d') FROM t;
+--------------------------+
| MATCH(c) AGAINST('I\'d') |
+--------------------------+
|                        0 |
|          1.2968142032623 |
|                        0 |
|                        0 |
|                        0 |
+--------------------------+
5 rows in set (0.01 sec)

내장 파서와는 달리 "case"및 "insensitive"는 "case-insensitive"과 일치하지 않습니다.