若要編寫全文解析器外掛程式，請在此外掛程式原始檔中加入下列標頭檔。視外掛程式的功能和需求而定，可能也需要其他 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 所顯示的名稱。

如需詳細資訊，請參閱 第 4.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);
};

如結構定義所示，描述符具有介面版本號碼，並包含指向三個函式的指標。

介面版本號碼會使用符號 (格式為：MYSQL_xxx_INTERFACE_VERSION) 指定。對於全文解析器外掛程式，此符號為 MYSQL_FTPARSER_INTERFACE_VERSION。在原始碼中，您會發現全文解析器外掛程式的實際介面版本號碼定義於 include/mysql/plugin_ftparser.h 中。目前的介面版本號碼為 0x0101。

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 成員，其指向的類型特定外掛程式描述符也是如此。不過，這些函式配對有不同的用途，而且會因不同的原因而叫用。

外掛程式描述符中命名的每個介面函式都應該傳回零 (表示成功) 或非零 (表示失敗)，而且每個介面函式都會接收指向包含剖析內容的 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;

結構成員的使用方式如下：

如果剖析器在布林模式下被呼叫，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;
  int position;
  /* 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, ' ', 0 };

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

對於布林模式剖析，add_word() 會按照先前關於 st_mysql_ftparser_boolean_info 結構的討論所述，填寫 bool_info 結構的成員。

設定狀態變數。對於 simple_parser 外掛程式，以下狀態變數陣列會設定一個值為靜態文字的狀態變數，以及另一個值儲存在長整數變數中的狀態變數。

long number_of_calls= 0;

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

透過使用以外掛程式名稱開頭的狀態變數名稱，您可以使用 SHOW STATUS 輕鬆顯示外掛程式的變數。

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

若要編譯並安裝外掛程式程式庫檔案，請使用第 4.4.3 節「編譯與安裝外掛程式程式庫」中的說明。若要使程式庫檔案可供使用，請將其安裝在外掛程式目錄中（由 plugin_dir 系統變數命名的目錄）。對於 simple_parser 外掛程式，當您從原始碼建置 MySQL 時，它會被編譯和安裝。它也包含在二進位散發版本中。建置過程會產生一個名為 mypluglib.so 的共用物件程式庫（.so 副檔名可能會因您的平台而異）。

若要使用外掛程式，請向伺服器註冊它。例如，若要在執行階段註冊外掛程式，請使用此陳述式，並根據您的平台調整 .so 副檔名：

INSTALL PLUGIN simple_parser SONAME 'mypluglib.so';

有關外掛程式載入的更多資訊，請參閱安裝和解除安裝外掛程式。

若要驗證外掛程式安裝，請檢查 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
    ->   ('utf8mb4_0900_as_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                                                |
+--------------------------------------------------+
| utf8mb4_0900_as_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」 匹配。