如何給MySQL添加自定義語法的方法示例

Posted on by

1 背景

MySQL語法解析器用的bison（即yacc）來實現的，而詞法解析是自己來實現的，涉及到的token都在文件lex.h裡面，然後通過Lex_input_stream 裡面相關的函數，解析client的sql字節流（其中會通過提前構造好的hash表幫助快速找到對應symbol，相關代碼在sql_lex_hash.cc裡面），轉換為token，交給bison進行語法解析。

為瞭給MySQL添加一個新的語法，我們必須添加新的token（如果有新增），以及增加新的語法（sql_yacc.yy）裡面。本文以給create table增加一個新的options為例，來演示如何給MySQL新增一個語法。最終的效果如下：

create table t1 (
  id int primary key,
  name varchar(100)
) global_partition by hash(id) partitions 10; //global_partition by為新增語法，global_partition為新增token

涉及到的修改文件如下：

sql/lex.h //token
sql/parse_tree_nodes.cc
sql/parse_tree_nodes.h
sql/parse_tree_partitions.cc
sql/parse_tree_partitions.h
sql/parser_yystype.h
sql/sql_yacc.yy

2 新增關鍵詞（token）

文件：sql/lex.h

static const SYMBOL symbols[] = {
    /*
     Insert new SQL keywords after that commentary (by alphabetical order):
    */
    //省略部分代碼
    {SYM("GLOBAL_PARTITION", GLOBAL_PARTITION_SYM)}, //註意按照字典序進行添加。
    //省略部分代碼
};

按照上面的格式添加即可

3 新增語法

文件：sql/sql_yacc.yy

該文件為bison的語法，關於bison語法可以查看這裡。下面凡是註釋標有###為新增部分，沒有標的註釋是為瞭方便理解

%token<lexer.keyword> GLOBAL_PARTITION_SYM 1309            /* seancheer */  //### 聲明上一步添加的token，聲明瞭才可以使用，編號1309選擇一個未使用的就行
%type <global_partition_clause> global_partition_clause //### 聲明新增加的數據結構，後面會介紹

