OpenGauss Gin 索引

概述

GIN（Generalized Inverted Index）通用倒排索引，是首选的文本搜索索引类型。倒排索引对应的列上的数据类型通常是一个多值类型，索引中包含每个单词的索引条目，以及所匹配的位置的压缩列表。如果搜索条件是多个单词，可以先使用第一个单词进行匹配，再在找到的结果中使用其他单词删除不匹配的项。Gin 索引的 key 是多值类型中出现的单词，叶子节点中存储了每个单词出现的 TID 的列表。如果这个 TID 列表比较小，它可以和元素放在同一个页面中（称为 posting list）。如果列表比较大，就需要用到更高效的数据结构 B-tree，这样的 B-tree 位于单独的数据页上（称为 posting tree）。

索引结构

Gin 索引大的组织结构是一棵B-tree(结构是 blink-tree， 和 OpenGauss 的 btree 索引结构上相似，但 gin 索引不需要支持逆向 scan，只需要指向右兄弟节点的 link ptr) 如图-1 所示
其中也有 meta-page、root-page 等 page，如果一个 key 对应的 tids 比较少可以和 key 放在同一个 page 中作为叶子节点； 如果对应的 tids 比较多(占用的空间的大小)，需要将这些 tids 放到单独的数据页上，并且以 B-tree 的形式组织方便快速查找，叶子节点中记录对应的 B-tree 的 root-page 的信息。

语法

CREATE INDEX name ON table USING GIN (column);
OpenGauss 中创建 gin 索引时，索引列的类型必须是 tsvector 类型。

Example:

postgres=# create table ts(doc text, doc_tsv tsvector);

postgres=# insert into ts(doc) values
  ('Can a sheet slitter slit sheets?'), 
  ('How many sheets could a sheet slitter slit?'),
  ('I slit a sheet, a sheet I slit.'),
  ('Upon a slitted sheet I sit.'), 
  ('Whoever slit the sheets is a good sheet slitter.'), 
  ('I am a sheet slitter.'),
  ('I slit sheets.'),
  ('I am the sleekest sheet slitter that ever slit sheets.'),
  ('She slits the sheet she sits on.');

postgres=# update ts set doc_tsv = to_tsvector(doc);

postgres=# create index on ts using gin(doc_tsv);

查询一个既包含 many 又包含 slitter 的 doc 如下：

实现

Gin 索引的实现主要在 src/gausskernel/storage/access/gin 下，主要文件及功能如下：

查看 pg_am 中 Gin 索引相关处理函数:

构建 Gin 索引

ginbuild
{
    ...
    // 初始化工作，如 创建 gin 索引的 meta 和 root，记 XLOG 等
    buildInitialize(index, &buildstate);
    // scan heap tuples 调用 ginBuildCallback 处理每个要加入索引的 tuple
    // ginBuildCallback 会从 heap tuple 中提取 entries，如果有多个值
    // 会对这些值进行去重和排序。得到去重及排完序的 entries 后，调用 ginInsertBAEntries  
    // 将这些 entries  及 对应的 tids 插入一棵RB-tree
    reltuples = tableam_index_build_scan(heap, index, indexInfo, false, ginBuildCallback, (void*)&buildstate);
    ...
    // 从RB-tree中把之前插入的 entries 和 tids scan 出来，插入到 gin index 中
    while ((list = ginGetBAEntry(&buildstate.accum, &attnum, &key, &category, &nlist)) != NULL) {
        /* there could be many entries, so be willing to abort here */
        CHECK_FOR_INTERRUPTS();
        // 如果 key 不存在，则新增一个 key entry，如果已经存在则更新对应的 tids
        // 首先在gin索引中查找到对应 key 的叶子节点，如果 key 已经存在，更新对应的 tids
        // 不存在则插入一个新的叶子节点
        ginEntryInsert(&buildstate.ginstate, attnum, key, category, list, nlist, &buildstate.buildStats);
    }
 
    ...
    // 更新 meta-page 中的信息, 记 XLOG
    ginUpdateStats(index, &buildstate.buildStats);
    ...
    返回结果    
}

