如何阅读 TiDB 的源代码（二）

Sun, Jul 12, 2020

接上篇，我们知道了怎么去搭建读代码的环境，从哪里入口来读代码。本篇开始会根据一些常见地查看代码需求，介绍它们的查看方法。

如何查看某个语法的支持程度

常见的有两种方法，

通过 parser repo 来查
直接在 TiDB repo 里查看

这两种方法都需要上篇的环境搭建部分。还没尝试的可以去尝试一下。

准备工作

安装 GoYacc Support

GoYacc Support 插件是我司同学的作品，JetBrains 正式接受的第三方插件，属于上得了厅堂的作品。其包含了语法高亮和 Intelligent，非常赞！
下载 parser repo

如果从 parser 直接看语法，需要手动下载；如果从 TiDB 里跳转，IDEA 会自动下载代码，反而不需要额外操作。

通过 parser repo 来查

用 IDEA 打开 parser，切换到自己需要的分支，找到 parser.y 文件。不过，更推荐的是从 TiDB 里查看。

通过 TiDB repo 来查

用 IDEA 打开 TiDB 工程，切换到需要的分支
找到 parser.y 文件，注意搜索的时候要选最大的搜索的 scope

也可以从文件列表里找到，

下面我们以查 SHOW ENGINES 这个 SQL 来举例。

整个语句解析的入口是 Start 它下面是 StatementList，然后是，Statement。在 Statement 的大列表下，可以找到 ShowStmt

parser.y4

但是 ShowStmt 其实非常复杂，另一种方式是直接在 parser.y 里搜索 ShowEngines，因为其命名都是遵循 Golang 的规则，驼峰式+暴漏对外要首字母大写。当然，如果熟悉代码的话会知道，ShowEngines 其实在 ShowTargetFilterable 里。其第一个分支就是 ShowEngines

parser.y5

那对 SHOW ENGINES 的支持是怎样的呢？

可以看一下对 ast.ShowEngines 是怎么处理的。这里就不能继续跳转了，需要复制后搜索。

parser.y6

这里只需要看 TiDB 下是怎么处理的，test 文件里的也可以直接跳过。

parser.y7

这里一个是实际的实现，

parser.y7

另一个是 build schema，也就是表头，可以不用管，

parser.y7

进了 fetchShowEngines 就能看到了，其实它的具体实现很简单，就是执行一个内部 SQL，读了一下系统表。

parser.y7

查看 SHOW ENGINES 就到此结束了。可以看到它是完全支持的。

哪些语句是只有语法支持的呢？

以创建临时表的语法为例，找到它在 parser.y 里的位置

parser.y8

它是一个选项

parser.y9

其实可以看到，如果指定了临时表选项的话，它只会返回一个 true，然后附加一个 warning，说明，这个表还是按照普通表来处理的。 parser 里以前还有很多只是返回但什么都不干的操作，连 warning 都没有，不过这些现在比较少了。

通过 TiDB repo 查询的好处

可以看到，通过 TiDB repo 来看，可以通过 IDEA 找对应的 parser 的详细的 hash。如果，通过 parser 来直接看需要先从 TiDB 的 go.mod 里查一下 parser 的 hash，然后，在 parser 里 check out 到对应的 hash，如果要查具体实现，需要再回到 TiDB 里，这样查来查去不如在一个工程下看方便，唯一的好处是，可以方便地 blame 提交历史。