oceanbase源码 OceanBase 代码片段

OceanBase 开发者中心（OceanBase Developer Center，ODC）作为企业级数据库开发平台，为您提供代码片段模块以方便您在 ODC 中进行数据库开发工作。当您在开发过程中遗忘了一些语句的具体用法时，可以直接在 ODC 提供的代码片段模块中进行查询。代码片段模块会根据您当前连接的数据库模式（Oracle 或 MySQL）提供对应的代码片段。除了内置的代码片段外，您还可以自定义代码片段以记录您常用的代码方便下次使用，自定义的代码片段仅可被创建者查看。

在 SQL 窗口、匿名块窗口和 PL 对象编辑页面的工具栏中，单击 代码片段 按钮弹出代码片段面板。

查看代码片段

在代码片段面板中以卡片列表的形式展示代码片段，每个卡片上直接展示了代码片段名称、代码片段描述和代码片段类型等信息。将鼠标放置在卡片代码片段名称后的提示图标上，会浮现提示窗展示目标代码片段的全部代码信息。

在卡片列表的上方 ODC 提供了搜索框，您可以借助搜索功能直接查找具体的代码片段。在搜索框的下方提供按类型进行筛选的筛选器。筛选器中默认选中全部类型，您可以单击筛选器选择筛选出 常规、DML、DDL、流程控制语句 和 全部类型 的代码片段。

新建代码片段

在代码片段列表的右上角，单击 +新建 按钮弹出 新建代码片段 面板。在面板中需指定以下信息：

• 代码片段名称：指定代码片段的名称。名称可由英文字母、数字和下划线组成，长度不超过 60 字符，必填项。

• 代码片段类型：选择代码的类型。支持选择 常规、DML、DDL 和 流程控制语句 等类型，默认为 常规 类型。

• 代码片段：在 代码片段 标签下的编辑框中输入代码片段的具体代码内容，长度不能超过 200 字符，必填项。与 SQL 窗口类似，编辑区的工具栏中还提供了格式化、查找/替换、撤销、重做、大小写、缩进和注释等工具，且提供代码高亮和联想等功能。

• 代码片段描述：对代码片段内容的补充说明，长度不能超过 200 字符，必填项。

引用代码片段

创建好的代码片段除了供您在编辑脚本的时候查看代码的具体内容外，还支持直接将内容直接引用进脚本。引用代码片段有以下三种方法：

• 方法一：您可以直接将列表中的卡片拖拽进编辑区中，该代码片段指定的代码内容将被粘贴进编辑区。

• 方法二：在目标代码片段的卡片上，单击卡片右下角的复制图标以复制代码内容，在编辑区中通过快捷键 Ctrl+V 或 Cmd + V 将代码内容粘贴进编辑区。

• 方法三：SQL 窗口的编辑区支持代码联想功能，当您在编辑区中编辑脚本时，创建好的代码片段会出现在代码联想的提示窗中，您可以通过代码联想的提示查看和引用代码片段。

管理代码片段

自定义的代码片段提供 编辑 和 删除 两个管理操作，您无法对内置的代码片段进行管理。

• 编辑：单击目标代码卡片右上角的管理图标（···）在弹出的列表中单击 编辑 按钮进入 编辑代码片段 面板。面板中展示新建代码片段时指定的 代码片段名称、代码片段类型、代码片段 和 代码片段描述 等信息，您可以按需进行修改。

• 删除：单击目标代码卡片右上角的管理图标（···）在弹出的列表中单击 删除 按钮以删除当前代码片段。