在向gin索引中插入数据时，首先和B-tree索引一样，首先需要查找对应的 key 是否存在；
如果 key 已经存在，则查看现在叶子节点中 key 对应的 tids 是 posting tree 还是 posting list，更新 tids;
posting list 如果由于更新导致 tids 比较多，可能变为 posting tree
如果 key 不存在，则在叶子节点中插入这个新的 key 以及对应的 tids。

void ginEntryInsert(GinState *ginstate, OffsetNumber attnum, Datum key, GinNullCategory category,
                    ItemPointerData *items, uint32 nitem, GinStatsData *buildStats)
{
    GinBtreeData btree;
    GinBtreeEntryInsertData insertdata;
    GinBtreeStack *stack = NULL;
    IndexTuple itup;
    Page page;

    insertdata.isDelete = FALSE;

    /* During index build, count the to-be-inserted entry */
    if (buildStats != NULL)
        buildStats->nEntries++;

    ginPrepareEntryScan(&btree, attnum, key, category, ginstate);

    // 在 B-tree 中找到叶子节点
    stack = ginFindLeafPage(&btree, false);
    page = BufferGetPage(stack->buffer);

    // 如果 key 已经存在
    if (btree.findItem(&btree, stack)) {
        /* found pre-existing entry */
        itup = (IndexTuple)PageGetItem(page, PageGetItemId(page, stack->off));
        // 如果是 posting tree 结构
        if (GinIsPostingTree(itup)) {
            /* add entries to existing posting tree */
            BlockNumber rootPostingTree = GinGetPostingTree(itup);

            /* release all stack */
            LockBuffer(stack->buffer, GIN_UNLOCK);
            freeGinBtreeStack(stack);

            /* insert into posting tree */
            ginInsertItemPointers(ginstate->index, rootPostingTree, items, nitem, buildStats);
            return;
        }
        // 如果是 posting  list
        /* modify an existing leaf entry */
        itup = addItemPointersToLeafTuple(ginstate, itup, items, nitem, buildStats);

        insertdata.isDelete = TRUE;
    } else { // 对应的 key 不存在， 需要新建一个叶子节点里的对象
        /* no match, so construct a new leaf entry */
        itup = buildFreshLeafTuple(ginstate, attnum, key, category, items, nitem, buildStats);
    }

    /* Insert the new or modified leaf tuple */
    insertdata.entry = itup;
    ginInsertValue(&btree, stack, &insertdata, buildStats);
    pfree(itup);
    itup = NULL;
}

gin 的 B-tree 也会涉及分裂等问题，和 B-tree 的分裂类似，因此在使用过程中也会有与 B-tree 索引使用过程中 moveright 类似的动作，本文不展开介绍分裂相关内容了。

相关数据结构：

// 用于表示一个 key 及 与其关联的 tids 的数据结构
typedef struct GinEntryAccumulator {
    RBNode rbnode;
    Datum key;
    GinNullCategory category;
    OffsetNumber attnum;
    bool shouldSort;
    ItemPointerData *list;
    uint32 maxcount; /* allocated size of list[] */
    uint32 count;    /* current number of list[] entries */
} GinEntryAccumulator;

// Gin 索引整体结构为 B-tree 结构
// B-tree 中的一个节点
typedef struct GinBtreeStack {
    BlockNumber blkno;
    Buffer buffer;
    OffsetNumber off;
    ItemPointerData iptr;  
    /* predictNumber contains predicted number of pages on current level */
    uint32 predictNumber;
    struct GinBtreeStack *parent; // 父节点
} GinBtreeStack;

typedef struct GinBtreeData *GinBtree;

gin 索引的查找和插入的流程在构建 gin 索引的流程中都有涉及，和 B-tree 有些类似，本文不展开介绍了。
另外需要注意的一点是，gin 索引是行存表和列存表都支持的索引类型，但是在pg_am中行存表的 gin 和 列存表的 gin 是两条记录，cgin pg_am 中相关处理函数如下所示：

可以看出列存表的 gin 索引大部分处理函数和行存表是共用的，但索引构建的实现和行存不同，主要差异点是行存表和列存表底层存储及访问方式的差异，gin 索引本身的实现并没有太大差别。

索引删除和vacuum相关的内容不在本文讨论，这块内容后面单独叙述。

参考资料：
Indexes in PostgreSQL — 7 (GIN)
GIN and GiST Index Types