如何访问PostgreSQL GIN索引的(key, posting list)存储结构？

GIN索引存储一组(key, posting list)对，其中posting list是key出现对应位置的row IDs集合。

PostgreSQL没有面向普通用户开放直接读取GIN索引内部键值对的原生SQL接口，常规查询只会通过GIN索引做匹配过滤，最终返回符合条件的业务数据，不会暴露索引内部存储结构。如果需要拿到原始的(key, posting list)列表，可以通过以下几种方式实现：

• 用官方自带的pageinspect扩展读取：这是最方便的在线读取方式，不需要重启数据库或者修改编译参数
  • 先在目标库执行CREATE EXTENSION pageinspect;加载扩展
  • 调用gin_metap(索引regclass)拿到GIN索引元页信息，获取根节点位置、页大小等基础参数
  • 调用gin_leafpage_items(索引regclass, 页号block号)读取指定叶子页的内容，返回结果会直接展示该页存储的所有key，以及key对应的posting list内容；如果key对应的posting list过长转为posting tree存储，返回结果会带posting tree的根页号
  • 针对posting tree存储的长posting list，调用gin_posting_tree_pages(索引regclass, 页号)遍历对应树结构，就能拿到完整的row ID集合
• 开启数据库调试参数输出扫描明细：
  • 会话级开启debug_print_plan等GIN相关调试参数后，执行触发GIN索引扫描的查询时，数据库日志会打印扫描过程中加载的key、匹配到的posting list范围、最终筛选的row ID等全流程明细，不需要额外安装扩展
• 离线解析索引物理文件：
  • 每个GIN索引在数据目录下对应独立的物理文件，路径为$PGDATA/base/对应数据库OID/索引对应relfilenode编号，按照GIN公开的页存储格式规范，可以直接逐字节解析文件内容，拿到所有持久化存储的(key, posting list)对，这种方式不需要启动数据库实例，适合离线分析场景
• 调试内核进程读取内存结构：
  • 如果是自己编译的带调试符号的PostgreSQL版本，可以用gdb、lldb这类调试工具附加到正在运行的PostgreSQL服务进程，在GIN索引扫描、页面加载的相关内核函数处加断点，直接读取内存中缓存的key和posting list实时数据。

内容的提问来源于stack exchange，提问作者Yorai Levi