16.4. 创建handlerton

优质

小牛编辑

136浏览

2023-12-01

handlerton（“单个处理程序”的简称）定义了存储引擎，并包含指向函数的函数指针，它以整体方式作用在引擎上，而函数工作在单独的处理程序实例中。在这类函数的一些示例中，包含用于处理注释和回滚的事务函数。

下面给出了一个来自EXAMPLE存储引擎的示例：

handlerton example_hton= {

  "EXAMPLE",

  SHOW_OPTION_YES,

  "Example storage engine",

  DB_TYPE_EXAMPLE_DB,

  NULL,    /* Initialize */

  0,       /* slot */

  0,       /* savepoint size. */

  NULL,    /* close_connection */

  NULL,    /* savepoint */

  NULL,    /* rollback to savepoint */

  NULL,    /* release savepoint */

  NULL,    /* commit */

  NULL,    /* rollback */

  NULL,    /* prepare */

  NULL,    /* recover */

  NULL,    /* commit_by_xid */

  NULL,    /* rollback_by_xid */

  NULL,    /* create_cursor_read_view */

  NULL,    /* set_cursor_read_view */

  NULL,    /* close_cursor_read_view */

  example_create_handler,    /* Create a new handler */

  NULL,    /* Drop a database */

  NULL,    /* Panic call */

  NULL,    /* Release temporary latches */

  NULL,    /* Update Statistics */

  NULL,    /* Start Consistent Snapshot */

  NULL,    /* Flush logs */

  NULL,    /* Show status */

  NULL,    /* Replication Report Sent Binlog */

  HTON_CAN_RECREATE

};

下面给出了来自handler.h的handlerton定义：

typedef struct

    const char *name;

    SHOW_COMP_OPTION state;

    const char *comment;

    enum db_type db_type;

    bool (*init)();

    uint slot;

    uint savepoint_offset;

    int  (*close_connection)(THD *thd);

    int  (*savepoint_set)(THD *thd, void *sv);

    int  (*savepoint_rollback)(THD *thd, void *sv);

    int  (*savepoint_release)(THD *thd, void *sv);

    int  (*commit)(THD *thd, bool all);

    int  (*rollback)(THD *thd, bool all);

    int  (*prepare)(THD *thd, bool all);

    int  (*recover)(XID *xid_list, uint len);

    int  (*commit_by_xid)(XID *xid);

    int  (*rollback_by_xid)(XID *xid);

    void *(*create_cursor_read_view)();

    void (*set_cursor_read_view)(void *);

    void (*close_cursor_read_view)(void *);

    handler *(*create)(TABLE *table);

    void (*drop_database)(char* path);

    int (*panic)(enum ha_panic_function flag);

    int (*release_temporary_latches)(THD *thd);

    int (*update_statistics)();

    int (*start_consistent_snapshot)(THD *thd);

    bool (*flush_logs)();

    bool (*show_status)(THD *thd, stat_print_fn *print, enum ha_stat_type stat);

    int (*repl_report_sent_binlog)(THD *thd, char *log_file_name, my_off_t end_offset);

    uint32 flags;

  } handlerton;

共有30个handlerton元素，但只有少量元素是强制性的（明确地讲是前4个元素和第21个元素）。

1. 存储引擎的名称。这是创建表时将使用的名称（CREATE TABLE ... ENGINE = FOO;）。

2. 确定使用SHOW STORAGE ENGINES命令时是否列出存储引擎。

3. 存储引擎注释，对使用SHOW STORAGE ENGINES命令时显示的存储引擎的描述。

4. 在MySQL服务器内唯一识别存储引擎的整数。内置存储引擎使用的常数定义在handler.h文件中。作为创建常数的可选方法，可使用大于25的整数。

5. 指向存储引擎初始化程序的指针。仅当启动服务器时才调用该函数，以便在实例化处理程序之前，存储引擎类能执行必要的内务操作。

6. 插槽。保存每连接的信息时，每个存储引擎在thd中有自己的内存区域（实际上为指针）。它是作为thd->ha_data[foo_hton.slot]访问的。插槽编号在调用foo_init()后由MySQL初始化。

7. 保存点偏移。为了保存每个savepoint数据，为存储引擎提供了请求的大小（典型情况下为0）。

必须以静态方式初始化savepoint偏移，使其具有所有的内存大小，以便保存每个savepoint的信息。在foo_init之后，它被更改为savepoint存储区域的偏移，存储引擎不需要使用它。

8. 由事务性存储引擎使用，清理其存储段内分配的内存，和／或回滚任何未完成的事务。

9. 由事务性存储引擎选择性使用，创建savepoint（保存点），并将其保存到提供的内存中。

10.指向处理程序rollback_to_savepoint()函数的函数指针。它用于在事务期间返回savepoint。仅对支持保存点的存储引擎才会填充它。

11.指向处理程序release_savepoint()函数的函数指针。它用于在事务期间释放保存点的资源。仅对支持保存点的存储引擎才会填充它。

12.指向处理程序commit()函数的函数指针。它用于提交事务。仅对支持事务的存储引擎才会填充它。

13.指向处理程序rollback()函数的函数指针。它用于回滚交易。仅对支持事务的存储引擎才会填充它。

14.XA事务性存储引擎所需。为提交操作准备事务。将XID与事务关联起来。

15.XA事务性存储引擎所需。恢复由XID标识的事务。

16.XA事务性存储引擎所需。提交由XID标识的事务。

17.XA事务性存储引擎所需。回滚由XID标识的事务。

18.与服务器端光标一起使用，尚未实施。

19.与服务器端光标一起使用，尚未实施。

20.与服务器端光标一起使用，尚未实施。

21.MANDATORY：构造并返回处理程序实例。

22.撤销方案时，如果存储引擎需要执行特殊步骤时使用（如在使用表空间的存储引擎中使用）。

23.清理在服务器关闭和崩溃时调用的函数。

24.InnoDB特殊函数。

25.在启动SHOW STATUS时调用InnoDB特殊函数。

26.调用InnoDB特殊函数以开始连续读取。

27.调用它，指明应将日志刷新为可靠的存储。

28.在存储引擎上提供可被人员读取的状态信息。

29.InnoDB特殊函数用于复制。

30.Handlerton标志，通常与ALTER TABLE相关。可能的值定义于sql/handler.h文件中，并在此列出；

31.       #define HTON_NO_FLAGS 0

32.       #define HTON_CLOSE_CURSORS_AT_COMMIT (1 << 0)

33.       #define HTON_ALTER_NOT_SUPPORTED     (1 << 1)

34.       #define HTON_CAN_RECREATE    (1 << 2)

35.       #define HTON_FLUSH_AFTER_RENAME      (1 << 3)

36.       #define HTON_NOT_USER_SELECTABLE     (1 << 4)

HTON_ALTER_NOT_SUPPORTED由FEDERATED存储引擎使用，用以指明存储引擎不接受AFTER TABLE语句。

HTON_FLUSH_AFTER_RENAME指明，重命名表后，必须调用FLUSH LOGS。

HTON_NOT_USER_SELECTABLE指明存储引擎不能由用户选择，而是用作系统存储引擎，如用于二进制日志的伪存储引擎。