create_table_stmt:
          CREATE opt_temporary TABLE_SYM opt_if_not_exists table_ident
          '(' table_element_list ')' opt_create_table_options_etc //最後一個標記在YYSTYPE中對應的是create_table_tail， 後面會介紹
          {
            $$= NEW_PTN PT_create_table_stmt(YYMEM_ROOT, $1, $2, $4, $5,
                                             $7,
                                             $9.opt_create_table_options,
                                             $9.opt_partitioning,
                                             $9.opt_global_partitioning, //### 賦值給對應參數，該構造函數需要新增，後面會介紹
                                             $9.on_duplicate,
                                             $9.opt_query_expression);
          }
        | CREATE opt_temporary TABLE_SYM opt_if_not_exists table_ident
          opt_create_table_options_etc
          {
            $$= NEW_PTN PT_create_table_stmt(YYMEM_ROOT, $1, $2, $4, $5,
                                             NULL,
                                             $6.opt_create_table_options,
                                             $6.opt_partitioning,
                                             $6.opt_global_partitioning, //### 賦值給對應參數，該構造函數需要新增，後面會介紹
                                             $6.on_duplicate,
                                             $6.opt_query_expression);
//partition相關的語法                                             
opt_create_partitioning_etc:
          partition_clause opt_duplicate_as_qe //這裡是原生的partition表語法
          {
            $$= $2;
            $$.opt_partitioning= $1;
          }
        | global_partition_clause opt_duplicate_as_qe //### 此處是新增的global_partition語法，
          {
            $$= $2;
            $$.opt_global_partitioning= $1;
          }
        | opt_duplicate_as_qe
        ;

//### 下面為重點，新增的global_partition語法，可以看到，用到瞭新增的token
global_partition_clause:
          GLOBAL_PARTITION_SYM BY part_type_def opt_num_parts
          {
            $$= NEW_PTN PT_global_partition($3, @4, $4);
          }
        ;

4 類似於PT_partition添加對應的數據結構global_partition_clause

文件：parser_yystype.h：該文件是bison（yacc）運行的一環，代替bison內置的YYSTYPE的，當bison對相關語法解析後，需要構造相關的數據結構，通過對YYSTYPE的自定義，就可以實現構造自定義數據結構的目的瞭。添加我們自定義的數據結構代碼如下：

union YYSTYPE {
  PT_sub_partition *opt_sub_part;
  PT_part_type_def *part_type_def;
  PT_partition *partition_clause;
  PT_global_partition *global_partition_clause; //新加數據結構
  
  struct {
    Mem_root_array<PT_create_table_option *> *opt_create_table_options;
    PT_partition *opt_partitioning;
    PT_global_partition *opt_global_partitioning; //同時註意添加到create_table_tail裡面，因為create table語法會有該操作
    On_duplicate on_duplicate;
    PT_query_primary *opt_query_expression;
  } create_table_tail;
};
static_assert(sizeof(YYSTYPE) <= 40, "YYSTYPE is too big"); //因為struct裡面添加瞭一個成員變量，所以該union需要的空間也會變大，因此註意修改這一行

下面內容介紹PT_global_partition數據結構，為瞭保持和MySQL習慣一致，新增加的數據結構放在瞭

sql/parse_tree_nodes.cc sql/parse_tree_nodes.h sql/parse_tree_partitions.cc sql/parse_tree_partitions.h

四個文件裡，理論上可以放在任何地方。可根據自身需求添加對應數據結構：

文件：sql/parse_tree_partitions.h sql/parse_tree_partitions.cc

/**
新增數據結構
*/
class PT_global_partition : public Parse_tree_node {
    typedef Parse_tree_node super;

    PT_part_type_def *const part_type_def;
    const POS part_defs_pos;
    uint num_parts;
public:
    partition_info part_info;
public:
    PT_global_partition(PT_part_type_def *part_type_def, const POS &part_defs_pos,
                        uint opt_num_parts)
            : part_type_def(part_type_def),
              part_defs_pos(part_defs_pos),
              num_parts(opt_num_parts) {}
    bool contextualize(Parse_context *pc) override;
};

//模仿其原生的實現方式即可
bool PT_global_partition::contextualize(Parse_context *pc) {
    if (super::contextualize(pc)) return true;

    Partition_parse_context part_pc(pc->thd, &part_info, false);
    if (part_type_def->contextualize(&part_pc)) return true;

    if (part_info.part_type != partition_type::HASH) {
        //only support hash partition for shard key
        my_error(ER_PARTITIONS_MUST_BE_DEFINED_ERROR, MYF(0), "NOT HASH");
        return true;
    }

    uint count_curr_parts = part_info.partitions.elements;

    if (part_info.num_parts != 0) {
        if (part_info.num_parts != count_curr_parts) {
            error(&part_pc, part_defs_pos,
                  ER_THD(pc->thd, ER_PARTITION_WRONG_NO_PART_ERROR));
            return true;
        }
    } else if (count_curr_parts > 0)
        part_info.num_parts = count_curr_parts;
    return false;
}

文件：sql/parse_tree_nodes.cc sql/parse_tree_nodes.h

接下來修改create table對應的數據結構，將新增的PT_global_partition添加到create table裡面

class PT_create_table_stmt final : public PT_table_ddl_stmt_base {
  PT_partition *opt_partitioning;
  PT_global_partition *opt_global_partitioning; //添加成員變量
  PT_create_table_stmt(
    MEM_ROOT *mem_root, PT_hint_list *opt_hints, bool is_temporary,
    bool only_if_not_exists, Table_ident *table_name,
    const Mem_root_array<PT_table_element *> *opt_table_element_list,
    const Mem_root_array<PT_create_table_option *> *opt_create_table_options,
    PT_partition *opt_partitioning,
    PT_global_partition *opt_global_partitioning, On_duplicate on_duplicate,
    PT_query_primary *opt_query_expression)
    : PT_table_ddl_stmt_base(mem_root),
  m_opt_hints(opt_hints),
  is_temporary(is_temporary),
  only_if_not_exists(only_if_not_exists),
  table_name(table_name),
  opt_table_element_list(opt_table_element_list),
  opt_create_table_options(opt_create_table_options),
  opt_partitioning(opt_partitioning),
  opt_global_partitioning(opt_global_partitioning), //添加構造函數，主要是為瞭增加對PT_global_partition的賦值操作
  on_duplicate(on_duplicate),
  opt_query_expression(opt_query_expression),
  opt_like_clause(nullptr) {}
  
//在其對應的函數中增加相關邏輯，調用對應的初始化函數contextualize
Sql_cmd *PT_create_table_stmt::make_cmd(THD *thd) {
    if (opt_global_partitioning){
        if (opt_global_partitioning->contextualize(&pc)) return nullptr;
        lex->part_info = &opt_global_partitioning->part_info;
    }
}

 到此這篇關於如何給MySQL添加自定義語法的方法示例的文章就介紹到這瞭,更多相關MySQL添加自定義語法內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：